about summary refs log tree commit diff stats
path: root/docs/profanity-ban.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-ban.1')
-rw-r--r--docs/profanity-ban.124
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/profanity-ban.1 b/docs/profanity-ban.1
new file mode 100644
index 00000000..548a2409
--- /dev/null
+++ b/docs/profanity-ban.1
@@ -0,0 +1,24 @@
+.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
+
+.SH NAME
+/ban
+
+.SH DESCRIPTION
+Ban user from chat room.
+
+.SH SYNOPSIS
+/ban <jid> [<reason>]
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fB<jid>\fR
+.RS 4
+Bare JID of the user to ban from the room.
+.RE
+.PP
+\fB<reason>\fR
+.RS 4
+Optional reason for banning the user.
+.RE