about summary refs log tree commit diff stats
path: root/docs/profanity-sub.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-sub.1')
-rw-r--r--docs/profanity-sub.173
1 files changed, 73 insertions, 0 deletions
diff --git a/docs/profanity-sub.1 b/docs/profanity-sub.1
new file mode 100644
index 00000000..9da04634
--- /dev/null
+++ b/docs/profanity-sub.1
@@ -0,0 +1,73 @@
+.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
+
+.SH NAME
+/sub
+
+.SH DESCRIPTION
+Manage subscriptions to contact presence. If jid is omitted, the contact of the current window is used.
+
+.SH SYNOPSIS
+/sub request [<jid>]
+
+.LP
+/sub allow [<jid>]
+
+.LP
+/sub deny [<jid>]
+
+.LP
+/sub show [<jid>]
+
+.LP
+/sub sent
+
+.LP
+/sub received
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fBrequest [<jid>]\fR
+.RS 4
+Send a subscription request to the user.
+.RE
+.PP
+\fBallow [<jid>]\fR
+.RS 4
+Approve a contact's subscription request.
+.RE
+.PP
+\fBdeny [<jid>]\fR
+.RS 4
+Remove subscription for a contact, or deny a request.
+.RE
+.PP
+\fBshow [<jid>]\fR
+.RS 4
+Show subscription status for a contact.
+.RE
+.PP
+\fBsent\fR
+.RS 4
+Show all sent subscription requests pending a response.
+.RE
+.PP
+\fBreceived\fR
+.RS 4
+Show all received subscription requests awaiting your response.
+.RE
+
+.SH EXAMPLES
+/sub request odin@valhalla.edda
+
+.LP
+/sub allow odin@valhalla.edda
+
+.LP
+/sub request
+
+.LP
+/sub sent
+
+.LP