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 @@
1+XMPP(1) General Commands Manual XMPP(1)
2+
3+
4+
5+NAME
6+ xmpp - XMPP client
7+
8+SYNOPSIS
9+ xmpp [ -n nick ] [ -r resource ] [ -p ] [ -h ] [ -y ] jid | jid@server
10+
11+DESCRIPTION
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+
80+SOURCE
81+ https://github.com/ftrvxmtrx/xmpp
82+
83+BUGS
84+ Of course.
85+
86+NOTES
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
4646 .EX
4747 /j [jid[/nick] [passwd]]
4848 .EE
49− join MUC
49+ join MUC
5050 .EX
5151 /p [target]
5252 .EE
53− part MUC
53+ part MUC
5454 .EX
5555 /q data
5656 .EE
57− send raw data to the server
57+ send raw data to the server
5858 .EX
5959 /t target
6060 .EE
61− cycle through matching targets
61+ cycle through matching targets
6262 .EX
6363 /w [target]
6464 .EE
65− get list of active nicks in the MUC
65+ get list of active nicks in the MUC
6666 .EX
6767 /W [target]
68− get list of all nicks in the MUC
6968 .EE
69+ get list of all nicks in the MUC
7070 .EX
7171 /b
7272 .EE
73− list bookmarked MUCs
73+ list bookmarked MUCs
7474 .EX
7575 /b+
7676 .EE
77− bookmark current MUC
77+ bookmark current MUC
7878 .EX
7979 /b-
8080 .EE
81− remove current MUC from bookmarks
81+ remove current MUC from bookmarks
8282 .EX
8383 /a target affiliation
8484 .EE
85− set affiliation (for a target in MUC)
85+ set affiliation (for a target in MUC)
8686 .EX
8787 /a [room]
8888 .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)
9090 .EX
9191 /me ...
9292 .EE
93− "/me"-style message
93+ "/me"-style message
9494 .EX
9595 /m
9696 .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)
9898 .EX
9999 /n nick
100100 .EE
101− set nick for current MUC
101+ set nick for current MUC
102102 .EX
103103 /r
104104 .EE
105− show roster (list online contacts)
105+ show roster (list online contacts)
106106 .EX
107107 /R
108108 .EE
109− show roster (show offline and jids)
109+ show roster (show offline and jids)
110110 .EX
111111 /r+ (jid|target) [name]
112112 .EE
113− subscribe/approve, add to roster
113+ subscribe/approve, add to roster
114114 .EX
115115 /r- target
116116 .EE
117− unsubscribe/decline, remove from roster
117+ unsubscribe/decline, remove from roster
118118 .EX
119119 /s [room]
120120 .EE
121− show current subject
121+ show current subject
122122 .EX
123123 /S [room]
124124 .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)
126126 .PP
127127 Affiliations are: none, owner, admin, member, outcast.
128128 .PP
@@ -144,7 +144,6 @@ as follows: · 15 unmodified lines
144144 /t pr/kgb
145145 /t p/k
146146 .EE
147−.PP
148147 .SH SOURCE
149148 https://github.com/ftrvxmtrx/xmpp
150149 .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