Mercurial > hg
annotate mcabber/doc/mcabber.1 @ 1405:e21757606b5b
Update UK help files
author | Myhailo Danylenko <isbear@ukrpost.net> |
---|---|
date | Fri, 11 Jan 2008 12:06:50 +0100 |
parents | 305f7a609545 |
children | 243dc5dbd987 |
rev | line source |
---|---|
1096 | 1 .\" Title: mcabber |
2 .\" Author: Mikael BERTHE | |
1341
305f7a609545
Add "/room names --detail"
Mikael Berthe <mikael@lilotux.net>
parents:
1259
diff
changeset
|
3 .\" Date: 11/03/2007 |
1242 | 4 .\" Manual: |
5 .\" Source: | |
1096 | 6 .\" |
1341
305f7a609545
Add "/room names --detail"
Mikael Berthe <mikael@lilotux.net>
parents:
1259
diff
changeset
|
7 .TH "MCABBER" "1" "11/03/2007" "" "" |
1096 | 8 .\" disable hyphenation |
9 .nh | |
10 .\" disable justification (adjust text to left margin only) | |
11 .ad l | |
12 .SH "NAME" | |
226 | 13 mcabber \- a simple Jabber console client |
14 .SH "SYNOPSIS" | |
1259
c5c09f8f60b0
Change command line option -v to -V
Mikael Berthe <mikael@lilotux.net>
parents:
1257
diff
changeset
|
15 \fImcabber\fR [ \-h | \-V | \-f configfile ] |
1242 | 16 .sp |
226 | 17 .SH "DESCRIPTION" |
1096 | 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. |
1242 | 19 .sp |
1096 | 20 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet. |
1242 | 21 .sp |
226 | 22 Here are some of the features of mcabber: |
1242 | 23 .sp |
24 .sp | |
25 .RS 4 | |
26 \h'-04'\(bu\h'+03' | |
1096 | 27 \fISSL support\fR. |
1242 | 28 .RE |
29 .sp | |
30 .RS 4 | |
31 \h'-04'\(bu\h'+03' | |
1096 | 32 \fIMUC support\fR |
33 (Multi\-User Chat). | |
1242 | 34 .RE |
35 .sp | |
36 .RS 4 | |
37 \h'-04'\(bu\h'+03' | |
1096 | 38 \fIPGP support\fR |
1242 | 39 .RE |
40 .sp | |
41 .RS 4 | |
42 \h'-04'\(bu\h'+03' | |
1096 | 43 \fIChat States\fR |
44 support (typing notifications) | |
1242 | 45 .RE |
46 .sp | |
47 .RS 4 | |
48 \h'-04'\(bu\h'+03' | |
1096 | 49 \fIHistory logging:\fR |
50 If enabled (see the CONFIGURATION FILE section), | |
51 mcabber | |
52 can save discussions to history log files. | |
1242 | 53 .RE |
54 .sp | |
55 .RS 4 | |
56 \h'-04'\(bu\h'+03' | |
1096 | 57 \fICommands completion:\fR |
58 If possible, | |
59 mcabber | |
60 will try to complete your command line if you hit the Tab key. | |
1242 | 61 .RE |
62 .sp | |
63 .RS 4 | |
64 \h'-04'\(bu\h'+03' | |
1096 | 65 \fIInput line history:\fR |
66 Any message or command entered is in the input line history and can be reused easily. | |
1242 | 67 .RE |
68 .sp | |
69 .RS 4 | |
70 \h'-04'\(bu\h'+03' | |
1096 | 71 \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 | |
73 mcabber | |
74 source code, in the contrib directory. | |
1242 | 75 .RE |
1096 | 76 .SH "OPTIONS" |
77 .PP | |
78 \-\-help, \-h | |
1242 | 79 .RS 4 |
1096 | 80 Quick help usage message |
81 .RE | |
82 .PP | |
83 \-f configfile | |
1242 | 84 .RS 4 |
1096 | 85 Use configuration file |
86 \fIconfigfile\fR | |
87 .RE | |
88 .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. | |
1242 | 90 .sp |
1096 | 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. |
1242 | 92 .sp |
1096 | 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. |
1242 | 94 .sp |
1096 | 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. |
1242 | 96 .sp |
1096 | 97 .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\&...). | |
1242 | 99 .sp |
1096 | 100 PageUp and PageDown keys are used to move in the roster. |
1242 | 101 .sp |
1096 | 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). |
1242 | 103 .sp |
1096 | 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. |
1242 | 105 .sp |
1096 | 106 Here is a quick description of the key bindings: |
1242 | 107 .sp |
1096 | 108 .TS |
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 | |
1242 | 130 .sp |
1096 | 131 T}:T{ |
132 Disable chat mode | |
1242 | 133 .sp |
1096 | 134 T} |
135 T{ | |
136 Ctrl\-d | |
1242 | 137 .sp |
1096 | 138 T}:T{ |
139 Send/terminate a multi\-line message | |
1242 | 140 .sp |
1096 | 141 T} |
142 T{ | |
143 Ctrl\-p/Ctrl\-n | |
1242 | 144 .sp |
1096 | 145 T}:T{ |
146 Scroll up/down half a screen in the buffer window (chat mode) | |
1242 | 147 .sp |
1096 | 148 T} |
149 T{ | |
150 Ctrl\-Left | |
1242 | 151 .sp |
1096 | 152 T}:T{ |
153 Move the cursor back to the start of the current or previous word | |
1242 | 154 .sp |
1096 | 155 T} |
156 T{ | |
157 Ctrl\-Right | |
1242 | 158 .sp |
1096 | 159 T}:T{ |
160 Move the cursor forward to the end of the current or next word | |
1242 | 161 .sp |
1096 | 162 T} |
163 T{ | |
164 Ctrl\-u | |
1242 | 165 .sp |
1096 | 166 T}:T{ |
167 Delete from beginning of the line to the cursor | |
1242 | 168 .sp |
1096 | 169 T} |
170 T{ | |
171 Ctrl\-k | |
1242 | 172 .sp |
1096 | 173 T}:T{ |
174 Delete from the cursor to the end of line | |
1242 | 175 .sp |
1096 | 176 T} |
177 T{ | |
178 Ctrl\-w | |
1242 | 179 .sp |
1096 | 180 T}:T{ |
181 Backward kill word | |
1242 | 182 .sp |
1096 | 183 T} |
184 T{ | |
185 Ctrl\-t | |
1242 | 186 .sp |
1096 | 187 T}:T{ |
188 Transpose chars | |
1242 | 189 .sp |
1096 | 190 T} |
191 T{ | |
192 Ctrl\-o | |
1242 | 193 .sp |
1096 | 194 T}:T{ |
195 Accept line and put the next history line in the input line (accept\-line\-and\-down\-history) | |
1242 | 196 .sp |
1096 | 197 T} |
198 T{ | |
199 Ctrl\-a | |
1242 | 200 .sp |
1096 | 201 T}:T{ |
202 Go to the beginning of the input line | |
1242 | 203 .sp |
1096 | 204 T} |
205 T{ | |
206 Ctrl\-e | |
1242 | 207 .sp |
1096 | 208 T}:T{ |
209 Go to the end of the input line | |
1242 | 210 .sp |
1096 | 211 T} |
212 T{ | |
213 Ctrl\-l | |
1242 | 214 .sp |
1096 | 215 T}:T{ |
216 Force a refresh | |
1242 | 217 .sp |
1096 | 218 T} |
219 T{ | |
220 Up/Down | |
1242 | 221 .sp |
1096 | 222 T}:T{ |
223 Move in the input line history | |
1242 | 224 .sp |
1096 | 225 T} |
226 T{ | |
227 PgUp/PgDown | |
1242 | 228 .sp |
1096 | 229 T}:T{ |
230 Move inside the roster (buddylist) | |
1242 | 231 .sp |
1096 | 232 T} |
233 T{ | |
234 Tab | |
1242 | 235 .sp |
1096 | 236 T}:T{ |
237 Complete current word, in the input line | |
1242 | 238 .sp |
1096 | 239 T} |
240 T{ | |
241 Ctrl\-g | |
1242 | 242 .sp |
1096 | 243 T}:T{ |
244 Cancel completion | |
1242 | 245 .sp |
1096 | 246 T} |
247 T{ | |
248 Ctrl\-c | |
1242 | 249 .sp |
1096 | 250 T}:T{ |
251 Abort multi\-line messages and completions | |
1242 | 252 .sp |
1096 | 253 T} |
254 .TE | |
1242 | 255 .sp |
1096 | 256 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section. |
1242 | 257 .sp |
1096 | 258 .SH "MCABBER'S ROSTER" |
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. | |
1242 | 260 .sp |
1096 | 261 Group names are displayed above the resources that are within them, and are indicated by \fI\-\-\-\fR to the left of the name. |
1242 | 262 .sp |
1096 | 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. |
1242 | 264 .sp |
854 | 265 The online status is one of the following: |
1242 | 266 .sp |
1096 | 267 .TS |
268 tab(:); | |
269 l l | |
270 l l | |
271 l l | |
272 l l | |
273 l l | |
274 l l | |
275 l l | |
276 l l | |
277 l l | |
278 l l. | |
279 T{ | |
280 \fIo\fR | |
1242 | 281 .sp |
1096 | 282 T}:T{ |
283 online | |
1242 | 284 .sp |
1096 | 285 T} |
286 T{ | |
287 \fIC\fR | |
1242 | 288 .sp |
1096 | 289 T}:T{ |
290 a conference room in which you are participating | |
1242 | 291 .sp |
1096 | 292 T} |
293 T{ | |
294 \fIf\fR | |
1242 | 295 .sp |
1096 | 296 T}:T{ |
297 free for chat | |
1242 | 298 .sp |
1096 | 299 T} |
300 T{ | |
301 \fIa\fR | |
1242 | 302 .sp |
1096 | 303 T}:T{ |
304 away | |
1242 | 305 .sp |
1096 | 306 T} |
307 T{ | |
308 \fIn\fR | |
1242 | 309 .sp |
1096 | 310 T}:T{ |
311 not available (labeled \fIextended away\fR in some clients) | |
1242 | 312 .sp |
1096 | 313 T} |
314 T{ | |
315 \fId\fR | |
1242 | 316 .sp |
1096 | 317 T}:T{ |
318 do not disturb | |
1242 | 319 .sp |
1096 | 320 T} |
321 T{ | |
322 \fIi\fR | |
1242 | 323 .sp |
1096 | 324 T}:T{ |
325 invisible (displayed only for your resource) | |
1242 | 326 .sp |
1096 | 327 T} |
328 T{ | |
329 \fI_\fR | |
1242 | 330 .sp |
1096 | 331 T}:T{ |
332 offline (or invisible to you) | |
1242 | 333 .sp |
1096 | 334 T} |
335 T{ | |
336 \fI?\fR | |
1242 | 337 .sp |
1096 | 338 T}:T{ |
339 unknown, usually meaning you are not authorized to see this resource's status | |
1242 | 340 .sp |
1096 | 341 T} |
342 T{ | |
343 \fIx\fR | |
1242 | 344 .sp |
1096 | 345 T}:T{ |
346 a conference room in which you are not participating | |
1242 | 347 .sp |
1096 | 348 T} |
349 .TE | |
1242 | 350 .sp |
1096 | 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. |
1242 | 352 .sp |
1096 | 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. |
1242 | 354 .sp |
854 | 355 Examples: |
1242 | 356 .sp |
1096 | 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 | |
1242 | 366 .sp |
1096 | 367 T}:T{ |
368 This is a group named \fIBuds\fR | |
1242 | 369 .sp |
1096 | 370 T} |
371 T{ | |
372 \fI#[o] John\fR | |
1242 | 373 .sp |
1096 | 374 T}:T{ |
375 John is online, can see your status, and sent you a message that you did not read yet | |
1242 | 376 .sp |
1096 | 377 T} |
378 T{ | |
379 \fI {?} Sally\fR | |
1242 | 380 .sp |
1096 | 381 T}:T{ |
382 Neither you nor Sally have authorized each other to see your online status | |
1242 | 383 .sp |
1096 | 384 T} |
385 T{ | |
386 \fI {a} Jane\fR | |
1242 | 387 .sp |
1096 | 388 T}:T{ |
389 Jane is away, but she cannot see your online status | |
1242 | 390 .sp |
1096 | 391 T} |
392 T{ | |
393 \fI#[C] x@y.c\fR | |
1242 | 394 .sp |
1096 | 395 T}:T{ |
396 You are participating in x@y.c conference room, and there are unread messages | |
1242 | 397 .sp |
1096 | 398 T} |
399 .TE | |
1242 | 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 | |
854 | 404 .SH "COMMANDS RELATED TO MCABBER" |
1096 | 405 .PP |
406 /alias [name [= command line]] | |
1242 | 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". | |
1096 | 413 .RE |
414 .PP | |
415 /bind [keycode [= command line]] | |
1242 | 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). | |
1096 | 424 .RE |
425 .PP | |
1139 | 426 /buffer clear|close|close_all|purge, /buffer top|bottom|date|%|search_backward|search_forward, /buffer scroll_lock|scroll_unlock|scroll_toggle |
1242 | 427 .RS 4 |
1096 | 428 The |
429 \fIbuffer\fR | |
430 command manipulates the current buddy's buffer (chat window). | |
431 .TS | |
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{ | |
1139 | 452 \fIclose\fR |
1096 | 453 T}:T{ |
1139 | 454 empty all contents of the buffer and close the current buddy chat window |
1096 | 455 T} |
456 T{ | |
1139 | 457 \fIclose_all\fR |
1096 | 458 T}:T{ |
1139 | 459 empty all contents of the chat buffers and close the chat windows |
1096 | 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{ | |
1139 | 467 \fItop\fR |
468 T}:T{ | |
469 jump to the top of the current buddy chat buffer | |
470 T} | |
471 T{ | |
1096 | 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} | |
1139 | 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} | |
1096 | 527 .TE |
1242 | 528 .sp |
1096 | 529 .RE |
530 .PP | |
531 /clear | |
1242 | 532 .RS 4 |
1096 | 533 The |
534 \fIclear\fR | |
535 command is actually an alias for "/buffer clear". | |
536 .RE | |
537 .PP | |
538 /help [command] | |
1242 | 539 .RS 4 |
1096 | 540 Display generic help or help about a specific mcabber command. |
541 .RE | |
542 .PP | |
543 /quit | |
1242 | 544 .RS 4 |
1096 | 545 Disconnect and leave |
546 mcabber(1). | |
547 .RE | |
548 .PP | |
1242 | 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 | |
1096 | 559 /version |
1242 | 560 .RS 4 |
854 | 561 Display mcabber version |
1096 | 562 .RE |
854 | 563 .SH "COMMANDS RELATED TO THE SERVER AND CONNECTION" |
1096 | 564 .PP |
565 /connect | |
1242 | 566 .RS 4 |
1096 | 567 Establish connection to the Jabber server. |
568 .RE | |
569 .PP | |
570 /disconnect | |
1242 | 571 .RS 4 |
1096 | 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 | |
1242 | 576 .RS 4 |
1096 | 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 | |
1242 | 605 .sp |
1096 | 606 .RE |
607 .PP | |
608 /rawxml send string | |
1242 | 609 .RS 4 |
829 | 610 |
1096 | 611 \fIsend\fR |
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. | |
613 .RE | |
854 | 614 .SH "COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES" |
1096 | 615 .PP |
616 /add [jid [nickname]] | |
1242 | 617 .RS 4 |
1096 | 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] | |
1242 | 622 .RS 4 |
1096 | 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 | |
1242 | 651 .sp |
1096 | 652 .RE |
653 .PP | |
654 /del | |
1242 | 655 .RS 4 |
1096 | 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 | |
1242 | 660 .RS 4 |
1096 | 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 | |
1242 | 685 .sp |
1096 | 686 .RE |
687 .PP | |
688 /info | |
1242 | 689 .RS 4 |
1096 | 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] | |
1242 | 694 .RS 4 |
1096 | 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 | |
1242 | 699 .RS 4 |
1096 | 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 | |
1242 | 758 .sp |
1096 | 759 .RE |
760 .PP | |
1242 | 761 /pgp disable|enable|force|info [jid], /pgp setkey [jid [key]] |
762 .RS 4 | |
1096 | 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 | |
1242 | 769 l l |
1096 | 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{ | |
1242 | 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{ | |
1096 | 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 | |
1242 | 802 .sp |
1096 | 803 .RE |
804 .PP | |
805 /rename name | |
1242 | 806 .RS 4 |
1096 | 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. |
808 .RE | |
809 .PP | |
810 /request last|time|vcard|version [jid] | |
1242 | 811 .RS 4 |
1096 | 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. |
813 .RE | |
814 .PP | |
815 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy, /room invite|kick|ban|role|affil, /room bookmark [add|del] [\-autojoin|+autojoin] | |
1242 | 816 .RS 4 |
1096 | 817 The |
818 \fIroom\fR | |
819 command handles Multi\-User Chat room actions. | |
820 .TS | |
821 tab(:); | |
822 l l | |
823 l l | |
824 l l | |
825 l l | |
826 l l | |
827 l l | |
828 l l | |
829 l l | |
830 l l | |
831 l l | |
832 l l | |
833 l l | |
834 l l | |
835 l l | |
836 l l. | |
837 T{ | |
838 \fIjoin\fR | |
839 [room [nick [pass]]] | |
840 T}:T{ | |
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. | |
842 T} | |
843 T{ | |
844 \fIwhois\fR | |
845 nick | |
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 | |
1341
305f7a609545
Add "/room names --detail"
Mikael Berthe <mikael@lilotux.net>
parents:
1259
diff
changeset
|
889 [\-\-detail|\-\-short|\-\-quiet] |
1096 | 890 T}:T{ |
1242 | 891 display the members of the current room |
1096 | 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 | |
907 T}:T{ | |
908 remove the current room from the roster (you must have left this room before) | |
909 T} | |
910 T{ | |
911 \fItopic\fR | |
912 T}:T{ | |
913 set topic for current room | |
914 T} | |
915 T{ | |
916 \fIunlock\fR | |
917 T}:T{ | |
918 unlock current room (if you are the owner) | |
919 T} | |
920 T{ | |
921 \fIdestroy\fR | |
922 [reason] | |
923 T}:T{ | |
924 destroy the current room (use with care!) | |
925 T} | |
926 .TE | |
1242 | 927 .sp |
1096 | 928 .RE |
929 .PP | |
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] | |
1242 | 931 .RS 4 |
1096 | 932 The |
933 \fIroster\fR | |
934 command manipulates the roster/buddylist. Here are the available parameters: | |
935 .TS | |
936 tab(:); | |
937 l l | |
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 | |
958 T}:T{ | |
959 jump to the bottom of the roster | |
960 T} | |
961 T{ | |
962 \fIsearch\fR | |
963 bud | |
964 T}:T{ | |
965 search for a buddy with a name or jid containing "bud" (only in the displayed buddylist) | |
966 T} | |
967 T{ | |
968 \fIhide_offline\fR | |
969 T}:T{ | |
970 hide offline buddies | |
971 T} | |
972 T{ | |
973 \fIshow_offline\fR | |
974 T}:T{ | |
975 show offline buddies | |
976 T} | |
977 T{ | |
978 \fItoggle_offline\fR | |
979 T}:T{ | |
980 toggle display of offline buddies | |
981 T} | |
982 T{ | |
983 \fIitem_lock\fR | |
984 jid | |
985 T}:T{ | |
986 lock the roster item so it remains visible regardless of its status | |
987 T} | |
988 T{ | |
989 \fIitem_unlock\fR | |
990 jid | |
991 T}:T{ | |
992 undo the effects of item_lock | |
993 T} | |
994 T{ | |
995 \fIhide\fR | |
996 T}:T{ | |
997 hide roster (full\-width chat window) | |
998 T} | |
999 T{ | |
1000 \fIshow\fR | |
1001 T}:T{ | |
1002 show roster | |
1003 T} | |
1004 T{ | |
1005 \fItoggle\fR | |
1006 T}:T{ | |
1007 toggle roster visibility | |
1008 T} | |
1009 T{ | |
1010 \fInote\fR | |
1011 [text] | |
1012 T}:T{ | |
1013 display or set an annotation (if text is "\-", the annotation is deleted). In the "status" buffer, it will display all annotations. | |
1014 T} | |
1015 T{ | |
1016 \fItop\fR | |
1017 T}:T{ | |
1018 jump to the top of the roster | |
1019 T} | |
1020 T{ | |
1021 \fIup\fR | |
1022 T}:T{ | |
1023 move up in the roster | |
1024 T} | |
1025 T{ | |
1026 \fIdown\fR | |
1027 T}:T{ | |
1028 move down in the roster | |
1029 T} | |
1030 T{ | |
1031 \fIgroup_prev\fR | |
1032 T}:T{ | |
1033 jump to the previous group in the roster | |
1034 T} | |
1035 T{ | |
1036 \fIgroup_next\fR | |
1037 T}:T{ | |
1038 jump to the next group in the roster | |
1039 T} | |
1040 T{ | |
1041 \fIalternate\fR | |
1042 T}:T{ | |
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") | |
1044 T} | |
1045 T{ | |
1046 \fIunread_first\fR | |
1047 T}:T{ | |
1048 jump to the first unread message | |
1049 T} | |
1050 T{ | |
1051 \fIunread_next\fR | |
1052 T}:T{ | |
1053 jump to the next unread message | |
1054 T} | |
1055 .TE | |
1242 | 1056 .sp |
1096 | 1057 .RE |
1058 .PP | |
1059 /say text | |
1242 | 1060 .RS 4 |
1096 | 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. |
1062 .RE | |
1063 .PP | |
1064 /say_to jid text | |
1242 | 1065 .RS 4 |
1096 | 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. |
1067 .RE | |
1068 .PP | |
1069 /status [online|avail|invisible|free|dnd|notavail|away [\-|StatusMessage]] | |
1242 | 1070 .RS 4 |
1071 Show or set the current status. | |
1072 If no status is specified, display the current status. | |
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. | |
1096 | 1074 .RE |
1075 .PP | |
1076 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] | |
1242 | 1077 .RS 4 |
1078 Send the requested status to the specified Jabber user. | |
1079 If the specified jid is ".", the current buddy is used. | |
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). | |
1096 | 1081 .RE |
226 | 1082 .SH "CONFIGURATION FILE" |
1096 | 1083 See the provided sample configuration file, which should be self\-documenting. |
1242 | 1084 .sp |
226 | 1085 .SH "FILES" |
1086 The following files can be used by mcabber(1): | |
1242 | 1087 .sp |
1088 .sp | |
1089 .RS 4 | |
226 | 1090 .nf |
1096 | 1091 $HOME/.mcabber/mcabberrc Default configuration file |
1092 $HOME/.mcabberrc Configuration file used if no other has been found | |
1093 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled | |
226 | 1094 .fi |
1096 | 1095 .RE |
226 | 1096 .SH "BUGS" |
1096 | 1097 Certainly. Please tell me if you find one! :\-) |
1242 | 1098 .sp |
226 | 1099 .SH "AUTHOR" |
1242 | 1100 Written by \fIMikael BERTHE\fR\&[1]. Originally based on \fICabber\fR\&[2], please consult the AUTHORS file for details. |
1101 .sp | |
226 | 1102 .SH "RESOURCES" |
1242 | 1103 \fIMain web site\fR\&[3] |
1104 .sp | |
226 | 1105 .SH "COPYING" |
1242 | 1106 Copyright (C) 2005, 2006, 2007 Mikael Berthe. Some portions are Copyright (C) 2002\-2004 \fIcabber@ajmacias.com\fR\&[4]. |
1107 .sp | |
1096 | 1108 Free use of this software is granted under the terms of the GNU General Public License (GPL). |
1242 | 1109 .sp |
1096 | 1110 .SH "REFERENCES" |
1242 | 1111 .IP " 1." 4 |
1112 Mikael BERTHE | |
1113 .RS 4 | |
1096 | 1114 \%mailto:mcabber@lilotux.net |
1242 | 1115 .RE |
1116 .IP " 2." 4 | |
1117 Cabber | |
1118 .RS 4 | |
1096 | 1119 \%http://cabber.sourceforge.net |
1242 | 1120 .RE |
1121 .IP " 3." 4 | |
1122 Main web site | |
1123 .RS 4 | |
1096 | 1124 \%http://www.lilotux.net/~mikael/mcabber/ |
1242 | 1125 .RE |
1126 .IP " 4." 4 | |
1127 cabber@ajmacias.com | |
1128 .RS 4 | |
1096 | 1129 \%mailto:cabber@ajmacias.com |
1242 | 1130 .RE |