about summary refs log tree commit diff stats
path: root/docs/profanity-affiliation.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-affiliation.1')
-rw-r--r--docs/profanity-affiliation.143
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/profanity-affiliation.1 b/docs/profanity-affiliation.1
new file mode 100644
index 00000000..daccf5a4
--- /dev/null
+++ b/docs/profanity-affiliation.1
@@ -0,0 +1,43 @@
+.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
+
+.SH NAME
+/affiliation
+
+.SH DESCRIPTION
+Manage room affiliations. Affiliation may be one of owner, admin, member, outcast or none.
+
+.SH SYNOPSIS
+/affiliation set <affiliation> <jid> [<reason>]
+
+.LP
+/affiliation list [<affiliation>]
+
+.LP
+/affiliation request
+
+.LP
+/affiliation register
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fBset <affiliation> <jid> [<reason>]\fR
+.RS 4
+Set the affiliation of user with jid, with an optional reason.
+.RE
+.PP
+\fBlist [<affiliation>]\fR
+.RS 4
+List all users with the specified affiliation, or all if none specified.
+.RE
+.PP
+\fBrequest\fR
+.RS 4
+Request voice.
+.RE
+.PP
+\fBregister\fR
+.RS 4
+Register your nickname with the MUC.
+.RE