about summary refs log tree commit diff stats
path: root/docs/profanity-msg.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/profanity-msg.1')
-rw-r--r--docs/profanity-msg.151
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/profanity-msg.1 b/docs/profanity-msg.1
new file mode 100644
index 00000000..6d9c0fcc
--- /dev/null
+++ b/docs/profanity-msg.1
@@ -0,0 +1,51 @@
+.TH man 1 "2022-10-12" "0.13.0" "Profanity XMPP client"
+
+.SH NAME
+/msg
+
+.SH DESCRIPTION
+Send a one to one chat message, or a private message to a chat room occupant. If the message is omitted, a new chat window will be opened without sending a message. Use quotes if the nickname includes spaces.
+
+.SH SYNOPSIS
+/msg <contact> [<message>]
+
+.LP
+/msg <nick> [<message>]
+
+.LP
+
+.SH ARGUMENTS
+.PP
+\fB<contact>\fR
+.RS 4
+Open chat window with contact, by JID or nickname.
+.RE
+.PP
+\fB<contact> [<message>]\fR
+.RS 4
+Send message to contact, by JID or nickname.
+.RE
+.PP
+\fB<nick>\fR
+.RS 4
+Open private chat window with chat room occupant.
+.RE
+.PP
+\fB<nick> [<message>]\fR
+.RS 4
+Send a private message to a chat room occupant.
+.RE
+
+.SH EXAMPLES
+/msg thor@valhalla.edda Hey, here's a message!
+
+.LP
+/msg heimdall@valhalla.edda
+
+.LP
+/msg Thor Here is a private message
+
+.LP
+/msg "My Friend" Hi, how are you?
+
+.LP