about summary refs log tree commit diff stats
path: root/docs/profanity-role.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-role.1')
-rw-r--r--docs/profanity-role.127
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/profanity-role.1 b/docs/profanity-role.1
new file mode 100644
index 00000000..4d843b2e
--- /dev/null
+++ b/docs/profanity-role.1
@@ -0,0 +1,27 @@
+.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
+
+.SH NAME
+/role
+
+.SH DESCRIPTION
+Manage room roles. Role may be one of moderator, participant, visitor or none.
+
+.SH SYNOPSIS
+/role set <role> <nick> [<reason>]
+
+.LP
+/role list [<role>]
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fBset <role> <nick> [<reason>]\fR
+.RS 4
+Set the role of occupant with nick, with an optional reason.
+.RE
+.PP
+\fBlist [<role>]\fR
+.RS 4
+List all occupants with the specified role, or all if none specified.
+.RE