Mercurial > hg
annotate mcabber/doc/mcabber.1 @ 2349:b951567c78bf 1.1.1
Release 1.1.1
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Sun, 06 Sep 2020 19:24:27 +0200 |
parents | 457891789a7d |
children | 1d4274111c5d |
rev | line source |
---|---|
1759 | 1 '\" t |
1096 | 2 .\" Title: mcabber |
2314 | 3 .\" Author: Mikael BERTHE <mcabber@lilotux.net> |
4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> | |
2349 | 5 .\" Date: September 2020 |
1759 | 6 .\" Manual: \ \& |
2349 | 7 .\" Source: \ \& 1.1.1 |
1759 | 8 .\" Language: English |
1096 | 9 .\" |
2349 | 10 .TH "MCABBER" "1" "September 2020" "\ \& 1\&.1\&.1" "\ \&" |
1759 | 11 .\" ----------------------------------------------------------------- |
12 .\" * Define some portability stuff | |
13 .\" ----------------------------------------------------------------- | |
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
15 .\" http://bugs.debian.org/507673 | |
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html | |
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
18 .ie \n(.g .ds Aq \(aq | |
19 .el .ds Aq ' | |
20 .\" ----------------------------------------------------------------- | |
21 .\" * set default formatting | |
22 .\" ----------------------------------------------------------------- | |
1096 | 23 .\" disable hyphenation |
24 .nh | |
25 .\" disable justification (adjust text to left margin only) | |
26 .ad l | |
1759 | 27 .\" ----------------------------------------------------------------- |
28 .\" * MAIN CONTENT STARTS HERE * | |
29 .\" ----------------------------------------------------------------- | |
1096 | 30 .SH "NAME" |
1759 | 31 mcabber \- a simple Jabber (XMPP) console client |
226 | 32 .SH "SYNOPSIS" |
1242 | 33 .sp |
1759 | 34 \fImcabber\fR [ \-h | \-V | \-f configfile ] |
226 | 35 .SH "DESCRIPTION" |
1242 | 36 .sp |
1759 | 37 mcabber(1) is a small Jabber (XMPP) console client\&. For now it needs a configuration file to start, so please copy the sample mcabberrc file and adapt your connection settings\&. |
38 .sp | |
39 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet\&. | |
1242 | 40 .sp |
226 | 41 Here are some of the features of mcabber: |
1242 | 42 .sp |
43 .RS 4 | |
1759 | 44 .ie n \{\ |
45 \h'-04'\(bu\h'+03'\c | |
46 .\} | |
47 .el \{\ | |
48 .sp -1 | |
49 .IP \(bu 2.3 | |
50 .\} | |
51 \fISASL/SSL/TLS support\fR\&. | |
1242 | 52 .RE |
53 .sp | |
54 .RS 4 | |
1759 | 55 .ie n \{\ |
56 \h'-04'\(bu\h'+03'\c | |
57 .\} | |
58 .el \{\ | |
59 .sp -1 | |
60 .IP \(bu 2.3 | |
61 .\} | |
1096 | 62 \fIMUC support\fR |
1759 | 63 (Multi\-User Chat)\&. |
1242 | 64 .RE |
65 .sp | |
66 .RS 4 | |
1759 | 67 .ie n \{\ |
68 \h'-04'\(bu\h'+03'\c | |
69 .\} | |
70 .el \{\ | |
71 .sp -1 | |
72 .IP \(bu 2.3 | |
73 .\} | |
74 \fIPGP, OTR support\fR | |
1242 | 75 .RE |
76 .sp | |
77 .RS 4 | |
1759 | 78 .ie n \{\ |
79 \h'-04'\(bu\h'+03'\c | |
80 .\} | |
81 .el \{\ | |
82 .sp -1 | |
83 .IP \(bu 2.3 | |
84 .\} | |
1096 | 85 \fIChat States\fR |
86 support (typing notifications) | |
1242 | 87 .RE |
88 .sp | |
89 .RS 4 | |
1759 | 90 .ie n \{\ |
91 \h'-04'\(bu\h'+03'\c | |
92 .\} | |
93 .el \{\ | |
94 .sp -1 | |
95 .IP \(bu 2.3 | |
96 .\} | |
1096 | 97 \fIHistory logging:\fR |
98 If enabled (see the CONFIGURATION FILE section), | |
99 mcabber | |
1759 | 100 can save discussions to text history log files\&. |
1242 | 101 .RE |
102 .sp | |
103 .RS 4 | |
1759 | 104 .ie n \{\ |
105 \h'-04'\(bu\h'+03'\c | |
106 .\} | |
107 .el \{\ | |
108 .sp -1 | |
109 .IP \(bu 2.3 | |
110 .\} | |
1096 | 111 \fICommands completion:\fR |
112 If possible, | |
113 mcabber | |
1759 | 114 will try to complete your command line if you hit the Tab key\&. |
1242 | 115 .RE |
116 .sp | |
117 .RS 4 | |
1759 | 118 .ie n \{\ |
119 \h'-04'\(bu\h'+03'\c | |
120 .\} | |
121 .el \{\ | |
122 .sp -1 | |
123 .IP \(bu 2.3 | |
124 .\} | |
1096 | 125 \fIInput line history:\fR |
1759 | 126 Any message or command entered is in the input line history and can be reused easily\&. |
1242 | 127 .RE |
128 .sp | |
129 .RS 4 | |
1759 | 130 .ie n \{\ |
131 \h'-04'\(bu\h'+03'\c | |
132 .\} | |
133 .el \{\ | |
134 .sp -1 | |
135 .IP \(bu 2.3 | |
136 .\} | |
1096 | 137 \fIExternal actions:\fR |
1759 | 138 Some events (like receiving a message) can trigger an external action such as a shell script if you enable it in your configuration file\&. A sample events script ("eventcmd") is provided with |
1096 | 139 mcabber |
1759 | 140 source code, in the contrib directory\&. |
141 .RE | |
142 .sp | |
143 .RS 4 | |
144 .ie n \{\ | |
145 \h'-04'\(bu\h'+03'\c | |
146 .\} | |
147 .el \{\ | |
148 .sp -1 | |
149 .IP \(bu 2.3 | |
150 .\} | |
2314 | 151 \fIModules:\fRmcabber |
1759 | 152 can load modules (a\&.k\&.a\&. plugins) at runtime that extend its features\&. |
1242 | 153 .RE |
1096 | 154 .SH "OPTIONS" |
155 .PP | |
1759 | 156 \-h |
1242 | 157 .RS 4 |
1096 | 158 Quick help usage message |
159 .RE | |
160 .PP | |
1759 | 161 \-V |
162 .RS 4 | |
163 Displays | |
164 mcabber | |
165 version and compile\-time definitions\&. | |
166 .RE | |
167 .PP | |
1096 | 168 \-f configfile |
1242 | 169 .RS 4 |
1096 | 170 Use configuration file |
171 \fIconfigfile\fR | |
172 .RE | |
173 .SH "WINDOWS/PANES" | |
1242 | 174 .sp |
1759 | 175 The mcabber(1) screen is divided into 4 regions\&. The \fIroster\fR, alias \fIbuddylist\fR, is on the left\&. The \fIchat window\fR, or chat buffer, is on the right\&. The \fIinput line\fR lies at the bottom of the screen, under a small \fIlog window\fR\&. |
1242 | 176 .sp |
1759 | 177 Two status lines surround the log window\&. The bottom status line is the "main status line" and reflects mcabber general status\&. The other line is the "chat status line" and shows the status of the currently selected buddy\&. |
178 .sp | |
2314 | 179 To display buddies chat buffers, you will have to enter \fIchat mode\fR\&. You can enter chat mode by pressing enter (unless \fIvi mode\fR is enabled), and leave chat mode with the ESC key\&. Simply sending a message will also enable chat mode (unless \fIvi mode\fR is enabled)\&. |
1242 | 180 .sp |
1759 | 181 There are several advantages to the two\-mode implementation: first, it allows accurate "unread" message functionality, as described in the next section; without this, merely scrolling to a specific buddy will "read" the new messages of all buddies in\-between\&. Second, it allows quickly hiding the conversation with a single keystroke\&. Third, it allows jumping between the few buddies with whom you are conversing with the \fI/roster alternate\fR command described in another section, without having to manually scroll back and forth\&. |
182 .SH "KEYS" | |
1242 | 183 .sp |
1759 | 184 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...)\&. |
1242 | 185 .sp |
1759 | 186 PageUp and PageDown keys are used to move in the roster\&. |
1242 | 187 .sp |
1759 | 188 Up and Down arrow keys can be used to move in the input line history; they jump to the previous/next line from the history beginning with the same string (from first column to the cursor column)\&. |
1242 | 189 .sp |
1759 | 190 To send a message, move to the chosen buddy in the buddylist, type your message and hit enter\&. If the line begins with a slash, this will be interpreted as a command (see the COMMAND section below)\&. Hit escape to leave the chat mode\&. |
1242 | 191 .sp |
1759 | 192 Here is a quick description of the default key bindings: |
193 .PP | |
194 Esc | |
195 .RS 4 | |
196 Disable chat mode | |
197 .RE | |
198 .PP | |
199 Ctrl\-a | |
200 .RS 4 | |
201 Go to the beginning of the input line | |
202 .RE | |
203 .PP | |
204 Ctrl\-e | |
205 .RS 4 | |
206 Go to the end of the input line | |
207 .RE | |
208 .PP | |
209 Ctrl\-l | |
210 .RS 4 | |
211 Force a refresh | |
212 .RE | |
213 .PP | |
214 Up/Down | |
215 .RS 4 | |
216 Move in the input line history | |
217 .RE | |
218 .PP | |
219 PgUp/PgDown | |
220 .RS 4 | |
221 Move inside the roster (buddylist) | |
222 .RE | |
223 .PP | |
224 Tab | |
225 .RS 4 | |
226 Complete current word, in the input line | |
227 .RE | |
228 .PP | |
229 Ctrl\-g | |
230 .RS 4 | |
231 Cancel completion | |
232 .RE | |
233 .PP | |
234 Ctrl\-c | |
235 .RS 4 | |
236 Abort multi\-line messages and completions | |
237 .RE | |
238 .PP | |
239 Ctrl\-d | |
240 .RS 4 | |
241 Send/terminate a multi\-line message | |
242 .RE | |
243 .PP | |
244 Ctrl\-p/Ctrl\-n | |
245 .RS 4 | |
246 Scroll up/down half a screen in the buffer window (chat mode) | |
247 .RE | |
248 .PP | |
249 Ctrl\-Left | |
250 .RS 4 | |
251 Move the cursor back to the start of the current or previous word | |
252 .RE | |
253 .PP | |
254 Ctrl\-Right | |
255 .RS 4 | |
256 Move the cursor forward to the end of the current or next word | |
257 .RE | |
258 .PP | |
259 Ctrl\-u | |
260 .RS 4 | |
261 Delete from beginning of the line to the cursor | |
262 .RE | |
263 .PP | |
264 Ctrl\-k | |
265 .RS 4 | |
266 Delete from the cursor to the end of line | |
267 .RE | |
268 .PP | |
1096 | 269 Ctrl\-w |
1759 | 270 .RS 4 |
1096 | 271 Backward kill word |
1759 | 272 .RE |
273 .PP | |
1096 | 274 Ctrl\-t |
1759 | 275 .RS 4 |
1096 | 276 Transpose chars |
1759 | 277 .RE |
278 .PP | |
1096 | 279 Ctrl\-o |
1759 | 280 .RS 4 |
1096 | 281 Accept line and put the next history line in the input line (accept\-line\-and\-down\-history) |
1759 | 282 .RE |
1242 | 283 .sp |
1759 | 284 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section\&. |
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
285 .SH "VI MODE" |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
286 .sp |
2314 | 287 If the "vi_mode" option is set to 1, mcabber(1) accepts a few commands loosely based on those available in vi(1)\*(Aqs normal mode\&. In this case, chat mode is not entered by pressing enter, and messages cannot be composed outside of the chat mode\&. The following commands are accepted: |
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
288 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
289 A |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
290 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
291 Call "/roster unread_first"\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
292 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
293 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
294 a |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
295 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
296 Call "/roster unread_next"\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
297 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
298 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
299 F |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
300 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
301 Call "/roster group_prev"\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
302 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
303 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
304 f |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
305 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
306 Call "/roster group_next"\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
307 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
308 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
309 G |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
310 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
311 Call "/roster bottom"\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
312 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
313 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
314 gg |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
315 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
316 Call "/roster top"\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
317 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
318 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
319 i |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
320 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
321 Enter chat mode\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
322 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
323 .PP |
2314 | 324 [N]j |
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
325 .RS 4 |
2314 | 326 Call "/roster down [N]"\&. |
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
327 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
328 .PP |
2314 | 329 [N]k |
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
330 .RS 4 |
2314 | 331 Call "/roster up [N]"\&. |
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
332 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
333 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
334 n |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
335 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
336 Repeat the previous search (if any)\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
337 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
338 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
339 O |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
340 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
341 Call "/roster unread_first" and open chat window\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
342 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
343 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
344 o |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
345 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
346 Call "/roster unread_next" and open chat window\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
347 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
348 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
349 ZZ |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
350 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
351 Call "/quit"\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
352 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
353 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
354 zM |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
355 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
356 Call "/group fold" for all groups\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
357 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
358 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
359 zR |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
360 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
361 Call "/group unfold" for all groups\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
362 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
363 .PP |
2314 | 364 \*(Aq\*(Aq |
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
365 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
366 Call "/roster alternate"\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
367 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
368 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
369 ! |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
370 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
371 Toggle attention flag for current buddy\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
372 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
373 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
374 # |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
375 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
376 Toggle unread messages flag for current buddy\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
377 .RE |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
378 .PP |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
379 <Space> |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
380 .RS 4 |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
381 Call "/group toggle" for the current group\&. |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
382 .RE |
2314 | 383 .sp |
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
384 A leading slash enables search mode: |
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
385 .PP |
2314 | 386 /string |
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
387 .RS 4 |
2314 | 388 Call "/roster search string"\&. |
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
389 .RE |
2314 | 390 .sp |
391 A leading colon enabled command\-line mode: | |
392 .sp | |
393 .if n \{\ | |
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
394 .RS 4 |
2314 | 395 .\} |
396 .nf | |
397 above commands)\&. | |
398 .fi | |
399 .if n \{\ | |
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
400 .RE |
2314 | 401 .\} |
402 .sp | |
403 Commands entered with a leading colon and searches are either submitted by pressing enter or aborted by hitting escape\&. In either case, mcabber(1) returns to the normal (non\-chat) mode\&. History editing is supported in command\-line mode and in search mode\&. In command\-line mode, tab completion is supported as well\&. | |
1759 | 404 .SH "MCABBER\(cqS ROSTER" |
1242 | 405 .sp |
1842 | 406 The first listed item on the roster is \fI[status]\fR, which keeps a log of everything that appears in the short log window below the main chat area\&. While the log window was designed for showing the latest few elements, the dedicated \fI[status]\fR buffer allows more comfortable viewing of the log, as well as scrolling it in a standard manner\&. |
1242 | 407 .sp |
1842 | 408 Group names are displayed above the items that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&. |
1242 | 409 .sp |
1842 | 410 For every real Jabber contact, the roster displays four pieces of information: the buddy\(cqs name or alias, its online status, its authorization status, and whether there are unread messages from the buddy waiting for you\&. |
1242 | 411 .sp |
854 | 412 The online status is one of the following: |
1759 | 413 .PP |
1096 | 414 \fIo\fR |
1759 | 415 .RS 4 |
1096 | 416 online |
1759 | 417 .RE |
418 .PP | |
419 \fIf\fR | |
420 .RS 4 | |
421 free for chat | |
422 .RE | |
423 .PP | |
424 \fIa\fR | |
425 .RS 4 | |
426 away | |
427 .RE | |
428 .PP | |
429 \fIn\fR | |
430 .RS 4 | |
431 not available (labeled | |
432 \fIextended away\fR | |
433 in some clients) | |
434 .RE | |
435 .PP | |
436 \fId\fR | |
437 .RS 4 | |
438 do not disturb | |
439 .RE | |
440 .PP | |
441 \fI_\fR | |
442 .RS 4 | |
443 offline (or invisible to you) | |
444 .RE | |
445 .PP | |
446 \fI?\fR | |
447 .RS 4 | |
1842 | 448 unknown, usually meaning you are not authorized to see this buddy\(cqs status |
1759 | 449 .RE |
450 .PP | |
451 \fIx\fR | |
452 .RS 4 | |
453 a conference room in which you are not participating | |
454 .RE | |
455 .PP | |
1096 | 456 \fIC\fR |
1759 | 457 .RS 4 |
1096 | 458 a conference room in which you are participating |
1759 | 459 .RE |
1242 | 460 .sp |
1842 | 461 The authorization status indicates whether a buddy is authorized to receive your online status updates, and is displayed by the brackets surrounding the buddy\(cqs online status\&. Square brackets, like \fI[o]\fR, indicate that this buddy is authorized to receive your status\&. Curly braces, like \fI{o}\fR, indicate that they are not authorized to receive your status\&. |
1242 | 462 .sp |
1842 | 463 When there are unread messages from a buddy which you have not looked at, a hash mark (\fI#\fR) appears in the leftmost section of the roster for that buddy\&. The hash mark disappears once you view that buddy\(cqs message buffer\&. When the user attention is requested (or when you receive a message containing your nickname in a MUC room), the hash mark is replaced with the \fIattention sign\fR, an exclamation mark (\fI!\fR)\&. |
1242 | 464 .sp |
854 | 465 Examples: |
1759 | 466 .PP |
2314 | 467 \*(Aq \-\-\- Buds\*(Aq |
1759 | 468 .RS 4 |
469 This is a group named | |
470 \fIBuds\fR | |
471 .RE | |
472 .PP | |
1096 | 473 \fI#[o] John\fR |
1759 | 474 .RS 4 |
1096 | 475 John is online, can see your status, and sent you a message that you did not read yet |
1759 | 476 .RE |
477 .PP | |
2314 | 478 \*(Aq {?} Sally\*(Aq |
1759 | 479 .RS 4 |
480 Neither you nor Sally have authorized each other to see your online status | |
481 .RE | |
482 .PP | |
2314 | 483 \*(Aq {a} Jane\*(Aq |
1759 | 484 .RS 4 |
485 Jane is away, but she cannot see your online status | |
486 .RE | |
487 .PP | |
488 \fI#[C] x@y\&.c\fR | |
489 .RS 4 | |
490 You are participating in x@y\&.c conference room, and there are unread messages | |
491 .RE | |
492 .SH "COMMANDS" | |
1242 | 493 .sp |
1759 | 494 Please refer to the online help (command /help), it is probably more up\-to\-date than this manpage\&. Furthermore, help files have been translated into several languages\&. You will find an overview of the mcabber commands in this manual\&. |
495 .SH "COMMANDS RELATED TO MCABBER" | |
496 .PP | |
497 /add [jid [nickname]] | |
498 .RS 4 | |
499 Add the "jid" Jabber user to our roster (default group), and send a notification request to this buddy\&. If no nickname is specified, the jid is used\&. If no jid (or an empty string "") is provided or if jid is "\&.", the current buddy is used\&. | |
500 .PP | |
501 [\fIjid\fR [nickname]] | |
502 .RS 4 | |
503 Add to our roster "jid" as "nickname" | |
1242 | 504 .sp |
1759 | 505 .if n \{\ |
506 .RS 4 | |
507 .\} | |
508 .nf | |
509 Example: "/add somebody@jabber\&.server\&.com Somebody" | |
510 .fi | |
511 .if n \{\ | |
512 .RE | |
513 .\} | |
514 .RE | |
515 .RE | |
1096 | 516 .PP |
517 /alias [name [= command line]] | |
1242 | 518 .RS 4 |
1759 | 519 This command let you to add aliases which can simplify sophisticated commands\&. |
520 | |
521 You can manage your aliases by: | |
522 .PP | |
523 (without arguments) | |
524 .RS 4 | |
525 Print list of currently defined aliases | |
526 .RE | |
527 .PP | |
528 \fIname\fR | |
529 .RS 4 | |
530 Print the value of alias called "name" | |
531 .RE | |
532 .PP | |
533 \fIname\fR= | |
534 .RS 4 | |
535 Unset alias called "name" | |
536 .RE | |
537 .PP | |
538 \fIname\fR = command line | |
539 .RS 4 | |
540 Set alias called "name" with value "command line" | |
541 .sp | |
542 .if n \{\ | |
543 .RS 4 | |
544 .\} | |
545 .nf | |
546 Example: "/alias away = status away" | |
547 .fi | |
548 .if n \{\ | |
549 .RE | |
550 .\} | |
551 .RE | |
552 .RE | |
553 .PP | |
554 /authorization allow|cancel|request|request_unsubscribe [jid] | |
555 .RS 4 | |
556 This command manages presence subscriptions: it allows you to request presence subscriptions from others on your roster, and allows you to control who receives your presence notifications\&. | |
557 | |
558 If no JID is provided, the currently\-selected buddy is used\&. | |
559 .PP | |
560 \fIallow\fR | |
561 .RS 4 | |
562 Allow the buddy to receive your presence updates | |
563 .RE | |
564 .PP | |
565 \fIcancel\fR | |
566 .RS 4 | |
567 Cancel the buddy\(cqs subscription to your presence updates | |
568 .RE | |
569 .PP | |
570 \fIrequest\fR | |
571 .RS 4 | |
572 Request a subscription to the buddy\(cqs presence updates | |
573 .RE | |
574 .PP | |
575 \fIrequest_unsubscribe\fR | |
576 .RS 4 | |
577 Request unsubscription from the buddy\(cqs presence updates | |
578 .RE | |
1096 | 579 .RE |
580 .PP | |
581 /bind [keycode [= command line]] | |
1242 | 582 .RS 4 |
1759 | 583 Bind the command to the key given as "keycode"\&. To examine which keys are currently not used look at |
584 mcabber | |
585 log window and press examined key\&. For example: "Unknown key=265" means that you can bind some command to key #265\&. | |
586 .PP | |
587 (without arguments) | |
588 .RS 4 | |
589 Display list of current bindings | |
590 .RE | |
591 .PP | |
592 \fIkeycode\fR | |
593 .RS 4 | |
594 Display the command line bound to this key | |
595 .RE | |
596 .PP | |
597 \fIkeycode\fR= | |
598 .RS 4 | |
599 Unbind key with code "keycode" | |
600 .RE | |
601 .PP | |
602 \fIkeycode\fR = command line | |
603 .RS 4 | |
604 Bind "command line" to the key with code "keycode" | |
605 .sp | |
606 .if n \{\ | |
607 .RS 4 | |
608 .\} | |
609 .nf | |
610 Example: "/bind 265 = status away" (265 is F1)\&. + | |
611 Note: keycodes can be different depending on your ncurses configuration\&. + | |
612 Tip: aliases also can be used instead of commands\&. | |
613 .fi | |
614 .if n \{\ | |
615 .RE | |
616 .\} | |
617 .RE | |
618 .RE | |
619 .PP | |
620 /buffer clear|close|close_all|purge|list, /buffer top|bottom|date|%|search_backward|search_forward, /buffer scroll_lock|scroll_unlock|scroll_toggle, /buffer save filename | |
621 .RS 4 | |
1842 | 622 Buddy\(cqs buffer manipulation command\&. E\&.g\&. you can search through buffer for "text", clear chat window etc\&. |
1759 | 623 .PP |
624 \fIclear\fR | |
625 .RS 4 | |
626 Clear the current buddy chat window | |
627 .RE | |
628 .PP | |
629 \fIclose\fR [jid] | |
630 .RS 4 | |
631 Empty all contents of the buffer and close the current buddy chat window | |
632 .RE | |
633 .PP | |
634 \fIclose_all\fR | |
635 .RS 4 | |
636 Empty all contents of the chat buffers and close the chat windows | |
637 .RE | |
638 .PP | |
639 \fIpurge\fR [jid] | |
640 .RS 4 | |
641 Clear the current buddy chat window and empty all contents of the chat buffer | |
642 .RE | |
643 .PP | |
644 \fIlist\fR | |
645 .RS 4 | |
646 Display the list of existing buffers, with their length (lines/blocks) | |
1096 | 647 .RE |
648 .PP | |
1759 | 649 \fItop\fR |
1242 | 650 .RS 4 |
1759 | 651 Jump to the top of the current buddy chat buffer |
652 .RE | |
653 .PP | |
1096 | 654 \fIbottom\fR |
1759 | 655 .RS 4 |
656 Jump to the bottom of the current buddy chat buffer | |
657 .RE | |
658 .PP | |
659 \fIup\fR [n] | |
660 .RS 4 | |
661 Scroll the buffer up [n] lines (default: half a screen) | |
662 .RE | |
663 .PP | |
664 \fIdown\fR [n] | |
665 .RS 4 | |
666 Scroll the buffer down [n] lines (default: half a screen) | |
667 .RE | |
668 .PP | |
669 \fIdate\fR [date] | |
670 .RS 4 | |
671 Jump to the first line after the specified [date] in the chat buffer (date format: "YYYY\-mm\-dd") | |
672 .RE | |
673 .PP | |
674 % n | |
675 .RS 4 | |
676 Jump to position %n of the buddy chat buffer | |
677 .RE | |
678 .PP | |
679 \fIsearch_backward\fR text | |
680 .RS 4 | |
681 Search for [text] in the current buddy chat buffer | |
682 .RE | |
683 .PP | |
684 \fIsearch_forward\fR text | |
685 .RS 4 | |
686 Search for [text] in the current buddy chat buffer | |
687 .RE | |
688 .PP | |
1139 | 689 \fIscroll_lock\fR |
1759 | 690 .RS 4 |
691 Lock buffer scrolling | |
692 .RE | |
693 .PP | |
1139 | 694 \fIscroll_unlock\fR |
1759 | 695 .RS 4 |
696 Unlock buffer scrolling | |
697 .RE | |
698 .PP | |
1139 | 699 \fIscroll_toggle\fR |
1759 | 700 .RS 4 |
701 Toggle buffer scrolling (lock/unlock) | |
702 .RE | |
703 .PP | |
704 \fIsave\fR filename | |
705 .RS 4 | |
706 Save the contents of the current buffer to the file "filename" | |
707 .RE | |
708 .RE | |
709 .PP | |
710 /chat_disable [\-\-show\-roster] | |
711 .RS 4 | |
712 Disable chat mode\&. | |
713 | |
714 With \-\-show\-roster, the fullscreen mode will be disabled\&. | |
1096 | 715 .RE |
716 .PP | |
717 /clear | |
1242 | 718 .RS 4 |
1759 | 719 This command is actually an alias for "/buffer clear"\&. It clears the current buddy chat window\&. |
720 .RE | |
721 .PP | |
722 /color roster (status wildcard (color|\-)|clear), /color mucnick nick (color|\-), /color muc (jid|\&.|*) [on|preset|off|\-] | |
723 .RS 4 | |
1096 | 724 The |
1759 | 725 \fIcolor\fR |
726 command allows setting dynamic color properties of the screen\&. | |
727 .PP | |
728 \fIroster\fR clear | |
729 .RS 4 | |
730 Remove all color rules for the roster\&. All roster items will get its default color\&. | |
731 .RE | |
732 .PP | |
733 \fIroster\fR status wildcard color | |
734 .RS 4 | |
735 Set a color rule (or overwrite, if it already exists)\&. The status is string containing all statuses the roster item can have for the rule to match, or * if any status is OK\&. Wildcard is the file\-matching wildcard that will be applied to JID\&. Color is the wanted color\&. If color is \-, the rule is removed\&. If more than one rule matches, the color from the last created (not overwritten) is used\&. | |
736 .RE | |
737 .PP | |
738 \fImucnick\fR nick (color|\-) | |
739 .RS 4 | |
740 Marks the nick to be colored by given color\&. If a MUC has colored nicks, this one will be used\&. If color is \-, the color is marked as chosen automatically, which means it will not be used in | |
741 \fIpreset\fR | |
742 coloring mode, but will stay the same in | |
743 \fIon\fR | |
744 coloring mode\&. | |
745 .RE | |
746 .PP | |
747 \fImuc\fR (jid|\&.|*) [on|preset|off|\-] | |
748 .RS 4 | |
749 Sets a MUC nick coloring mode\&. If a jid (\&. means currently selected jid) is provided, the mode will apply to this specific MUC\&. If * is used, it will be applied to all MUCs, except the ones set by their jid\&. Mode | |
750 \fIon\fR | |
751 colors all nicks, | |
752 \fIpreset\fR | |
753 only the ones manually set by /color mucnick command and | |
754 \fIoff\fR | |
755 colors none\&. If not specified, defaults to | |
756 \fIon\fR\&. Mode | |
757 \fI\-\fR | |
758 removes the mode from given JID, which means the global one will apply\&. You can not remove the global mode\&. Default global coloring mode is | |
759 \fIoff\fR\&. | |
760 .RE | |
761 .RE | |
762 .PP | |
763 /connect | |
764 .RS 4 | |
765 Establish connection to the Jabber server\&. | |
766 .RE | |
767 .PP | |
768 /del | |
769 .RS 4 | |
770 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&. | |
771 .RE | |
772 .PP | |
773 /disconnect | |
774 .RS 4 | |
775 Terminate the connection to the Jabber server\&. | |
776 | |
777 Note: the roster is only available when the connection to the server is active, so the buddylist is empty when disconnected\&. | |
778 .RE | |
779 .PP | |
780 /echo message | |
781 .RS 4 | |
782 Display "message" in the log window\&. | |
783 .RE | |
784 .PP | |
785 /event #n|* accept|ignore|reject [event\-specific arguments], /event list | |
786 .RS 4 | |
787 Tell mcabber what to do about pending events\&. | |
788 | |
789 If the first parameter is | |
790 \fI*\fR, the command will apply to all queued events\&. | |
791 | |
792 Event\-specific arguments will be interpreted on event\-to event basis\&. The only built\-in case, when argument is used is MUC invitation reject \- argument, if present, will be interpreted as reject reason\&. | |
793 .PP | |
794 #N|* accept [event\-specific arguments] | |
795 .RS 4 | |
796 Event number #N/All events will be accepted | |
797 .RE | |
798 .PP | |
799 #N|* ignore [event\-specific arguments] | |
800 .RS 4 | |
801 Event number #N/All events will be ignored | |
802 .RE | |
803 .PP | |
804 #N|* reject [event\-specific arguments] | |
805 .RS 4 | |
806 Event number #N/All events will be rejected | |
807 .RE | |
808 .PP | |
809 \fIlist\fR | |
810 .RS 4 | |
811 List all pending events | |
812 .RE | |
813 .RE | |
814 .PP | |
815 /group fold|unfold|toggle [groupname] | |
816 .RS 4 | |
817 This command changes the current group display\&. | |
818 .PP | |
819 \fIfold\fR [groupname] | |
820 .RS 4 | |
821 Fold (shrink) the current/specified group tree in the roster | |
822 .RE | |
823 .PP | |
824 \fIunfold\fR [groupname] | |
825 .RS 4 | |
826 Unfold (expand) the current/specified group tree in the roster | |
827 .RE | |
828 .PP | |
829 \fItoggle\fR [groupname] | |
830 .RS 4 | |
831 Toggle the state (fold/unfold) of the current/specified tree | |
832 .RE | |
833 .RE | |
834 .PP | |
835 /help [command|+topic] | |
836 .RS 4 | |
837 Display help for command "command" or topic "topic"\&. | |
838 | |
839 Example: "/help buffer" | |
840 .RE | |
841 .PP | |
842 /iline fchar|bchar|char_fdel|char_bdel|char_swap, /iline fword|bword|word_bdel|word_fdel, /iline word_upcase|word_downcase|word_capit, /iline hist_beginning_search_bwd|hist_beginning_search_fwd, /iline hist_prev|hist_next, /iline iline_start|iline_end|iline_fdel|iline_bdel, /iline iline_accept|iline_accept_down_hist, /iline compl_do|compl_cancel, /iline send_multiline | |
843 .RS 4 | |
844 Input line commands | |
845 .PP | |
846 \fIfchar\fR | |
847 .RS 4 | |
848 Move to the next letter | |
849 .RE | |
850 .PP | |
851 \fIbchar\fR | |
852 .RS 4 | |
853 Move to the previous letter | |
854 .RE | |
855 .PP | |
856 \fIchar_fdel\fR | |
857 .RS 4 | |
858 Delete the letter at cursor position | |
859 .RE | |
860 .PP | |
861 \fIchar_bdel\fR | |
862 .RS 4 | |
863 Delete the letter before cursor position | |
864 .RE | |
865 .PP | |
866 \fIchar_swap\fR | |
867 .RS 4 | |
868 Transpose chars | |
869 .RE | |
870 .PP | |
871 \fIfword\fR | |
872 .RS 4 | |
873 Move the cursor forward to the end of the current or next word | |
874 .RE | |
875 .PP | |
876 \fIbword\fR | |
877 .RS 4 | |
878 Move the cursor back to the start of the current or previous word | |
879 .RE | |
880 .PP | |
881 \fIword_bdel\fR | |
882 .RS 4 | |
883 Delete the word from cursor position to its start | |
884 .RE | |
885 .PP | |
886 \fIword_fdel\fR | |
887 .RS 4 | |
888 Delete the word from cursor position to its end | |
889 .RE | |
890 .PP | |
891 \fIword_upcase\fR | |
892 .RS 4 | |
893 Convert the word from cursor position to its end to upper case | |
894 .RE | |
895 .PP | |
896 \fIword_downcase\fR | |
897 .RS 4 | |
898 Convert the word from cursor position to its end to down case | |
899 .RE | |
900 .PP | |
901 \fIword_capit\fR | |
902 .RS 4 | |
903 Capitalize the word from cursor position to its end | |
904 .RE | |
905 .PP | |
906 \fIhist_beginning_search_bwd\fR | |
907 .RS 4 | |
908 Search backward in the history for a line beginning with the current line up to the cursor (this leaves the cursor in its original position) | |
909 .RE | |
910 .PP | |
911 \fIhist_beginning_search_fwd\fR | |
912 .RS 4 | |
913 Search forward in the history for a line beginning with the current line up to the cursor (this leaves the cursor in its original position) | |
914 .RE | |
915 .PP | |
916 \fIhist_prev\fR | |
917 .RS 4 | |
918 Previous line of input line history | |
919 .RE | |
920 .PP | |
921 \fIhist_next\fR | |
922 .RS 4 | |
923 Next line of input line history | |
924 .RE | |
925 .PP | |
926 \fIiline_start\fR | |
927 .RS 4 | |
928 Go to the beginning of the input line | |
929 .RE | |
930 .PP | |
931 \fIiline_end\fR | |
932 .RS 4 | |
933 Go to the end of the input line | |
934 .RE | |
935 .PP | |
936 \fIiline_fdel\fR | |
937 .RS 4 | |
938 Delete from the cursor to the end of line | |
1096 | 939 .RE |
940 .PP | |
1759 | 941 \fIiline_bdel\fR |
942 .RS 4 | |
943 Delete from beginning of the line to the cursor | |
944 .RE | |
945 .PP | |
946 \fIiline_accept\fR | |
947 .RS 4 | |
948 Accept line | |
949 .RE | |
950 .PP | |
951 \fIiline_accept_down_hist\fR | |
952 .RS 4 | |
953 Accept line and put the next history line in the input line | |
954 .RE | |
955 .PP | |
956 \fIcompl_do\fR | |
957 .RS 4 | |
958 Complete current word, in the input line | |
959 .RE | |
960 .PP | |
961 \fIcompl_cancel\fR | |
962 .RS 4 | |
963 Cancel completion | |
964 .RE | |
965 .PP | |
966 \fIsend_multiline\fR | |
967 .RS 4 | |
968 Send/terminate a multi\-line message | |
969 .RE | |
970 .RE | |
971 .PP | |
972 /info | |
973 .RS 4 | |
974 Display info on the selected entry (user, agent, group\&...)\&. | |
975 | |
976 For users, resources are displayed with the status, priority and status message (if available) of each resource\&. | |
977 .RE | |
978 .PP | |
979 /module load|unload [\-f] module, /module info module, /module [list] | |
980 .RS 4 | |
981 Load, unload or show info on module\&. | |
982 .PP | |
983 \fIload\fR [\-f] module | |
984 .RS 4 | |
985 Loads specified module\&. If \-f flag is specified, most of module loading errors will be ignored\&. | |
986 .RE | |
987 .PP | |
988 \fIunload\fR [\-f] module | |
989 .RS 4 | |
1842 | 990 Unloads specified module\&. Note: The force flag will not remove any dependency on this module! |
1759 | 991 .RE |
992 .PP | |
993 \fIinfo\fR module | |
994 .RS 4 | |
995 Shows available information about this module\&. | |
996 .RE | |
997 .PP | |
998 [\fIlist\fR] | |
999 .RS 4 | |
1000 Lists modules in a format: [modulename] [reference count] ([Manually/Automatically loaded]) [any extra info, like version or dependencies] | |
1001 .RE | |
1002 .RE | |
1003 .PP | |
1004 /move [groupname] | |
1005 .RS 4 | |
1006 Move the current buddy to the requested group\&. If no group is specified, then the buddy is moved to the default group\&. If the group "groupname" doesn\(cqt exist, it is created\&. | |
1007 | |
1008 Tip: if the chatmode is enabled, you can use "/roster alternate" to jump to the moved buddy\&. | |
1009 .RE | |
1010 .PP | |
1011 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort | |
1012 .RS 4 | |
1013 Send a multi\-line message\&. To write a single message with several lines, the | |
1014 \fImulti\-line mode\fR | |
1015 should be used\&. | |
1016 | |
1017 In multi\-line mode, each line (except command lines) typed in the input line will be added to the multi\-line message\&. Once the message is finished, it can be sent to the current selected buddy with the "/msay send" command\&. | |
1018 | |
1019 The | |
1020 \fIbegin\fR | |
1021 subcommand enables multi\-line mode\&. Note that it allows a message subject to be specified\&. | |
1022 | |
1023 The | |
1024 \fIverbatim\fR | |
1025 multi\-line mode disables commands, so that it is possible to enter lines starting with a slash\&. Only the "/msay" command (with send or abort parameters) can be used to exit verbatim mode\&. | |
1026 | |
1027 The | |
1028 \fItoggle\fR | |
1029 subcommand can be bound to a key to use the multi\-line mode quickly (for example, "bind M13 = msay toggle" to switch using the Meta\-Enter combination)\&. | |
1030 .PP | |
1031 \fIbegin\fR [subject] | |
1032 .RS 4 | |
1033 Enter multi\-line mode | |
1034 .RE | |
1035 .PP | |
1036 \fIverbatim\fR | |
1037 .RS 4 | |
1038 Enter verbatim multi\-line mode | |
1039 .RE | |
1040 .PP | |
1041 \fIsend\fR [\-n|\-h] | |
1042 .RS 4 | |
1043 Send the current multi\-line message to the currently selected buddy | |
1044 .RE | |
1045 .PP | |
1046 \fIsend_to\fR [\-n|\-h] jid | |
1242 | 1047 .RS 4 |
1759 | 1048 Send the current multi\-line message to "jid" |
1049 .RE | |
1050 .PP | |
1051 \fItoggle\fR|\fItoggle_verbatim\fR | |
1052 .RS 4 | |
1053 Switch to/from multi\-line mode (begin/send) | |
1054 .RE | |
1055 .PP | |
1056 \fIabort\fR | |
1057 .RS 4 | |
1058 Leave multi\-line mode without sending the message | |
1059 .sp | |
1060 .if n \{\ | |
1061 .RS 4 | |
1062 .\} | |
1063 .nf | |
1064 The \-n or \-h flags turn the message to "normal" or "headline" accordingly, as opposed to default "chat" message\&. | |
1065 .fi | |
1066 .if n \{\ | |
1067 .RE | |
1068 .\} | |
1069 .RE | |
1070 .RE | |
1071 .PP | |
1072 /otr key, /otr start|stop|info [jid], /otr fingerprint [jid [fpr]], /otr smpq|smpr [jid] secret, /otr smpa [jid] | |
1073 .RS 4 | |
1074 You can use the shortcut\-jid "\&." for the currently selected contact\&. | |
1075 .PP | |
1076 \fIkey\fR | |
1077 .RS 4 | |
1078 Print the fingerprint of your private key to the Status Buffer | |
1079 .RE | |
1080 .PP | |
1081 \fIstart\fR [jid] | |
1082 .RS 4 | |
1083 Open an OTR channel to the specified jid (or the currently selected contact) | |
1084 .RE | |
1085 .PP | |
1086 \fIstop\fR [jid] | |
1087 .RS 4 | |
1088 Close the OTR channel to the specified jid (or the currently selected contact) | |
1089 .RE | |
1090 .PP | |
1091 \fIinfo\fR [jid] | |
1092 .RS 4 | |
1093 Show current OTR status for the specified jid (or the currently selected contact) | |
1094 .RE | |
1095 .PP | |
1096 \fIfingerprint\fR [jid [fpr]] | |
1097 .RS 4 | |
1098 Show the active fingerprint of an OTR channel\&. If the fingerprint is provided instead of "fpr", the fingerprint will become trusted\&. If you replace "fpr" by some bogus string the fingerprint will loose the trusted status\&. | |
1099 .RE | |
1100 .PP | |
1101 \fIsmpq\fR [jid] secret | |
1102 .RS 4 | |
1103 Initiate the Socialist Millionaires Protocol with the secret and the buddy | |
1104 .RE | |
1105 .PP | |
1106 \fIsmpr\fR [jid] secret | |
1107 .RS 4 | |
1108 Respond to the Initiation of the jid with the secret | |
1109 .RE | |
1110 .PP | |
1111 \fIsmpa\fR [jid] | |
1112 .RS 4 | |
1113 Abort the running Socialist Millionaires Protocol | |
1114 .RE | |
1115 .RE | |
1116 .PP | |
1117 /otrpolicy, /otrpolicy (default|jid) (plain|manual|opportunistic|always) | |
1118 .RS 4 | |
1119 You can use the shortcut\-jid "\&." for the currently selected contact\&. | |
1120 .PP | |
1121 (without arguments) | |
1122 .RS 4 | |
1123 Prints all OTR policies to the status buffer | |
1124 .RE | |
1125 .PP | |
1126 (\fIdefault\fR|\fIjid\fR) (plain|manual|opportunistic|always) | |
1127 .RS 4 | |
1128 Sets either the default policy or the policy for the given jid The plain policy should never be used, because you won\(cqt be able to receive or send any OTR encrypted messages\&. If you set the policy to manual, you or your chat partner have to start the OTR encryption by hand (e\&.g\&. with /otr start)\&. The policy "opportunistic" does that itself by sending a special whitespace\-sequence at the end of unencrypted messages\&. So the other OTR\-enabled chat client knows, that you want to use OTR\&. Note that the first message will always be unencryted, if you use this policy\&. With the policy "always" no message will be sent in plain text\&. If you try to sent the first message unencrypted, mcabber will try to establish an OTR channel\&. Please resend your message, when you get the information that the channel was established\&. If someone sends you plaintext messages while the policy is set to "always", you\(cqll be able to read the message but it won\(cqt be saved to the history\&. | |
1129 .RE | |
1130 .RE | |
1131 .PP | |
1132 /pgp disable|enable|force|info [jid], /pgp setkey [jid [key]] | |
1133 .RS 4 | |
1134 This command manipulates PGP settings for the specified jid (by default the currently selected contact)\&. | |
1135 | |
1136 Please note that PGP encryption won\(cqt be used if no remote PGP support is detected, even if PGP is enabled with this command\&. You can force PGP encryption with the "force" subcommand\&. | |
1137 .PP | |
1138 \fIdisable\fR [jid] | |
1139 .RS 4 | |
1140 Disable PGP encryption for jid (or the currently selected contact) | |
1141 .RE | |
1142 .PP | |
1143 \fIenable\fR [jid] | |
1144 .RS 4 | |
1145 Enable PGP encryption for jid (or the currently selected contact) | |
1146 .RE | |
1147 .PP | |
1148 \fIforce\fR [jid] | |
1149 .RS 4 | |
1150 Enforce PGP encryption, even for offline messages, and always assume the recipient has PGP support\&. If a message can\(cqt be encrypted (missing key or key id), the messages won\(cqt be sent at all\&. This option is ignored when PGP is disabled\&. | |
1151 .RE | |
1152 .PP | |
1153 \fIinfo\fR [jid] | |
1154 .RS 4 | |
1155 Show current PGP settings for the contact | |
1156 .RE | |
1157 .PP | |
1158 \fIsetkey\fR [jid [key]] | |
1159 .RS 4 | |
1160 Set the PGP key to be used to encrypt message for this contact\&. If no key is provided, the current key is erased\&. You can use the shortcut\-jid "\&." for the currently selected contact\&. | |
1161 .RE | |
1096 | 1162 .RE |
1163 .PP | |
1164 /quit | |
1242 | 1165 .RS 4 |
1759 | 1166 This command closes all connections and quit mcabber\&. |
1096 | 1167 .RE |
1168 .PP | |
1169 /rawxml send string | |
1242 | 1170 .RS 4 |
1759 | 1171 Send "string" (raw XML format) to the Jabber server\&. |
829 | 1172 |
1759 | 1173 No check is done on the string provided\&. |
1174 | |
1175 BEWARE! Use this only if you know what you are doing, or you could terminate the connection\&. | |
1176 | |
1177 Example: "/rawxml send <presence><show>away</show></presence>" | |
1096 | 1178 .RE |
1179 .PP | |
1180 /rename name | |
1242 | 1181 .RS 4 |
1759 | 1182 Rename the current buddy or group to the given "name"\&. If "name" is \-, the name is removed from the roster (and mcabber will display the JID or username)\&. |
1183 .RE | |
1184 .PP | |
1185 /request last|ping|time|vcard|version [jid] | |
1186 .RS 4 | |
1187 Send a "IQ" query to the current buddy, or to the specified Jabber user\&. If the resource is not provided with the jid, mcabber will send the query to all known resources for this user\&. | |
1188 .PP | |
1189 \fIlast\fR | |
1190 .RS 4 | |
1191 Request "last" information (usually idle time) | |
1192 .RE | |
1193 .PP | |
1194 \fIping\fR | |
1195 .RS 4 | |
1196 Send an XMPP Ping request\&. Note that you should use the full JID since a ping sent to a bare JID will be handled by the server\&. | |
1096 | 1197 .RE |
1198 .PP | |
1759 | 1199 \fItime\fR |
1242 | 1200 .RS 4 |
1759 | 1201 Request time from the buddy |
1096 | 1202 .RE |
1203 .PP | |
1759 | 1204 \fIvcard\fR |
1205 .RS 4 | |
1206 Request VCard from the buddy | |
1207 .RE | |
1208 .PP | |
1209 \fIversion\fR | |
1210 .RS 4 | |
1211 Request version from the buddy | |
1212 .RE | |
1213 .RE | |
1214 .PP | |
1215 /room join|leave|names|nick|remove|topic|unlock|destroy, /room privmsg|invite|whois|kick|ban|unban|role|affil, /room setopt print_status|auto_whois [value], /room bookmark [add|del] [\-autojoin|+autojoin] [\-|nick] | |
1242 | 1216 .RS 4 |
1096 | 1217 The |
1218 \fIroom\fR | |
1759 | 1219 command handles Multi\-User Chat room actions\&. |
1220 .PP | |
1221 \fIjoin\fR [room [nick [pass]]] | |
1222 .RS 4 | |
1223 Join "room", using "nick" as nickname\&. If no nickname is provided (or if it is an empty string), the "nickname" option value is used (see sample configuration file)\&. If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "\&." can be used instead of the full room id\&. A password can be provided to enter protected rooms\&. If your nickname contains space characters, use quotes\&. | |
1224 .RE | |
1225 .PP | |
1226 \fIleave\fR [message] | |
1227 .RS 4 | |
1228 Leave the current room | |
1229 .RE | |
1230 .PP | |
1231 \fInames\fR [\-\-detail|\-\-short|\-\-quiet|\-\-compact] | |
1232 .RS 4 | |
1233 Display members of the current room | |
1234 .RE | |
1235 .PP | |
1236 \fInick\fR newnick | |
1237 .RS 4 | |
1238 Change your nickname in the current room | |
1239 .RE | |
1240 .PP | |
1241 \fIprivmsg\fR nick msg | |
1242 .RS 4 | |
1243 Send private message "msg" to "nick" | |
1244 .RE | |
1245 .PP | |
1096 | 1246 \fIremove\fR |
1759 | 1247 .RS 4 |
1248 Remove the current room from the roster (you must have left this room before) | |
1249 .RE | |
1250 .PP | |
1251 \fItopic\fR \-|newtopic | |
1252 .RS 4 | |
1253 Set topic for current room | |
1254 .RE | |
1255 .PP | |
1096 | 1256 \fIunlock\fR |
1759 | 1257 .RS 4 |
1258 Unlock current room (if you are the owner) | |
1259 .RE | |
1260 .PP | |
1261 \fIdestroy\fR [reason] | |
1262 .RS 4 | |
1263 Destroy the current room (use with care!) | |
1096 | 1264 .RE |
1265 .PP | |
1759 | 1266 \fIwhois\fR nick |
1267 .RS 4 | |
1268 Display MUC information about "nick" | |
1269 .RE | |
1270 .PP | |
1271 \fIban\fR jid [reason] | |
1272 .RS 4 | |
1273 Ban jid from the current room | |
1274 .RE | |
1275 .PP | |
1276 \fIunban\fR jid | |
1277 .RS 4 | |
1278 Unban jid from the current room | |
1279 .RE | |
1280 .PP | |
1281 \fIinvite\fR jid [reason] | |
1282 .RS 4 | |
1283 Invite jid to the current room | |
1284 .RE | |
1285 .PP | |
1286 \fIkick\fR nick [reason] | |
1287 .RS 4 | |
1288 Kick "nick" from the current room | |
1289 .RE | |
1290 .PP | |
2271
8e4e91c5cf6b
Update manpage wrt latest change
Mikael Berthe <mikael@lilotux.net>
parents:
2257
diff
changeset
|
1291 \fIrole\fR nick role [reason] |
1759 | 1292 .RS 4 |
2271
8e4e91c5cf6b
Update manpage wrt latest change
Mikael Berthe <mikael@lilotux.net>
parents:
2257
diff
changeset
|
1293 Change nick\(cqs role (role can be "none", "visitor", "participant", "moderator") |
1759 | 1294 .RE |
1295 .PP | |
1296 \fIaffil\fR jid affil [reason] | |
1297 .RS 4 | |
1298 Change jid\(cqs affiliation (affil can be "none", "member", "admin", "owner") | |
1299 .RE | |
1300 .PP | |
1301 \fIsetopt\fR print_status|auto_whois [value] | |
1302 .RS 4 | |
1303 Change settings for the current room For print_status, the possible values are "default", "none", "in_and_out", "all"\&. For auto_whois, the possible values are "default", "off", "on"\&. When the value is "default", the options muc_print_status / muc_auto_whois is used\&. | |
1304 .RE | |
1305 .PP | |
1306 \fIbookmark\fR [add|del] [\-autojoin|+autojoin] [\-|nick] | |
1307 .RS 4 | |
1308 Add, remove or update a bookmark (default is add)\&. If autojoin is set, mcabber will automatically join the MUC room when it connects to the server\&. To see the list of bookmarks, use /room bookmark in the status buffer\&. | |
1309 .RE | |
1310 .RE | |
1311 .PP | |
1312 /roster bottom|top|up|down|group_prev|group_next, /roster alternate|unread_first|unread_next, /roster search bud, /roster display|hide_offline|show_offline|toggle_offline, /roster item_lock|item_unlock|item_toggle_lock, /roster hide|show|toggle, /roster note [\-|text] | |
1242 | 1313 .RS 4 |
1096 | 1314 The |
1315 \fIroster\fR | |
1759 | 1316 command manipulates the roster/buddylist\&. |
1317 | |
1318 Here are the available parameters: | |
1319 .PP | |
1096 | 1320 \fIbottom\fR |
1759 | 1321 .RS 4 |
1322 Jump to the bottom of the roster | |
1323 .RE | |
1324 .PP | |
1325 \fItop\fR | |
1326 .RS 4 | |
1327 Jump to the top of the roster | |
1328 .RE | |
1329 .PP | |
1330 \fIup\fR [n] | |
1331 .RS 4 | |
1332 Move up [n lines] in the roster | |
1333 .RE | |
1334 .PP | |
1335 \fIdown\fR [n] | |
1336 .RS 4 | |
1337 Move down [n lines] in the roster | |
1338 .RE | |
1339 .PP | |
1340 \fIgroup_prev\fR | |
1341 .RS 4 | |
1342 Jump to the previous group in the roster | |
1343 .RE | |
1344 .PP | |
1345 \fIgroup_next\fR | |
1346 .RS 4 | |
1347 Jump to the next group in the roster | |
1348 .RE | |
1349 .PP | |
1350 \fIalternate\fR | |
1351 .RS 4 | |
1352 Jump to alternate buddy\&. The "alternate" buddy is the last buddy left while being in chat mode\&. This command is thus especially useful after commands like "/roster unread_next" (Ctrl\-q)\&. | |
1353 .RE | |
1354 .PP | |
1355 \fIunread_first\fR | |
1356 .RS 4 | |
1357 Jump to the first unread message | |
1358 .RE | |
1359 .PP | |
1360 \fIunread_next\fR | |
1361 .RS 4 | |
1362 Jump to the next unread message | |
1363 .RE | |
1364 .PP | |
1365 \fIsearch\fR bud | |
1366 .RS 4 | |
1367 Search for a buddy with a name or jid containing "bud" (only in the displayed buddylist) | |
1368 .RE | |
1369 .PP | |
1370 \fIdisplay\fR [mask] | |
1371 .RS 4 | |
1372 See or update the roster filter\&. The mask should contain the shortcut letters of the status you want to see ([o]nline, [f]ree_for_chat, [d]o_not_disturb, [n]ot_available, [a]way, [_]offline)\&. For example "ofdna" to display only connected buddies\&. | |
1373 .RE | |
1374 .PP | |
1096 | 1375 \fIhide_offline\fR |
1759 | 1376 .RS 4 |
1377 Hide offline buddies (same as /roster display ofdna) | |
1378 .RE | |
1379 .PP | |
1096 | 1380 \fIshow_offline\fR |
1759 | 1381 .RS 4 |
1382 Show offline buddies (same as /roster display ofdna_) | |
1383 .RE | |
1384 .PP | |
1096 | 1385 \fItoggle_offline\fR |
1759 | 1386 .RS 4 |
1387 Toggle display of offline buddies | |
1388 .RE | |
1389 .PP | |
1390 \fIitem_lock\fR [jid] | |
1391 .RS 4 | |
1392 Lock the roster item so it remains visible regardless of its status | |
1393 .RE | |
1394 .PP | |
1395 \fIitem_unlock\fR [jid] | |
1396 .RS 4 | |
1397 Undo the effects of item_lock | |
1398 .RE | |
1399 .PP | |
1400 \fIitem_toggle_lock\fR [jid] | |
1401 .RS 4 | |
1402 Invert the current lock flag | |
1403 .RE | |
1404 .PP | |
1096 | 1405 \fIhide\fR |
1759 | 1406 .RS 4 |
1407 Hide roster (full\-width chat window) | |
1408 .RE | |
1409 .PP | |
1096 | 1410 \fIshow\fR |
1759 | 1411 .RS 4 |
1412 Show roster | |
1413 .RE | |
1414 .PP | |
1096 | 1415 \fItoggle\fR |
1759 | 1416 .RS 4 |
1417 Toggle roster visibility | |
1096 | 1418 .RE |
1419 .PP | |
1759 | 1420 \fInote\fR [\-|text] |
1242 | 1421 .RS 4 |
1759 | 1422 Set/update/delete an annotation\&. If there is no text, the current item\(cqs annotation is displayed \(em if you are in the status buffer, all notes are displayed\&. If text is "\-", the note is erased\&. |
1423 .RE | |
1424 .RE | |
1425 .PP | |
1426 /say [\-n|\-h|\-\-] text | |
1427 .RS 4 | |
1428 Send the "text" message to the currently selected buddy\&. It can be useful if you want to send a message beginning with a slash, for example\&. | |
1429 | |
1430 The "\-n" flag turns the message to "normal" type, "\-h" to "headline"\&. "\-\-" can be used to send chat message beginning with \-n or \-h\&. | |
1096 | 1431 .RE |
1432 .PP | |
1759 | 1433 /say_to [\-n|\-h] [\-q] [\-f file] jid text |
1242 | 1434 .RS 4 |
1759 | 1435 Send the "text" message to the specified jid\&. |
1436 | |
1437 Please note that this command doesn\(cqt set the default resource for a contact, so if you want to send several messages to a specific resource you will have to use "/say_to" for each message\&. | |
1438 | |
2314 | 1439 You can send a message to a specific resource of the currently selected contact by using /say_to \&./resourcename message\&. |
1924
57c352ed37f9
Update help/documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1891
diff
changeset
|
1440 |
1759 | 1441 The "\-n" flag turns the message to "normal" type, "\-h" to "headline"\&. "\-\-" can be used to send chat messages beginning with \-n or \-h\&. |
1442 | |
1443 When "\-q" is used, the message will be sent in the background and will not change the current active window\&. | |
1444 | |
1445 A text file can be provided with the "\-f" switch (in which case there\(cqs no need to pass a text argument after the jid, of course)\&. | |
1446 .RE | |
1447 .PP | |
1448 /screen_refresh | |
1449 .RS 4 | |
1450 Refresh the mcabber screen\&. | |
1096 | 1451 .RE |
1452 .PP | |
1842 | 1453 /set [option [= value]] |
1242 | 1454 .RS 4 |
1759 | 1455 Display or set an option value\&. |
1842 | 1456 |
1457 Without arguments prints a list of all set options with their values | |
1759 | 1458 .RE |
1459 .PP | |
1460 /source pattern | |
1461 .RS 4 | |
1462 Read configuration files, that match glob pattern (sorted in alphabetical order)\&. | |
1096 | 1463 .RE |
1464 .PP | |
1973 | 1465 /status [online|avail|free|dnd|notavail|away [\-|statusmessage]], /status message \-|statusmessage |
1242 | 1466 .RS 4 |
1759 | 1467 Show or set the current status\&. |
1468 | |
1469 If no status is specified, display the current status\&. | |
1470 | |
1471 If a status message is specified, it will overrride the message* variables (these variables can be set in the configuration file)\&. | |
1472 | |
1473 If no relevant message* variable is set and no status message provided, the current status message is kept\&. | |
1474 | |
1475 If StatusMessage is "\-", the current status message is cleared\&. | |
1476 | |
1477 With the "/status message" command, mcabber will update the message while preserving the status\&. | |
1478 .RE | |
1479 .PP | |
1973 | 1480 /status_to jid online|avail|free|dnd|notavail|away [statusmessage], /status_to jid message statusmessage |
1759 | 1481 .RS 4 |
1482 Send the requested status to the specified Jabber user\&. | |
1483 | |
1484 If the specified jid is "\&.", the current buddy is used\&. | |
1485 | |
1486 Note: this status will be overridden by subsequent "/status" commands\&. If you are using the auto\-away feature, the status will overridden too\&. | |
1487 | |
1488 Note: The jid can include a resource (i\&.e\&. user@server/resource)\&. | |
1489 .RE | |
1490 .PP | |
1491 /version | |
1492 .RS 4 | |
1493 Display current version of mcabber\&. | |
1096 | 1494 .RE |
226 | 1495 .SH "CONFIGURATION FILE" |
1242 | 1496 .sp |
1759 | 1497 See the provided sample configuration file, which should be self\-documenting\&. |
226 | 1498 .SH "FILES" |
1759 | 1499 .sp |
226 | 1500 The following files can be used by mcabber(1): |
1242 | 1501 .sp |
1759 | 1502 .if n \{\ |
1242 | 1503 .RS 4 |
1759 | 1504 .\} |
226 | 1505 .nf |
1759 | 1506 $HOME/\&.mcabber/mcabberrc Default configuration file |
2314 | 1507 $HOME/\&.config/mcabber/mcabberrc Alternate location (can use XDG_CONFIG_HOME) |
1759 | 1508 $HOME/\&.mcabberrc Configuration file used if no other has been found |
1509 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled | |
1510 /usr/share/mcabber/help/ Default directory for online help files | |
1511 /usr/lib/mcabber/ Default directory for modules | |
226 | 1512 .fi |
1759 | 1513 .if n \{\ |
1096 | 1514 .RE |
1759 | 1515 .\} |
226 | 1516 .SH "BUGS" |
1242 | 1517 .sp |
1759 | 1518 Certainly\&. Please tell me if you find one! :\-) Please visit our website to find out about the MUC room and the bug tracker\&. |
226 | 1519 .SH "AUTHOR" |
1242 | 1520 .sp |
1759 | 1521 Written by \m[blue]\fBMikael BERTHE\fR\m[]\&\s-2\u[1]\d\s+2 and others (see AUTHORS file)\&. |
226 | 1522 .SH "RESOURCES" |
1242 | 1523 .sp |
1759 | 1524 \m[blue]\fBMain web site\fR\m[]\&\s-2\u[2]\d\s+2 |
1842 | 1525 .sp |
1526 \m[blue]\fBOfficial wiki\fR\m[]\&\s-2\u[3]\d\s+2 | |
1527 .sp | |
1528 \m[blue]\fBMCabber MUC room\fR\m[]\&\s-2\u[4]\d\s+2 | |
226 | 1529 .SH "COPYING" |
1759 | 1530 .sp |
2349 | 1531 Copyright (C) 2005\-2020 Mikael Berthe and others\&. |
1242 | 1532 .sp |
1759 | 1533 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. |
2314 | 1534 .SH "AUTHOR" |
1535 .PP | |
1536 \fBMikael BERTHE\fR <\&mcabber@lilotux\&.net\&> | |
1537 .RS 4 | |
1538 Author. | |
1539 .RE | |
1759 | 1540 .SH "NOTES" |
1242 | 1541 .IP " 1." 4 |
1542 Mikael BERTHE | |
1543 .RS 4 | |
1759 | 1544 \%mailto:mikael@lilotux.net |
1242 | 1545 .RE |
1546 .IP " 2." 4 | |
1547 Main web site | |
1548 .RS 4 | |
1759 | 1549 \%http://mcabber.com/ |
1242 | 1550 .RE |
1842 | 1551 .IP " 3." 4 |
1552 Official wiki | |
1553 .RS 4 | |
1554 \%http://wiki.mcabber.com/ | |
1555 .RE | |
1556 .IP " 4." 4 | |
1557 MCabber MUC room | |
1558 .RS 4 | |
1559 \%xmpp:mcabber@conf.lilotux.net | |
1560 .RE |