about summary refs log tree commit diff stats
path: root/docs/profanity-subject.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-subject.1')
-rw-r--r--docs/profanity-subject.159
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/profanity-subject.1 b/docs/profanity-subject.1
new file mode 100644
index 00000000..0e2dff92
--- /dev/null
+++ b/docs/profanity-subject.1
@@ -0,0 +1,59 @@
+.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
+
+.SH NAME
+/subject
+
+.SH DESCRIPTION
+Set, modify, or clear room subject.
+
+.SH SYNOPSIS
+/subject set <subject>
+
+.LP
+/subject edit <subject>
+
+.LP
+/subject editor
+
+.LP
+/subject prepend <text>
+
+.LP
+/subject append <text>
+
+.LP
+/subject clear
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fBset <subject>\fR
+.RS 4
+Set the room subject.
+.RE
+.PP
+\fBedit <subject>\fR
+.RS 4
+Edit the current room subject, tab autocompletion will display the subject to edit.
+.RE
+.PP
+\fBeditor\fR
+.RS 4
+Edit the current room subject in external editor.
+.RE
+.PP
+\fBprepend <text>\fR
+.RS 4
+Prepend text to the current room subject, use double quotes if a trailing space is needed.
+.RE
+.PP
+\fBappend <text>\fR
+.RS 4
+Append text to the current room subject, use double quotes if a preceding space is needed.
+.RE
+.PP
+\fBclear\fR
+.RS 4
+Clear the room subject.
+.RE