Mercurial > ~mikael > mcabber > hg
annotate mcabber/doc/mcabber.1 @ 1131:73e6ca0a03a9
Un-hardcode Ctrl-q binding, it can be done in the config. file
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Sun, 21 Jan 2007 15:31:34 +0100 |
parents | 3d92e648a8db |
children | 104676e3389b |
rev | line source |
---|---|
1096 | 1 .\" Title: mcabber |
2 .\" Author: Mikael BERTHE | |
3 .\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/> | |
4 .\" Date: 12/09/2006 | |
5 .\" Manual: | |
6 .\" Source: | |
7 .\" | |
8 .TH "MCABBER" "1" "12/09/2006" "" "" | |
9 .\" disable hyphenation | |
10 .nh | |
11 .\" disable justification (adjust text to left margin only) | |
12 .ad l | |
13 .SH "NAME" | |
226 | 14 mcabber \- a simple Jabber console client |
15 .SH "SYNOPSIS" | |
1096 | 16 \fImcabber\fR [ \-f configfile ] [ \-\-help | \-h ] |
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. |
19 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet. | |
226 | 20 Here are some of the features of mcabber: |
1096 | 21 .TP 3n |
226 | 22 \(bu |
1096 | 23 |
24 \fISSL support\fR. | |
25 .TP 3n | |
226 | 26 \(bu |
1096 | 27 |
28 \fIMUC support\fR | |
29 (Multi\-User Chat). | |
30 .TP 3n | |
226 | 31 \(bu |
1096 | 32 |
33 \fIPGP support\fR | |
34 .TP 3n | |
618 | 35 \(bu |
226 | 36 |
1096 | 37 \fIChat States\fR |
38 support (typing notifications) | |
39 .TP 3n | |
40 \(bu | |
854 | 41 |
1096 | 42 \fIHistory logging:\fR |
43 If enabled (see the CONFIGURATION FILE section), | |
44 mcabber | |
45 can save discussions to history log files. | |
46 .TP 3n | |
47 \(bu | |
854 | 48 |
1096 | 49 \fICommands completion:\fR |
50 If possible, | |
51 mcabber | |
52 will try to complete your command line if you hit the Tab key. | |
53 .TP 3n | |
54 \(bu | |
226 | 55 |
1096 | 56 \fIInput line history:\fR |
57 Any message or command entered is in the input line history and can be reused easily. | |
58 .TP 3n | |
59 \(bu | |
226 | 60 |
1096 | 61 \fIExternal actions:\fR |
62 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 | |
63 mcabber | |
64 source code, in the contrib directory. | |
65 .SH "OPTIONS" | |
66 .PP | |
67 \-\-help, \-h | |
68 .RS 3n | |
69 Quick help usage message | |
70 .RE | |
71 .PP | |
72 \-f configfile | |
73 .RS 3n | |
74 Use configuration file | |
75 \fIconfigfile\fR | |
76 .RE | |
77 .SH "WINDOWS/PANES" | |
78 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. | |
79 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. | |
80 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. | |
81 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. | |
82 .SH "KEYS" | |
83 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...). | |
84 PageUp and PageDown keys are used to move in the roster. | |
85 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). | |
86 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. | |
87 Here is a quick description of the key bindings: | |
88 .TS | |
89 tab(:); | |
90 l l | |
91 l l | |
92 l l | |
93 l l | |
94 l l | |
95 l l | |
96 l l | |
97 l l | |
98 l l | |
99 l l | |
100 l l | |
101 l l | |
102 l l | |
103 l l | |
104 l l | |
105 l l | |
106 l l | |
107 l l | |
108 l l. | |
109 T{ | |
110 Esc | |
111 T}:T{ | |
112 Disable chat mode | |
113 T} | |
114 T{ | |
115 Ctrl\-d | |
116 T}:T{ | |
117 Send/terminate a multi\-line message | |
118 T} | |
119 T{ | |
120 Ctrl\-p/Ctrl\-n | |
121 T}:T{ | |
122 Scroll up/down half a screen in the buffer window (chat mode) | |
123 T} | |
124 T{ | |
125 Ctrl\-Left | |
126 T}:T{ | |
127 Move the cursor back to the start of the current or previous word | |
128 T} | |
129 T{ | |
130 Ctrl\-Right | |
131 T}:T{ | |
132 Move the cursor forward to the end of the current or next word | |
133 T} | |
134 T{ | |
135 Ctrl\-u | |
136 T}:T{ | |
137 Delete from beginning of the line to the cursor | |
138 T} | |
139 T{ | |
140 Ctrl\-k | |
141 T}:T{ | |
142 Delete from the cursor to the end of line | |
143 T} | |
144 T{ | |
145 Ctrl\-w | |
146 T}:T{ | |
147 Backward kill word | |
148 T} | |
149 T{ | |
150 Ctrl\-t | |
151 T}:T{ | |
152 Transpose chars | |
153 T} | |
154 T{ | |
155 Ctrl\-o | |
156 T}:T{ | |
157 Accept line and put the next history line in the input line (accept\-line\-and\-down\-history) | |
158 T} | |
159 T{ | |
160 Ctrl\-a | |
161 T}:T{ | |
162 Go to the beginning of the input line | |
163 T} | |
164 T{ | |
165 Ctrl\-e | |
166 T}:T{ | |
167 Go to the end of the input line | |
168 T} | |
169 T{ | |
170 Ctrl\-l | |
171 T}:T{ | |
172 Force a refresh | |
173 T} | |
174 T{ | |
175 Up/Down | |
176 T}:T{ | |
177 Move in the input line history | |
178 T} | |
179 T{ | |
180 PgUp/PgDown | |
181 T}:T{ | |
182 Move inside the roster (buddylist) | |
183 T} | |
184 T{ | |
185 Tab | |
186 T}:T{ | |
187 Complete current word, in the input line | |
188 T} | |
189 T{ | |
190 Ctrl\-g | |
191 T}:T{ | |
192 Cancel completion | |
193 T} | |
194 T{ | |
195 Ctrl\-c | |
196 T}:T{ | |
197 Abort multi\-line messages and completions | |
198 T} | |
199 .TE | |
854 | 200 |
1096 | 201 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section. |
202 .SH "MCABBER'S ROSTER" | |
203 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. | |
204 Group names are displayed above the resources that are within them, and are indicated by \fI\-\-\-\fR to the left of the name. | |
205 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. | |
854 | 206 The online status is one of the following: |
1096 | 207 .TS |
208 tab(:); | |
209 l l | |
210 l l | |
211 l l | |
212 l l | |
213 l l | |
214 l l | |
215 l l | |
216 l l | |
217 l l | |
218 l l. | |
219 T{ | |
220 \fIo\fR | |
221 T}:T{ | |
222 online | |
223 T} | |
224 T{ | |
225 \fIC\fR | |
226 T}:T{ | |
227 a conference room in which you are participating | |
228 T} | |
229 T{ | |
230 \fIf\fR | |
231 T}:T{ | |
232 free for chat | |
233 T} | |
234 T{ | |
235 \fIa\fR | |
236 T}:T{ | |
237 away | |
238 T} | |
239 T{ | |
240 \fIn\fR | |
241 T}:T{ | |
242 not available (labeled \fIextended away\fR in some clients) | |
243 T} | |
244 T{ | |
245 \fId\fR | |
246 T}:T{ | |
247 do not disturb | |
248 T} | |
249 T{ | |
250 \fIi\fR | |
251 T}:T{ | |
252 invisible (displayed only for your resource) | |
253 T} | |
254 T{ | |
255 \fI_\fR | |
256 T}:T{ | |
257 offline (or invisible to you) | |
258 T} | |
259 T{ | |
260 \fI?\fR | |
261 T}:T{ | |
262 unknown, usually meaning you are not authorized to see this resource's status | |
263 T} | |
264 T{ | |
265 \fIx\fR | |
266 T}:T{ | |
267 a conference room in which you are not participating | |
268 T} | |
269 .TE | |
226 | 270 |
1096 | 271 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. |
272 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. | |
854 | 273 Examples: |
1096 | 274 .TS |
275 tab(:); | |
276 l l | |
277 l l | |
278 l l | |
279 l l | |
280 l l. | |
281 T{ | |
282 \fI \-\-\- Buds\fR | |
283 T}:T{ | |
284 This is a group named \fIBuds\fR | |
285 T} | |
286 T{ | |
287 \fI#[o] John\fR | |
288 T}:T{ | |
289 John is online, can see your status, and sent you a message that you did not read yet | |
290 T} | |
291 T{ | |
292 \fI {?} Sally\fR | |
293 T}:T{ | |
294 Neither you nor Sally have authorized each other to see your online status | |
295 T} | |
296 T{ | |
297 \fI {a} Jane\fR | |
298 T}:T{ | |
299 Jane is away, but she cannot see your online status | |
300 T} | |
301 T{ | |
302 \fI#[C] x@y.c\fR | |
303 T}:T{ | |
304 You are participating in x@y.c conference room, and there are unread messages | |
305 T} | |
306 .TE | |
854 | 307 |
308 .SH "COMMANDS RELATED TO MCABBER" | |
1096 | 309 .PP |
310 /alias [name [= command line]] | |
311 .RS 3n | |
312 Add "name" as an alias for "command line". Aliases are expanded only once, thus they can not be chained. "/alias name" displays the value associated with the "name" alias; "/alias name =" unsets the "name" alias. "/alias" displays a list of the existing aliases. Example: "/alias away = status away". | |
313 .RE | |
314 .PP | |
315 /bind [keycode [= command line]] | |
316 .RS 3n | |
317 Bind a command line to the key with the "keycode" code number. Keycodes of unused keys are displayed by | |
318 mcabber | |
319 in the log window when pressing the key, for example "Unknown key=265". "/bind keycode" displays the command line bound to the given keycode; "/bind keycode =" unbinds the given keycode. "/bind" displays a list of the bound keycodes. Note: aliases can be used in key bindings. Example: "/bind 265 = status online" (265 is F1 for me, but it may depend on your ncurses installation). | |
320 .RE | |
321 .PP | |
322 /buffer clear|purge|top|bottom|date|%|search_backward|search_forward, /buffer scroll_lock|scroll_unlock|scroll_toggle | |
323 .RS 3n | |
324 The | |
325 \fIbuffer\fR | |
326 command manipulates the current buddy's buffer (chat window). | |
327 .TS | |
328 tab(:); | |
329 l l | |
330 l l | |
331 l l | |
332 l l | |
333 l l | |
334 l l | |
335 l l | |
336 l l | |
337 l l | |
338 l l | |
339 l l | |
340 l l | |
341 l l. | |
342 T{ | |
343 \fIclear\fR | |
344 T}:T{ | |
345 clear the current buddy chat window | |
346 T} | |
347 T{ | |
348 \fIsearch_forward\fR | |
349 text | |
350 T}:T{ | |
351 search for "text" in the current buddy chat buffer | |
352 T} | |
353 T{ | |
354 \fIscroll_lock\fR | |
355 T}:T{ | |
356 lock buffer scrolling | |
357 T} | |
358 T{ | |
359 \fIscroll_unlock\fR | |
360 T}:T{ | |
361 unlock buffer scrolling | |
362 T} | |
363 T{ | |
364 \fIscroll_toggle\fR | |
365 T}:T{ | |
366 toggle buffer scrolling (lock/unlock) | |
367 T} | |
368 T{ | |
369 \fIpurge\fR | |
370 T}:T{ | |
371 clear the current buddy chat window and empty all contents of the chat buffer | |
372 T} | |
373 T{ | |
374 \fIbottom\fR | |
375 T}:T{ | |
376 jump to the bottom of the current buddy chat buffer | |
377 T} | |
378 T{ | |
379 \fItop\fR | |
380 T}:T{ | |
381 jump to the top of the current buddy chat buffer | |
382 T} | |
383 T{ | |
384 \fIup\fR | |
385 [n] | |
386 T}:T{ | |
387 scroll the buffer up n lines (default: half a screen) | |
388 T} | |
389 T{ | |
390 \fIdown\fR | |
391 [n] | |
392 T}:T{ | |
393 scroll the buffer down n lines (default: half a screen) | |
394 T} | |
395 T{ | |
396 \fIdate\fR | |
397 date | |
398 T}:T{ | |
399 jump to the first line after the specified date in the chat buffer (date format: "YYYY\-mm\-dd[THH:MM:SS]", "\-" and ":" are optional) | |
400 T} | |
401 T{ | |
402 \fI%\fR | |
403 n | |
404 T}:T{ | |
405 jump to position %n of the buddy chat buffer | |
406 T} | |
407 T{ | |
408 \fIsearch_backward\fR | |
409 text | |
410 T}:T{ | |
411 search for "text" in the current buddy chat buffer | |
412 T} | |
413 .TE | |
854 | 414 |
1096 | 415 .RE |
416 .PP | |
417 /clear | |
418 .RS 3n | |
419 The | |
420 \fIclear\fR | |
421 command is actually an alias for "/buffer clear". | |
422 .RE | |
423 .PP | |
424 /help [command] | |
425 .RS 3n | |
426 Display generic help or help about a specific mcabber command. | |
427 .RE | |
428 .PP | |
429 /quit | |
430 .RS 3n | |
431 Disconnect and leave | |
432 mcabber(1). | |
433 .RE | |
434 .PP | |
435 /version | |
436 .RS 3n | |
854 | 437 Display mcabber version |
1096 | 438 .RE |
854 | 439 .SH "COMMANDS RELATED TO THE SERVER AND CONNECTION" |
1096 | 440 .PP |
441 /connect | |
442 .RS 3n | |
443 Establish connection to the Jabber server. | |
444 .RE | |
445 .PP | |
446 /disconnect | |
447 .RS 3n | |
448 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. | |
449 .RE | |
450 .PP | |
451 /event #n|* accept|ignore|reject, /event list | |
452 .RS 3n | |
453 Tell mcabber what to do about a pending event. If the first parameter is "*", the command will apply to all queued events. | |
454 .TS | |
455 tab(:); | |
456 l l | |
457 l l | |
458 l l | |
459 l l. | |
460 T{ | |
461 \fIaccept\fR | |
462 T}:T{ | |
463 accept the event #n | |
464 T} | |
465 T{ | |
466 \fIignore\fR | |
467 T}:T{ | |
468 remove the event #n from the list | |
469 T} | |
470 T{ | |
471 \fIreject\fR | |
472 T}:T{ | |
473 reject the event #n | |
474 T} | |
475 T{ | |
476 \fIlist\fR | |
477 T}:T{ | |
478 list all pending events | |
479 T} | |
480 .TE | |
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
481 |
1096 | 482 .RE |
483 .PP | |
484 /rawxml send string | |
485 .RS 3n | |
829 | 486 |
1096 | 487 \fIsend\fR |
488 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. | |
489 .RE | |
854 | 490 .SH "COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES" |
1096 | 491 .PP |
492 /add [jid [nickname]] | |
493 .RS 3n | |
494 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. | |
495 .RE | |
496 .PP | |
497 /authorization allow|cancel|request|request_unsubscribe [jid] | |
498 .RS 3n | |
499 Manage the presence subscriptions. If no jid is provided, the current buddy is used. | |
500 .TS | |
501 tab(:); | |
502 l l | |
503 l l | |
504 l l | |
505 l l. | |
506 T{ | |
507 \fIallow\fR | |
508 T}:T{ | |
509 allow the buddy to receive your presence updates | |
510 T} | |
511 T{ | |
512 \fIcancel\fR | |
513 T}:T{ | |
514 cancel the buddy' subscription to your presence updates | |
515 T} | |
516 T{ | |
517 \fIrequest\fR | |
518 T}:T{ | |
519 request a subscription to the buddy's presence updates | |
520 T} | |
521 T{ | |
522 \fIrequest_unsubscribe\fR | |
523 T}:T{ | |
524 request unsubscription from the buddy's presence updates | |
525 T} | |
526 .TE | |
854 | 527 |
1096 | 528 .RE |
529 .PP | |
530 /del | |
531 .RS 3n | |
532 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours. | |
533 .RE | |
534 .PP | |
535 /group fold|unfold|toggle | |
536 .RS 3n | |
537 The | |
538 \fIgroup\fR | |
539 command changes the current group display. | |
540 .TS | |
541 tab(:); | |
542 l l | |
543 l l | |
544 l l. | |
545 T{ | |
546 \fIfold\fR | |
547 T}:T{ | |
548 fold (shrink) the current group tree in the roster | |
549 T} | |
550 T{ | |
551 \fIunfold\fR | |
552 T}:T{ | |
553 unfold (expand) the current group tree in the roster | |
554 T} | |
555 T{ | |
556 \fItoggle\fR | |
557 T}:T{ | |
558 toggle the state (fold/unfold) of the current tree | |
559 T} | |
560 .TE | |
226 | 561 |
1096 | 562 .RE |
563 .PP | |
564 /info | |
565 .RS 3n | |
566 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. | |
567 .RE | |
568 .PP | |
569 /move [groupname] | |
570 .RS 3n | |
571 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. | |
572 .RE | |
573 .PP | |
574 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort | |
575 .RS 3n | |
576 Send a multi\-line message. To write a single message with several lines, the | |
577 \fImulti\-line mode\fR | |
578 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 | |
579 \fIbegin\fR | |
580 subcommand enables multi\-line mode. Note that it allows a message subject to be specified. The | |
581 \fIverbatim\fR | |
582 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 | |
583 \fItoggle\fR | |
584 and | |
585 \fItoggle_verbatim\fR | |
586 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). | |
587 .TS | |
588 tab(:); | |
589 l l | |
590 l l | |
591 l l | |
592 l l | |
593 l l | |
594 l l | |
595 l l. | |
596 T{ | |
597 \fIbegin\fR | |
598 [subject] | |
599 T}:T{ | |
600 enter multi\-line mode | |
601 T} | |
602 T{ | |
603 \fIverbatim\fR | |
604 T}:T{ | |
605 enter verbatim multi\-line mode | |
606 T} | |
607 T{ | |
608 \fIsend\fR | |
609 T}:T{ | |
610 send the current multi\-line message to the currently selected buddy | |
611 T} | |
612 T{ | |
613 \fIsend_to\fR | |
614 jid | |
615 T}:T{ | |
616 send the current multi\-line message to "jid" | |
617 T} | |
618 T{ | |
619 \fItoggle\fR | |
620 T}:T{ | |
621 switch to/from multi\-line mode (begin/send) | |
622 T} | |
623 T{ | |
624 \fItoggle_verbatim\fR | |
625 T}:T{ | |
626 same with verbatim multi\-line mode | |
627 T} | |
628 T{ | |
629 \fIabort\fR | |
630 T}:T{ | |
631 leave multi\-line mode without sending the message | |
632 T} | |
633 .TE | |
799 | 634 |
1096 | 635 .RE |
636 .PP | |
637 /pgp disable|enable|info [jid], /pgp setkey [jid [key]] | |
638 .RS 3n | |
639 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. | |
640 .TS | |
641 tab(:); | |
642 l l | |
643 l l | |
644 l l | |
645 l l. | |
646 T{ | |
647 \fIdisable\fR | |
648 [jid] | |
649 T}:T{ | |
650 disable PGP encryption for jid (or the currently selected contact) | |
651 T} | |
652 T{ | |
653 \fIenable\fR | |
654 [jid] | |
655 T}:T{ | |
656 enable PGP encryption for jid (or the currently selected contact) | |
657 T} | |
658 T{ | |
659 \fIinfo\fR | |
660 [jid] | |
661 T}:T{ | |
662 show current PGP settings for the contact | |
663 T} | |
664 T{ | |
665 \fIsetkey\fR | |
666 [jid [key]] | |
667 T}:T{ | |
668 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. | |
669 T} | |
670 .TE | |
226 | 671 |
1096 | 672 .RE |
673 .PP | |
674 /rename name | |
675 .RS 3n | |
676 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. | |
677 .RE | |
678 .PP | |
679 /request last|time|vcard|version [jid] | |
680 .RS 3n | |
681 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. | |
682 .RE | |
683 .PP | |
684 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy, /room invite|kick|ban|role|affil, /room bookmark [add|del] [\-autojoin|+autojoin] | |
685 .RS 3n | |
686 The | |
687 \fIroom\fR | |
688 command handles Multi\-User Chat room actions. | |
689 .TS | |
690 tab(:); | |
691 l l | |
692 l l | |
693 l l | |
694 l l | |
695 l l | |
696 l l | |
697 l l | |
698 l l | |
699 l l | |
700 l l | |
701 l l | |
702 l l | |
703 l l | |
704 l l | |
705 l l. | |
706 T{ | |
707 \fIjoin\fR | |
708 [room [nick [pass]]] | |
709 T}:T{ | |
710 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. | |
711 T} | |
712 T{ | |
713 \fIwhois\fR | |
714 nick | |
715 T}:T{ | |
716 display MUC information about "nick" | |
717 T} | |
718 T{ | |
719 \fIban\fR | |
720 jid [reason] | |
721 T}:T{ | |
722 ban jid from the current room | |
723 T} | |
724 T{ | |
725 \fIinvite\fR | |
726 jid [reason] | |
727 T}:T{ | |
728 invite jid to the current room | |
729 T} | |
730 T{ | |
731 \fIkick\fR | |
732 nick [reason] | |
733 T}:T{ | |
734 kick "nick" from the current room | |
735 T} | |
736 T{ | |
737 \fIrole\fR | |
738 jid role [reason] | |
739 T}:T{ | |
740 change jid's role (role can be "none", "visitor", "participant", "moderator") | |
741 T} | |
742 T{ | |
743 \fIaffil\fR | |
744 jid affil [reason] | |
745 T}:T{ | |
746 change jid's affiliation (affil can be "none", "member", "admin", "owner") | |
747 \fIbookmark\fR | |
748 add/update/remove a room bookmark, set/unset autojoin | |
749 T} | |
750 T{ | |
751 \fIleave\fR | |
752 [message] | |
753 T}:T{ | |
754 leave the current room | |
755 T} | |
756 T{ | |
757 \fInames\fR | |
758 T}:T{ | |
759 display members of the current room | |
760 T} | |
761 T{ | |
762 \fInick\fR | |
763 nick | |
764 T}:T{ | |
765 change your nickname in the current room | |
766 T} | |
767 T{ | |
768 \fIprivmsg\fR | |
769 nick msg | |
770 T}:T{ | |
771 send private message "msg" to "nick" | |
772 T} | |
773 T{ | |
774 \fIremove\fR | |
775 T}:T{ | |
776 remove the current room from the roster (you must have left this room before) | |
777 T} | |
778 T{ | |
779 \fItopic\fR | |
780 T}:T{ | |
781 set topic for current room | |
782 T} | |
783 T{ | |
784 \fIunlock\fR | |
785 T}:T{ | |
786 unlock current room (if you are the owner) | |
787 T} | |
788 T{ | |
789 \fIdestroy\fR | |
790 [reason] | |
791 T}:T{ | |
792 destroy the current room (use with care!) | |
793 T} | |
794 .TE | |
226 | 795 |
1096 | 796 .RE |
797 .PP | |
798 /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] | |
799 .RS 3n | |
800 The | |
801 \fIroster\fR | |
802 command manipulates the roster/buddylist. Here are the available parameters: | |
803 .TS | |
804 tab(:); | |
805 l l | |
806 l l | |
807 l l | |
808 l l | |
809 l l | |
810 l l | |
811 l l | |
812 l l | |
813 l l | |
814 l l | |
815 l l | |
816 l l | |
817 l l | |
818 l l | |
819 l l | |
820 l l | |
821 l l | |
822 l l | |
823 l l. | |
824 T{ | |
825 \fIbottom\fR | |
826 T}:T{ | |
827 jump to the bottom of the roster | |
828 T} | |
829 T{ | |
830 \fIsearch\fR | |
831 bud | |
832 T}:T{ | |
833 search for a buddy with a name or jid containing "bud" (only in the displayed buddylist) | |
834 T} | |
835 T{ | |
836 \fIhide_offline\fR | |
837 T}:T{ | |
838 hide offline buddies | |
839 T} | |
840 T{ | |
841 \fIshow_offline\fR | |
842 T}:T{ | |
843 show offline buddies | |
844 T} | |
845 T{ | |
846 \fItoggle_offline\fR | |
847 T}:T{ | |
848 toggle display of offline buddies | |
849 T} | |
850 T{ | |
851 \fIitem_lock\fR | |
852 jid | |
853 T}:T{ | |
854 lock the roster item so it remains visible regardless of its status | |
855 T} | |
856 T{ | |
857 \fIitem_unlock\fR | |
858 jid | |
859 T}:T{ | |
860 undo the effects of item_lock | |
861 T} | |
862 T{ | |
863 \fIhide\fR | |
864 T}:T{ | |
865 hide roster (full\-width chat window) | |
866 T} | |
867 T{ | |
868 \fIshow\fR | |
869 T}:T{ | |
870 show roster | |
871 T} | |
872 T{ | |
873 \fItoggle\fR | |
874 T}:T{ | |
875 toggle roster visibility | |
876 T} | |
877 T{ | |
878 \fInote\fR | |
879 [text] | |
880 T}:T{ | |
881 display or set an annotation (if text is "\-", the annotation is deleted). In the "status" buffer, it will display all annotations. | |
882 T} | |
883 T{ | |
884 \fItop\fR | |
885 T}:T{ | |
886 jump to the top of the roster | |
887 T} | |
888 T{ | |
889 \fIup\fR | |
890 T}:T{ | |
891 move up in the roster | |
892 T} | |
893 T{ | |
894 \fIdown\fR | |
895 T}:T{ | |
896 move down in the roster | |
897 T} | |
898 T{ | |
899 \fIgroup_prev\fR | |
900 T}:T{ | |
901 jump to the previous group in the roster | |
902 T} | |
903 T{ | |
904 \fIgroup_next\fR | |
905 T}:T{ | |
906 jump to the next group in the roster | |
907 T} | |
908 T{ | |
909 \fIalternate\fR | |
910 T}:T{ | |
911 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") | |
912 T} | |
913 T{ | |
914 \fIunread_first\fR | |
915 T}:T{ | |
916 jump to the first unread message | |
917 T} | |
918 T{ | |
919 \fIunread_next\fR | |
920 T}:T{ | |
921 jump to the next unread message | |
922 T} | |
923 .TE | |
226 | 924 |
1096 | 925 .RE |
926 .PP | |
927 /say text | |
928 .RS 3n | |
929 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. | |
930 .RE | |
931 .PP | |
932 /say_to jid text | |
933 .RS 3n | |
934 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. | |
935 .RE | |
936 .PP | |
937 /status [online|avail|invisible|free|dnd|notavail|away [\-|StatusMessage]] | |
938 .RS 3n | |
939 Show or set the current status. If no status is specified, display the current status. 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. | |
940 .RE | |
941 .PP | |
942 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] | |
943 .RS 3n | |
944 Send the requested status to the specified Jabber user. If the specified jid is ".", the current buddy is used. 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). | |
945 .RE | |
226 | 946 .SH "CONFIGURATION FILE" |
1096 | 947 See the provided sample configuration file, which should be self\-documenting. |
226 | 948 .SH "FILES" |
949 The following files can be used by mcabber(1): | |
950 | |
1096 | 951 .RS 3n |
226 | 952 .nf |
1096 | 953 $HOME/.mcabber/mcabberrc Default configuration file |
954 $HOME/.mcabberrc Configuration file used if no other has been found | |
955 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled | |
226 | 956 .fi |
1096 | 957 .RE |
226 | 958 .SH "BUGS" |
1096 | 959 Certainly. Please tell me if you find one! :\-) |
226 | 960 .SH "AUTHOR" |
1096 | 961 Written by [1]\&\fIMikael BERTHE\fR. Originally based on [2]\&\fICabber\fR, please consult the AUTHORS file for details. |
226 | 962 .SH "RESOURCES" |
1096 | 963 [3]\&\fIMain web site\fR |
226 | 964 .SH "COPYING" |
1096 | 965 Copyright (C) 2005, 2006 Mikael Berthe. Some portions are Copyright (C) 2002\-2004 [4]\&\fIcabber@ajmacias.com\fR. |
966 Free use of this software is granted under the terms of the GNU General Public License (GPL). | |
967 .SH "REFERENCES" | |
968 .TP 3 | |
969 1.\ Mikael BERTHE | |
970 \%mailto:mcabber@lilotux.net | |
971 .TP 3 | |
972 2.\ Cabber | |
973 \%http://cabber.sourceforge.net | |
974 .TP 3 | |
975 3.\ Main web site | |
976 \%http://www.lilotux.net/~mikael/mcabber/ | |
977 .TP 3 | |
978 4.\ cabber@ajmacias.com | |
979 \%mailto:cabber@ajmacias.com |