Mercurial > ~mikael > mcabber > hg
annotate mcabber/doc/mcabber.1.html @ 263:1bcc3eec08f0
Add Ctrl-o: accept-line-and-down-history
| author | mikael@frmp8452 |
|---|---|
| date | Sat, 02 Jul 2005 12:05:11 +0100 |
| parents | 33e1a05864a6 |
| children | 49e9e02dd6d0 |
| 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> | |
| 201 /buffer clear|top|bottom | |
| 202 </b></dt> | |
| 203 <dd> | |
| 204 The <b>buffer</b> command manipulates the current buddy's buffer | |
| 205 (chat window). | |
| 206 <table class="hlist"> | |
| 207 <tr valign="top"> | |
| 208 <td> | |
| 209 <b>clear</b> | |
| 210 </td> | |
| 211 <td> | |
| 212 clear the current buddy chat window | |
| 213 </td> | |
| 214 </tr> | |
| 215 <tr valign="top"> | |
| 216 <td> | |
| 217 <b>top</b> | |
| 218 </td> | |
| 219 <td> | |
| 220 jump to the top of the current buddy chat buffer | |
| 221 </td> | |
| 222 </tr> | |
| 223 <tr valign="top"> | |
| 224 <td> | |
| 225 <b>bottom</b> | |
| 226 </td> | |
| 227 <td> | |
| 228 jump to the bottom of the current buddy chat buffer | |
| 229 </td> | |
| 230 </tr> | |
| 231 </table> | |
| 232 </dd> | |
| 233 <dt><b> | |
| 234 /clear | |
| 235 </b></dt> | |
| 236 <dd> | |
| 237 The <b>clear</b> command is actually an alias for "/buffer clear". | |
| 238 </dd> | |
| 239 <dt><b> | |
| 240 /del | |
| 241 </b></dt> | |
| 242 <dd> | |
| 243 Delete the current buddy from our roster, unsubscribe from its presence | |
| 244 notification and unsubscribe it from ours. | |
| 245 </dd> | |
| 246 <dt><b> | |
| 240 | 247 /group fold|unfold|toggle |
| 229 | 248 </b></dt> |
| 249 <dd> | |
| 240 | 250 The <b>group</b> command changes the current group display. |
| 229 | 251 <table class="hlist"> |
| 252 <tr valign="top"> | |
| 253 <td> | |
| 240 | 254 <b>fold</b> |
| 229 | 255 </td> |
| 256 <td> | |
| 240 | 257 fold (shrink) the current group tree in the roster |
| 229 | 258 </td> |
| 259 </tr> | |
| 260 <tr valign="top"> | |
| 261 <td> | |
| 240 | 262 <b>unfold</b> |
| 229 | 263 </td> |
| 264 <td> | |
| 240 | 265 unfold (expand) the current group tree in the roster |
| 229 | 266 </td> |
| 267 </tr> | |
| 268 <tr valign="top"> | |
| 269 <td> | |
| 270 <b>toggle</b> | |
| 271 </td> | |
| 272 <td> | |
| 240 | 273 toggle the state (fold/unfold) of the current tree |
| 229 | 274 </td> |
| 275 </tr> | |
| 276 </table> | |
| 277 </dd> | |
| 278 <dt><b> | |
| 279 /info | |
| 280 </b></dt> | |
| 281 <dd> | |
| 282 Display info on the selected entry (user, agent, group…). | |
| 283 </dd> | |
| 284 <dt><b> | |
| 285 /move [groupname] | |
| 286 </b></dt> | |
| 287 <dd> | |
| 288 Move the current buddy to the requested group. If no group is | |
| 289 specified, then the buddy is moved to the default group. | |
| 290 This command only works with users (not agents), at the moment. | |
| 291 </dd> | |
| 292 <dt><b> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
293 /msay begin|verbatim|send|abort |
| 238 | 294 </b></dt> |
| 295 <dd> | |
| 296 Send a multi-line message. To write a single message with several | |
| 297 lines, the <b>multi-line mode</b> should be used. In multi-line mode, | |
| 298 each line (except command lines) typed in the input line will | |
| 299 be added to the multi-line message. Once the message is finished, it | |
| 300 can be sent to the current selected buddy with the "msay /send" | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
301 command. The <b>verbatim</b> multi-line mode disables commands, so that it |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
302 is possible to enter lines starting with a slash. Only the "/msay" |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
303 command (with send or abort parameters) can be used to exit verbatim mode. |
| 238 | 304 <table class="hlist"> |
| 305 <tr valign="top"> | |
| 306 <td> | |
| 307 <b>begin</b> | |
| 308 </td> | |
| 309 <td> | |
| 310 enter multi-line mode | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
311 </td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
312 </tr> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
313 <tr valign="top"> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
314 <td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
315 <b>verbatim</b> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
316 </td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
317 <td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
318 enter verbatim multi-line mode |
| 238 | 319 </td> |
| 320 </tr> | |
| 321 <tr valign="top"> | |
| 322 <td> | |
| 323 <b>send</b> | |
| 324 </td> | |
| 325 <td> | |
| 326 send the current multi-line message to the currently selected buddy | |
| 327 </td> | |
| 328 </tr> | |
| 329 <tr valign="top"> | |
| 330 <td> | |
| 331 <b>abort</b> | |
| 332 </td> | |
| 333 <td> | |
| 334 leave multi-line mode without sending the message | |
| 335 </td> | |
| 336 </tr> | |
| 337 </table> | |
| 338 </dd> | |
| 339 <dt><b> | |
| 229 | 340 /quit |
| 341 </b></dt> | |
| 342 <dd> | |
| 343 Disconnect and leave <tt>mcabber(1)</tt>. | |
| 344 </dd> | |
| 345 <dt><b> | |
| 346 /rename nickname | |
| 347 </b></dt> | |
| 348 <dd> | |
| 349 Rename current buddy to the given nickname. | |
| 350 This command does not work for groups, at the moment (but you can move | |
| 351 the buddies to another group with the /move command). | |
| 352 </dd> | |
| 353 <dt><b> | |
| 354 /roster hide_offline|show_offline|top|bottom | |
| 355 </b></dt> | |
| 356 <dd> | |
| 357 The <b>roster</b> command manipulates the roster/buddylist. | |
| 358 <table class="hlist"> | |
| 359 <tr valign="top"> | |
| 360 <td> | |
| 361 <b>hide_offline</b> | |
| 362 </td> | |
| 363 <td> | |
| 364 hide offline buddies | |
| 365 </td> | |
| 366 </tr> | |
| 367 <tr valign="top"> | |
| 368 <td> | |
| 369 <b>show_offline</b> | |
| 370 </td> | |
| 371 <td> | |
| 372 show offline buddies | |
| 373 </td> | |
| 374 </tr> | |
| 375 <tr valign="top"> | |
| 376 <td> | |
| 377 <b>top</b> | |
| 378 </td> | |
| 379 <td> | |
| 380 jump to the top of the roster | |
| 381 </td> | |
| 382 </tr> | |
| 383 <tr valign="top"> | |
| 384 <td> | |
| 385 <b>bottom</b> | |
| 386 </td> | |
| 387 <td> | |
| 388 jump to the bottom of the roster | |
| 389 </td> | |
| 390 </tr> | |
| 236 | 391 <tr valign="top"> |
| 392 <td> | |
| 393 <b>unread_first</b> | |
| 394 </td> | |
| 395 <td> | |
| 396 jump to the first unread message | |
| 397 </td> | |
| 398 </tr> | |
| 399 <tr valign="top"> | |
| 400 <td> | |
| 401 <b>unread_next</b> | |
| 402 </td> | |
| 403 <td> | |
| 404 jump to the next unread message | |
| 405 </td> | |
| 406 </tr> | |
| 229 | 407 </table> |
| 408 </dd> | |
| 409 <dt><b> | |
| 410 /say text | |
| 411 </b></dt> | |
| 412 <dd> | |
| 413 Send the text message to the currently selected buddy. Can be useful | |
| 414 if you want to send a message beginning with a slash, for example. | |
| 415 </dd> | |
| 416 <dt><b> | |
| 417 /status [online|avail|invisible|free|dnd|busy|notavail|away] | |
| 418 </b></dt> | |
| 419 <dd> | |
| 420 Set the current status. If no status is specified, display the | |
| 421 current status. | |
| 422 </dd> | |
| 423 </dl> | |
| 424 <h2>CONFIGURATION FILE</h2> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
425 <p>See the provided sample configuration file, which should be self-documented.</p> |
| 229 | 426 <h2>FILES</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
427 <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
|
428 <div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc Default configuration file |
| 229 | 429 $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
|
430 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled</pre></div> |
| 229 | 431 <h2>BUGS</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
432 <p>Certainly a lot. Please tell me if you find one! :-)</p> |
| 229 | 433 <h2>AUTHOR</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
434 <p>Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br /> |
| 229 | 435 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
|
436 consult the AUTHORS file for details.</p> |
| 229 | 437 <h2>RESOURCES</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
438 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p> |
| 229 | 439 <h2>COPYING</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
440 <p>Copyright © 2005 Mikael Berthe.<br /> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
441 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
|
442 <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
|
443 License (GPL).</p> |
| 229 | 444 <div id="footer"> |
| 445 <p> | |
| 254 | 446 Version 0.6.2<br /> |
| 263 | 447 Last updated 02-Jul-2005 13:00:02 CEST |
| 229 | 448 </p> |
| 449 </div> | |
| 450 </div> | |
| 451 </body> | |
| 452 </html> |