about summary refs log tree commit diff stats
path: root/docs/profanity-invite.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-invite.1')
-rw-r--r--docs/profanity-invite.146
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/profanity-invite.1 b/docs/profanity-invite.1
new file mode 100644
index 00000000..c351fb8a
--- /dev/null
+++ b/docs/profanity-invite.1
@@ -0,0 +1,46 @@
+.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
+
+.SH NAME
+/invite
+
+.SH DESCRIPTION
+Manage room invites. Send an invite to a contact for the current chat room. List received invites. Decline them using /invite decline and accept them using /join.
+
+.SH SYNOPSIS
+/invite send <contact> [<message>]
+
+.LP
+/invite list
+
+.LP
+/invite decline
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fBsend <contact> [<message>]\fR
+.RS 4
+The contact you wish to invite. And an optional message.
+.RE
+.PP
+\fBlist\fR
+.RS 4
+Show all rooms that you have been invited to, and not accepted or declined.
+.RE
+.PP
+\fBdecline <room>\fR
+.RS 4
+Decline a chat room invitation.
+.RE
+
+.SH EXAMPLES
+/invite send gustavo@pollos.tx
+
+.LP
+/invite decline profanity@rooms.dismail.de
+
+.LP
+/invite list
+
+.LP