ref: cb2c30bfbf3f7d0ce1ecc28faf6891c98ab28273
parent: 38fbed97371f4f970a542945883e7d68762a2184
author: Sigrid Haflínudóttir <[email protected]>
date: Mon Mar 16 14:32:49 EDT 2020
fix up man page a bit and put it into a readme
--- /dev/null
+++ b/README
@@ -1,0 +1,91 @@
+XMPP(1) General Commands Manual XMPP(1)
+
+
+
+NAME
+ xmpp - XMPP client
+
+SYNOPSIS
+ xmpp [ -n nick ] [ -r resource ] [ -p ] [ -h ] [ -y ] jid | jid@server
+
+DESCRIPTION
+ xmpp is a simple XMPP client.
+
+ It supports multi-user chat (MUC). Server-side bookmarks are used to
+ join specific MUCs automatically on connect. TLS is required, SCRAM-
+ SHA-1, DIGEST-MD5 and PLAIN authentication methods are supported. The
+ latter is enabled using -y option. Thumbprints of trusted servers are
+ expected to be in /sys/lib/tls/xmpp, see thumbprint(6).
+
+ -p enables "joined"/"left" messages, which are disabled by default.
+
+ -h allows MUCs to send out "discussion history".
+
+ The command language understood by xmpp is as follows:
+ /j [jid[/nick] [passwd]]
+ join MUC
+ /p [target]
+ part MUC
+ /q data
+ send raw data to the server
+ /t target
+ cycle through matching targets
+ /w [target]
+ get list of active nicks in the MUC
+ /W [target]
+ get list of all nicks in the MUC
+ /b
+ list bookmarked MUCs
+ /b+
+ bookmark current MUC
+ /b-
+ remove current MUC from bookmarks
+ /a target affiliation
+ set affiliation (for a target in MUC)
+ /a [room]
+ get affiliations for a room (current one if no args given)
+ /me ...
+ "/me"-style message
+ /m
+ start multiline message (end with a dot on a single line)
+ /n nick
+ set nick for current MUC
+ /r
+ show roster (list online contacts)
+ /R
+ show roster (show offline and jids)
+ /r+ (jid|target) [name]
+ subscribe/approve, add to roster
+ /r- target
+ unsubscribe/decline, remove from roster
+ /s [room]
+ show current subject
+ /S [room]
+ start new subject (end with a dot on a single line)
+
+ Affiliations are: none, owner, admin, member, outcast.
+
+ The target can be specified as follows:
+ room@domain a specific room
+ room@domain/nick private chat (MUC)
+ Wernher private chat (roster, name)
+ [email protected] private chat (roster, jid)
+
+ Assuming you previously joined a MUC [email protected], you can quickly
+ switch to private chat with kgbvax as follows:
+ /t pravda/kgbvax
+ /t pr/kgb
+ /t p/k
+
+SOURCE
+ https://github.com/ftrvxmtrx/xmpp
+
+BUGS
+ Of course.
+
+NOTES
+ XMPP sucks. XML sucks.
+
+
+
+ XMPP(1)
--- a/xmpp.man
+++ b/xmpp.man
@@ -46,83 +46,83 @@
.EX
/j [jid[/nick] [passwd]]
.EE
- join MUC
+ join MUC
.EX
/p [target]
.EE
- part MUC
+ part MUC
.EX
/q data
.EE
- send raw data to the server
+ send raw data to the server
.EX
/t target
.EE
- cycle through matching targets
+ cycle through matching targets
.EX
/w [target]
.EE
- get list of active nicks in the MUC
+ get list of active nicks in the MUC
.EX
/W [target]
- get list of all nicks in the MUC
.EE
+ get list of all nicks in the MUC
.EX
/b
.EE
- list bookmarked MUCs
+ list bookmarked MUCs
.EX
/b+
.EE
- bookmark current MUC
+ bookmark current MUC
.EX
/b-
.EE
- remove current MUC from bookmarks
+ remove current MUC from bookmarks
.EX
/a target affiliation
.EE
- set affiliation (for a target in MUC)
+ set affiliation (for a target in MUC)
.EX
/a [room]
.EE
- get affiliations for a room (current one if no args given)
+ get affiliations for a room (current one if no args given)
.EX
/me ...
.EE
- "/me"-style message
+ "/me"-style message
.EX
/m
.EE
- start multiline message (end with a dot on a single line)
+ start multiline message (end with a dot on a single line)
.EX
/n nick
.EE
- set nick for current MUC
+ set nick for current MUC
.EX
/r
.EE
- show roster (list online contacts)
+ show roster (list online contacts)
.EX
/R
.EE
- show roster (show offline and jids)
+ show roster (show offline and jids)
.EX
/r+ (jid|target) [name]
.EE
- subscribe/approve, add to roster
+ subscribe/approve, add to roster
.EX
/r- target
.EE
- unsubscribe/decline, remove from roster
+ unsubscribe/decline, remove from roster
.EX
/s [room]
.EE
- show current subject
+ show current subject
.EX
/S [room]
.EE
- start new subject (end with a dot on a single line)
+ start new subject (end with a dot on a single line)
.PP
Affiliations are: none, owner, admin, member, outcast.
.PP
@@ -144,7 +144,6 @@
/t pr/kgb
/t p/k
.EE
-.PP
.SH SOURCE
https://github.com/ftrvxmtrx/xmpp
.SH BUGS