Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1 @ 1759:921429804e20

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update documentation
author Mikael Berthe <mikael@lilotux.net>
date Sat, 13 Mar 2010 18:05:07 +0100
parents d7f26538c24c
children cec7cbeb1c2e
comparison
equal deleted inserted replaced
1758:499d3ec34188 1759:921429804e20
1 '\" t
1 .\" Title: mcabber 2 .\" Title: mcabber
2 .\" Author: Mikael BERTHE 3 .\" Author: [see the "AUTHOR" section]
3 .\" Date: 11/03/2007 4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
4 .\" Manual: 5 .\" Date: 03/13/2010
5 .\" Source: 6 .\" Manual: \ \&
7 .\" Source: \ \& 0.10.0-dev
8 .\" Language: English
6 .\" 9 .\"
7 .TH "MCABBER" "1" "11/03/2007" "" "" 10 .TH "MCABBER" "1" "03/13/2010" "\ \& 0\&.10\&.0\-dev" "\ \&"
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 .\" -----------------------------------------------------------------
8 .\" disable hyphenation 23 .\" disable hyphenation
9 .nh 24 .nh
10 .\" disable justification (adjust text to left margin only) 25 .\" disable justification (adjust text to left margin only)
11 .ad l 26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
12 .SH "NAME" 30 .SH "NAME"
13 mcabber \- a simple Jabber console client 31 mcabber \- a simple Jabber (XMPP) console client
14 .SH "SYNOPSIS" 32 .SH "SYNOPSIS"
33 .sp
15 \fImcabber\fR [ \-h | \-V | \-f configfile ] 34 \fImcabber\fR [ \-h | \-V | \-f configfile ]
16 .sp
17 .SH "DESCRIPTION" 35 .SH "DESCRIPTION"
18 mcabber(1) is a small Jabber console client. For now it needs a configuration file to start, so please copy the sample mcabberrc file and adapt your connection settings. 36 .sp
19 .sp 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\&.
20 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet. 38 .sp
39 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet\&.
21 .sp 40 .sp
22 Here are some of the features of mcabber: 41 Here are some of the features of mcabber:
23 .sp 42 .sp
24 .sp 43 .RS 4
25 .RS 4 44 .ie n \{\
26 \h'-04'\(bu\h'+03' 45 \h'-04'\(bu\h'+03'\c
27 \fISSL/TLS support\fR. 46 .\}
28 .RE 47 .el \{\
29 .sp 48 .sp -1
30 .RS 4 49 .IP \(bu 2.3
31 \h'-04'\(bu\h'+03' 50 .\}
51
52 \fISASL/SSL/TLS support\fR\&.
53 .RE
54 .sp
55 .RS 4
56 .ie n \{\
57 \h'-04'\(bu\h'+03'\c
58 .\}
59 .el \{\
60 .sp -1
61 .IP \(bu 2.3
62 .\}
63
32 \fIMUC support\fR 64 \fIMUC support\fR
33 (Multi\-User Chat). 65 (Multi\-User Chat)\&.
34 .RE 66 .RE
35 .sp 67 .sp
36 .RS 4 68 .RS 4
37 \h'-04'\(bu\h'+03' 69 .ie n \{\
38 \fIPGP support\fR 70 \h'-04'\(bu\h'+03'\c
39 .RE 71 .\}
40 .sp 72 .el \{\
41 .RS 4 73 .sp -1
42 \h'-04'\(bu\h'+03' 74 .IP \(bu 2.3
75 .\}
76
77 \fIPGP, OTR support\fR
78 .RE
79 .sp
80 .RS 4
81 .ie n \{\
82 \h'-04'\(bu\h'+03'\c
83 .\}
84 .el \{\
85 .sp -1
86 .IP \(bu 2.3
87 .\}
88
43 \fIChat States\fR 89 \fIChat States\fR
44 support (typing notifications) 90 support (typing notifications)
45 .RE 91 .RE
46 .sp 92 .sp
47 .RS 4 93 .RS 4
48 \h'-04'\(bu\h'+03' 94 .ie n \{\
95 \h'-04'\(bu\h'+03'\c
96 .\}
97 .el \{\
98 .sp -1
99 .IP \(bu 2.3
100 .\}
101
49 \fIHistory logging:\fR 102 \fIHistory logging:\fR
50 If enabled (see the CONFIGURATION FILE section), 103 If enabled (see the CONFIGURATION FILE section),
51 mcabber 104 mcabber
52 can save discussions to history log files. 105 can save discussions to text history log files\&.
53 .RE 106 .RE
54 .sp 107 .sp
55 .RS 4 108 .RS 4
56 \h'-04'\(bu\h'+03' 109 .ie n \{\
110 \h'-04'\(bu\h'+03'\c
111 .\}
112 .el \{\
113 .sp -1
114 .IP \(bu 2.3
115 .\}
116
57 \fICommands completion:\fR 117 \fICommands completion:\fR
58 If possible, 118 If possible,
59 mcabber 119 mcabber
60 will try to complete your command line if you hit the Tab key. 120 will try to complete your command line if you hit the Tab key\&.
61 .RE 121 .RE
62 .sp 122 .sp
63 .RS 4 123 .RS 4
64 \h'-04'\(bu\h'+03' 124 .ie n \{\
125 \h'-04'\(bu\h'+03'\c
126 .\}
127 .el \{\
128 .sp -1
129 .IP \(bu 2.3
130 .\}
131
65 \fIInput line history:\fR 132 \fIInput line history:\fR
66 Any message or command entered is in the input line history and can be reused easily. 133 Any message or command entered is in the input line history and can be reused easily\&.
67 .RE 134 .RE
68 .sp 135 .sp
69 .RS 4 136 .RS 4
70 \h'-04'\(bu\h'+03' 137 .ie n \{\
138 \h'-04'\(bu\h'+03'\c
139 .\}
140 .el \{\
141 .sp -1
142 .IP \(bu 2.3
143 .\}
144
71 \fIExternal actions:\fR 145 \fIExternal actions:\fR
72 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 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
73 mcabber 147 mcabber
74 source code, in the contrib directory. 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\&.
75 .RE 163 .RE
76 .SH "OPTIONS" 164 .SH "OPTIONS"
77 .PP 165 .PP
78 \-\-help, \-h 166 \-h
79 .RS 4 167 .RS 4
80 Quick help usage message 168 Quick help usage message
169 .RE
170 .PP
171 \-V
172 .RS 4
173 Displays
174 mcabber
175 version and compile\-time definitions\&.
81 .RE 176 .RE
82 .PP 177 .PP
83 \-f configfile 178 \-f configfile
84 .RS 4 179 .RS 4
85 Use configuration file 180 Use configuration file
86 \fIconfigfile\fR 181 \fIconfigfile\fR
87 .RE 182 .RE
88 .SH "WINDOWS/PANES" 183 .SH "WINDOWS/PANES"
89 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. 184 .sp
90 .sp 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\&.
91 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. 186 .sp
92 .sp 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\&.
93 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. 188 .sp
94 .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\&.
95 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. 190 .sp
96 .sp 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\&.
97 .SH "KEYS" 192 .SH "KEYS"
98 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...). 193 .sp
99 .sp 194 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...)\&.
100 PageUp and PageDown keys are used to move in the roster. 195 .sp
101 .sp 196 PageUp and PageDown keys are used to move in the roster\&.
102 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). 197 .sp
103 .sp 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)\&.
104 To send a message, move to the choosen 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. 199 .sp
105 .sp 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\&.
106 Here is a quick description of the key bindings: 201 .sp
107 .sp 202 Here is a quick description of the default key bindings:
108 .TS 203 .PP
109 tab(:);
110 l l
111 l l
112 l l
113 l l
114 l l
115 l l
116 l l
117 l l
118 l l
119 l l
120 l l
121 l l
122 l l
123 l l
124 l l
125 l l
126 l l
127 l l.
128 T{
129 Esc 204 Esc
130 .sp 205 .RS 4
131 T}:T{
132 Disable chat mode 206 Disable chat mode
133 .sp 207 .RE
134 T} 208 .PP
135 T{ 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
136 Ctrl\-d 249 Ctrl\-d
137 .sp 250 .RS 4
138 T}:T{
139 Send/terminate a multi\-line message 251 Send/terminate a multi\-line message
140 .sp 252 .RE
141 T} 253 .PP
142 T{
143 Ctrl\-p/Ctrl\-n 254 Ctrl\-p/Ctrl\-n
144 .sp 255 .RS 4
145 T}:T{
146 Scroll up/down half a screen in the buffer window (chat mode) 256 Scroll up/down half a screen in the buffer window (chat mode)
147 .sp 257 .RE
148 T} 258 .PP
149 T{
150 Ctrl\-Left 259 Ctrl\-Left
151 .sp 260 .RS 4
152 T}:T{
153 Move the cursor back to the start of the current or previous word 261 Move the cursor back to the start of the current or previous word
154 .sp 262 .RE
155 T} 263 .PP
156 T{
157 Ctrl\-Right 264 Ctrl\-Right
158 .sp 265 .RS 4
159 T}:T{
160 Move the cursor forward to the end of the current or next word 266 Move the cursor forward to the end of the current or next word
161 .sp 267 .RE
162 T} 268 .PP
163 T{
164 Ctrl\-u 269 Ctrl\-u
165 .sp 270 .RS 4
166 T}:T{
167 Delete from beginning of the line to the cursor 271 Delete from beginning of the line to the cursor
168 .sp 272 .RE
169 T} 273 .PP
170 T{
171 Ctrl\-k 274 Ctrl\-k
172 .sp 275 .RS 4
173 T}:T{
174 Delete from the cursor to the end of line 276 Delete from the cursor to the end of line
175 .sp 277 .RE
176 T} 278 .PP
177 T{
178 Ctrl\-w 279 Ctrl\-w
179 .sp 280 .RS 4
180 T}:T{
181 Backward kill word 281 Backward kill word
182 .sp 282 .RE
183 T} 283 .PP
184 T{
185 Ctrl\-t 284 Ctrl\-t
186 .sp 285 .RS 4
187 T}:T{
188 Transpose chars 286 Transpose chars
189 .sp 287 .RE
190 T} 288 .PP
191 T{
192 Ctrl\-o 289 Ctrl\-o
193 .sp 290 .RS 4
194 T}:T{
195 Accept line and put the next history line in the input line (accept\-line\-and\-down\-history) 291 Accept line and put the next history line in the input line (accept\-line\-and\-down\-history)
196 .sp 292 .RE
197 T} 293 .sp
198 T{ 294 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section\&.
199 Ctrl\-a 295 .SH "MCABBER\(cqS ROSTER"
200 .sp 296 .sp
201 T}:T{ 297 The first listed resource 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\&.
298 .sp
299 Group names are displayed above the resources that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&.
300 .sp
301 For every real Jabber resource, the roster displays four pieces of information: the resource\(cqs name or alias, its online status, its authorization status, and whether there are unread messages from the resource waiting for you\&.
302 .sp
303 The online status is one of the following:
304 .PP
305 \fIo\fR
306 .RS 4
307 online
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
344 unknown, usually meaning you are not authorized to see this resource\(cqs status
345 .RE
346 .PP
347 \fIx\fR
348 .RS 4
349 a conference room in which you are not participating
350 .RE
351 .PP
352 \fIC\fR
353 .RS 4
354 a conference room in which you are participating
355 .RE
356 .sp
357 The authorization status indicates whether a resource is authorized to receive your online status updates, and is displayed by the brackets surrounding the resource\(cqs online status\&. Square brackets, like \fI[o]\fR, indicate that this resource is authorized to receive your status\&. Curly braces, like \fI{o}\fR, indicate that they are not authorized to receive your status\&.
358 .sp
359 When there are unread messages from the resource which you have not looked at, a hash mark (\fI#\fR) appears in the leftmost section of the roster for that resource\&. The hash mark disappears once you view that resource\(cqs message log\&.
360 .sp
361 Examples:
362 .PP
363 \fI\-\-\- Buds\fR
364 .RS 4
365 This is a group named
366 \fIBuds\fR
367 .RE
368 .PP
369 \fI#[o] John\fR
370 .RS 4
371 John is online, can see your status, and sent you a message that you did not read yet
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"
389 .sp
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"
400 .sp
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
412 .PP
413 /alias [name [= command line]]
414 .RS 4
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
475 .RE
476 .PP
477 /bind [keycode [= command line]]
478 .RS 4
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
518 Buddy\(cqs buffer manipulation command\&. Eg\&. you can search through buffer for "text", clear chat window etc\&.
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)
543 .RE
544 .PP
545 \fItop\fR
546 .RS 4
547 Jump to the top of the current buddy chat buffer
548 .RE
549 .PP
550 \fIbottom\fR
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
585 \fIscroll_lock\fR
586 .RS 4
587 Lock buffer scrolling
588 .RE
589 .PP
590 \fIscroll_unlock\fR
591 .RS 4
592 Unlock buffer scrolling
593 .RE
594 .PP
595 \fIscroll_toggle\fR
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\&.
611 .RE
612 .PP
613 /clear
614 .RS 4
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
620 The
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
202 Go to the beginning of the input line 824 Go to the beginning of the input line
203 .sp 825 .RE
204 T} 826 .PP
205 T{ 827 \fIiline_end\fR
206 Ctrl\-e 828 .RS 4
207 .sp
208 T}:T{
209 Go to the end of the input line 829 Go to the end of the input line
210 .sp 830 .RE
211 T} 831 .PP
212 T{ 832 \fIiline_fdel\fR
213 Ctrl\-l 833 .RS 4
214 .sp 834 Delete from the cursor to the end of line
215 T}:T{ 835 .RE
216 Force a refresh 836 .PP
217 .sp 837 \fIiline_bdel\fR
218 T} 838 .RS 4
219 T{ 839 Delete from beginning of the line to the cursor
220 Up/Down 840 .RE
221 .sp 841 .PP
222 T}:T{ 842 \fIiline_accept\fR
223 Move in the input line history 843 .RS 4
224 .sp 844 Accept line
225 T} 845 .RE
226 T{ 846 .PP
227 PgUp/PgDown 847 \fIiline_accept_down_hist\fR
228 .sp 848 .RS 4
229 T}:T{ 849 Accept line and put the next history line in the input line
230 Move inside the roster (buddylist) 850 .RE
231 .sp 851 .PP
232 T} 852 \fIcompl_do\fR
233 T{ 853 .RS 4
234 Tab
235 .sp
236 T}:T{
237 Complete current word, in the input line 854 Complete current word, in the input line
238 .sp 855 .RE
239 T} 856 .PP
240 T{ 857 \fIcompl_cancel\fR
241 Ctrl\-g 858 .RS 4
242 .sp
243 T}:T{
244 Cancel completion 859 Cancel completion
245 .sp 860 .RE
246 T} 861 .PP
247 T{ 862 \fIsend_multiline\fR
248 Ctrl\-c 863 .RS 4
249 .sp 864 Send/terminate a multi\-line message
250 T}:T{ 865 .RE
251 Abort multi\-line messages and completions 866 .RE
252 .sp 867 .PP
253 T} 868 /info
254 .TE 869 .RS 4
255 .sp 870 Display info on the selected entry (user, agent, group\&...)\&.
256 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section. 871
257 .sp 872 For users, resources are displayed with the status, priority and status message (if available) of each resource\&.
258 .SH "MCABBER'S ROSTER" 873 .RE
259 The first listed resource 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. 874 .PP
260 .sp 875 /module load|unload [\-f] module, /module info module, /module [list]
261 Group names are displayed above the resources that are within them, and are indicated by \fI\-\-\-\fR to the left of the name. 876 .RS 4
262 .sp 877 Load, unload or show info on module\&.
263 For every real Jabber resource, the roster displays four pieces of information: the resource's name or alias, its online status, its authorization status, and whether there are unread messages from the resource waiting for you. 878 .PP
264 .sp 879 \fIload\fR [\-f] module
265 The online status is one of the following: 880 .RS 4
266 .sp 881 Loads specified module\&. If \-f flag is specified, most of module loading errors will be ignored\&.
267 .TS 882 .RE
268 tab(:); 883 .PP
269 l l 884 \fIunload\fR [\-f] module
270 l l 885 .RS 4
271 l l 886 Unloads specified module\&. Note: The force flag will not remove any dependent on this modules!
272 l l 887 .RE
273 l l 888 .PP
274 l l 889 \fIinfo\fR module
275 l l 890 .RS 4
276 l l 891 Shows available information about this module\&.
277 l l 892 .RE
278 l l. 893 .PP
279 T{ 894 [\fIlist\fR]
280 \fIo\fR 895 .RS 4
281 .sp 896 Lists modules in a format: [modulename] [reference count] ([Manually/Automatically loaded]) [any extra info, like version or dependencies]
282 T}:T{ 897 .RE
283 online 898 .RE
284 .sp 899 .PP
285 T} 900 /move [groupname]
286 T{ 901 .RS 4
287 \fIC\fR 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\&.
288 .sp 903
289 T}:T{ 904 Tip: if the chatmode is enabled, you can use "/roster alternate" to jump to the moved buddy\&.
290 a conference room in which you are participating 905 .RE
291 .sp 906 .PP
292 T} 907 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort
293 T{ 908 .RS 4
294 \fIf\fR 909 Send a multi\-line message\&. To write a single message with several lines, the
295 .sp 910 \fImulti\-line mode\fR
296 T}:T{ 911 should be used\&.
297 free for chat 912
298 .sp 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\&.
299 T} 914
300 T{
301 \fIa\fR
302 .sp
303 T}:T{
304 away
305 .sp
306 T}
307 T{
308 \fIn\fR
309 .sp
310 T}:T{
311 not available (labeled \fIextended away\fR in some clients)
312 .sp
313 T}
314 T{
315 \fId\fR
316 .sp
317 T}:T{
318 do not disturb
319 .sp
320 T}
321 T{
322 \fIi\fR
323 .sp
324 T}:T{
325 invisible (displayed only for your resource)
326 .sp
327 T}
328 T{
329 \fI_\fR
330 .sp
331 T}:T{
332 offline (or invisible to you)
333 .sp
334 T}
335 T{
336 \fI?\fR
337 .sp
338 T}:T{
339 unknown, usually meaning you are not authorized to see this resource's status
340 .sp
341 T}
342 T{
343 \fIx\fR
344 .sp
345 T}:T{
346 a conference room in which you are not participating
347 .sp
348 T}
349 .TE
350 .sp
351 The authorization status indicates whether a resource is authorized to receive your online status updates, and is displayed by the brackets surrounding the resource's online status. Square brackets, like \fI[o]\fR, indicate that this resource is authorized to receive your status. Curly braces, like \fI{o}\fR, indicate that they are not authorized to receive your status.
352 .sp
353 When there are unread messages from the resource which you have not looked at, a hash mark (\fI#\fR) appears in the leftmost section of the roster for that resource. The hash mark disappears once you view that resource's message log.
354 .sp
355 Examples:
356 .sp
357 .TS
358 tab(:);
359 l l
360 l l
361 l l
362 l l
363 l l.
364 T{
365 \fI \-\-\- Buds\fR
366 .sp
367 T}:T{
368 This is a group named \fIBuds\fR
369 .sp
370 T}
371 T{
372 \fI#[o] John\fR
373 .sp
374 T}:T{
375 John is online, can see your status, and sent you a message that you did not read yet
376 .sp
377 T}
378 T{
379 \fI {?} Sally\fR
380 .sp
381 T}:T{
382 Neither you nor Sally have authorized each other to see your online status
383 .sp
384 T}
385 T{
386 \fI {a} Jane\fR
387 .sp
388 T}:T{
389 Jane is away, but she cannot see your online status
390 .sp
391 T}
392 T{
393 \fI#[C] x@y.c\fR
394 .sp
395 T}:T{
396 You are participating in x@y.c conference room, and there are unread messages
397 .sp
398 T}
399 .TE
400 .sp
401 .SH "COMMANDS"
402 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.
403 .sp
404 .SH "COMMANDS RELATED TO MCABBER"
405 .PP
406 /alias [name [= command line]]
407 .RS 4
408 Add "name" as an alias for "command line".
409 Aliases are expanded only once, thus they can not be chained.
410 "/alias name" displays the value associated with the "name" alias;
411 "/alias name =" unsets the "name" alias.
412 "/alias" displays a list of the existing aliases. Example: "/alias away = status away".
413 .RE
414 .PP
415 /bind [keycode [= command line]]
416 .RS 4
417 Bind a command line to the key with the "keycode" code number.
418 Keycodes of unused keys are displayed by mcabber in the log window when pressing the key, for example "Unknown key=265".
419 "/bind keycode" displays the command line bound to the given keycode;
420 "/bind keycode =" unbinds the given keycode.
421 "/bind" displays a list of the bound keycodes.
422 Note: aliases can be used in key bindings.
423 Example: "/bind 265 = status online" (265 is F1 for me, but it may depend on your ncurses installation).
424 .RE
425 .PP
426 /buffer clear|close|close_all|purge, /buffer top|bottom|date|%|search_backward|search_forward, /buffer scroll_lock|scroll_unlock|scroll_toggle
427 .RS 4
428 The 915 The
429 \fIbuffer\fR 916 \fIbegin\fR
430 command manipulates the current buddy's buffer (chat window). 917 subcommand enables multi\-line mode\&. Note that it allows a message subject to be specified\&.
431 .TS 918
432 tab(:);
433 l l
434 l l
435 l l
436 l l
437 l l
438 l l
439 l l
440 l l
441 l l
442 l l
443 l l
444 l l
445 l l.
446 T{
447 \fIclear\fR
448 T}:T{
449 clear the current buddy chat window
450 T}
451 T{
452 \fIclose\fR
453 T}:T{
454 empty all contents of the buffer and close the current buddy chat window
455 T}
456 T{
457 \fIclose_all\fR
458 T}:T{
459 empty all contents of the chat buffers and close the chat windows
460 T}
461 T{
462 \fIpurge\fR
463 T}:T{
464 clear the current buddy chat window and empty all contents of the chat buffer
465 T}
466 T{
467 \fItop\fR
468 T}:T{
469 jump to the top of the current buddy chat buffer
470 T}
471 T{
472 \fIbottom\fR
473 T}:T{
474 jump to the bottom of the current buddy chat buffer
475 T}
476 T{
477 \fIup\fR
478 [n]
479 T}:T{
480 scroll the buffer up n lines (default: half a screen)
481 T}
482 T{
483 \fIdown\fR
484 [n]
485 T}:T{
486 scroll the buffer down n lines (default: half a screen)
487 T}
488 T{
489 \fIdate\fR
490 date
491 T}:T{
492 jump to the first line after the specified date in the chat buffer (date format: "YYYY\-mm\-dd[THH:MM:SS]", "\-" and ":" are optional)
493 T}
494 T{
495 \fI%\fR
496 n
497 T}:T{
498 jump to position %n of the buddy chat buffer
499 T}
500 T{
501 \fIsearch_backward\fR
502 text
503 T}:T{
504 search for "text" in the current buddy chat buffer
505 T}
506 T{
507 \fIsearch_forward\fR
508 text
509 T}:T{
510 search for "text" in the current buddy chat buffer
511 T}
512 T{
513 \fIscroll_lock\fR
514 T}:T{
515 lock buffer scrolling
516 T}
517 T{
518 \fIscroll_unlock\fR
519 T}:T{
520 unlock buffer scrolling
521 T}
522 T{
523 \fIscroll_toggle\fR
524 T}:T{
525 toggle buffer scrolling (lock/unlock)
526 T}
527 .TE
528 .sp
529 .RE
530 .PP
531 /clear
532 .RS 4
533 The 919 The
534 \fIclear\fR 920 \fIverbatim\fR
535 command is actually an alias for "/buffer clear". 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\&.
536 .RE 922
537 .PP 923 The
538 /help [command] 924 \fItoggle\fR
539 .RS 4 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)\&.
540 Display generic help or help about a specific mcabber command. 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
943 .RS 4
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
541 .RE 1058 .RE
542 .PP 1059 .PP
543 /quit 1060 /quit
544 .RS 4 1061 .RS 4
545 Disconnect and leave 1062 This command closes all connections and quit mcabber\&.
546 mcabber(1).
547 .RE
548 .PP
549 /set option[=value]
550 .RS 4
551 Display or set an option value.
552 .RE
553 .PP
554 /source [file]
555 .RS 4
556 Read a configuration file.
557 .RE
558 .PP
559 /version
560 .RS 4
561 Display mcabber version
562 .RE
563 .SH "COMMANDS RELATED TO THE SERVER AND CONNECTION"
564 .PP
565 /connect
566 .RS 4
567 Establish connection to the Jabber server.
568 .RE
569 .PP
570 /disconnect
571 .RS 4
572 Terminate connection to the Jabber server. Note: the roster is only available when the connection to the server is active, so the buddylist is empty when disconnected.
573 .RE
574 .PP
575 /event #n|* accept|ignore|reject, /event list
576 .RS 4
577 Tell mcabber what to do about a pending event. If the first parameter is "*", the command will apply to all queued events.
578 .TS
579 tab(:);
580 l l
581 l l
582 l l
583 l l.
584 T{
585 \fIaccept\fR
586 T}:T{
587 accept the event #n
588 T}
589 T{
590 \fIignore\fR
591 T}:T{
592 remove the event #n from the list
593 T}
594 T{
595 \fIreject\fR
596 T}:T{
597 reject the event #n
598 T}
599 T{
600 \fIlist\fR
601 T}:T{
602 list all pending events
603 T}
604 .TE
605 .sp
606 .RE 1063 .RE
607 .PP 1064 .PP
608 /rawxml send string 1065 /rawxml send string
609 .RS 4 1066 .RS 4
610 1067 Send "string" (raw XML format) to the Jabber server\&.
611 \fIsend\fR 1068
612 string: send string (raw XML format) to the Jabber server. No check is done on the string provided. BEWARE! Use this only if you know what you are doing, or you could terminate the connection. 1069 No check is done on the string provided\&.
613 .RE 1070
614 .SH "COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES" 1071 BEWARE! Use this only if you know what you are doing, or you could terminate the connection\&.
615 .PP 1072
616 /add [jid [nickname]] 1073 Example: "/rawxml send <presence><show>away</show></presence>"
617 .RS 4
618 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.
619 .RE
620 .PP
621 /authorization allow|cancel|request|request_unsubscribe [jid]
622 .RS 4
623 Manage the presence subscriptions. If no jid is provided, the current buddy is used.
624 .TS
625 tab(:);
626 l l
627 l l
628 l l
629 l l.
630 T{
631 \fIallow\fR
632 T}:T{
633 allow the buddy to receive your presence updates
634 T}
635 T{
636 \fIcancel\fR
637 T}:T{
638 cancel the buddy' subscription to your presence updates
639 T}
640 T{
641 \fIrequest\fR
642 T}:T{
643 request a subscription to the buddy's presence updates
644 T}
645 T{
646 \fIrequest_unsubscribe\fR
647 T}:T{
648 request unsubscription from the buddy's presence updates
649 T}
650 .TE
651 .sp
652 .RE
653 .PP
654 /del
655 .RS 4
656 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours.
657 .RE
658 .PP
659 /group fold|unfold|toggle
660 .RS 4
661 The
662 \fIgroup\fR
663 command changes the current group display.
664 .TS
665 tab(:);
666 l l
667 l l
668 l l.
669 T{
670 \fIfold\fR
671 T}:T{
672 fold (shrink) the current group tree in the roster
673 T}
674 T{
675 \fIunfold\fR
676 T}:T{
677 unfold (expand) the current group tree in the roster
678 T}
679 T{
680 \fItoggle\fR
681 T}:T{
682 toggle the state (fold/unfold) of the current tree
683 T}
684 .TE
685 .sp
686 .RE
687 .PP
688 /info
689 .RS 4
690 Display info on the selected entry (user, agent, group\&...). For users, resources are displayed with the status, priority and status message (if available) of each resource.
691 .RE
692 .PP
693 /move [groupname]
694 .RS 4
695 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't exist, it is created. Tip: if the chatmode is enabled, you can use "/roster alternate" to jump to the moved buddy.
696 .RE
697 .PP
698 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort
699 .RS 4
700 Send a multi\-line message. To write a single message with several lines, the
701 \fImulti\-line mode\fR
702 should be used. 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 (or Ctrl\-d). The
703 \fIbegin\fR
704 subcommand enables multi\-line mode. Note that it allows a message subject to be specified. The
705 \fIverbatim\fR
706 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. The
707 \fItoggle\fR
708 and
709 \fItoggle_verbatim\fR
710 subcommands can be bound to a key to use the multi\-line mode quickly (for example, "bind M109 = msay toggle" to switch using the Meta\-m combination).
711 .TS
712 tab(:);
713 l l
714 l l
715 l l
716 l l
717 l l
718 l l
719 l l.
720 T{
721 \fIbegin\fR
722 [subject]
723 T}:T{
724 enter multi\-line mode
725 T}
726 T{
727 \fIverbatim\fR
728 T}:T{
729 enter verbatim multi\-line mode
730 T}
731 T{
732 \fIsend\fR
733 T}:T{
734 send the current multi\-line message to the currently selected buddy
735 T}
736 T{
737 \fIsend_to\fR
738 jid
739 T}:T{
740 send the current multi\-line message to "jid"
741 T}
742 T{
743 \fItoggle\fR
744 T}:T{
745 switch to/from multi\-line mode (begin/send)
746 T}
747 T{
748 \fItoggle_verbatim\fR
749 T}:T{
750 same with verbatim multi\-line mode
751 T}
752 T{
753 \fIabort\fR
754 T}:T{
755 leave multi\-line mode without sending the message
756 T}
757 .TE
758 .sp
759 .RE
760 .PP
761 /pgp disable|enable|force|info [jid], /pgp setkey [jid [key]]
762 .RS 4
763 Manipulate PGP settings for the specified jid (by default the currently selected contact). Please note that PGP encryption won't be used if no remote PGP support is detected, even if PGP is enabled with this command.
764 .TS
765 tab(:);
766 l l
767 l l
768 l l
769 l l
770 l l.
771 T{
772 \fIdisable\fR
773 [jid]
774 T}:T{
775 disable PGP encryption for jid (or the currently selected contact)
776 T}
777 T{
778 \fIenable\fR
779 [jid]
780 T}:T{
781 enable PGP encryption for jid (or the currently selected contact)
782 T}
783 T{
784 \fIforce\fR
785 [jid]
786 T}:T{
787 enforce PGP encryption, even for offline messages, and always assume the recipient has PGP support
788 T}
789 T{
790 \fIinfo\fR
791 [jid]
792 T}:T{
793 show current PGP settings for the contact
794 T}
795 T{
796 \fIsetkey\fR
797 [jid [key]]
798 T}:T{
799 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.
800 T}
801 .TE
802 .sp
803 .RE 1074 .RE
804 .PP 1075 .PP
805 /rename name 1076 /rename name
806 .RS 4 1077 .RS 4
807 Rename current buddy or group to the given name. Please note that a group name change is only done when the server's acknowledgment is received, so a slight delay can be noticed. 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)\&.
808 .RE 1079 .RE
809 .PP 1080 .PP
810 /request last|time|vcard|version [jid] 1081 /request last|ping|time|vcard|version [jid]
811 .RS 4 1082 .RS 4
812 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. 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\&.
813 .RE 1084 .PP
814 .PP 1085 \fIlast\fR
815 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy, /room invite|kick|ban|role|affil, /room bookmark [add|del] [\-autojoin|+autojoin] 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\&.
1093 .RE
1094 .PP
1095 \fItime\fR
1096 .RS 4
1097 Request time from the buddy
1098 .RE
1099 .PP
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]
816 .RS 4 1112 .RS 4
817 The 1113 The
818 \fIroom\fR 1114 \fIroom\fR
819 command handles Multi\-User Chat room actions. 1115 command handles Multi\-User Chat room actions\&.
820 .TS 1116 .PP
821 tab(:); 1117 \fIjoin\fR [room [nick [pass]]]
822 l l 1118 .RS 4
823 l l 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\&.
824 l l 1120 .RE
825 l l 1121 .PP
826 l l 1122 \fIleave\fR [message]
827 l l 1123 .RS 4
828 l l 1124 Leave the current room
829 l l 1125 .RE
830 l l 1126 .PP
831 l l 1127 \fInames\fR [\-\-detail|\-\-short|\-\-quiet|\-\-compact]
832 l l 1128 .RS 4
833 l l 1129 Display members of the current room
834 l l 1130 .RE
835 l l 1131 .PP
836 l l. 1132 \fInick\fR newnick
837 T{ 1133 .RS 4
838 \fIjoin\fR 1134 Change your nickname in the current room
839 [room [nick [pass]]] 1135 .RE
840 T}:T{ 1136 .PP
841 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. 1137 \fIprivmsg\fR nick msg
842 T} 1138 .RS 4
843 T{ 1139 Send private message "msg" to "nick"
844 \fIwhois\fR 1140 .RE
845 nick 1141 .PP
846 T}:T{
847 display MUC information about "nick"
848 T}
849 T{
850 \fIban\fR
851 jid [reason]
852 T}:T{
853 ban jid from the current room
854 T}
855 T{
856 \fIinvite\fR
857 jid [reason]
858 T}:T{
859 invite jid to the current room
860 T}
861 T{
862 \fIkick\fR
863 nick [reason]
864 T}:T{
865 kick "nick" from the current room
866 T}
867 T{
868 \fIrole\fR
869 jid role [reason]
870 T}:T{
871 change jid's role (role can be "none", "visitor", "participant", "moderator")
872 T}
873 T{
874 \fIaffil\fR
875 jid affil [reason]
876 T}:T{
877 change jid's affiliation (affil can be "none", "member", "admin", "owner")
878 \fIbookmark\fR
879 add/update/remove a room bookmark, set/unset autojoin
880 T}
881 T{
882 \fIleave\fR
883 [message]
884 T}:T{
885 leave the current room
886 T}
887 T{
888 \fInames\fR
889 [\-\-detail|\-\-short|\-\-quiet]
890 T}:T{
891 display the members of the current room
892 T}
893 T{
894 \fInick\fR
895 nick
896 T}:T{
897 change your nickname in the current room
898 T}
899 T{
900 \fIprivmsg\fR
901 nick msg
902 T}:T{
903 send private message "msg" to "nick"
904 T}
905 T{
906 \fIremove\fR 1142 \fIremove\fR
907 T}:T{ 1143 .RS 4
908 remove the current room from the roster (you must have left this room before) 1144 Remove the current room from the roster (you must have left this room before)
909 T} 1145 .RE
910 T{ 1146 .PP
911 \fItopic\fR 1147 \fItopic\fR \-|newtopic
912 T}:T{ 1148 .RS 4
913 set topic for current room 1149 Set topic for current room
914 T} 1150 .RE
915 T{ 1151 .PP
916 \fIunlock\fR 1152 \fIunlock\fR
917 T}:T{ 1153 .RS 4
918 unlock current room (if you are the owner) 1154 Unlock current room (if you are the owner)
919 T} 1155 .RE
920 T{ 1156 .PP
921 \fIdestroy\fR 1157 \fIdestroy\fR [reason]
922 [reason] 1158 .RS 4
923 T}:T{ 1159 Destroy the current room (use with care!)
924 destroy the current room (use with care!) 1160 .RE
925 T} 1161 .PP
926 .TE 1162 \fIwhois\fR nick
927 .sp 1163 .RS 4
928 .RE 1164 Display MUC information about "nick"
929 .PP 1165 .RE
930 /roster bottom|top|up|down|group_prev|group_next, /roster alternate|unread_first|unread_next, /roster search bud, /roster hide_offline|show_offline|toggle_offline, /roster item_lock|item_unlock, /roster hide|show|toggle, /roster note [\-|text] 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]
931 .RS 4 1209 .RS 4
932 The 1210 The
933 \fIroster\fR 1211 \fIroster\fR
934 command manipulates the roster/buddylist. Here are the available parameters: 1212 command manipulates the roster/buddylist\&.
935 .TS 1213
936 tab(:); 1214 Here are the available parameters:
937 l l 1215 .PP
938 l l
939 l l
940 l l
941 l l
942 l l
943 l l
944 l l
945 l l
946 l l
947 l l
948 l l
949 l l
950 l l
951 l l
952 l l
953 l l
954 l l
955 l l.
956 T{
957 \fIbottom\fR 1216 \fIbottom\fR
958 T}:T{ 1217 .RS 4
959 jump to the bottom of the roster 1218 Jump to the bottom of the roster
960 T} 1219 .RE
961 T{ 1220 .PP
962 \fIsearch\fR 1221 \fItop\fR
963 bud 1222 .RS 4
964 T}:T{ 1223 Jump to the top of the roster
965 search for a buddy with a name or jid containing "bud" (only in the displayed buddylist) 1224 .RE
966 T} 1225 .PP
967 T{ 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
968 \fIhide_offline\fR 1271 \fIhide_offline\fR
969 T}:T{ 1272 .RS 4
970 hide offline buddies 1273 Hide offline buddies (same as /roster display ofdna)
971 T} 1274 .RE
972 T{ 1275 .PP
973 \fIshow_offline\fR 1276 \fIshow_offline\fR
974 T}:T{ 1277 .RS 4
975 show offline buddies 1278 Show offline buddies (same as /roster display ofdna_)
976 T} 1279 .RE
977 T{ 1280 .PP
978 \fItoggle_offline\fR 1281 \fItoggle_offline\fR
979 T}:T{ 1282 .RS 4
980 toggle display of offline buddies 1283 Toggle display of offline buddies
981 T} 1284 .RE
982 T{ 1285 .PP
983 \fIitem_lock\fR 1286 \fIitem_lock\fR [jid]
984 jid 1287 .RS 4
985 T}:T{ 1288 Lock the roster item so it remains visible regardless of its status
986 lock the roster item so it remains visible regardless of its status 1289 .RE
987 T} 1290 .PP
988 T{ 1291 \fIitem_unlock\fR [jid]
989 \fIitem_unlock\fR 1292 .RS 4
990 jid 1293 Undo the effects of item_lock
991 T}:T{ 1294 .RE
992 undo the effects of item_lock 1295 .PP
993 T} 1296 \fIitem_toggle_lock\fR [jid]
994 T{ 1297 .RS 4
1298 Invert the current lock flag
1299 .RE
1300 .PP
995 \fIhide\fR 1301 \fIhide\fR
996 T}:T{ 1302 .RS 4
997 hide roster (full\-width chat window) 1303 Hide roster (full\-width chat window)
998 T} 1304 .RE
999 T{ 1305 .PP
1000 \fIshow\fR 1306 \fIshow\fR
1001 T}:T{ 1307 .RS 4
1002 show roster 1308 Show roster
1003 T} 1309 .RE
1004 T{ 1310 .PP
1005 \fItoggle\fR 1311 \fItoggle\fR
1006 T}:T{ 1312 .RS 4
1007 toggle roster visibility 1313 Toggle roster visibility
1008 T} 1314 .RE
1009 T{ 1315 .PP
1010 \fInote\fR 1316 \fInote\fR [\-|text]
1011 [text] 1317 .RS 4
1012 T}:T{ 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\&.
1013 display or set an annotation (if text is "\-", the annotation is deleted). In the "status" buffer, it will display all annotations. 1319 .RE
1014 T} 1320 .RE
1015 T{ 1321 .PP
1016 \fItop\fR 1322 /say [\-n|\-h|\-\-] text
1017 T}:T{ 1323 .RS 4
1018 jump to the top of the roster 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\&.
1019 T} 1325
1020 T{ 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\&.
1021 \fIup\fR 1327 .RE
1022 T}:T{ 1328 .PP
1023 move up in the roster 1329 /say_to [\-n|\-h] [\-q] [\-f file] jid text
1024 T} 1330 .RS 4
1025 T{ 1331 Send the "text" message to the specified jid\&.
1026 \fIdown\fR 1332
1027 T}:T{ 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\&.
1028 move down in the roster 1334
1029 T} 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\&.
1030 T{ 1336
1031 \fIgroup_prev\fR 1337 When "\-q" is used, the message will be sent in the background and will not change the current active window\&.
1032 T}:T{ 1338
1033 jump to the previous group in the roster 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)\&.
1034 T} 1340 .RE
1035 T{ 1341 .PP
1036 \fIgroup_next\fR 1342 /screen_refresh
1037 T}:T{ 1343 .RS 4
1038 jump to the next group in the roster 1344 Refresh the mcabber screen\&.
1039 T} 1345 .RE
1040 T{ 1346 .PP
1041 \fIalternate\fR 1347 /set option [= value]
1042 T}:T{ 1348 .RS 4
1043 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_first") 1349 Display or set an option value\&.
1044 T} 1350 .RE
1045 T{ 1351 .PP
1046 \fIunread_first\fR 1352 /source pattern
1047 T}:T{ 1353 .RS 4
1048 jump to the first unread message 1354 Read configuration files, that match glob pattern (sorted in alphabetical order)\&.
1049 T} 1355 .RE
1050 T{ 1356 .PP
1051 \fIunread_next\fR 1357 /status [online|avail|invisible|free|dnd|notavail|away [\-|statusmessage]], /status message \-|statusmessage
1052 T}:T{ 1358 .RS 4
1053 jump to the next unread message 1359 Show or set the current status\&.
1054 T} 1360
1055 .TE 1361 If no status is specified, display the current status\&.
1056 .sp 1362
1057 .RE 1363 If a status message is specified, it will overrride the message* variables (these variables can be set in the configuration file)\&.
1058 .PP 1364
1059 /say text 1365 If no relevant message* variable is set and no status message provided, the current status message is kept\&.
1060 .RS 4 1366
1061 Send the "text" message to the currently selected buddy. Can be useful if you want to send a message beginning with a slash, for example. 1367 If StatusMessage is "\-", the current status message is cleared\&.
1062 .RE 1368
1063 .PP 1369 With the "/status message" command, mcabber will update the message while preserving the status\&.
1064 /say_to jid text 1370 .RE
1065 .RS 4 1371 .PP
1066 Send the "text" message to the specified jid. Please note that this command doesn't 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. 1372 /status_to jid online|avail|invisible|free|dnd|notavail|away [statusmessage], /status_to jid message statusmessage
1067 .RE 1373 .RS 4
1068 .PP 1374 Send the requested status to the specified Jabber user\&.
1069 /status [online|avail|invisible|free|dnd|notavail|away [\-|StatusMessage]] 1375
1070 .RS 4 1376 If the specified jid is "\&.", the current buddy is used\&.
1071 Show or set the current status. 1377
1072 If no status is specified, display the current status. 1378 Note: this status will be overridden by subsequent "/status" commands\&. If you are using the auto\-away feature, the status will overridden too\&.
1073 If a status message is specified, it will overrride the message* variables (these variables can be set in the configuration file). If no relevant message* variable is set and no status message provided, the current status message is kept. If StatusMessage is "\-", the current status message is cleared. 1379
1074 .RE 1380 Note: The jid can include a resource (i\&.e\&. user@server/resource)\&.
1075 .PP 1381 .RE
1076 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] 1382 .PP
1077 .RS 4 1383 /version
1078 Send the requested status to the specified Jabber user. 1384 .RS 4
1079 If the specified jid is ".", the current buddy is used. 1385 Display current version of mcabber\&.
1080 Note: this status will be overridden by subsequent "/status" commands. If you are using the auto\-away feature, the status will overridden too. Note: The jid can include a resource (i.e. user@server/resource).
1081 .RE 1386 .RE
1082 .SH "CONFIGURATION FILE" 1387 .SH "CONFIGURATION FILE"
1083 See the provided sample configuration file, which should be self\-documenting. 1388 .sp
1084 .sp 1389 See the provided sample configuration file, which should be self\-documenting\&.
1085 .SH "FILES" 1390 .SH "FILES"
1391 .sp
1086 The following files can be used by mcabber(1): 1392 The following files can be used by mcabber(1):
1087 .sp 1393 .sp
1088 .sp 1394 .if n \{\
1089 .RS 4 1395 .RS 4
1396 .\}
1090 .nf 1397 .nf
1091 $HOME/.mcabber/mcabberrc Default configuration file 1398 $HOME/\&.mcabber/mcabberrc Default configuration file
1092 $HOME/.mcabberrc Configuration file used if no other has been found 1399 $HOME/\&.mcabberrc Configuration file used if no other has been found
1093 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled 1400 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled
1401 /usr/share/mcabber/help/ Default directory for online help files
1402 /usr/lib/mcabber/ Default directory for modules
1094 .fi 1403 .fi
1095 .RE 1404 .if n \{\
1405 .RE
1406 .\}
1096 .SH "BUGS" 1407 .SH "BUGS"
1097 Certainly. Please tell me if you find one! :\-) 1408 .sp
1098 .sp 1409 Certainly\&. Please tell me if you find one! :\-) Please visit our website to find out about the MUC room and the bug tracker\&.
1099 .SH "AUTHOR" 1410 .SH "AUTHOR"
1100 Written by \fIMikael BERTHE\fR\&[1]. Originally based on \fICabber\fR\&[2], please consult the AUTHORS file for details. 1411 .sp
1101 .sp 1412 Written by \m[blue]\fBMikael BERTHE\fR\m[]\&\s-2\u[1]\d\s+2 and others (see AUTHORS file)\&.
1102 .SH "RESOURCES" 1413 .SH "RESOURCES"
1103 \fIMain web site\fR\&[3] 1414 .sp
1104 .sp 1415 \m[blue]\fBMain web site\fR\m[]\&\s-2\u[2]\d\s+2
1105 .SH "COPYING" 1416 .SH "COPYING"
1106 Copyright (C) 2005, 2006, 2007, 2008 Mikael Berthe. Some portions are Copyright (C) 2002\-2004 \fIcabber@ajmacias.com\fR\&[4]. 1417 .sp
1107 .sp 1418 Copyright (C) 2005\-2010 Mikael Berthe and others\&.
1108 Free use of this software is granted under the terms of the GNU General Public License (GPL). 1419 .sp
1109 .sp 1420 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.
1110 .SH "REFERENCES" 1421 .SH "NOTES"
1111 .IP " 1." 4 1422 .IP " 1." 4
1112 Mikael BERTHE 1423 Mikael BERTHE
1113 .RS 4 1424 .RS 4
1114 \%mailto:mcabber@lilotux.net 1425 \%mailto:mikael@lilotux.net
1115 .RE 1426 .RE
1116 .IP " 2." 4 1427 .IP " 2." 4
1117 Cabber
1118 .RS 4
1119 \%http://cabber.sourceforge.net
1120 .RE
1121 .IP " 3." 4
1122 Main web site 1428 Main web site
1123 .RS 4 1429 .RS 4
1124 \%http://www.lilotux.net/~mikael/mcabber/ 1430 \%http://mcabber.com/
1125 .RE 1431 .RE
1126 .IP " 4." 4
1127 cabber@ajmacias.com
1128 .RS 4
1129 \%mailto:cabber@ajmacias.com
1130 .RE