Mercurial > hg
annotate mcabber/doc/mcabber.1.html @ 289:72fa52203651
Update documentation
* Update /alias doc
* Add documentation for /bind
* Improve /msay help for AsciiDoc and HTML formats. Don't know how to get a
better presentation with the manpage format :(
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Fri, 08 Jul 2005 22:10:42 +0100 |
parents | a3d65d7f0bc3 |
children | f63839a4cb35 |
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" /> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
5 <meta name="generator" content="AsciiDoc 7.0.0" /> |
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> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
26 <p>The <tt>mcabber(1)</tt> screen is divided into 4 regions. |
229 | 27 The <b>roster</b>, alias <b>buddylist</b>, is on the left. The <b>chat window</b>, or chat |
28 buffer, is on the right. The <b>input line</b> lies at the bottom of the screen, | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
29 under a small <b>log window</b>.</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
30 <p>To display buddies chat buffers, you will have to enter <b>chat mode</b>. |
229 | 31 You can enter chat mode by pressing enter, and leave chat mode with the ESC |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
32 key. Simply sending a message will also enable chat mode.</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
33 <p>Here are some of the features of <tt>mcabber</tt>:</p> |
229 | 34 <ul> |
35 <li> | |
36 <p> | |
37 <b>SSL support</b>. | |
38 </p> | |
39 </li> | |
40 <li> | |
41 <p> | |
42 <b>History logging:</b> If enabled (see the CONFIGURATION FILE section), | |
43 <tt>mcabber(1)</tt> can save discussions to history log files. | |
44 </p> | |
45 </li> | |
46 <li> | |
47 <p> | |
48 <b>Commands completion:</b> If possible, <tt>mcabber(1)</tt> will try to complete your | |
49 command line if you hit the Tab key. | |
50 </p> | |
51 </li> | |
52 <li> | |
53 <p> | |
54 <b>External actions:</b> Some events (like receiving a message) can trigger an | |
55 external action, for example a shell script (you need to enable it in your | |
56 configuration file). | |
57 </p> | |
58 </li> | |
59 </ul> | |
60 <h2>OPTIONS</h2> | |
61 <dl> | |
62 <dt><b> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
63 --help, -h |
229 | 64 </b></dt> |
65 <dd> | |
66 Quick help usage message | |
67 </dd> | |
68 <dt><b> | |
69 -f configfile | |
70 </b></dt> | |
71 <dd> | |
72 Use configuration file <b>configfile</b> | |
73 </dd> | |
74 </dl> | |
75 <h2>KEYS</h2> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
76 <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
|
77 (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
|
78 <p>PageUp and PageDown keys are used to move in the roster.</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
79 <p>To send a message, move to the choosen buddy in the buddylist, type your |
229 | 80 message and hit enter. If the line begins with a slash, this will be |
81 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
|
82 leave the chat mode.</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
83 <p>Here is a quick description of the key bindings:</p> |
229 | 84 <table class="hlist"> |
85 <tr valign="top"> | |
86 <td> | |
87 Ctrl-a | |
88 </td> | |
89 <td> | |
90 Go to the beginning of the input line | |
91 </td> | |
92 </tr> | |
93 <tr valign="top"> | |
94 <td> | |
95 Ctrl-e | |
96 </td> | |
97 <td> | |
98 Go to the end of the input line | |
99 </td> | |
100 </tr> | |
101 <tr valign="top"> | |
102 <td> | |
103 Ctrl-l | |
104 </td> | |
105 <td> | |
106 Force a resize | |
107 </td> | |
108 </tr> | |
109 <tr valign="top"> | |
110 <td> | |
111 PgUp/PgDown | |
112 </td> | |
113 <td> | |
114 Move inside the roster (buddylist) | |
115 </td> | |
116 </tr> | |
117 <tr valign="top"> | |
118 <td> | |
119 Tab | |
120 </td> | |
121 <td> | |
122 Complete current word, in the input line | |
123 </td> | |
124 </tr> | |
125 <tr valign="top"> | |
126 <td> | |
127 Ctrl-g | |
128 </td> | |
129 <td> | |
130 Cancel completion / ctrl-g | |
131 </td> | |
132 </tr> | |
133 <tr valign="top"> | |
134 <td> | |
135 Ctrl-p/Ctrl-n | |
136 </td> | |
137 <td> | |
138 Scroll up/down half a screen in the buffer window (chat mode) | |
139 </td> | |
140 </tr> | |
141 <tr valign="top"> | |
142 <td> | |
143 Ctrl-u | |
144 </td> | |
145 <td> | |
146 Delete from beginning of the line to the cursor | |
147 </td> | |
148 </tr> | |
149 <tr valign="top"> | |
150 <td> | |
151 Ctrl-k | |
152 </td> | |
153 <td> | |
154 Delete from the cursor to the end of line | |
155 </td> | |
156 </tr> | |
157 <tr valign="top"> | |
158 <td> | |
159 Ctrl-w | |
160 </td> | |
161 <td> | |
162 Backward kill word | |
163 </td> | |
164 </tr> | |
165 <tr valign="top"> | |
166 <td> | |
167 Ctrl-t | |
168 </td> | |
169 <td> | |
170 Transpose chars | |
171 </td> | |
172 </tr> | |
173 <tr valign="top"> | |
174 <td> | |
263 | 175 Ctrl-o |
176 </td> | |
177 <td> | |
178 Accept line and put the next history line in the input line (accept-line-and-down-history) | |
179 </td> | |
180 </tr> | |
181 <tr valign="top"> | |
182 <td> | |
229 | 183 Ctrl-q |
184 </td> | |
185 <td> | |
236 | 186 Jump to the next unread message |
229 | 187 </td> |
188 </tr> | |
189 </table> | |
190 <h2>COMMANDS</h2> | |
191 <dl> | |
192 <dt><b> | |
245 | 193 /add jid [nickname] |
229 | 194 </b></dt> |
195 <dd> | |
245 | 196 Add the <b>jid</b> Jabber user to our roster (default group), and send a |
197 notification request to this buddy. If no nickname is specified, the | |
198 jid is used. | |
229 | 199 </dd> |
200 <dt><b> | |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
201 /alias name = command line |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
202 </b></dt> |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
203 <dd> |
289 | 204 Add "name" as an alias for "command line".<br /> |
205 Aliases are expanded only once, thus they can not be chained.<br /> | |
206 "/alias name" displays the value associated with the "name" alias; | |
207 "/alias name =" unsets the "name" alias.<br /> | |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
208 Example: "/alias away = status away". |
289 | 209 </dd> |
210 <dt><b> | |
211 /bind keycode = command line | |
212 </b></dt> | |
213 <dd> | |
214 Bind a command line to the key with the "keycode" code number.<br /> | |
215 Keycodes of unused keys are displayed by mcabber in the log window | |
216 when pressing the key, for example "Unknown key=265".<br /> | |
217 "/bind keycode" displays the command line bound to the given keycode; | |
218 "/bind keycode" unbinds the given keycode.<br /> | |
219 Note: aliases can be used in key bindings.<br /> | |
220 Example: "/bind 265 = status online" (265 is F1 for me, but it can | |
221 depend on your ncurses installation). | |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
222 </dd> |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
223 <dt><b> |
229 | 224 /buffer clear|top|bottom |
225 </b></dt> | |
226 <dd> | |
227 The <b>buffer</b> command manipulates the current buddy's buffer | |
228 (chat window). | |
229 <table class="hlist"> | |
230 <tr valign="top"> | |
231 <td> | |
232 <b>clear</b> | |
233 </td> | |
234 <td> | |
235 clear the current buddy chat window | |
236 </td> | |
237 </tr> | |
238 <tr valign="top"> | |
239 <td> | |
240 <b>top</b> | |
241 </td> | |
242 <td> | |
243 jump to the top of the current buddy chat buffer | |
244 </td> | |
245 </tr> | |
246 <tr valign="top"> | |
247 <td> | |
248 <b>bottom</b> | |
249 </td> | |
250 <td> | |
251 jump to the bottom of the current buddy chat buffer | |
252 </td> | |
253 </tr> | |
254 </table> | |
255 </dd> | |
256 <dt><b> | |
257 /clear | |
258 </b></dt> | |
259 <dd> | |
260 The <b>clear</b> command is actually an alias for "/buffer clear". | |
261 </dd> | |
262 <dt><b> | |
263 /del | |
264 </b></dt> | |
265 <dd> | |
266 Delete the current buddy from our roster, unsubscribe from its presence | |
267 notification and unsubscribe it from ours. | |
268 </dd> | |
269 <dt><b> | |
240 | 270 /group fold|unfold|toggle |
229 | 271 </b></dt> |
272 <dd> | |
240 | 273 The <b>group</b> command changes the current group display. |
229 | 274 <table class="hlist"> |
275 <tr valign="top"> | |
276 <td> | |
240 | 277 <b>fold</b> |
229 | 278 </td> |
279 <td> | |
240 | 280 fold (shrink) the current group tree in the roster |
229 | 281 </td> |
282 </tr> | |
283 <tr valign="top"> | |
284 <td> | |
240 | 285 <b>unfold</b> |
229 | 286 </td> |
287 <td> | |
240 | 288 unfold (expand) the current group tree in the roster |
229 | 289 </td> |
290 </tr> | |
291 <tr valign="top"> | |
292 <td> | |
293 <b>toggle</b> | |
294 </td> | |
295 <td> | |
240 | 296 toggle the state (fold/unfold) of the current tree |
229 | 297 </td> |
298 </tr> | |
299 </table> | |
300 </dd> | |
301 <dt><b> | |
302 /info | |
303 </b></dt> | |
304 <dd> | |
305 Display info on the selected entry (user, agent, group…). | |
306 </dd> | |
307 <dt><b> | |
308 /move [groupname] | |
309 </b></dt> | |
310 <dd> | |
311 Move the current buddy to the requested group. If no group is | |
312 specified, then the buddy is moved to the default group. | |
313 This command only works with users (not agents), at the moment. | |
314 </dd> | |
315 <dt><b> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
316 /msay begin|verbatim|send|abort |
238 | 317 </b></dt> |
318 <dd> | |
319 Send a multi-line message. To write a single message with several | |
289 | 320 lines, the <b>multi-line mode</b> should be used.<br /> |
321 In multi-line mode, each line (except command lines) typed in the input | |
322 line will be added to the multi-line message. Once the message is | |
323 finished, it can be sent to the current selected buddy with the "msay | |
324 /send" command.<br /> | |
325 The <b>verbatim</b> multi-line mode disables commands, so that it is | |
326 possible to enter lines starting with a slash. Only the "/msay" | |
327 command (with send or abort parameters) can be used to exit verbatim | |
328 mode. | |
238 | 329 <table class="hlist"> |
330 <tr valign="top"> | |
331 <td> | |
332 <b>begin</b> | |
333 </td> | |
334 <td> | |
335 enter multi-line mode | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
336 </td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
337 </tr> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
338 <tr valign="top"> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
339 <td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
340 <b>verbatim</b> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
341 </td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
342 <td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
343 enter verbatim multi-line mode |
238 | 344 </td> |
345 </tr> | |
346 <tr valign="top"> | |
347 <td> | |
348 <b>send</b> | |
349 </td> | |
350 <td> | |
351 send the current multi-line message to the currently selected buddy | |
352 </td> | |
353 </tr> | |
354 <tr valign="top"> | |
355 <td> | |
356 <b>abort</b> | |
357 </td> | |
358 <td> | |
359 leave multi-line mode without sending the message | |
360 </td> | |
361 </tr> | |
362 </table> | |
363 </dd> | |
364 <dt><b> | |
229 | 365 /quit |
366 </b></dt> | |
367 <dd> | |
368 Disconnect and leave <tt>mcabber(1)</tt>. | |
369 </dd> | |
370 <dt><b> | |
371 /rename nickname | |
372 </b></dt> | |
373 <dd> | |
374 Rename current buddy to the given nickname. | |
375 This command does not work for groups, at the moment (but you can move | |
376 the buddies to another group with the /move command). | |
377 </dd> | |
378 <dt><b> | |
265 | 379 /roster bottom|top|hide_offline|show_offline|unread_first|unread_next |
380 </b></dt> | |
381 <dt><b> | |
382 /roster search bud | |
229 | 383 </b></dt> |
384 <dd> | |
265 | 385 The <b>roster</b> command manipulates the roster/buddylist. Here are the available parameters: |
229 | 386 <table class="hlist"> |
387 <tr valign="top"> | |
388 <td> | |
265 | 389 <b>bottom</b> |
390 </td> | |
391 <td> | |
392 jump to the bottom of the roster | |
393 </td> | |
394 </tr> | |
395 <tr valign="top"> | |
396 <td> | |
397 <b>top</b> | |
398 </td> | |
399 <td> | |
400 jump to the top of the roster | |
401 </td> | |
402 </tr> | |
403 <tr valign="top"> | |
404 <td> | |
229 | 405 <b>hide_offline</b> |
406 </td> | |
407 <td> | |
408 hide offline buddies | |
409 </td> | |
410 </tr> | |
411 <tr valign="top"> | |
412 <td> | |
413 <b>show_offline</b> | |
414 </td> | |
415 <td> | |
416 show offline buddies | |
417 </td> | |
418 </tr> | |
419 <tr valign="top"> | |
420 <td> | |
265 | 421 <b>search</b> bud |
229 | 422 </td> |
423 <td> | |
265 | 424 search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) |
229 | 425 </td> |
426 </tr> | |
236 | 427 <tr valign="top"> |
428 <td> | |
429 <b>unread_first</b> | |
430 </td> | |
431 <td> | |
432 jump to the first unread message | |
433 </td> | |
434 </tr> | |
435 <tr valign="top"> | |
436 <td> | |
437 <b>unread_next</b> | |
438 </td> | |
439 <td> | |
440 jump to the next unread message | |
441 </td> | |
442 </tr> | |
229 | 443 </table> |
444 </dd> | |
445 <dt><b> | |
446 /say text | |
447 </b></dt> | |
448 <dd> | |
449 Send the text message to the currently selected buddy. Can be useful | |
450 if you want to send a message beginning with a slash, for example. | |
451 </dd> | |
452 <dt><b> | |
277
4d7040cff8ee
Remove busy/occupied status, which does not really exist
Mikael Berthe <mikael@lilotux.net>
parents:
265
diff
changeset
|
453 /status [online|avail|invisible|free|dnd|notavail|away] |
229 | 454 </b></dt> |
455 <dd> | |
456 Set the current status. If no status is specified, display the | |
457 current status. | |
458 </dd> | |
459 </dl> | |
460 <h2>CONFIGURATION FILE</h2> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
461 <p>See the provided sample configuration file, which should be self-documented.</p> |
229 | 462 <h2>FILES</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
463 <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
|
464 <div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc Default configuration file |
229 | 465 $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
|
466 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled</pre></div> |
229 | 467 <h2>BUGS</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
468 <p>Certainly a lot. Please tell me if you find one! :-)</p> |
229 | 469 <h2>AUTHOR</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
470 <p>Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br /> |
229 | 471 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
|
472 consult the AUTHORS file for details.</p> |
229 | 473 <h2>RESOURCES</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
474 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p> |
229 | 475 <h2>COPYING</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
476 <p>Copyright © 2005 Mikael Berthe.<br /> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
477 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
|
478 <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
|
479 License (GPL).</p> |
229 | 480 <div id="footer"> |
481 <p> | |
254 | 482 Version 0.6.2<br /> |
289 | 483 Last updated 08-Jul-2005 23:04:30 CEST |
229 | 484 </p> |
485 </div> | |
486 </div> | |
487 </body> | |
488 </html> |