about summary refs log tree commit diff stats
path: root/docs/profanity-console.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-console.1')
-rw-r--r--docs/profanity-console.170
1 files changed, 70 insertions, 0 deletions
diff --git a/docs/profanity-console.1 b/docs/profanity-console.1
new file mode 100644
index 00000000..2ef7ee19
--- /dev/null
+++ b/docs/profanity-console.1
@@ -0,0 +1,70 @@
+.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
+
+.SH NAME
+/console
+
+.SH DESCRIPTION
+Configure what is displayed in the console window when messages are received. The default is set to 'all' for all types of messages.
+
+.SH SYNOPSIS
+/console chat all|first|none
+
+.LP
+/console muc all|first|mention|none
+
+.LP
+/console private all|first|none
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fBchat all\fR
+.RS 4
+Indicate all new chat messages in the console.
+.RE
+.PP
+\fBchat first\fR
+.RS 4
+Indicate only the first new message per chat in the console.
+.RE
+.PP
+\fBchat none\fR
+.RS 4
+Do not show any new chat messages in the console window.
+.RE
+.PP
+\fBmuc all\fR
+.RS 4
+Indicate all new chat room messages in the console.
+.RE
+.PP
+\fBmuc first\fR
+.RS 4
+Indicate only the first new message in each room in the console.
+.RE
+.PP
+\fBmuc mention\fR
+.RS 4
+Indicate only messages in which you have beeen mentioned in the console.
+.RE
+.PP
+\fBmuc none\fR
+.RS 4
+Do not show any new chat room messages in the console window.
+.RE
+.PP
+\fBprivate all\fR
+.RS 4
+Indicate all new private room messages in the console.
+.RE
+.PP
+\fBprivate first\fR
+.RS 4
+Indicate only the first private room message in the console.
+.RE
+.PP
+\fBprivate none\fR
+.RS 4
+Do not show any new private room messages in the console window.
+.RE