about summary refs log tree commit diff stats
path: root/docs/profanity-alias.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-alias.1')
-rw-r--r--docs/profanity-alias.152
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/profanity-alias.1 b/docs/profanity-alias.1
new file mode 100644
index 00000000..eb6aa28a
--- /dev/null
+++ b/docs/profanity-alias.1
@@ -0,0 +1,52 @@
+.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
+
+.SH NAME
+/alias
+
+.SH DESCRIPTION
+Add, remove or list command aliases.
+
+.SH SYNOPSIS
+/alias list
+
+.LP
+/alias add <name> <value>
+
+.LP
+/alias remove <name>
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fBlist\fR
+.RS 4
+List all aliases.
+.RE
+.PP
+\fBadd <name> <value>\fR
+.RS 4
+Add a new command alias.
+.RE
+.PP
+\fBremove <name>\fR
+.RS 4
+Remove a command alias.
+.RE
+
+.SH EXAMPLES
+/alias add friends /who online friends
+
+.LP
+/alias add /q /quit
+
+.LP
+/alias add a /away "I'm in a meeting."
+
+.LP
+/alias remove q
+
+.LP
+/alias list
+
+.LP