1759
|
1 '\" t
|
1096
|
2 .\" Title: mcabber
|
1759
|
3 .\" Author: [see the "AUTHOR" section]
|
|
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
1842
|
5 .\" Date: 03/28/2010
|
1759
|
6 .\" Manual: \ \&
|
1891
|
7 .\" Source: \ \& 0.10.1-dev
|
1759
|
8 .\" Language: English
|
1096
|
9 .\"
|
1842
|
10 .TH "MCABBER" "1" "03/28/2010" "\ \& 0\&.10\&.0\-dev" "\ \&"
|
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
|
|
52 \fISASL/SSL/TLS support\fR\&.
|
1242
|
53 .RE
|
|
54 .sp
|
|
55 .RS 4
|
1759
|
56 .ie n \{\
|
|
57 \h'-04'\(bu\h'+03'\c
|
|
58 .\}
|
|
59 .el \{\
|
|
60 .sp -1
|
|
61 .IP \(bu 2.3
|
|
62 .\}
|
|
63
|
1096
|
64 \fIMUC support\fR
|
1759
|
65 (Multi\-User Chat)\&.
|
1242
|
66 .RE
|
|
67 .sp
|
|
68 .RS 4
|
1759
|
69 .ie n \{\
|
|
70 \h'-04'\(bu\h'+03'\c
|
|
71 .\}
|
|
72 .el \{\
|
|
73 .sp -1
|
|
74 .IP \(bu 2.3
|
|
75 .\}
|
|
76
|
|
77 \fIPGP, OTR support\fR
|
1242
|
78 .RE
|
|
79 .sp
|
|
80 .RS 4
|
1759
|
81 .ie n \{\
|
|
82 \h'-04'\(bu\h'+03'\c
|
|
83 .\}
|
|
84 .el \{\
|
|
85 .sp -1
|
|
86 .IP \(bu 2.3
|
|
87 .\}
|
|
88
|
1096
|
89 \fIChat States\fR
|
|
90 support (typing notifications)
|
1242
|
91 .RE
|
|
92 .sp
|
|
93 .RS 4
|
1759
|
94 .ie n \{\
|
|
95 \h'-04'\(bu\h'+03'\c
|
|
96 .\}
|
|
97 .el \{\
|
|
98 .sp -1
|
|
99 .IP \(bu 2.3
|
|
100 .\}
|
|
101
|
1096
|
102 \fIHistory logging:\fR
|
|
103 If enabled (see the CONFIGURATION FILE section),
|
|
104 mcabber
|
1759
|
105 can save discussions to text history log files\&.
|
1242
|
106 .RE
|
|
107 .sp
|
|
108 .RS 4
|
1759
|
109 .ie n \{\
|
|
110 \h'-04'\(bu\h'+03'\c
|
|
111 .\}
|
|
112 .el \{\
|
|
113 .sp -1
|
|
114 .IP \(bu 2.3
|
|
115 .\}
|
|
116
|
1096
|
117 \fICommands completion:\fR
|
|
118 If possible,
|
|
119 mcabber
|
1759
|
120 will try to complete your command line if you hit the Tab key\&.
|
1242
|
121 .RE
|
|
122 .sp
|
|
123 .RS 4
|
1759
|
124 .ie n \{\
|
|
125 \h'-04'\(bu\h'+03'\c
|
|
126 .\}
|
|
127 .el \{\
|
|
128 .sp -1
|
|
129 .IP \(bu 2.3
|
|
130 .\}
|
|
131
|
1096
|
132 \fIInput line history:\fR
|
1759
|
133 Any message or command entered is in the input line history and can be reused easily\&.
|
1242
|
134 .RE
|
|
135 .sp
|
|
136 .RS 4
|
1759
|
137 .ie n \{\
|
|
138 \h'-04'\(bu\h'+03'\c
|
|
139 .\}
|
|
140 .el \{\
|
|
141 .sp -1
|
|
142 .IP \(bu 2.3
|
|
143 .\}
|
|
144
|
1096
|
145 \fIExternal actions:\fR
|
1759
|
146 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
|
147 mcabber
|
1759
|
148 source code, in the contrib directory\&.
|
|
149 .RE
|
|
150 .sp
|
|
151 .RS 4
|
|
152 .ie n \{\
|
|
153 \h'-04'\(bu\h'+03'\c
|
|
154 .\}
|
|
155 .el \{\
|
|
156 .sp -1
|
|
157 .IP \(bu 2.3
|
|
158 .\}
|
|
159
|
|
160 \fIModules:\fR
|
|
161 mcabber
|
|
162 can load modules (a\&.k\&.a\&. plugins) at runtime that extend its features\&.
|
1242
|
163 .RE
|
1096
|
164 .SH "OPTIONS"
|
|
165 .PP
|
1759
|
166 \-h
|
1242
|
167 .RS 4
|
1096
|
168 Quick help usage message
|
|
169 .RE
|
|
170 .PP
|
1759
|
171 \-V
|
|
172 .RS 4
|
|
173 Displays
|
|
174 mcabber
|
|
175 version and compile\-time definitions\&.
|
|
176 .RE
|
|
177 .PP
|
1096
|
178 \-f configfile
|
1242
|
179 .RS 4
|
1096
|
180 Use configuration file
|
|
181 \fIconfigfile\fR
|
|
182 .RE
|
|
183 .SH "WINDOWS/PANES"
|
1242
|
184 .sp
|
1759
|
185 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
|
186 .sp
|
1759
|
187 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\&.
|
|
188 .sp
|
|
189 To display buddies chat buffers, you will have to enter \fIchat mode\fR\&. You can enter chat mode by pressing enter, and leave chat mode with the ESC key\&. Simply sending a message will also enable chat mode\&.
|
1242
|
190 .sp
|
1759
|
191 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\&.
|
|
192 .SH "KEYS"
|
1242
|
193 .sp
|
1759
|
194 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...)\&.
|
1242
|
195 .sp
|
1759
|
196 PageUp and PageDown keys are used to move in the roster\&.
|
1242
|
197 .sp
|
1759
|
198 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
|
199 .sp
|
1759
|
200 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
|
201 .sp
|
1759
|
202 Here is a quick description of the default key bindings:
|
|
203 .PP
|
|
204 Esc
|
|
205 .RS 4
|
|
206 Disable chat mode
|
|
207 .RE
|
|
208 .PP
|
|
209 Ctrl\-a
|
|
210 .RS 4
|
|
211 Go to the beginning of the input line
|
|
212 .RE
|
|
213 .PP
|
|
214 Ctrl\-e
|
|
215 .RS 4
|
|
216 Go to the end of the input line
|
|
217 .RE
|
|
218 .PP
|
|
219 Ctrl\-l
|
|
220 .RS 4
|
|
221 Force a refresh
|
|
222 .RE
|
|
223 .PP
|
|
224 Up/Down
|
|
225 .RS 4
|
|
226 Move in the input line history
|
|
227 .RE
|
|
228 .PP
|
|
229 PgUp/PgDown
|
|
230 .RS 4
|
|
231 Move inside the roster (buddylist)
|
|
232 .RE
|
|
233 .PP
|
|
234 Tab
|
|
235 .RS 4
|
|
236 Complete current word, in the input line
|
|
237 .RE
|
|
238 .PP
|
|
239 Ctrl\-g
|
|
240 .RS 4
|
|
241 Cancel completion
|
|
242 .RE
|
|
243 .PP
|
|
244 Ctrl\-c
|
|
245 .RS 4
|
|
246 Abort multi\-line messages and completions
|
|
247 .RE
|
|
248 .PP
|
|
249 Ctrl\-d
|
|
250 .RS 4
|
|
251 Send/terminate a multi\-line message
|
|
252 .RE
|
|
253 .PP
|
|
254 Ctrl\-p/Ctrl\-n
|
|
255 .RS 4
|
|
256 Scroll up/down half a screen in the buffer window (chat mode)
|
|
257 .RE
|
|
258 .PP
|
|
259 Ctrl\-Left
|
|
260 .RS 4
|
|
261 Move the cursor back to the start of the current or previous word
|
|
262 .RE
|
|
263 .PP
|
|
264 Ctrl\-Right
|
|
265 .RS 4
|
|
266 Move the cursor forward to the end of the current or next word
|
|
267 .RE
|
|
268 .PP
|
|
269 Ctrl\-u
|
|
270 .RS 4
|
|
271 Delete from beginning of the line to the cursor
|
|
272 .RE
|
|
273 .PP
|
|
274 Ctrl\-k
|
|
275 .RS 4
|
|
276 Delete from the cursor to the end of line
|
|
277 .RE
|
|
278 .PP
|
1096
|
279 Ctrl\-w
|
1759
|
280 .RS 4
|
1096
|
281 Backward kill word
|
1759
|
282 .RE
|
|
283 .PP
|
1096
|
284 Ctrl\-t
|
1759
|
285 .RS 4
|
1096
|
286 Transpose chars
|
1759
|
287 .RE
|
|
288 .PP
|
1096
|
289 Ctrl\-o
|
1759
|
290 .RS 4
|
1096
|
291 Accept line and put the next history line in the input line (accept\-line\-and\-down\-history)
|
1759
|
292 .RE
|
1242
|
293 .sp
|
1759
|
294 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section\&.
|
|
295 .SH "MCABBER\(cqS ROSTER"
|
1242
|
296 .sp
|
1842
|
297 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
|
298 .sp
|
1842
|
299 Group names are displayed above the items that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&.
|
1242
|
300 .sp
|
1842
|
301 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
|
302 .sp
|
854
|
303 The online status is one of the following:
|
1759
|
304 .PP
|
1096
|
305 \fIo\fR
|
1759
|
306 .RS 4
|
1096
|
307 online
|
1759
|
308 .RE
|
|
309 .PP
|
|
310 \fIf\fR
|
|
311 .RS 4
|
|
312 free for chat
|
|
313 .RE
|
|
314 .PP
|
|
315 \fIa\fR
|
|
316 .RS 4
|
|
317 away
|
|
318 .RE
|
|
319 .PP
|
|
320 \fIn\fR
|
|
321 .RS 4
|
|
322 not available (labeled
|
|
323 \fIextended away\fR
|
|
324 in some clients)
|
|
325 .RE
|
|
326 .PP
|
|
327 \fId\fR
|
|
328 .RS 4
|
|
329 do not disturb
|
|
330 .RE
|
|
331 .PP
|
|
332 \fIi\fR
|
|
333 .RS 4
|
|
334 invisible (displayed only for your resource)
|
|
335 .RE
|
|
336 .PP
|
|
337 \fI_\fR
|
|
338 .RS 4
|
|
339 offline (or invisible to you)
|
|
340 .RE
|
|
341 .PP
|
|
342 \fI?\fR
|
|
343 .RS 4
|
1842
|
344 unknown, usually meaning you are not authorized to see this buddy\(cqs status
|
1759
|
345 .RE
|
|
346 .PP
|
|
347 \fIx\fR
|
|
348 .RS 4
|
|
349 a conference room in which you are not participating
|
|
350 .RE
|
|
351 .PP
|
1096
|
352 \fIC\fR
|
1759
|
353 .RS 4
|
1096
|
354 a conference room in which you are participating
|
1759
|
355 .RE
|
1242
|
356 .sp
|
1842
|
357 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
|
358 .sp
|
1842
|
359 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
|
360 .sp
|
854
|
361 Examples:
|
1759
|
362 .PP
|
|
363 \fI\-\-\- Buds\fR
|
|
364 .RS 4
|
|
365 This is a group named
|
|
366 \fIBuds\fR
|
|
367 .RE
|
|
368 .PP
|
1096
|
369 \fI#[o] John\fR
|
1759
|
370 .RS 4
|
1096
|
371 John is online, can see your status, and sent you a message that you did not read yet
|
1759
|
372 .RE
|
|
373 .PP
|
|
374 \fI{?} Sally\fR
|
|
375 .RS 4
|
|
376 Neither you nor Sally have authorized each other to see your online status
|
|
377 .RE
|
|
378 .PP
|
|
379 \fI{a} Jane\fR
|
|
380 .RS 4
|
|
381 Jane is away, but she cannot see your online status
|
|
382 .RE
|
|
383 .PP
|
|
384 \fI#[C] x@y\&.c\fR
|
|
385 .RS 4
|
|
386 You are participating in x@y\&.c conference room, and there are unread messages
|
|
387 .RE
|
|
388 .SH "COMMANDS"
|
1242
|
389 .sp
|
1759
|
390 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\&.
|
|
391 .SH "COMMANDS RELATED TO MCABBER"
|
|
392 .PP
|
|
393 /add [jid [nickname]]
|
|
394 .RS 4
|
|
395 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\&.
|
|
396 .PP
|
|
397 [\fIjid\fR [nickname]]
|
|
398 .RS 4
|
|
399 Add to our roster "jid" as "nickname"
|
1242
|
400 .sp
|
1759
|
401 .if n \{\
|
|
402 .RS 4
|
|
403 .\}
|
|
404 .nf
|
|
405 Example: "/add somebody@jabber\&.server\&.com Somebody"
|
|
406 .fi
|
|
407 .if n \{\
|
|
408 .RE
|
|
409 .\}
|
|
410 .RE
|
|
411 .RE
|
1096
|
412 .PP
|
|
413 /alias [name [= command line]]
|
1242
|
414 .RS 4
|
1759
|
415 This command let you to add aliases which can simplify sophisticated commands\&.
|
|
416
|
|
417 You can manage your aliases by:
|
|
418 .PP
|
|
419 (without arguments)
|
|
420 .RS 4
|
|
421 Print list of currently defined aliases
|
|
422 .RE
|
|
423 .PP
|
|
424 \fIname\fR
|
|
425 .RS 4
|
|
426 Print the value of alias called "name"
|
|
427 .RE
|
|
428 .PP
|
|
429 \fIname\fR=
|
|
430 .RS 4
|
|
431 Unset alias called "name"
|
|
432 .RE
|
|
433 .PP
|
|
434 \fIname\fR = command line
|
|
435 .RS 4
|
|
436 Set alias called "name" with value "command line"
|
|
437 .sp
|
|
438 .if n \{\
|
|
439 .RS 4
|
|
440 .\}
|
|
441 .nf
|
|
442 Example: "/alias away = status away"
|
|
443 .fi
|
|
444 .if n \{\
|
|
445 .RE
|
|
446 .\}
|
|
447 .RE
|
|
448 .RE
|
|
449 .PP
|
|
450 /authorization allow|cancel|request|request_unsubscribe [jid]
|
|
451 .RS 4
|
|
452 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\&.
|
|
453
|
|
454 If no JID is provided, the currently\-selected buddy is used\&.
|
|
455 .PP
|
|
456 \fIallow\fR
|
|
457 .RS 4
|
|
458 Allow the buddy to receive your presence updates
|
|
459 .RE
|
|
460 .PP
|
|
461 \fIcancel\fR
|
|
462 .RS 4
|
|
463 Cancel the buddy\(cqs subscription to your presence updates
|
|
464 .RE
|
|
465 .PP
|
|
466 \fIrequest\fR
|
|
467 .RS 4
|
|
468 Request a subscription to the buddy\(cqs presence updates
|
|
469 .RE
|
|
470 .PP
|
|
471 \fIrequest_unsubscribe\fR
|
|
472 .RS 4
|
|
473 Request unsubscription from the buddy\(cqs presence updates
|
|
474 .RE
|
1096
|
475 .RE
|
|
476 .PP
|
|
477 /bind [keycode [= command line]]
|
1242
|
478 .RS 4
|
1759
|
479 Bind the command to the key given as "keycode"\&. To examine which keys are currently not used look at
|
|
480 mcabber
|
|
481 log window and press examined key\&. For example: "Unknown key=265" means that you can bind some command to key #265\&.
|
|
482 .PP
|
|
483 (without arguments)
|
|
484 .RS 4
|
|
485 Display list of current bindings
|
|
486 .RE
|
|
487 .PP
|
|
488 \fIkeycode\fR
|
|
489 .RS 4
|
|
490 Display the command line bound to this key
|
|
491 .RE
|
|
492 .PP
|
|
493 \fIkeycode\fR=
|
|
494 .RS 4
|
|
495 Unbind key with code "keycode"
|
|
496 .RE
|
|
497 .PP
|
|
498 \fIkeycode\fR = command line
|
|
499 .RS 4
|
|
500 Bind "command line" to the key with code "keycode"
|
|
501 .sp
|
|
502 .if n \{\
|
|
503 .RS 4
|
|
504 .\}
|
|
505 .nf
|
|
506 Example: "/bind 265 = status away" (265 is F1)\&. +
|
|
507 Note: keycodes can be different depending on your ncurses configuration\&. +
|
|
508 Tip: aliases also can be used instead of commands\&.
|
|
509 .fi
|
|
510 .if n \{\
|
|
511 .RE
|
|
512 .\}
|
|
513 .RE
|
|
514 .RE
|
|
515 .PP
|
|
516 /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
|
|
517 .RS 4
|
1842
|
518 Buddy\(cqs buffer manipulation command\&. E\&.g\&. you can search through buffer for "text", clear chat window etc\&.
|
1759
|
519 .PP
|
|
520 \fIclear\fR
|
|
521 .RS 4
|
|
522 Clear the current buddy chat window
|
|
523 .RE
|
|
524 .PP
|
|
525 \fIclose\fR [jid]
|
|
526 .RS 4
|
|
527 Empty all contents of the buffer and close the current buddy chat window
|
|
528 .RE
|
|
529 .PP
|
|
530 \fIclose_all\fR
|
|
531 .RS 4
|
|
532 Empty all contents of the chat buffers and close the chat windows
|
|
533 .RE
|
|
534 .PP
|
|
535 \fIpurge\fR [jid]
|
|
536 .RS 4
|
|
537 Clear the current buddy chat window and empty all contents of the chat buffer
|
|
538 .RE
|
|
539 .PP
|
|
540 \fIlist\fR
|
|
541 .RS 4
|
|
542 Display the list of existing buffers, with their length (lines/blocks)
|
1096
|
543 .RE
|
|
544 .PP
|
1759
|
545 \fItop\fR
|
1242
|
546 .RS 4
|
1759
|
547 Jump to the top of the current buddy chat buffer
|
|
548 .RE
|
|
549 .PP
|
1096
|
550 \fIbottom\fR
|
1759
|
551 .RS 4
|
|
552 Jump to the bottom of the current buddy chat buffer
|
|
553 .RE
|
|
554 .PP
|
|
555 \fIup\fR [n]
|
|
556 .RS 4
|
|
557 Scroll the buffer up [n] lines (default: half a screen)
|
|
558 .RE
|
|
559 .PP
|
|
560 \fIdown\fR [n]
|
|
561 .RS 4
|
|
562 Scroll the buffer down [n] lines (default: half a screen)
|
|
563 .RE
|
|
564 .PP
|
|
565 \fIdate\fR [date]
|
|
566 .RS 4
|
|
567 Jump to the first line after the specified [date] in the chat buffer (date format: "YYYY\-mm\-dd")
|
|
568 .RE
|
|
569 .PP
|
|
570 % n
|
|
571 .RS 4
|
|
572 Jump to position %n of the buddy chat buffer
|
|
573 .RE
|
|
574 .PP
|
|
575 \fIsearch_backward\fR text
|
|
576 .RS 4
|
|
577 Search for [text] in the current buddy chat buffer
|
|
578 .RE
|
|
579 .PP
|
|
580 \fIsearch_forward\fR text
|
|
581 .RS 4
|
|
582 Search for [text] in the current buddy chat buffer
|
|
583 .RE
|
|
584 .PP
|
1139
|
585 \fIscroll_lock\fR
|
1759
|
586 .RS 4
|
|
587 Lock buffer scrolling
|
|
588 .RE
|
|
589 .PP
|
1139
|
590 \fIscroll_unlock\fR
|
1759
|
591 .RS 4
|
|
592 Unlock buffer scrolling
|
|
593 .RE
|
|
594 .PP
|
1139
|
595 \fIscroll_toggle\fR
|
1759
|
596 .RS 4
|
|
597 Toggle buffer scrolling (lock/unlock)
|
|
598 .RE
|
|
599 .PP
|
|
600 \fIsave\fR filename
|
|
601 .RS 4
|
|
602 Save the contents of the current buffer to the file "filename"
|
|
603 .RE
|
|
604 .RE
|
|
605 .PP
|
|
606 /chat_disable [\-\-show\-roster]
|
|
607 .RS 4
|
|
608 Disable chat mode\&.
|
|
609
|
|
610 With \-\-show\-roster, the fullscreen mode will be disabled\&.
|
1096
|
611 .RE
|
|
612 .PP
|
|
613 /clear
|
1242
|
614 .RS 4
|
1759
|
615 This command is actually an alias for "/buffer clear"\&. It clears the current buddy chat window\&.
|
|
616 .RE
|
|
617 .PP
|
|
618 /color roster (status wildcard (color|\-)|clear), /color mucnick nick (color|\-), /color muc (jid|\&.|*) [on|preset|off|\-]
|
|
619 .RS 4
|
1096
|
620 The
|
1759
|
621 \fIcolor\fR
|
|
622 command allows setting dynamic color properties of the screen\&.
|
|
623 .PP
|
|
624 \fIroster\fR clear
|
|
625 .RS 4
|
|
626 Remove all color rules for the roster\&. All roster items will get its default color\&.
|
|
627 .RE
|
|
628 .PP
|
|
629 \fIroster\fR status wildcard color
|
|
630 .RS 4
|
|
631 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\&.
|
|
632 .RE
|
|
633 .PP
|
|
634 \fImucnick\fR nick (color|\-)
|
|
635 .RS 4
|
|
636 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
|
|
637 \fIpreset\fR
|
|
638 coloring mode, but will stay the same in
|
|
639 \fIon\fR
|
|
640 coloring mode\&.
|
|
641 .RE
|
|
642 .PP
|
|
643 \fImuc\fR (jid|\&.|*) [on|preset|off|\-]
|
|
644 .RS 4
|
|
645 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
|
|
646 \fIon\fR
|
|
647 colors all nicks,
|
|
648 \fIpreset\fR
|
|
649 only the ones manually set by /color mucnick command and
|
|
650 \fIoff\fR
|
|
651 colors none\&. If not specified, defaults to
|
|
652 \fIon\fR\&. Mode
|
|
653 \fI\-\fR
|
|
654 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
|
|
655 \fIoff\fR\&.
|
|
656 .RE
|
|
657 .RE
|
|
658 .PP
|
|
659 /connect
|
|
660 .RS 4
|
|
661 Establish connection to the Jabber server\&.
|
|
662 .RE
|
|
663 .PP
|
|
664 /del
|
|
665 .RS 4
|
|
666 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&.
|
|
667 .RE
|
|
668 .PP
|
|
669 /disconnect
|
|
670 .RS 4
|
|
671 Terminate the connection to the Jabber server\&.
|
|
672
|
|
673 Note: the roster is only available when the connection to the server is active, so the buddylist is empty when disconnected\&.
|
|
674 .RE
|
|
675 .PP
|
|
676 /echo message
|
|
677 .RS 4
|
|
678 Display "message" in the log window\&.
|
|
679 .RE
|
|
680 .PP
|
|
681 /event #n|* accept|ignore|reject [event\-specific arguments], /event list
|
|
682 .RS 4
|
|
683 Tell mcabber what to do about pending events\&.
|
|
684
|
|
685 If the first parameter is
|
|
686 \fI*\fR, the command will apply to all queued events\&.
|
|
687
|
|
688 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\&.
|
|
689 .PP
|
|
690 #N|* accept [event\-specific arguments]
|
|
691 .RS 4
|
|
692 Event number #N/All events will be accepted
|
|
693 .RE
|
|
694 .PP
|
|
695 #N|* ignore [event\-specific arguments]
|
|
696 .RS 4
|
|
697 Event number #N/All events will be ignored
|
|
698 .RE
|
|
699 .PP
|
|
700 #N|* reject [event\-specific arguments]
|
|
701 .RS 4
|
|
702 Event number #N/All events will be rejected
|
|
703 .RE
|
|
704 .PP
|
|
705 \fIlist\fR
|
|
706 .RS 4
|
|
707 List all pending events
|
|
708 .RE
|
|
709 .RE
|
|
710 .PP
|
|
711 /group fold|unfold|toggle [groupname]
|
|
712 .RS 4
|
|
713 This command changes the current group display\&.
|
|
714 .PP
|
|
715 \fIfold\fR [groupname]
|
|
716 .RS 4
|
|
717 Fold (shrink) the current/specified group tree in the roster
|
|
718 .RE
|
|
719 .PP
|
|
720 \fIunfold\fR [groupname]
|
|
721 .RS 4
|
|
722 Unfold (expand) the current/specified group tree in the roster
|
|
723 .RE
|
|
724 .PP
|
|
725 \fItoggle\fR [groupname]
|
|
726 .RS 4
|
|
727 Toggle the state (fold/unfold) of the current/specified tree
|
|
728 .RE
|
|
729 .RE
|
|
730 .PP
|
|
731 /help [command|+topic]
|
|
732 .RS 4
|
|
733 Display help for command "command" or topic "topic"\&.
|
|
734
|
|
735 Example: "/help buffer"
|
|
736 .RE
|
|
737 .PP
|
|
738 /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
|
|
739 .RS 4
|
|
740 Input line commands
|
|
741 .PP
|
|
742 \fIfchar\fR
|
|
743 .RS 4
|
|
744 Move to the next letter
|
|
745 .RE
|
|
746 .PP
|
|
747 \fIbchar\fR
|
|
748 .RS 4
|
|
749 Move to the previous letter
|
|
750 .RE
|
|
751 .PP
|
|
752 \fIchar_fdel\fR
|
|
753 .RS 4
|
|
754 Delete the letter at cursor position
|
|
755 .RE
|
|
756 .PP
|
|
757 \fIchar_bdel\fR
|
|
758 .RS 4
|
|
759 Delete the letter before cursor position
|
|
760 .RE
|
|
761 .PP
|
|
762 \fIchar_swap\fR
|
|
763 .RS 4
|
|
764 Transpose chars
|
|
765 .RE
|
|
766 .PP
|
|
767 \fIfword\fR
|
|
768 .RS 4
|
|
769 Move the cursor forward to the end of the current or next word
|
|
770 .RE
|
|
771 .PP
|
|
772 \fIbword\fR
|
|
773 .RS 4
|
|
774 Move the cursor back to the start of the current or previous word
|
|
775 .RE
|
|
776 .PP
|
|
777 \fIword_bdel\fR
|
|
778 .RS 4
|
|
779 Delete the word from cursor position to its start
|
|
780 .RE
|
|
781 .PP
|
|
782 \fIword_fdel\fR
|
|
783 .RS 4
|
|
784 Delete the word from cursor position to its end
|
|
785 .RE
|
|
786 .PP
|
|
787 \fIword_upcase\fR
|
|
788 .RS 4
|
|
789 Convert the word from cursor position to its end to upper case
|
|
790 .RE
|
|
791 .PP
|
|
792 \fIword_downcase\fR
|
|
793 .RS 4
|
|
794 Convert the word from cursor position to its end to down case
|
|
795 .RE
|
|
796 .PP
|
|
797 \fIword_capit\fR
|
|
798 .RS 4
|
|
799 Capitalize the word from cursor position to its end
|
|
800 .RE
|
|
801 .PP
|
|
802 \fIhist_beginning_search_bwd\fR
|
|
803 .RS 4
|
|
804 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)
|
|
805 .RE
|
|
806 .PP
|
|
807 \fIhist_beginning_search_fwd\fR
|
|
808 .RS 4
|
|
809 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)
|
|
810 .RE
|
|
811 .PP
|
|
812 \fIhist_prev\fR
|
|
813 .RS 4
|
|
814 Previous line of input line history
|
|
815 .RE
|
|
816 .PP
|
|
817 \fIhist_next\fR
|
|
818 .RS 4
|
|
819 Next line of input line history
|
|
820 .RE
|
|
821 .PP
|
|
822 \fIiline_start\fR
|
|
823 .RS 4
|
|
824 Go to the beginning of the input line
|
|
825 .RE
|
|
826 .PP
|
|
827 \fIiline_end\fR
|
|
828 .RS 4
|
|
829 Go to the end of the input line
|
|
830 .RE
|
|
831 .PP
|
|
832 \fIiline_fdel\fR
|
|
833 .RS 4
|
|
834 Delete from the cursor to the end of line
|
1096
|
835 .RE
|
|
836 .PP
|
1759
|
837 \fIiline_bdel\fR
|
|
838 .RS 4
|
|
839 Delete from beginning of the line to the cursor
|
|
840 .RE
|
|
841 .PP
|
|
842 \fIiline_accept\fR
|
|
843 .RS 4
|
|
844 Accept line
|
|
845 .RE
|
|
846 .PP
|
|
847 \fIiline_accept_down_hist\fR
|
|
848 .RS 4
|
|
849 Accept line and put the next history line in the input line
|
|
850 .RE
|
|
851 .PP
|
|
852 \fIcompl_do\fR
|
|
853 .RS 4
|
|
854 Complete current word, in the input line
|
|
855 .RE
|
|
856 .PP
|
|
857 \fIcompl_cancel\fR
|
|
858 .RS 4
|
|
859 Cancel completion
|
|
860 .RE
|
|
861 .PP
|
|
862 \fIsend_multiline\fR
|
|
863 .RS 4
|
|
864 Send/terminate a multi\-line message
|
|
865 .RE
|
|
866 .RE
|
|
867 .PP
|
|
868 /info
|
|
869 .RS 4
|
|
870 Display info on the selected entry (user, agent, group\&...)\&.
|
|
871
|
|
872 For users, resources are displayed with the status, priority and status message (if available) of each resource\&.
|
|
873 .RE
|
|
874 .PP
|
|
875 /module load|unload [\-f] module, /module info module, /module [list]
|
|
876 .RS 4
|
|
877 Load, unload or show info on module\&.
|
|
878 .PP
|
|
879 \fIload\fR [\-f] module
|
|
880 .RS 4
|
|
881 Loads specified module\&. If \-f flag is specified, most of module loading errors will be ignored\&.
|
|
882 .RE
|
|
883 .PP
|
|
884 \fIunload\fR [\-f] module
|
|
885 .RS 4
|
1842
|
886 Unloads specified module\&. Note: The force flag will not remove any dependency on this module!
|
1759
|
887 .RE
|
|
888 .PP
|
|
889 \fIinfo\fR module
|
|
890 .RS 4
|
|
891 Shows available information about this module\&.
|
|
892 .RE
|
|
893 .PP
|
|
894 [\fIlist\fR]
|
|
895 .RS 4
|
|
896 Lists modules in a format: [modulename] [reference count] ([Manually/Automatically loaded]) [any extra info, like version or dependencies]
|
|
897 .RE
|
|
898 .RE
|
|
899 .PP
|
|
900 /move [groupname]
|
|
901 .RS 4
|
|
902 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\&.
|
|
903
|
|
904 Tip: if the chatmode is enabled, you can use "/roster alternate" to jump to the moved buddy\&.
|
|
905 .RE
|
|
906 .PP
|
|
907 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort
|
|
908 .RS 4
|
|
909 Send a multi\-line message\&. To write a single message with several lines, the
|
|
910 \fImulti\-line mode\fR
|
|
911 should be used\&.
|
|
912
|
|
913 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\&.
|
|
914
|
|
915 The
|
|
916 \fIbegin\fR
|
|
917 subcommand enables multi\-line mode\&. Note that it allows a message subject to be specified\&.
|
|
918
|
|
919 The
|
|
920 \fIverbatim\fR
|
|
921 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\&.
|
|
922
|
|
923 The
|
|
924 \fItoggle\fR
|
|
925 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)\&.
|
|
926 .PP
|
|
927 \fIbegin\fR [subject]
|
|
928 .RS 4
|
|
929 Enter multi\-line mode
|
|
930 .RE
|
|
931 .PP
|
|
932 \fIverbatim\fR
|
|
933 .RS 4
|
|
934 Enter verbatim multi\-line mode
|
|
935 .RE
|
|
936 .PP
|
|
937 \fIsend\fR [\-n|\-h]
|
|
938 .RS 4
|
|
939 Send the current multi\-line message to the currently selected buddy
|
|
940 .RE
|
|
941 .PP
|
|
942 \fIsend_to\fR [\-n|\-h] jid
|
1242
|
943 .RS 4
|
1759
|
944 Send the current multi\-line message to "jid"
|
|
945 .RE
|
|
946 .PP
|
|
947 \fItoggle\fR|\fItoggle_verbatim\fR
|
|
948 .RS 4
|
|
949 Switch to/from multi\-line mode (begin/send)
|
|
950 .RE
|
|
951 .PP
|
|
952 \fIabort\fR
|
|
953 .RS 4
|
|
954 Leave multi\-line mode without sending the message
|
|
955 .sp
|
|
956 .if n \{\
|
|
957 .RS 4
|
|
958 .\}
|
|
959 .nf
|
|
960 The \-n or \-h flags turn the message to "normal" or "headline" accordingly, as opposed to default "chat" message\&.
|
|
961 .fi
|
|
962 .if n \{\
|
|
963 .RE
|
|
964 .\}
|
|
965 .RE
|
|
966 .RE
|
|
967 .PP
|
|
968 /otr key, /otr start|stop|info [jid], /otr fingerprint [jid [fpr]], /otr smpq|smpr [jid] secret, /otr smpa [jid]
|
|
969 .RS 4
|
|
970 You can use the shortcut\-jid "\&." for the currently selected contact\&.
|
|
971 .PP
|
|
972 \fIkey\fR
|
|
973 .RS 4
|
|
974 Print the fingerprint of your private key to the Status Buffer
|
|
975 .RE
|
|
976 .PP
|
|
977 \fIstart\fR [jid]
|
|
978 .RS 4
|
|
979 Open an OTR channel to the specified jid (or the currently selected contact)
|
|
980 .RE
|
|
981 .PP
|
|
982 \fIstop\fR [jid]
|
|
983 .RS 4
|
|
984 Close the OTR channel to the specified jid (or the currently selected contact)
|
|
985 .RE
|
|
986 .PP
|
|
987 \fIinfo\fR [jid]
|
|
988 .RS 4
|
|
989 Show current OTR status for the specified jid (or the currently selected contact)
|
|
990 .RE
|
|
991 .PP
|
|
992 \fIfingerprint\fR [jid [fpr]]
|
|
993 .RS 4
|
|
994 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\&.
|
|
995 .RE
|
|
996 .PP
|
|
997 \fIsmpq\fR [jid] secret
|
|
998 .RS 4
|
|
999 Initiate the Socialist Millionaires Protocol with the secret and the buddy
|
|
1000 .RE
|
|
1001 .PP
|
|
1002 \fIsmpr\fR [jid] secret
|
|
1003 .RS 4
|
|
1004 Respond to the Initiation of the jid with the secret
|
|
1005 .RE
|
|
1006 .PP
|
|
1007 \fIsmpa\fR [jid]
|
|
1008 .RS 4
|
|
1009 Abort the running Socialist Millionaires Protocol
|
|
1010 .RE
|
|
1011 .RE
|
|
1012 .PP
|
|
1013 /otrpolicy, /otrpolicy (default|jid) (plain|manual|opportunistic|always)
|
|
1014 .RS 4
|
|
1015 You can use the shortcut\-jid "\&." for the currently selected contact\&.
|
|
1016 .PP
|
|
1017 (without arguments)
|
|
1018 .RS 4
|
|
1019 Prints all OTR policies to the status buffer
|
|
1020 .RE
|
|
1021 .PP
|
|
1022 (\fIdefault\fR|\fIjid\fR) (plain|manual|opportunistic|always)
|
|
1023 .RS 4
|
|
1024 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\&.
|
|
1025 .RE
|
|
1026 .RE
|
|
1027 .PP
|
|
1028 /pgp disable|enable|force|info [jid], /pgp setkey [jid [key]]
|
|
1029 .RS 4
|
|
1030 This command manipulates PGP settings for the specified jid (by default the currently selected contact)\&.
|
|
1031
|
|
1032 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\&.
|
|
1033 .PP
|
|
1034 \fIdisable\fR [jid]
|
|
1035 .RS 4
|
|
1036 Disable PGP encryption for jid (or the currently selected contact)
|
|
1037 .RE
|
|
1038 .PP
|
|
1039 \fIenable\fR [jid]
|
|
1040 .RS 4
|
|
1041 Enable PGP encryption for jid (or the currently selected contact)
|
|
1042 .RE
|
|
1043 .PP
|
|
1044 \fIforce\fR [jid]
|
|
1045 .RS 4
|
|
1046 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\&.
|
|
1047 .RE
|
|
1048 .PP
|
|
1049 \fIinfo\fR [jid]
|
|
1050 .RS 4
|
|
1051 Show current PGP settings for the contact
|
|
1052 .RE
|
|
1053 .PP
|
|
1054 \fIsetkey\fR [jid [key]]
|
|
1055 .RS 4
|
|
1056 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\&.
|
|
1057 .RE
|
1096
|
1058 .RE
|
|
1059 .PP
|
|
1060 /quit
|
1242
|
1061 .RS 4
|
1759
|
1062 This command closes all connections and quit mcabber\&.
|
1096
|
1063 .RE
|
|
1064 .PP
|
|
1065 /rawxml send string
|
1242
|
1066 .RS 4
|
1759
|
1067 Send "string" (raw XML format) to the Jabber server\&.
|
829
|
1068
|
1759
|
1069 No check is done on the string provided\&.
|
|
1070
|
|
1071 BEWARE! Use this only if you know what you are doing, or you could terminate the connection\&.
|
|
1072
|
|
1073 Example: "/rawxml send <presence><show>away</show></presence>"
|
1096
|
1074 .RE
|
|
1075 .PP
|
|
1076 /rename name
|
1242
|
1077 .RS 4
|
1759
|
1078 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)\&.
|
|
1079 .RE
|
|
1080 .PP
|
|
1081 /request last|ping|time|vcard|version [jid]
|
|
1082 .RS 4
|
|
1083 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\&.
|
|
1084 .PP
|
|
1085 \fIlast\fR
|
|
1086 .RS 4
|
|
1087 Request "last" information (usually idle time)
|
|
1088 .RE
|
|
1089 .PP
|
|
1090 \fIping\fR
|
|
1091 .RS 4
|
|
1092 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
|
1093 .RE
|
|
1094 .PP
|
1759
|
1095 \fItime\fR
|
1242
|
1096 .RS 4
|
1759
|
1097 Request time from the buddy
|
1096
|
1098 .RE
|
|
1099 .PP
|
1759
|
1100 \fIvcard\fR
|
|
1101 .RS 4
|
|
1102 Request VCard from the buddy
|
|
1103 .RE
|
|
1104 .PP
|
|
1105 \fIversion\fR
|
|
1106 .RS 4
|
|
1107 Request version from the buddy
|
|
1108 .RE
|
|
1109 .RE
|
|
1110 .PP
|
|
1111 /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
|
1112 .RS 4
|
1096
|
1113 The
|
|
1114 \fIroom\fR
|
1759
|
1115 command handles Multi\-User Chat room actions\&.
|
|
1116 .PP
|
|
1117 \fIjoin\fR [room [nick [pass]]]
|
|
1118 .RS 4
|
|
1119 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\&.
|
|
1120 .RE
|
|
1121 .PP
|
|
1122 \fIleave\fR [message]
|
|
1123 .RS 4
|
|
1124 Leave the current room
|
|
1125 .RE
|
|
1126 .PP
|
|
1127 \fInames\fR [\-\-detail|\-\-short|\-\-quiet|\-\-compact]
|
|
1128 .RS 4
|
|
1129 Display members of the current room
|
|
1130 .RE
|
|
1131 .PP
|
|
1132 \fInick\fR newnick
|
|
1133 .RS 4
|
|
1134 Change your nickname in the current room
|
|
1135 .RE
|
|
1136 .PP
|
|
1137 \fIprivmsg\fR nick msg
|
|
1138 .RS 4
|
|
1139 Send private message "msg" to "nick"
|
|
1140 .RE
|
|
1141 .PP
|
1096
|
1142 \fIremove\fR
|
1759
|
1143 .RS 4
|
|
1144 Remove the current room from the roster (you must have left this room before)
|
|
1145 .RE
|
|
1146 .PP
|
|
1147 \fItopic\fR \-|newtopic
|
|
1148 .RS 4
|
|
1149 Set topic for current room
|
|
1150 .RE
|
|
1151 .PP
|
1096
|
1152 \fIunlock\fR
|
1759
|
1153 .RS 4
|
|
1154 Unlock current room (if you are the owner)
|
|
1155 .RE
|
|
1156 .PP
|
|
1157 \fIdestroy\fR [reason]
|
|
1158 .RS 4
|
|
1159 Destroy the current room (use with care!)
|
1096
|
1160 .RE
|
|
1161 .PP
|
1759
|
1162 \fIwhois\fR nick
|
|
1163 .RS 4
|
|
1164 Display MUC information about "nick"
|
|
1165 .RE
|
|
1166 .PP
|
|
1167 \fIban\fR jid [reason]
|
|
1168 .RS 4
|
|
1169 Ban jid from the current room
|
|
1170 .RE
|
|
1171 .PP
|
|
1172 \fIunban\fR jid
|
|
1173 .RS 4
|
|
1174 Unban jid from the current room
|
|
1175 .RE
|
|
1176 .PP
|
|
1177 \fIinvite\fR jid [reason]
|
|
1178 .RS 4
|
|
1179 Invite jid to the current room
|
|
1180 .RE
|
|
1181 .PP
|
|
1182 \fIkick\fR nick [reason]
|
|
1183 .RS 4
|
|
1184 Kick "nick" from the current room
|
|
1185 .RE
|
|
1186 .PP
|
|
1187 \fIrole\fR jid role [reason]
|
|
1188 .RS 4
|
|
1189 Change jid\(cqs role (role can be "none", "visitor", "participant", "moderator")
|
|
1190 .RE
|
|
1191 .PP
|
|
1192 \fIaffil\fR jid affil [reason]
|
|
1193 .RS 4
|
|
1194 Change jid\(cqs affiliation (affil can be "none", "member", "admin", "owner")
|
|
1195 .RE
|
|
1196 .PP
|
|
1197 \fIsetopt\fR print_status|auto_whois [value]
|
|
1198 .RS 4
|
|
1199 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\&.
|
|
1200 .RE
|
|
1201 .PP
|
|
1202 \fIbookmark\fR [add|del] [\-autojoin|+autojoin] [\-|nick]
|
|
1203 .RS 4
|
|
1204 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\&.
|
|
1205 .RE
|
|
1206 .RE
|
|
1207 .PP
|
|
1208 /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
|
1209 .RS 4
|
1096
|
1210 The
|
|
1211 \fIroster\fR
|
1759
|
1212 command manipulates the roster/buddylist\&.
|
|
1213
|
|
1214 Here are the available parameters:
|
|
1215 .PP
|
1096
|
1216 \fIbottom\fR
|
1759
|
1217 .RS 4
|
|
1218 Jump to the bottom of the roster
|
|
1219 .RE
|
|
1220 .PP
|
|
1221 \fItop\fR
|
|
1222 .RS 4
|
|
1223 Jump to the top of the roster
|
|
1224 .RE
|
|
1225 .PP
|
|
1226 \fIup\fR [n]
|
|
1227 .RS 4
|
|
1228 Move up [n lines] in the roster
|
|
1229 .RE
|
|
1230 .PP
|
|
1231 \fIdown\fR [n]
|
|
1232 .RS 4
|
|
1233 Move down [n lines] in the roster
|
|
1234 .RE
|
|
1235 .PP
|
|
1236 \fIgroup_prev\fR
|
|
1237 .RS 4
|
|
1238 Jump to the previous group in the roster
|
|
1239 .RE
|
|
1240 .PP
|
|
1241 \fIgroup_next\fR
|
|
1242 .RS 4
|
|
1243 Jump to the next group in the roster
|
|
1244 .RE
|
|
1245 .PP
|
|
1246 \fIalternate\fR
|
|
1247 .RS 4
|
|
1248 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)\&.
|
|
1249 .RE
|
|
1250 .PP
|
|
1251 \fIunread_first\fR
|
|
1252 .RS 4
|
|
1253 Jump to the first unread message
|
|
1254 .RE
|
|
1255 .PP
|
|
1256 \fIunread_next\fR
|
|
1257 .RS 4
|
|
1258 Jump to the next unread message
|
|
1259 .RE
|
|
1260 .PP
|
|
1261 \fIsearch\fR bud
|
|
1262 .RS 4
|
|
1263 Search for a buddy with a name or jid containing "bud" (only in the displayed buddylist)
|
|
1264 .RE
|
|
1265 .PP
|
|
1266 \fIdisplay\fR [mask]
|
|
1267 .RS 4
|
|
1268 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\&.
|
|
1269 .RE
|
|
1270 .PP
|
1096
|
1271 \fIhide_offline\fR
|
1759
|
1272 .RS 4
|
|
1273 Hide offline buddies (same as /roster display ofdna)
|
|
1274 .RE
|
|
1275 .PP
|
1096
|
1276 \fIshow_offline\fR
|
1759
|
1277 .RS 4
|
|
1278 Show offline buddies (same as /roster display ofdna_)
|
|
1279 .RE
|
|
1280 .PP
|
1096
|
1281 \fItoggle_offline\fR
|
1759
|
1282 .RS 4
|
|
1283 Toggle display of offline buddies
|
|
1284 .RE
|
|
1285 .PP
|
|
1286 \fIitem_lock\fR [jid]
|
|
1287 .RS 4
|
|
1288 Lock the roster item so it remains visible regardless of its status
|
|
1289 .RE
|
|
1290 .PP
|
|
1291 \fIitem_unlock\fR [jid]
|
|
1292 .RS 4
|
|
1293 Undo the effects of item_lock
|
|
1294 .RE
|
|
1295 .PP
|
|
1296 \fIitem_toggle_lock\fR [jid]
|
|
1297 .RS 4
|
|
1298 Invert the current lock flag
|
|
1299 .RE
|
|
1300 .PP
|
1096
|
1301 \fIhide\fR
|
1759
|
1302 .RS 4
|
|
1303 Hide roster (full\-width chat window)
|
|
1304 .RE
|
|
1305 .PP
|
1096
|
1306 \fIshow\fR
|
1759
|
1307 .RS 4
|
|
1308 Show roster
|
|
1309 .RE
|
|
1310 .PP
|
1096
|
1311 \fItoggle\fR
|
1759
|
1312 .RS 4
|
|
1313 Toggle roster visibility
|
1096
|
1314 .RE
|
|
1315 .PP
|
1759
|
1316 \fInote\fR [\-|text]
|
1242
|
1317 .RS 4
|
1759
|
1318 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\&.
|
|
1319 .RE
|
|
1320 .RE
|
|
1321 .PP
|
|
1322 /say [\-n|\-h|\-\-] text
|
|
1323 .RS 4
|
|
1324 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\&.
|
|
1325
|
|
1326 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
|
1327 .RE
|
|
1328 .PP
|
1759
|
1329 /say_to [\-n|\-h] [\-q] [\-f file] jid text
|
1242
|
1330 .RS 4
|
1759
|
1331 Send the "text" message to the specified jid\&.
|
|
1332
|
|
1333 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\&.
|
|
1334
|
|
1335 The "\-n" flag turns the message to "normal" type, "\-h" to "headline"\&. "\-\-" can be used to send chat messages beginning with \-n or \-h\&.
|
|
1336
|
|
1337 When "\-q" is used, the message will be sent in the background and will not change the current active window\&.
|
|
1338
|
|
1339 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)\&.
|
|
1340 .RE
|
|
1341 .PP
|
|
1342 /screen_refresh
|
|
1343 .RS 4
|
|
1344 Refresh the mcabber screen\&.
|
1096
|
1345 .RE
|
|
1346 .PP
|
1842
|
1347 /set [option [= value]]
|
1242
|
1348 .RS 4
|
1759
|
1349 Display or set an option value\&.
|
1842
|
1350
|
|
1351 Without arguments prints a list of all set options with their values
|
1759
|
1352 .RE
|
|
1353 .PP
|
|
1354 /source pattern
|
|
1355 .RS 4
|
|
1356 Read configuration files, that match glob pattern (sorted in alphabetical order)\&.
|
1096
|
1357 .RE
|
|
1358 .PP
|
1759
|
1359 /status [online|avail|invisible|free|dnd|notavail|away [\-|statusmessage]], /status message \-|statusmessage
|
1242
|
1360 .RS 4
|
1759
|
1361 Show or set the current status\&.
|
|
1362
|
|
1363 If no status is specified, display the current status\&.
|
|
1364
|
|
1365 If a status message is specified, it will overrride the message* variables (these variables can be set in the configuration file)\&.
|
|
1366
|
|
1367 If no relevant message* variable is set and no status message provided, the current status message is kept\&.
|
|
1368
|
|
1369 If StatusMessage is "\-", the current status message is cleared\&.
|
|
1370
|
|
1371 With the "/status message" command, mcabber will update the message while preserving the status\&.
|
|
1372 .RE
|
|
1373 .PP
|
|
1374 /status_to jid online|avail|invisible|free|dnd|notavail|away [statusmessage], /status_to jid message statusmessage
|
|
1375 .RS 4
|
|
1376 Send the requested status to the specified Jabber user\&.
|
|
1377
|
|
1378 If the specified jid is "\&.", the current buddy is used\&.
|
|
1379
|
|
1380 Note: this status will be overridden by subsequent "/status" commands\&. If you are using the auto\-away feature, the status will overridden too\&.
|
|
1381
|
|
1382 Note: The jid can include a resource (i\&.e\&. user@server/resource)\&.
|
|
1383 .RE
|
|
1384 .PP
|
|
1385 /version
|
|
1386 .RS 4
|
|
1387 Display current version of mcabber\&.
|
1096
|
1388 .RE
|
226
|
1389 .SH "CONFIGURATION FILE"
|
1242
|
1390 .sp
|
1759
|
1391 See the provided sample configuration file, which should be self\-documenting\&.
|
226
|
1392 .SH "FILES"
|
1759
|
1393 .sp
|
226
|
1394 The following files can be used by mcabber(1):
|
1242
|
1395 .sp
|
1759
|
1396 .if n \{\
|
1242
|
1397 .RS 4
|
1759
|
1398 .\}
|
226
|
1399 .nf
|
1759
|
1400 $HOME/\&.mcabber/mcabberrc Default configuration file
|
|
1401 $HOME/\&.mcabberrc Configuration file used if no other has been found
|
|
1402 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled
|
|
1403 /usr/share/mcabber/help/ Default directory for online help files
|
|
1404 /usr/lib/mcabber/ Default directory for modules
|
226
|
1405 .fi
|
1759
|
1406 .if n \{\
|
1096
|
1407 .RE
|
1759
|
1408 .\}
|
226
|
1409 .SH "BUGS"
|
1242
|
1410 .sp
|
1759
|
1411 Certainly\&. Please tell me if you find one! :\-) Please visit our website to find out about the MUC room and the bug tracker\&.
|
226
|
1412 .SH "AUTHOR"
|
1242
|
1413 .sp
|
1759
|
1414 Written by \m[blue]\fBMikael BERTHE\fR\m[]\&\s-2\u[1]\d\s+2 and others (see AUTHORS file)\&.
|
226
|
1415 .SH "RESOURCES"
|
1242
|
1416 .sp
|
1759
|
1417 \m[blue]\fBMain web site\fR\m[]\&\s-2\u[2]\d\s+2
|
1842
|
1418 .sp
|
|
1419 \m[blue]\fBOfficial wiki\fR\m[]\&\s-2\u[3]\d\s+2
|
|
1420 .sp
|
|
1421 \m[blue]\fBMCabber MUC room\fR\m[]\&\s-2\u[4]\d\s+2
|
226
|
1422 .SH "COPYING"
|
1759
|
1423 .sp
|
|
1424 Copyright (C) 2005\-2010 Mikael Berthe and others\&.
|
1242
|
1425 .sp
|
1759
|
1426 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.
|
|
1427 .SH "NOTES"
|
1242
|
1428 .IP " 1." 4
|
|
1429 Mikael BERTHE
|
|
1430 .RS 4
|
1759
|
1431 \%mailto:mikael@lilotux.net
|
1242
|
1432 .RE
|
|
1433 .IP " 2." 4
|
|
1434 Main web site
|
|
1435 .RS 4
|
1759
|
1436 \%http://mcabber.com/
|
1242
|
1437 .RE
|
1842
|
1438 .IP " 3." 4
|
|
1439 Official wiki
|
|
1440 .RS 4
|
|
1441 \%http://wiki.mcabber.com/
|
|
1442 .RE
|
|
1443 .IP " 4." 4
|
|
1444 MCabber MUC room
|
|
1445 .RS 4
|
|
1446 \%xmpp:mcabber@conf.lilotux.net
|
|
1447 .RE
|