about summary refs log tree commit diff stats
path: root/docs/profanity-status.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-status.1')
-rw-r--r--docs/profanity-status.148
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/profanity-status.1 b/docs/profanity-status.1
new file mode 100644
index 00000000..5edfec2c
--- /dev/null
+++ b/docs/profanity-status.1
@@ -0,0 +1,48 @@
+.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client"
+
+.SH NAME
+/status
+
+.SH DESCRIPTION
+/status get: Find out a contact, or room members presence information. /status set: set own status.
+
+.SH SYNOPSIS
+/status set <state> ["<message>"]
+
+.LP
+/status get <contact>|<nick>
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fB<state>\fR
+.RS 4
+Own status. Possible values: chat, online, away, dnd, xa
+.RE
+.PP
+\fB<message>\fR
+.RS 4
+Optional message to use with the status. Needs quotation marks if it's more than one word.
+.RE
+.PP
+\fB<contact>\fR
+.RS 4
+The contact who's presence you which to see.
+.RE
+.PP
+\fB<nick>\fR
+.RS 4
+If in a chat room, the occupant who's presence you wish to see.
+.RE
+
+.SH EXAMPLES
+/status get odin@valhalla.edda
+
+.LP
+/status get jon
+
+.LP
+/status set online
+
+.LP