History

fix up man page a bit and put it into a readme

Sigrid Haflínudóttir committed 6 years ago

Commit cb2c30b1 parent 38fbed92 files · +111 −21Browse files

Unified · Split

2 files
  1. README +91 −0
  2. xmpp.man +20 −21
README+91−0
@@ -0,0 +1,91 @@
1XMPP(1) General Commands Manual XMPP(1)
2
3
4
5NAME
6 xmpp - XMPP client
7
8SYNOPSIS
9 xmpp [ -n nick ] [ -r resource ] [ -p ] [ -h ] [ -y ] jid | jid@server
10
11DESCRIPTION
12 xmpp is a simple XMPP client.
13
14 It supports multi-user chat (MUC). Server-side bookmarks are used to
15 join specific MUCs automatically on connect. TLS is required, SCRAM-
16 SHA-1, DIGEST-MD5 and PLAIN authentication methods are supported. The
17 latter is enabled using -y option. Thumbprints of trusted servers are
18 expected to be in /sys/lib/tls/xmpp, see thumbprint(6).
19
20 -p enables "joined"/"left" messages, which are disabled by default.
21
22 -h allows MUCs to send out "discussion history".
23
24 The command language understood by xmpp is as follows:
25 /j [jid[/nick] [passwd]]
26 join MUC
27 /p [target]
28 part MUC
29 /q data
30 send raw data to the server
31 /t target
32 cycle through matching targets
33 /w [target]
34 get list of active nicks in the MUC
35 /W [target]
36 get list of all nicks in the MUC
37 /b
38 list bookmarked MUCs
39 /b+
40 bookmark current MUC
41 /b-
42 remove current MUC from bookmarks
43 /a target affiliation
44 set affiliation (for a target in MUC)
45 /a [room]
46 get affiliations for a room (current one if no args given)
47 /me ...
48 "/me"-style message
49 /m
50 start multiline message (end with a dot on a single line)
51 /n nick
52 set nick for current MUC
53 /r
54 show roster (list online contacts)
55 /R
56 show roster (show offline and jids)
57 /r+ (jid|target) [name]
58 subscribe/approve, add to roster
59 /r- target
60 unsubscribe/decline, remove from roster
61 /s [room]
62 show current subject
63 /S [room]
64 start new subject (end with a dot on a single line)
65
66 Affiliations are: none, owner, admin, member, outcast.
67
68 The target can be specified as follows:
69 room@domain a specific room
70 room@domain/nick private chat (MUC)
71 Wernher private chat (roster, name)
72 wernher@paperclip.gov private chat (roster, jid)
73
74 Assuming you previously joined a MUC pravda@cc.cpsu.su, you can quickly
75 switch to private chat with kgbvax as follows:
76 /t pravda/kgbvax
77 /t pr/kgb
78 /t p/k
79
80SOURCE
81 https://github.com/ftrvxmtrx/xmpp
82
83BUGS
84 Of course.
85
86NOTES
87 XMPP sucks. XML sucks.
88
89
90
91 XMPP(1)
xmpp.man+20−21
@@ -46,83 +46,83 @@ is as follows: · 45 unmodified lines
46.EX46.EX
47/j [jid[/nick] [passwd]]47/j [jid[/nick] [passwd]]
48.EE48.EE
49 join MUC49 join MUC
50.EX50.EX
51/p [target]51/p [target]
52.EE52.EE
53 part MUC53 part MUC
54.EX54.EX
55/q data55/q data
56.EE56.EE
57 send raw data to the server57 send raw data to the server
58.EX58.EX
59/t target59/t target
60.EE60.EE
61 cycle through matching targets61 cycle through matching targets
62.EX62.EX
63/w [target]63/w [target]
64.EE64.EE
65 get list of active nicks in the MUC65 get list of active nicks in the MUC
66.EX66.EX
67/W [target]67/W [target]
68 get list of all nicks in the MUC
69.EE68.EE
69 get list of all nicks in the MUC
70.EX70.EX
71/b71/b
72.EE72.EE
73 list bookmarked MUCs73 list bookmarked MUCs
74.EX74.EX
75/b+75/b+
76.EE76.EE
77 bookmark current MUC77 bookmark current MUC
78.EX78.EX
79/b-79/b-
80.EE80.EE
81 remove current MUC from bookmarks81 remove current MUC from bookmarks
82.EX82.EX
83/a target affiliation83/a target affiliation
84.EE84.EE
85 set affiliation (for a target in MUC)85 set affiliation (for a target in MUC)
86.EX86.EX
87/a [room]87/a [room]
88.EE88.EE
89 get affiliations for a room (current one if no args given)89 get affiliations for a room (current one if no args given)
90.EX90.EX
91/me ...91/me ...
92.EE92.EE
93 "/me"-style message93 "/me"-style message
94.EX94.EX
95/m95/m
96.EE96.EE
97 start multiline message (end with a dot on a single line)97 start multiline message (end with a dot on a single line)
98.EX98.EX
99/n nick99/n nick
100.EE100.EE
101 set nick for current MUC101 set nick for current MUC
102.EX102.EX
103/r103/r
104.EE104.EE
105 show roster (list online contacts)105 show roster (list online contacts)
106.EX106.EX
107/R107/R
108.EE108.EE
109 show roster (show offline and jids)109 show roster (show offline and jids)
110.EX110.EX
111/r+ (jid|target) [name]111/r+ (jid|target) [name]
112.EE112.EE
113 subscribe/approve, add to roster113 subscribe/approve, add to roster
114.EX114.EX
115/r- target115/r- target
116.EE116.EE
117 unsubscribe/decline, remove from roster117 unsubscribe/decline, remove from roster
118.EX118.EX
119/s [room]119/s [room]
120.EE120.EE
121 show current subject121 show current subject
122.EX122.EX
123/S [room]123/S [room]
124.EE124.EE
125 start new subject (end with a dot on a single line)125 start new subject (end with a dot on a single line)
126.PP126.PP
127Affiliations are: none, owner, admin, member, outcast.127Affiliations are: none, owner, admin, member, outcast.
128.PP128.PP
@@ -144,7 +144,6 @@ as follows: · 15 unmodified lines
144/t pr/kgb144/t pr/kgb
145/t p/k145/t p/k
146.EE146.EE
147.PP
148.SH SOURCE147.SH SOURCE
149https://github.com/ftrvxmtrx/xmpp148https://github.com/ftrvxmtrx/xmpp
150.SH BUGS149.SH BUGS

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t