about summary refs log tree commit diff stats
path: root/docs/profanity-close.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-close.1')
-rw-r--r--docs/profanity-close.175
1 files changed, 75 insertions, 0 deletions
diff --git a/docs/profanity-close.1 b/docs/profanity-close.1
new file mode 100644
index 00000000..ce7735cd
--- /dev/null
+++ b/docs/profanity-close.1
@@ -0,0 +1,75 @@
+.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client"
+
+.SH NAME
+/close
+
+.SH DESCRIPTION
+Close windows. Passing no argument closes the current window.
+
+.SH SYNOPSIS
+/close
+
+.LP
+/close <num>
+
+.LP
+/close <barejid>
+
+.LP
+/close <nick>
+
+.LP
+/close <roomjid>
+
+.LP
+/close <roomoccupantjid>
+
+.LP
+/close xmlconsole
+
+.LP
+/close all|read
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fB<num>\fR
+.RS 4
+Close specified window number.
+.RE
+.PP
+\fB<barejid>\fR
+.RS 4
+Close chat window with contact by JID if open.
+.RE
+.PP
+\fB<nick>\fR
+.RS 4
+Close chat window with contact by nickname if open.
+.RE
+.PP
+\fB<roomjid>\fR
+.RS 4
+Close chat room window with roomjid if open.
+.RE
+.PP
+\fB<roomoccupantjid>\fR
+.RS 4
+Close private chat roomoccupantjid if open.
+.RE
+.PP
+\fBxmlconsole\fR
+.RS 4
+Close the XML Console window if open.
+.RE
+.PP
+\fBall\fR
+.RS 4
+Close all windows.
+.RE
+.PP
+\fBread\fR
+.RS 4
+Close all windows that have no unread messages.
+.RE