about summary refs log tree commit diff stats
path: root/docs/profanity-mood.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-mood.1')
-rw-r--r--docs/profanity-mood.146
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/profanity-mood.1 b/docs/profanity-mood.1
new file mode 100644
index 00000000..f319fd0f
--- /dev/null
+++ b/docs/profanity-mood.1
@@ -0,0 +1,46 @@
+.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
+
+.SH NAME
+/mood
+
+.SH DESCRIPTION
+Set your mood (XEP-0107).
+
+.SH SYNOPSIS
+/mood on|off
+
+.LP
+/mood set <mood> [text]
+
+.LP
+/mood clear
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fBon|off\fR
+.RS 4
+Enable or disable displaying the mood of other users. On by default.
+.RE
+.PP
+\fBset <mood> [text]\fR
+.RS 4
+Set user mood to <mood> with an optional [text]. Use /mood set <tab> to toggle through predefined moods.
+.RE
+.PP
+\fBclear\fR
+.RS 4
+Clear your user mood.
+.RE
+
+.SH EXAMPLES
+/mood set happy "So happy to use Profanity!"
+
+.LP
+/mood set amazed
+
+.LP
+/mood clear
+
+.LP