Mercurial > hg
annotate mcabber/doc/mcabber.1.html @ 919:653c1cdfb589
Mention the "lang" variable
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Tue, 27 Jun 2006 19:34:23 +0200 |
parents | 0032c43431df |
children | 1ef75178ce74 |
rev | line source |
---|---|
229 | 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
2 <html> | |
3 <head> | |
4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> | |
799 | 5 <meta name="generator" content="AsciiDoc 7.1.2" /> |
229 | 6 <meta name="author" content="Mikael BERTHE" /> |
7 <meta name="author-email" content="mcabber@lilotux.net" /> | |
8 <link rel="stylesheet" href="./manpage.css" type="text/css" /> | |
9 <title>mcabber</title> | |
10 </head> | |
11 <body> | |
12 <div id="content"> | |
13 <h1>MCABBER(1) Manual Page</h1> | |
14 <h2>NAME</h2> | |
15 <p>mcabber - | |
16 a simple Jabber console client | |
17 </p> | |
18 <div id="synopsis"> | |
19 <h2>SYNOPSIS</h2> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
20 <p><b>mcabber</b> [ -f configfile ] [ --help | -h ]</p> |
229 | 21 </div> |
22 <h2>DESCRIPTION</h2> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
23 <p><tt>mcabber(1)</tt> is a small Jabber console client.<br /> |
229 | 24 For now it needs a configuration file to start, so please copy the sample |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
25 mcabberrc file and adapt your connection settings.</p> |
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
26 <p>You also need to have an existing Jabber account to use this software, as |
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
27 it cannot (un)register accounts yet.</p> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
28 <p>Here are some of the features of <tt>mcabber</tt>:</p> |
229 | 29 <ul> |
30 <li> | |
31 <p> | |
32 <b>SSL support</b>. | |
33 </p> | |
34 </li> | |
35 <li> | |
36 <p> | |
467 | 37 <b>MUC support</b> (Multi-User Chat). |
38 </p> | |
39 </li> | |
40 <li> | |
41 <p> | |
229 | 42 <b>History logging:</b> If enabled (see the CONFIGURATION FILE section), |
432 | 43 <tt>mcabber</tt> can save discussions to history log files. |
229 | 44 </p> |
45 </li> | |
46 <li> | |
47 <p> | |
432 | 48 <b>Commands completion:</b> If possible, <tt>mcabber</tt> will try to complete your |
229 | 49 command line if you hit the Tab key. |
50 </p> | |
51 </li> | |
52 <li> | |
53 <p> | |
618 | 54 <b>Input line history:</b> Any message or command entered is in the input line |
55 history and can be reused easily. | |
56 </p> | |
57 </li> | |
58 <li> | |
59 <p> | |
229 | 60 <b>External actions:</b> Some events (like receiving a message) can trigger an |
854 | 61 external action such as a shell script if you enable it in your |
62 configuration file. A sample events script ("eventcmd") is provided with | |
432 | 63 <tt>mcabber</tt> source code, in the contrib directory. |
229 | 64 </p> |
65 </li> | |
66 </ul> | |
67 <h2>OPTIONS</h2> | |
68 <dl> | |
69 <dt><b> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
70 --help, -h |
229 | 71 </b></dt> |
72 <dd> | |
73 Quick help usage message | |
74 </dd> | |
75 <dt><b> | |
76 -f configfile | |
77 </b></dt> | |
78 <dd> | |
79 Use configuration file <b>configfile</b> | |
80 </dd> | |
81 </dl> | |
854 | 82 <h2>WINDOWS/PANES</h2> |
83 <p>The <tt>mcabber(1)</tt> screen is divided into 4 regions. | |
84 The <b>roster</b>, alias <b>buddylist</b>, is on the left. The <b>chat window</b>, or chat | |
85 buffer, is on the right. The <b>input line</b> lies at the bottom of the screen, | |
86 under a small <b>log window</b>.</p> | |
87 <p>Two status lines surround the log window. The bottom status line is the | |
88 "main status line" and reflects mcabber general status. The other line | |
89 is the "chat status line" and shows the status of the currently selected | |
90 buddy.</p> | |
91 <p>To display buddies chat buffers, you will have to enter <b>chat mode</b>. | |
92 You can enter chat mode by pressing enter, and leave chat mode with the ESC | |
93 key. Simply sending a message will also enable chat mode.</p> | |
94 <p>There are several advantages to the two-mode implementation: first, it allows | |
95 accurate "unread" message functionality, as described in the next section; | |
96 without this, merely scrolling to a specific buddy will "read" the new | |
97 messages of all buddies in-between. Second, it allows quickly hiding the | |
98 conversation with a single keystroke. Third, it allows jumping between | |
99 the few buddies with whom you are conversing with the <b>/roster alternate</b> | |
100 command described in another section, without having to manually scroll | |
101 back and forth.</p> | |
229 | 102 <h2>KEYS</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
103 <p>Text typing occurs in the <b>input line</b>; basic operations are supported |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
104 (left arrow, right arrow, home/end keys, insert, delete, backspace…).</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
105 <p>PageUp and PageDown keys are used to move in the roster.</p> |
618 | 106 <p>Up and Down arrow keys can be used to move in the input line history; they |
107 jump to the previous/next line from the history beginning with the same string | |
108 (from first column to the cursor column).</p> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
109 <p>To send a message, move to the choosen buddy in the buddylist, type your |
229 | 110 message and hit enter. If the line begins with a slash, this will be |
111 interpreted as a command (see the COMMAND section below). Hit escape to | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
112 leave the chat mode.</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
113 <p>Here is a quick description of the key bindings:</p> |
229 | 114 <table class="hlist"> |
115 <tr valign="top"> | |
116 <td> | |
117 Ctrl-a | |
118 </td> | |
119 <td> | |
120 Go to the beginning of the input line | |
121 </td> | |
122 </tr> | |
123 <tr valign="top"> | |
124 <td> | |
125 Ctrl-e | |
126 </td> | |
127 <td> | |
128 Go to the end of the input line | |
129 </td> | |
130 </tr> | |
131 <tr valign="top"> | |
132 <td> | |
133 Ctrl-l | |
134 </td> | |
135 <td> | |
618 | 136 Force a refresh |
137 </td> | |
138 </tr> | |
139 <tr valign="top"> | |
140 <td> | |
141 Up/Down | |
142 </td> | |
143 <td> | |
144 Move in the input line history | |
229 | 145 </td> |
146 </tr> | |
147 <tr valign="top"> | |
148 <td> | |
149 PgUp/PgDown | |
150 </td> | |
151 <td> | |
152 Move inside the roster (buddylist) | |
153 </td> | |
154 </tr> | |
155 <tr valign="top"> | |
156 <td> | |
157 Tab | |
158 </td> | |
159 <td> | |
160 Complete current word, in the input line | |
161 </td> | |
162 </tr> | |
163 <tr valign="top"> | |
164 <td> | |
165 Ctrl-g | |
166 </td> | |
167 <td> | |
168 Cancel completion / ctrl-g | |
169 </td> | |
170 </tr> | |
171 <tr valign="top"> | |
172 <td> | |
173 Ctrl-p/Ctrl-n | |
174 </td> | |
175 <td> | |
176 Scroll up/down half a screen in the buffer window (chat mode) | |
177 </td> | |
178 </tr> | |
179 <tr valign="top"> | |
180 <td> | |
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
181 Ctrl-Left |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
182 </td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
183 <td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
184 Move the cursor back to the start of the current or previous word |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
185 </td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
186 </tr> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
187 <tr valign="top"> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
188 <td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
189 Ctrl-Right |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
190 </td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
191 <td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
192 Move the cursor forward to the end of the current or next word |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
193 </td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
194 </tr> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
195 <tr valign="top"> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
196 <td> |
229 | 197 Ctrl-u |
198 </td> | |
199 <td> | |
200 Delete from beginning of the line to the cursor | |
201 </td> | |
202 </tr> | |
203 <tr valign="top"> | |
204 <td> | |
205 Ctrl-k | |
206 </td> | |
207 <td> | |
208 Delete from the cursor to the end of line | |
209 </td> | |
210 </tr> | |
211 <tr valign="top"> | |
212 <td> | |
213 Ctrl-w | |
214 </td> | |
215 <td> | |
216 Backward kill word | |
217 </td> | |
218 </tr> | |
219 <tr valign="top"> | |
220 <td> | |
221 Ctrl-t | |
222 </td> | |
223 <td> | |
224 Transpose chars | |
225 </td> | |
226 </tr> | |
227 <tr valign="top"> | |
228 <td> | |
263 | 229 Ctrl-o |
230 </td> | |
231 <td> | |
232 Accept line and put the next history line in the input line (accept-line-and-down-history) | |
233 </td> | |
234 </tr> | |
235 <tr valign="top"> | |
236 <td> | |
229 | 237 Ctrl-q |
238 </td> | |
239 <td> | |
236 | 240 Jump to the next unread message |
229 | 241 </td> |
242 </tr> | |
243 </table> | |
854 | 244 <p>Additional key bindings may be specified using the /bind command described |
245 in the COMMANDS section.</p> | |
246 <h2>MCABBER'S ROSTER</h2> | |
247 <p>The first listed resource on the roster is <b>[status]</b>, which keeps a log of | |
248 everything that appears in the short log window below the main chat area. | |
249 While the log window was designed for showing the latest few elements, the | |
250 dedicated <b>[status]</b> buffer allows more comfortable viewing of the log, as | |
251 well as scrolling it in a standard manner.</p> | |
252 <p>Group names are displayed above the resources that are within them, and are | |
253 indicated by <b>---</b> to the left of the name.</p> | |
254 <p>For every real Jabber resource, the roster displays four pieces of information: | |
255 the resource's name or alias, its online status, its authorization status, and | |
256 whether there are unread messages from the resource waiting for you.</p> | |
257 <p>The online status is one of the following:</p> | |
258 <table class="hlist"> | |
259 <tr valign="top"> | |
260 <td> | |
261 <b>o</b> | |
262 </td> | |
263 <td> | |
264 online | |
265 </td> | |
266 </tr> | |
267 <tr valign="top"> | |
268 <td> | |
269 <b>f</b> | |
270 </td> | |
271 <td> | |
272 free for chat | |
273 </td> | |
274 </tr> | |
275 <tr valign="top"> | |
276 <td> | |
277 <b>a</b> | |
278 </td> | |
279 <td> | |
280 away | |
281 </td> | |
282 </tr> | |
283 <tr valign="top"> | |
284 <td> | |
285 <b>n</b> | |
286 </td> | |
287 <td> | |
288 not available (labeled <b>extended away</b> in some clients) | |
289 </td> | |
290 </tr> | |
291 <tr valign="top"> | |
292 <td> | |
293 <b>d</b> | |
294 </td> | |
295 <td> | |
296 do not disturb | |
297 </td> | |
298 </tr> | |
299 <tr valign="top"> | |
300 <td> | |
301 <b>i</b> | |
302 </td> | |
303 <td> | |
304 invisible (displayed only for your resource) | |
305 </td> | |
306 </tr> | |
307 <tr valign="top"> | |
308 <td> | |
309 <b>_</b> | |
310 </td> | |
311 <td> | |
312 offline (or invisible to you) | |
313 </td> | |
314 </tr> | |
315 <tr valign="top"> | |
316 <td> | |
317 <b>?</b> | |
318 </td> | |
319 <td> | |
320 unknown, usually meaning you are not authorized to see this resource's status | |
321 </td> | |
322 </tr> | |
323 <tr valign="top"> | |
324 <td> | |
325 <b>x</b> | |
326 </td> | |
327 <td> | |
328 a conference room in which you are not participating | |
329 </td> | |
330 </tr> | |
331 <tr valign="top"> | |
332 <td> | |
333 <b>C</b> | |
334 </td> | |
335 <td> | |
336 a conference room in which you are participating | |
337 </td> | |
338 </tr> | |
339 </table> | |
340 <p>The authorization status indicates whether a resource is authorized to receive | |
341 your online status updates, and is displayed by the brackets surrounding the | |
342 resource's online status. Square brackets, like <b>[o]</b>, indicate that this | |
343 resource is authorized to receive your status. Curly braces, like <b>{o}</b>, | |
344 indicate that they are not authorized to receive your status.</p> | |
345 <p>When there are unread messages from the resource which you have not looked at, | |
346 a hash mark (<b>#</b>) appears in the leftmost section of the roster for that | |
347 resource. The hash mark disappears once you view that resource's message log.</p> | |
348 <p>Examples:</p> | |
349 <table class="hlist"> | |
350 <tr valign="top"> | |
351 <td> | |
352 <b> --- Buds</b> | |
353 </td> | |
354 <td> | |
355 This is a group named <b>Buds</b> | |
356 </td> | |
357 </tr> | |
358 <tr valign="top"> | |
359 <td> | |
360 <b>#[o] John</b> | |
361 </td> | |
362 <td> | |
363 John is online, can see your status, and sent you a message that you did not read yet | |
364 </td> | |
365 </tr> | |
366 <tr valign="top"> | |
367 <td> | |
368 <b> {?} Sally</b> | |
369 </td> | |
370 <td> | |
371 Neither you nor Sally have authorized each other to see your online status | |
372 </td> | |
373 </tr> | |
374 <tr valign="top"> | |
375 <td> | |
376 <b> {a} Jane</b> | |
377 </td> | |
378 <td> | |
379 Jane is away, but she cannot see your online status | |
380 </td> | |
381 </tr> | |
382 <tr valign="top"> | |
383 <td> | |
384 <b>#[C] x@y.c</b> | |
385 </td> | |
386 <td> | |
387 You are participating in x@y.c conference room, and there are unread messages | |
388 </td> | |
389 </tr> | |
390 </table> | |
391 <h2>COMMANDS RELATED TO MCABBER</h2> | |
229 | 392 <dl> |
393 <dt><b> | |
870 | 394 /alias [name [= command line]] |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
395 </b></dt> |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
396 <dd> |
289 | 397 Add "name" as an alias for "command line".<br /> |
398 Aliases are expanded only once, thus they can not be chained.<br /> | |
870 | 399 "/alias name" displays the value associated with the "name" alias;<br /> |
289 | 400 "/alias name =" unsets the "name" alias.<br /> |
870 | 401 "/alias" displays a list of the existing aliases.<br /> |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
402 Example: "/alias away = status away". |
289 | 403 </dd> |
404 <dt><b> | |
870 | 405 /bind [keycode [= command line]] |
289 | 406 </b></dt> |
407 <dd> | |
408 Bind a command line to the key with the "keycode" code number.<br /> | |
432 | 409 Keycodes of unused keys are displayed by <tt>mcabber</tt> in the log window |
289 | 410 when pressing the key, for example "Unknown key=265".<br /> |
870 | 411 "/bind keycode" displays the command line bound to the given keycode;<br /> |
412 "/bind keycode =" unbinds the given keycode.<br /> | |
413 "/bind" displays a list of the bound keycodes.<br /> | |
289 | 414 Note: aliases can be used in key bindings.<br /> |
450 | 415 Example: "/bind 265 = status online" (265 is F1 for me, but it may |
289 | 416 depend on your ncurses installation). |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
417 </dd> |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
418 <dt><b> |
870 | 419 /buffer clear|purge|top|bottom|date|%|search_backward|search_forward |
229 | 420 </b></dt> |
876 | 421 <dt><b> |
422 /buffer scroll_lock|scroll_unlock|scroll_toggle | |
423 </b></dt> | |
229 | 424 <dd> |
425 The <b>buffer</b> command manipulates the current buddy's buffer | |
426 (chat window). | |
427 <table class="hlist"> | |
428 <tr valign="top"> | |
429 <td> | |
430 <b>clear</b> | |
431 </td> | |
432 <td> | |
433 clear the current buddy chat window | |
434 </td> | |
435 </tr> | |
436 <tr valign="top"> | |
437 <td> | |
870 | 438 <b>purge</b> |
439 </td> | |
440 <td> | |
876 | 441 clear the current buddy chat window and empty all contents of the chat buffer |
870 | 442 </td> |
443 </tr> | |
444 <tr valign="top"> | |
445 <td> | |
511 | 446 <b>bottom</b> |
447 </td> | |
448 <td> | |
449 jump to the bottom of the current buddy chat buffer | |
450 </td> | |
451 </tr> | |
452 <tr valign="top"> | |
453 <td> | |
229 | 454 <b>top</b> |
455 </td> | |
456 <td> | |
457 jump to the top of the current buddy chat buffer | |
458 </td> | |
459 </tr> | |
460 <tr valign="top"> | |
461 <td> | |
511 | 462 <b>up</b> [n] |
229 | 463 </td> |
464 <td> | |
511 | 465 scroll the buffer up n lines (default: half a screen) |
466 </td> | |
467 </tr> | |
468 <tr valign="top"> | |
469 <td> | |
470 <b>down</b> [n] | |
471 </td> | |
472 <td> | |
473 scroll the buffer down n lines (default: half a screen) | |
229 | 474 </td> |
475 </tr> | |
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
476 <tr valign="top"> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
477 <td> |
618 | 478 <b>date</b> date |
479 </td> | |
480 <td> | |
481 jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional) | |
482 </td> | |
483 </tr> | |
484 <tr valign="top"> | |
485 <td> | |
486 <b>%</b> n | |
487 </td> | |
488 <td> | |
489 jump to position %n of the buddy chat buffer | |
490 </td> | |
491 </tr> | |
492 <tr valign="top"> | |
493 <td> | |
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
494 <b>search_backward</b> text |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
495 </td> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
496 <td> |
491 | 497 search for "text" in the current buddy chat buffer |
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
498 </td> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
499 </tr> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
500 <tr valign="top"> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
501 <td> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
502 <b>search_forward</b> text |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
503 </td> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
504 <td> |
491 | 505 search for "text" in the current buddy chat buffer |
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
506 </td> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
507 </tr> |
876 | 508 <tr valign="top"> |
509 <td> | |
510 <b>scroll_lock</b> | |
511 </td> | |
512 <td> | |
513 lock buffer scrolling | |
514 </td> | |
515 </tr> | |
516 <tr valign="top"> | |
517 <td> | |
518 <b>scroll_unlock</b> | |
519 </td> | |
520 <td> | |
521 unlock buffer scrolling | |
522 </td> | |
523 </tr> | |
524 <tr valign="top"> | |
525 <td> | |
526 <b>scroll_toggle</b> | |
527 </td> | |
528 <td> | |
529 toggle buffer scrolling (lock/unlock) | |
530 </td> | |
531 </tr> | |
229 | 532 </table> |
533 </dd> | |
534 <dt><b> | |
535 /clear | |
536 </b></dt> | |
537 <dd> | |
538 The <b>clear</b> command is actually an alias for "/buffer clear". | |
539 </dd> | |
540 <dt><b> | |
870 | 541 /help [command] |
542 </b></dt> | |
543 <dd> | |
544 Display generic help or help about a specific mcabber command. | |
545 </dd> | |
546 <dt><b> | |
854 | 547 /quit |
548 </b></dt> | |
549 <dd> | |
550 Disconnect and leave <tt>mcabber(1)</tt>. | |
551 </dd> | |
552 <dt><b> | |
553 /version | |
554 </b></dt> | |
555 <dd> | |
556 Display mcabber version | |
557 </dd> | |
558 </dl> | |
559 <h2>COMMANDS RELATED TO THE SERVER AND CONNECTION</h2> | |
560 <dl> | |
561 <dt><b> | |
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
562 /connect |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
563 </b></dt> |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
564 <dd> |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
565 Establish connection to the Jabber server. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
566 </dd> |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
567 <dt><b> |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
568 /disconnect |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
569 </b></dt> |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
570 <dd> |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
571 Terminate connection to the Jabber server. Note: the roster is only |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
572 available when the connection to the server is active, so the |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
573 buddylist is empty when disconnected. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
574 </dd> |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
575 <dt><b> |
829 | 576 /event #n|* accept|ignore|reject |
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
577 </b></dt> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
578 <dt><b> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
579 /event list |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
580 </b></dt> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
581 <dd> |
829 | 582 Tell mcabber what to do about a pending event.<br /> |
583 If the first parameter is "*", the command will apply to all | |
584 queued events. | |
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
585 <table class="hlist"> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
586 <tr valign="top"> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
587 <td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
588 <b>accept</b> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
589 </td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
590 <td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
591 accept the event #n |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
592 </td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
593 </tr> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
594 <tr valign="top"> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
595 <td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
596 <b>ignore</b> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
597 </td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
598 <td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
599 remove the event #n from the list |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
600 </td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
601 </tr> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
602 <tr valign="top"> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
603 <td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
604 <b>reject</b> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
605 </td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
606 <td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
607 reject the event #n |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
608 </td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
609 </tr> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
610 <tr valign="top"> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
611 <td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
612 <b>list</b> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
613 </td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
614 <td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
615 list all pending events |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
616 </td> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
617 </tr> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
618 </table> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
619 </dd> |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
620 <dt><b> |
901 | 621 /rawxml send string |
854 | 622 </b></dt> |
623 <dd> | |
624 <b>send</b> 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. | |
625 </dd> | |
626 </dl> | |
627 <h2>COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES</h2> | |
628 <dl> | |
629 <dt><b> | |
630 /add [jid [nickname]] | |
631 </b></dt> | |
632 <dd> | |
633 Add the "jid" Jabber user to our roster (default group), and send a | |
634 notification request to this buddy. If no nickname is specified, the | |
635 jid is used. If no jid (or an empty string "") is provided or if jid | |
636 is ".", the current buddy is used. | |
637 </dd> | |
638 <dt><b> | |
639 /authorization allow|cancel|request|request_unsubscribe [jid] | |
640 </b></dt> | |
641 <dd> | |
642 Manage the presence subscriptions.<br /> | |
643 If no jid is provided, the current buddy is used. | |
644 <table class="hlist"> | |
645 <tr valign="top"> | |
646 <td> | |
647 <b>allow</b> | |
648 </td> | |
649 <td> | |
650 allow the buddy to receive your presence updates | |
651 </td> | |
652 </tr> | |
653 <tr valign="top"> | |
654 <td> | |
655 <b>cancel</b> | |
656 </td> | |
657 <td> | |
658 cancel the buddy' subscription to your presence updates | |
659 </td> | |
660 </tr> | |
661 <tr valign="top"> | |
662 <td> | |
663 <b>request</b> | |
664 </td> | |
665 <td> | |
666 request a subscription to the buddy's presence updates | |
667 </td> | |
668 </tr> | |
669 <tr valign="top"> | |
670 <td> | |
671 <b>request_unsubscribe</b> | |
672 </td> | |
673 <td> | |
674 request unsubscription from the buddy's presence updates | |
675 </td> | |
676 </tr> | |
677 </table> | |
678 </dd> | |
679 <dt><b> | |
680 /del | |
681 </b></dt> | |
682 <dd> | |
683 Delete the current buddy from our roster, unsubscribe from its presence | |
684 notification and unsubscribe it from ours. | |
685 </dd> | |
686 <dt><b> | |
240 | 687 /group fold|unfold|toggle |
229 | 688 </b></dt> |
689 <dd> | |
240 | 690 The <b>group</b> command changes the current group display. |
229 | 691 <table class="hlist"> |
692 <tr valign="top"> | |
693 <td> | |
240 | 694 <b>fold</b> |
229 | 695 </td> |
696 <td> | |
240 | 697 fold (shrink) the current group tree in the roster |
229 | 698 </td> |
699 </tr> | |
700 <tr valign="top"> | |
701 <td> | |
240 | 702 <b>unfold</b> |
229 | 703 </td> |
704 <td> | |
240 | 705 unfold (expand) the current group tree in the roster |
229 | 706 </td> |
707 </tr> | |
708 <tr valign="top"> | |
709 <td> | |
710 <b>toggle</b> | |
711 </td> | |
712 <td> | |
240 | 713 toggle the state (fold/unfold) of the current tree |
229 | 714 </td> |
715 </tr> | |
716 </table> | |
717 </dd> | |
718 <dt><b> | |
719 /info | |
720 </b></dt> | |
721 <dd> | |
440
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
722 Display info on the selected entry (user, agent, group…).<br /> |
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
723 For users, resources are displayed with the status, priority and |
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
724 status message (if available) of each resource. |
229 | 725 </dd> |
726 <dt><b> | |
727 /move [groupname] | |
728 </b></dt> | |
729 <dd> | |
730 Move the current buddy to the requested group. If no group is | |
623 | 731 specified, then the buddy is moved to the default group.<br /> |
506
74dcd0df532e
"/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents:
495
diff
changeset
|
732 Tip: if the chatmode is enabled, you can use "/roster alternate" |
74dcd0df532e
"/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents:
495
diff
changeset
|
733 to jump to the moved buddy. |
229 | 734 </dd> |
735 <dt><b> | |
839 | 736 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort |
238 | 737 </b></dt> |
738 <dd> | |
739 Send a multi-line message. To write a single message with several | |
289 | 740 lines, the <b>multi-line mode</b> should be used.<br /> |
741 In multi-line mode, each line (except command lines) typed in the input | |
742 line will be added to the multi-line message. Once the message is | |
450 | 743 finished, it can be sent to the current selected buddy with the "/msay |
744 send" command.<br /> | |
810 | 745 The <b>begin</b> subcommand enables multi-line mode. Note that it allows |
746 a message subject to be specified.<br /> | |
289 | 747 The <b>verbatim</b> multi-line mode disables commands, so that it is |
748 possible to enter lines starting with a slash. Only the "/msay" | |
749 command (with send or abort parameters) can be used to exit verbatim | |
799 | 750 mode.<br /> |
839 | 751 The <b>toggle</b> and <b>toggle_verbatim</b> subcommands can be bound to a key to |
752 use the multi-line mode quickly (for example, "bind M109 = msay toggle" | |
753 to switch using the Meta-m combination). | |
238 | 754 <table class="hlist"> |
755 <tr valign="top"> | |
756 <td> | |
810 | 757 <b>begin</b> [subject] |
238 | 758 </td> |
759 <td> | |
760 enter multi-line mode | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
761 </td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
762 </tr> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
763 <tr valign="top"> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
764 <td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
765 <b>verbatim</b> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
766 </td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
767 <td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
768 enter verbatim multi-line mode |
238 | 769 </td> |
770 </tr> | |
771 <tr valign="top"> | |
772 <td> | |
773 <b>send</b> | |
774 </td> | |
775 <td> | |
776 send the current multi-line message to the currently selected buddy | |
777 </td> | |
778 </tr> | |
779 <tr valign="top"> | |
780 <td> | |
637 | 781 <b>send_to</b> jid |
782 </td> | |
783 <td> | |
784 send the current multi-line message to "jid" | |
785 </td> | |
786 </tr> | |
787 <tr valign="top"> | |
788 <td> | |
799 | 789 <b>toggle</b> |
790 </td> | |
791 <td> | |
792 switch to/from multi-line mode (begin/send) | |
793 </td> | |
794 </tr> | |
795 <tr valign="top"> | |
796 <td> | |
839 | 797 <b>toggle_verbatim</b> |
798 </td> | |
799 <td> | |
800 same with verbatim multi-line mode | |
801 </td> | |
802 </tr> | |
803 <tr valign="top"> | |
804 <td> | |
238 | 805 <b>abort</b> |
806 </td> | |
807 <td> | |
808 leave multi-line mode without sending the message | |
809 </td> | |
810 </tr> | |
811 </table> | |
812 </dd> | |
813 <dt><b> | |
886 | 814 /rename name |
229 | 815 </b></dt> |
816 <dd> | |
886 | 817 Rename current buddy or group to the given name. |
818 Please note that a group name change is only done when the server's | |
819 acknowledgment is received, so a slight delay can be noticed. | |
450 | 820 </dd> |
821 <dt><b> | |
700 | 822 /request time|version [jid] |
823 </b></dt> | |
824 <dd> | |
825 Send a "IQ" query to the current buddy, or to the specified Jabber | |
826 user. If the resource is not provided with the jid, mcabber will | |
827 send the query to all known resources for this user. | |
828 </dd> | |
829 <dt><b> | |
601 | 830 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy |
573 | 831 </b></dt> |
832 <dt><b> | |
593 | 833 /room invite|kick|ban|role|affil |
450 | 834 </b></dt> |
835 <dd> | |
836 The <b>room</b> command handles Multi-User Chat room actions. | |
837 <table class="hlist"> | |
838 <tr valign="top"> | |
839 <td> | |
901 | 840 <b>join</b> [room [nick [pass]]] |
450 | 841 </td> |
842 <td> | |
901 | 843 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. |
450 | 844 </td> |
845 </tr> | |
846 <tr valign="top"> | |
847 <td> | |
487 | 848 <b>leave</b> [message] |
450 | 849 </td> |
850 <td> | |
851 leave the current room | |
852 </td> | |
853 </tr> | |
854 <tr valign="top"> | |
855 <td> | |
856 <b>names</b> | |
857 </td> | |
858 <td> | |
859 display members of the current room | |
860 </td> | |
861 </tr> | |
862 <tr valign="top"> | |
863 <td> | |
470 | 864 <b>nick</b> nick |
865 </td> | |
866 <td> | |
867 change your nickname in the current room | |
868 </td> | |
869 </tr> | |
870 <tr valign="top"> | |
871 <td> | |
491 | 872 <b>privmsg</b> nick msg |
873 </td> | |
874 <td> | |
875 send private message "msg" to "nick" | |
876 </td> | |
877 </tr> | |
878 <tr valign="top"> | |
879 <td> | |
450 | 880 <b>remove</b> |
881 </td> | |
882 <td> | |
467 | 883 remove the current room from the roster (you must have left this room before) |
884 </td> | |
885 </tr> | |
886 <tr valign="top"> | |
887 <td> | |
475
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
888 <b>topic</b> |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
889 </td> |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
890 <td> |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
891 set topic for current room |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
892 </td> |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
893 </tr> |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
894 <tr valign="top"> |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
895 <td> |
467 | 896 <b>unlock</b> |
897 </td> | |
898 <td> | |
899 unlock current room (if you are the owner) | |
450 | 900 </td> |
901 </tr> | |
573 | 902 <tr valign="top"> |
903 <td> | |
601 | 904 <b>destroy</b> [reason] |
905 </td> | |
906 <td> | |
907 destroy the current room (use with care!) | |
908 </td> | |
909 </tr> | |
910 <tr valign="top"> | |
911 <td> | |
573 | 912 <b>whois</b> nick |
913 </td> | |
914 <td> | |
915 display MUC information about "nick" | |
916 </td> | |
917 </tr> | |
593 | 918 <tr valign="top"> |
919 <td> | |
920 <b>ban</b> jid [reason] | |
921 </td> | |
922 <td> | |
923 ban jid from the current room | |
924 </td> | |
925 </tr> | |
926 <tr valign="top"> | |
927 <td> | |
928 <b>invite</b> jid [reason] | |
929 </td> | |
930 <td> | |
931 invite jid to the current room | |
932 </td> | |
933 </tr> | |
934 <tr valign="top"> | |
935 <td> | |
936 <b>kick</b> nick [reason] | |
937 </td> | |
938 <td> | |
939 kick "nick" from the current room | |
940 </td> | |
941 </tr> | |
942 <tr valign="top"> | |
943 <td> | |
944 <b>role</b> jid role [reason] | |
945 </td> | |
946 <td> | |
947 change jid's role (role can be "none", "visitor", "participant", "moderator") | |
948 </td> | |
949 </tr> | |
950 <tr valign="top"> | |
951 <td> | |
952 <b>affil</b> jid affil [reason] | |
953 </td> | |
954 <td> | |
955 change jid's affiliation (affil can be "none", "member", "admin", "owner") | |
956 </td> | |
957 </tr> | |
450 | 958 </table> |
229 | 959 </dd> |
960 <dt><b> | |
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
961 /roster bottom|top|hide_offline|show_offline|toggle_offline |
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
962 </b></dt> |
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
963 <dt><b> |
710 | 964 /roster hide|show|toggle |
965 </b></dt> | |
966 <dt><b> | |
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
967 /roster alternate|unread_first|unread_next |
265 | 968 </b></dt> |
969 <dt><b> | |
970 /roster search bud | |
229 | 971 </b></dt> |
972 <dd> | |
265 | 973 The <b>roster</b> command manipulates the roster/buddylist. Here are the available parameters: |
229 | 974 <table class="hlist"> |
975 <tr valign="top"> | |
976 <td> | |
265 | 977 <b>bottom</b> |
978 </td> | |
979 <td> | |
980 jump to the bottom of the roster | |
981 </td> | |
982 </tr> | |
983 <tr valign="top"> | |
984 <td> | |
985 <b>top</b> | |
986 </td> | |
987 <td> | |
988 jump to the top of the roster | |
989 </td> | |
990 </tr> | |
991 <tr valign="top"> | |
992 <td> | |
377
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
993 <b>up</b> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
994 </td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
995 <td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
996 move up in the roster |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
997 </td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
998 </tr> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
999 <tr valign="top"> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1000 <td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1001 <b>down</b> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1002 </td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1003 <td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1004 move down in the roster |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1005 </td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1006 </tr> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1007 <tr valign="top"> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
1008 <td> |
229 | 1009 <b>hide_offline</b> |
1010 </td> | |
1011 <td> | |
1012 hide offline buddies | |
1013 </td> | |
1014 </tr> | |
1015 <tr valign="top"> | |
1016 <td> | |
1017 <b>show_offline</b> | |
1018 </td> | |
1019 <td> | |
1020 show offline buddies | |
1021 </td> | |
1022 </tr> | |
1023 <tr valign="top"> | |
1024 <td> | |
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1025 <b>toggle_offline</b> |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1026 </td> |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1027 <td> |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1028 toggle display of offline buddies |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1029 </td> |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1030 </tr> |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1031 <tr valign="top"> |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
1032 <td> |
710 | 1033 <b>hide</b> |
1034 </td> | |
1035 <td> | |
1036 hide roster (full-width chat window) | |
1037 </td> | |
1038 </tr> | |
1039 <tr valign="top"> | |
1040 <td> | |
1041 <b>show</b> | |
1042 </td> | |
1043 <td> | |
1044 show roster | |
1045 </td> | |
1046 </tr> | |
1047 <tr valign="top"> | |
1048 <td> | |
1049 <b>toggle</b> | |
1050 </td> | |
1051 <td> | |
1052 toggle roster visibility | |
1053 </td> | |
1054 </tr> | |
1055 <tr valign="top"> | |
1056 <td> | |
265 | 1057 <b>search</b> bud |
229 | 1058 </td> |
1059 <td> | |
916 | 1060 search for a buddy with a name or jid containing "bud" (only in the displayed buddylist) |
229 | 1061 </td> |
1062 </tr> | |
236 | 1063 <tr valign="top"> |
1064 <td> | |
330 | 1065 <b>alternate</b> |
1066 </td> | |
1067 <td> | |
1068 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") | |
1069 </td> | |
1070 </tr> | |
1071 <tr valign="top"> | |
1072 <td> | |
236 | 1073 <b>unread_first</b> |
1074 </td> | |
1075 <td> | |
1076 jump to the first unread message | |
1077 </td> | |
1078 </tr> | |
1079 <tr valign="top"> | |
1080 <td> | |
1081 <b>unread_next</b> | |
1082 </td> | |
1083 <td> | |
1084 jump to the next unread message | |
1085 </td> | |
1086 </tr> | |
229 | 1087 </table> |
1088 </dd> | |
1089 <dt><b> | |
1090 /say text | |
1091 </b></dt> | |
1092 <dd> | |
491 | 1093 Send the "text" message to the currently selected buddy. Can be useful |
229 | 1094 if you want to send a message beginning with a slash, for example. |
1095 </dd> | |
1096 <dt><b> | |
480 | 1097 /say_to jid text |
1098 </b></dt> | |
1099 <dd> | |
491 | 1100 Send the "text" message to the specified jid. |
480 | 1101 Please note that this command doesn't set the default resource for |
1102 a contact, so if you want to send several messages to a specific | |
916 | 1103 resource you will have to use "/say_to" for each message. |
480 | 1104 </dd> |
1105 <dt><b> | |
522 | 1106 /status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]] |
229 | 1107 </b></dt> |
1108 <dd> | |
522 | 1109 Show or set the current status.<br /> |
1110 If no status is specified, display the current status.<br /> | |
320
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
305
diff
changeset
|
1111 If a status message is specified, it will overrride the message* |
522 | 1112 variables (these variables can be set in the configuration file). |
1113 If no relevant message* variable is set and no status message provided, | |
1114 the current status message is kept. If StatusMessage is "-", the | |
1115 current status message is cleared. | |
229 | 1116 </dd> |
450 | 1117 <dt><b> |
1118 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] | |
1119 </b></dt> | |
1120 <dd> | |
1121 Send the requested status to the specified Jabber user.<br /> | |
660 | 1122 If the specified jid is ".", the current buddy is used.<br /> |
450 | 1123 Note: this status will be overridden by subsequent "/status" commands. |
1124 If you are using the auto-away feature, the status will overridden | |
1125 too.<br /> | |
1126 Note: The jid can include a resource (i.e. user@server/resource). | |
1127 </dd> | |
229 | 1128 </dl> |
1129 <h2>CONFIGURATION FILE</h2> | |
854 | 1130 <p>See the provided sample configuration file, which should be self-documenting.</p> |
229 | 1131 <h2>FILES</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
1132 <p>The following files can be used by <tt>mcabber(1)</tt>:</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
1133 <div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc Default configuration file |
229 | 1134 $HOME/.mcabberrc Configuration file used if no other has been found |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
1135 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled</pre></div> |
229 | 1136 <h2>BUGS</h2> |
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
1137 <p>Certainly. Please tell me if you find one! :-)</p> |
229 | 1138 <h2>AUTHOR</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
1139 <p>Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br /> |
229 | 1140 Originally based on <a href="http://cabber.sourceforge.net">Cabber</a>, please |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
1141 consult the AUTHORS file for details.</p> |
229 | 1142 <h2>RESOURCES</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
1143 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p> |
229 | 1144 <h2>COPYING</h2> |
700 | 1145 <p>Copyright © 2005, 2006 Mikael Berthe.<br /> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
1146 Some portions are Copyright © 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
1147 <p>Free use of this software is granted under the terms of the GNU General Public |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
1148 License (GPL).</p> |
229 | 1149 <div id="footer"> |
1150 <p> | |
906 | 1151 Version 0.7.7<br /> |
901 | 1152 Last updated 17-Jun-2006 10:23:23 CEST |
229 | 1153 </p> |
1154 </div> | |
1155 </div> | |
1156 </body> | |
1157 </html> |