about summary refs log tree commit diff stats
path: root/docs/profanity-script.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-script.1')
-rw-r--r--docs/profanity-script.146
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/profanity-script.1 b/docs/profanity-script.1
new file mode 100644
index 00000000..03f214e8
--- /dev/null
+++ b/docs/profanity-script.1
@@ -0,0 +1,46 @@
+.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
+
+.SH NAME
+/script
+
+.SH DESCRIPTION
+Run command scripts. Scripts are stored in $XDG_DATA_HOME/profanity/scripts/ which is usually $HOME/.local/share/profanity/scripts/.
+
+.SH SYNOPSIS
+/script run <script>
+
+.LP
+/script list
+
+.LP
+/script show <script>
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fBscript run <script>\fR
+.RS 4
+Execute a script.
+.RE
+.PP
+\fBscript list\fR
+.RS 4
+List all scripts TODO.
+.RE
+.PP
+\fBscript show <script>\fR
+.RS 4
+Show the commands in script TODO.
+.RE
+
+.SH EXAMPLES
+/script list
+
+.LP
+/script run myscript
+
+.LP
+/script show somescript
+
+.LP