Mercurial > ~mikael > mcabber > hg
annotate mcabber/doc/mcabber.1.html @ 829:114f08e3c29a
Update documentation
| author | Mikael Berthe <mikael@lilotux.net> |
|---|---|
| date | Sun, 30 Apr 2006 14:51:02 +0200 |
| parents | 8c45ec4bf9bc |
| children | cd011fe9f8a5 |
| 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>The <tt>mcabber(1)</tt> screen is divided into 4 regions. |
| 229 | 29 The <b>roster</b>, alias <b>buddylist</b>, is on the left. The <b>chat window</b>, or chat |
| 30 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
|
31 under a small <b>log window</b>.</p> |
|
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
32 <p>Two status lines surround the log window. The bottom status line is the |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
33 "main status line" and reflects mcabber general status. The other line |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
34 is the "chat status line" and shows the status of the currently selected |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
35 buddy.</p> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
36 <p>To display buddies chat buffers, you will have to enter <b>chat mode</b>. |
| 229 | 37 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
|
38 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
|
39 <p>Here are some of the features of <tt>mcabber</tt>:</p> |
| 229 | 40 <ul> |
| 41 <li> | |
| 42 <p> | |
| 43 <b>SSL support</b>. | |
| 44 </p> | |
| 45 </li> | |
| 46 <li> | |
| 47 <p> | |
| 467 | 48 <b>MUC support</b> (Multi-User Chat). |
| 49 </p> | |
| 50 </li> | |
| 51 <li> | |
| 52 <p> | |
| 229 | 53 <b>History logging:</b> If enabled (see the CONFIGURATION FILE section), |
| 432 | 54 <tt>mcabber</tt> can save discussions to history log files. |
| 229 | 55 </p> |
| 56 </li> | |
| 57 <li> | |
| 58 <p> | |
| 432 | 59 <b>Commands completion:</b> If possible, <tt>mcabber</tt> will try to complete your |
| 229 | 60 command line if you hit the Tab key. |
| 61 </p> | |
| 62 </li> | |
| 63 <li> | |
| 64 <p> | |
| 618 | 65 <b>Input line history:</b> Any message or command entered is in the input line |
| 66 history and can be reused easily. | |
| 67 </p> | |
| 68 </li> | |
| 69 <li> | |
| 70 <p> | |
| 229 | 71 <b>External actions:</b> Some events (like receiving a message) can trigger an |
| 72 external action, for example a shell script (you need to enable it in your | |
| 432 | 73 configuration file). A sample events script ("eventcmd") is provided with |
| 74 <tt>mcabber</tt> source code, in the contrib directory. | |
| 229 | 75 </p> |
| 76 </li> | |
| 77 </ul> | |
| 78 <h2>OPTIONS</h2> | |
| 79 <dl> | |
| 80 <dt><b> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
81 --help, -h |
| 229 | 82 </b></dt> |
| 83 <dd> | |
| 84 Quick help usage message | |
| 85 </dd> | |
| 86 <dt><b> | |
| 87 -f configfile | |
| 88 </b></dt> | |
| 89 <dd> | |
| 90 Use configuration file <b>configfile</b> | |
| 91 </dd> | |
| 92 </dl> | |
| 93 <h2>KEYS</h2> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
94 <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
|
95 (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
|
96 <p>PageUp and PageDown keys are used to move in the roster.</p> |
| 618 | 97 <p>Up and Down arrow keys can be used to move in the input line history; they |
| 98 jump to the previous/next line from the history beginning with the same string | |
| 99 (from first column to the cursor column).</p> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
100 <p>To send a message, move to the choosen buddy in the buddylist, type your |
| 229 | 101 message and hit enter. If the line begins with a slash, this will be |
| 102 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
|
103 leave the chat mode.</p> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
104 <p>Here is a quick description of the key bindings:</p> |
| 229 | 105 <table class="hlist"> |
| 106 <tr valign="top"> | |
| 107 <td> | |
| 108 Ctrl-a | |
| 109 </td> | |
| 110 <td> | |
| 111 Go to the beginning of the input line | |
| 112 </td> | |
| 113 </tr> | |
| 114 <tr valign="top"> | |
| 115 <td> | |
| 116 Ctrl-e | |
| 117 </td> | |
| 118 <td> | |
| 119 Go to the end of the input line | |
| 120 </td> | |
| 121 </tr> | |
| 122 <tr valign="top"> | |
| 123 <td> | |
| 124 Ctrl-l | |
| 125 </td> | |
| 126 <td> | |
| 618 | 127 Force a refresh |
| 128 </td> | |
| 129 </tr> | |
| 130 <tr valign="top"> | |
| 131 <td> | |
| 132 Up/Down | |
| 133 </td> | |
| 134 <td> | |
| 135 Move in the input line history | |
| 229 | 136 </td> |
| 137 </tr> | |
| 138 <tr valign="top"> | |
| 139 <td> | |
| 140 PgUp/PgDown | |
| 141 </td> | |
| 142 <td> | |
| 143 Move inside the roster (buddylist) | |
| 144 </td> | |
| 145 </tr> | |
| 146 <tr valign="top"> | |
| 147 <td> | |
| 148 Tab | |
| 149 </td> | |
| 150 <td> | |
| 151 Complete current word, in the input line | |
| 152 </td> | |
| 153 </tr> | |
| 154 <tr valign="top"> | |
| 155 <td> | |
| 156 Ctrl-g | |
| 157 </td> | |
| 158 <td> | |
| 159 Cancel completion / ctrl-g | |
| 160 </td> | |
| 161 </tr> | |
| 162 <tr valign="top"> | |
| 163 <td> | |
| 164 Ctrl-p/Ctrl-n | |
| 165 </td> | |
| 166 <td> | |
| 167 Scroll up/down half a screen in the buffer window (chat mode) | |
| 168 </td> | |
| 169 </tr> | |
| 170 <tr valign="top"> | |
| 171 <td> | |
|
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
172 Ctrl-Left |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
173 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
174 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
175 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
|
176 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
177 </tr> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
178 <tr valign="top"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
179 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
180 Ctrl-Right |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
181 </td> |
|
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 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
|
184 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
185 </tr> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
186 <tr valign="top"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
187 <td> |
| 229 | 188 Ctrl-u |
| 189 </td> | |
| 190 <td> | |
| 191 Delete from beginning of the line to the cursor | |
| 192 </td> | |
| 193 </tr> | |
| 194 <tr valign="top"> | |
| 195 <td> | |
| 196 Ctrl-k | |
| 197 </td> | |
| 198 <td> | |
| 199 Delete from the cursor to the end of line | |
| 200 </td> | |
| 201 </tr> | |
| 202 <tr valign="top"> | |
| 203 <td> | |
| 204 Ctrl-w | |
| 205 </td> | |
| 206 <td> | |
| 207 Backward kill word | |
| 208 </td> | |
| 209 </tr> | |
| 210 <tr valign="top"> | |
| 211 <td> | |
| 212 Ctrl-t | |
| 213 </td> | |
| 214 <td> | |
| 215 Transpose chars | |
| 216 </td> | |
| 217 </tr> | |
| 218 <tr valign="top"> | |
| 219 <td> | |
| 263 | 220 Ctrl-o |
| 221 </td> | |
| 222 <td> | |
| 223 Accept line and put the next history line in the input line (accept-line-and-down-history) | |
| 224 </td> | |
| 225 </tr> | |
| 226 <tr valign="top"> | |
| 227 <td> | |
| 229 | 228 Ctrl-q |
| 229 </td> | |
| 230 <td> | |
| 236 | 231 Jump to the next unread message |
| 229 | 232 </td> |
| 233 </tr> | |
| 234 </table> | |
| 235 <h2>COMMANDS</h2> | |
| 236 <dl> | |
| 237 <dt><b> | |
| 639 | 238 /add [jid [nickname]] |
| 229 | 239 </b></dt> |
| 240 <dd> | |
| 491 | 241 Add the "jid" Jabber user to our roster (default group), and send a |
| 245 | 242 notification request to this buddy. If no nickname is specified, the |
| 660 | 243 jid is used. If no jid (or an empty string "") is provided or if jid |
| 244 is ".", the current buddy is used. | |
| 229 | 245 </dd> |
| 246 <dt><b> | |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
247 /alias name = command line |
|
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
248 </b></dt> |
|
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
249 <dd> |
| 289 | 250 Add "name" as an alias for "command line".<br /> |
| 251 Aliases are expanded only once, thus they can not be chained.<br /> | |
| 252 "/alias name" displays the value associated with the "name" alias; | |
| 253 "/alias name =" unsets the "name" alias.<br /> | |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
254 Example: "/alias away = status away". |
| 289 | 255 </dd> |
| 256 <dt><b> | |
| 618 | 257 /authorization allow|cancel|request [jid] |
| 258 </b></dt> | |
| 259 <dd> | |
| 260 Manage the presence subscriptions.<br /> | |
| 261 If no jid is provided, the current buddy is used. | |
| 262 <table class="hlist"> | |
| 263 <tr valign="top"> | |
| 264 <td> | |
| 265 <b>allow</b> | |
| 266 </td> | |
| 267 <td> | |
| 268 allow the buddy to receive your presence updates | |
| 269 </td> | |
| 270 </tr> | |
| 271 <tr valign="top"> | |
| 272 <td> | |
| 273 <b>cancel</b> | |
| 274 </td> | |
| 275 <td> | |
| 276 cancel the buddy' subscription to your presence updates | |
| 277 </td> | |
| 278 </tr> | |
| 279 <tr valign="top"> | |
| 280 <td> | |
| 281 <b>request</b> | |
| 282 </td> | |
| 283 <td> | |
| 284 request a subscription to the buddy's presence updates | |
| 285 </td> | |
| 286 </tr> | |
| 287 </table> | |
| 288 </dd> | |
| 289 <dt><b> | |
| 289 | 290 /bind keycode = command line |
| 291 </b></dt> | |
| 292 <dd> | |
| 293 Bind a command line to the key with the "keycode" code number.<br /> | |
| 432 | 294 Keycodes of unused keys are displayed by <tt>mcabber</tt> in the log window |
| 289 | 295 when pressing the key, for example "Unknown key=265".<br /> |
| 296 "/bind keycode" displays the command line bound to the given keycode; | |
| 297 "/bind keycode" unbinds the given keycode.<br /> | |
| 298 Note: aliases can be used in key bindings.<br /> | |
| 450 | 299 Example: "/bind 265 = status online" (265 is F1 for me, but it may |
| 289 | 300 depend on your ncurses installation). |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
301 </dd> |
|
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
302 <dt><b> |
| 618 | 303 /buffer clear|top|bottom|date|%|search_backward|search_forward |
| 229 | 304 </b></dt> |
| 305 <dd> | |
| 306 The <b>buffer</b> command manipulates the current buddy's buffer | |
| 307 (chat window). | |
| 308 <table class="hlist"> | |
| 309 <tr valign="top"> | |
| 310 <td> | |
| 311 <b>clear</b> | |
| 312 </td> | |
| 313 <td> | |
| 314 clear the current buddy chat window | |
| 315 </td> | |
| 316 </tr> | |
| 317 <tr valign="top"> | |
| 318 <td> | |
| 511 | 319 <b>bottom</b> |
| 320 </td> | |
| 321 <td> | |
| 322 jump to the bottom of the current buddy chat buffer | |
| 323 </td> | |
| 324 </tr> | |
| 325 <tr valign="top"> | |
| 326 <td> | |
| 229 | 327 <b>top</b> |
| 328 </td> | |
| 329 <td> | |
| 330 jump to the top of the current buddy chat buffer | |
| 331 </td> | |
| 332 </tr> | |
| 333 <tr valign="top"> | |
| 334 <td> | |
| 511 | 335 <b>up</b> [n] |
| 229 | 336 </td> |
| 337 <td> | |
| 511 | 338 scroll the buffer up n lines (default: half a screen) |
| 339 </td> | |
| 340 </tr> | |
| 341 <tr valign="top"> | |
| 342 <td> | |
| 343 <b>down</b> [n] | |
| 344 </td> | |
| 345 <td> | |
| 346 scroll the buffer down n lines (default: half a screen) | |
| 229 | 347 </td> |
| 348 </tr> | |
|
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
349 <tr valign="top"> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
350 <td> |
| 618 | 351 <b>date</b> date |
| 352 </td> | |
| 353 <td> | |
| 354 jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional) | |
| 355 </td> | |
| 356 </tr> | |
| 357 <tr valign="top"> | |
| 358 <td> | |
| 359 <b>%</b> n | |
| 360 </td> | |
| 361 <td> | |
| 362 jump to position %n of the buddy chat buffer | |
| 363 </td> | |
| 364 </tr> | |
| 365 <tr valign="top"> | |
| 366 <td> | |
|
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
367 <b>search_backward</b> text |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
368 </td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
369 <td> |
| 491 | 370 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
|
371 </td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
372 </tr> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
373 <tr valign="top"> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
374 <td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
375 <b>search_forward</b> text |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
376 </td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
377 <td> |
| 491 | 378 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
|
379 </td> |
|
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
380 </tr> |
| 229 | 381 </table> |
| 382 </dd> | |
| 383 <dt><b> | |
| 384 /clear | |
| 385 </b></dt> | |
| 386 <dd> | |
| 387 The <b>clear</b> command is actually an alias for "/buffer clear". | |
| 388 </dd> | |
| 389 <dt><b> | |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
390 /connect |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
391 </b></dt> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
392 <dd> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
393 Establish connection to the Jabber server. |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
394 </dd> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
395 <dt><b> |
| 229 | 396 /del |
| 397 </b></dt> | |
| 398 <dd> | |
| 399 Delete the current buddy from our roster, unsubscribe from its presence | |
| 400 notification and unsubscribe it from ours. | |
| 401 </dd> | |
| 402 <dt><b> | |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
403 /disconnect |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
404 </b></dt> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
405 <dd> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
406 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
|
407 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
|
408 buddylist is empty when disconnected. |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
409 </dd> |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
410 <dt><b> |
| 829 | 411 /event #n|* accept|ignore|reject |
|
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
412 </b></dt> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
413 <dt><b> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
414 /event list |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
415 </b></dt> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
416 <dd> |
| 829 | 417 Tell mcabber what to do about a pending event.<br /> |
| 418 If the first parameter is "*", the command will apply to all | |
| 419 queued events. | |
|
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
420 <table class="hlist"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
421 <tr valign="top"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
422 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
423 <b>accept</b> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
424 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
425 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
426 accept the event #n |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
427 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
428 </tr> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
429 <tr valign="top"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
430 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
431 <b>ignore</b> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
432 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
433 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
434 remove the event #n from the list |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
435 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
436 </tr> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
437 <tr valign="top"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
438 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
439 <b>reject</b> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
440 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
441 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
442 reject the event #n |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
443 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
444 </tr> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
445 <tr valign="top"> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
446 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
447 <b>list</b> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
448 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
449 <td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
450 list all pending events |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
451 </td> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
452 </tr> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
453 </table> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
454 </dd> |
|
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
455 <dt><b> |
| 240 | 456 /group fold|unfold|toggle |
| 229 | 457 </b></dt> |
| 458 <dd> | |
| 240 | 459 The <b>group</b> command changes the current group display. |
| 229 | 460 <table class="hlist"> |
| 461 <tr valign="top"> | |
| 462 <td> | |
| 240 | 463 <b>fold</b> |
| 229 | 464 </td> |
| 465 <td> | |
| 240 | 466 fold (shrink) the current group tree in the roster |
| 229 | 467 </td> |
| 468 </tr> | |
| 469 <tr valign="top"> | |
| 470 <td> | |
| 240 | 471 <b>unfold</b> |
| 229 | 472 </td> |
| 473 <td> | |
| 240 | 474 unfold (expand) the current group tree in the roster |
| 229 | 475 </td> |
| 476 </tr> | |
| 477 <tr valign="top"> | |
| 478 <td> | |
| 479 <b>toggle</b> | |
| 480 </td> | |
| 481 <td> | |
| 240 | 482 toggle the state (fold/unfold) of the current tree |
| 229 | 483 </td> |
| 484 </tr> | |
| 485 </table> | |
| 486 </dd> | |
| 487 <dt><b> | |
| 488 /info | |
| 489 </b></dt> | |
| 490 <dd> | |
|
440
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
491 Display info on the selected entry (user, agent, group…).<br /> |
|
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
492 For users, resources are displayed with the status, priority and |
|
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
493 status message (if available) of each resource. |
| 229 | 494 </dd> |
| 495 <dt><b> | |
| 496 /move [groupname] | |
| 497 </b></dt> | |
| 498 <dd> | |
| 499 Move the current buddy to the requested group. If no group is | |
| 623 | 500 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
|
501 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
|
502 to jump to the moved buddy. |
| 229 | 503 </dd> |
| 504 <dt><b> | |
| 799 | 505 /msay begin|verbatim|send|send_to|toggle|abort |
| 238 | 506 </b></dt> |
| 507 <dd> | |
| 508 Send a multi-line message. To write a single message with several | |
| 289 | 509 lines, the <b>multi-line mode</b> should be used.<br /> |
| 510 In multi-line mode, each line (except command lines) typed in the input | |
| 511 line will be added to the multi-line message. Once the message is | |
| 450 | 512 finished, it can be sent to the current selected buddy with the "/msay |
| 513 send" command.<br /> | |
| 810 | 514 The <b>begin</b> subcommand enables multi-line mode. Note that it allows |
| 515 a message subject to be specified.<br /> | |
| 289 | 516 The <b>verbatim</b> multi-line mode disables commands, so that it is |
| 517 possible to enter lines starting with a slash. Only the "/msay" | |
| 518 command (with send or abort parameters) can be used to exit verbatim | |
| 799 | 519 mode.<br /> |
| 520 The <b>toggle</b> subcommand can be bound to a key to use the multi-line | |
| 521 mode quickly (for example, "bind M13 = msay toggle" to switch using | |
| 522 the Meta-Enter combination). | |
| 238 | 523 <table class="hlist"> |
| 524 <tr valign="top"> | |
| 525 <td> | |
| 810 | 526 <b>begin</b> [subject] |
| 238 | 527 </td> |
| 528 <td> | |
| 529 enter multi-line mode | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
530 </td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
531 </tr> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
532 <tr valign="top"> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
533 <td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
534 <b>verbatim</b> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
535 </td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
536 <td> |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
537 enter verbatim multi-line mode |
| 238 | 538 </td> |
| 539 </tr> | |
| 540 <tr valign="top"> | |
| 541 <td> | |
| 542 <b>send</b> | |
| 543 </td> | |
| 544 <td> | |
| 545 send the current multi-line message to the currently selected buddy | |
| 546 </td> | |
| 547 </tr> | |
| 548 <tr valign="top"> | |
| 549 <td> | |
| 637 | 550 <b>send_to</b> jid |
| 551 </td> | |
| 552 <td> | |
| 553 send the current multi-line message to "jid" | |
| 554 </td> | |
| 555 </tr> | |
| 556 <tr valign="top"> | |
| 557 <td> | |
| 799 | 558 <b>toggle</b> |
| 559 </td> | |
| 560 <td> | |
| 561 switch to/from multi-line mode (begin/send) | |
| 562 </td> | |
| 563 </tr> | |
| 564 <tr valign="top"> | |
| 565 <td> | |
| 238 | 566 <b>abort</b> |
| 567 </td> | |
| 568 <td> | |
| 569 leave multi-line mode without sending the message | |
| 570 </td> | |
| 571 </tr> | |
| 572 </table> | |
| 573 </dd> | |
| 574 <dt><b> | |
| 229 | 575 /quit |
| 576 </b></dt> | |
| 577 <dd> | |
| 578 Disconnect and leave <tt>mcabber(1)</tt>. | |
| 579 </dd> | |
| 580 <dt><b> | |
| 436 | 581 /rawxml send |
| 582 </b></dt> | |
| 583 <dd> | |
| 584 <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. | |
| 585 </dd> | |
| 586 <dt><b> | |
| 229 | 587 /rename nickname |
| 588 </b></dt> | |
| 589 <dd> | |
| 590 Rename current buddy to the given nickname. | |
| 591 This command does not work for groups, at the moment (but you can move | |
| 450 | 592 the buddies to another group with the "/move" command). |
| 593 </dd> | |
| 594 <dt><b> | |
| 700 | 595 /request time|version [jid] |
| 596 </b></dt> | |
| 597 <dd> | |
| 598 Send a "IQ" query to the current buddy, or to the specified Jabber | |
| 599 user. If the resource is not provided with the jid, mcabber will | |
| 600 send the query to all known resources for this user. | |
| 601 </dd> | |
| 602 <dt><b> | |
| 601 | 603 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy |
| 573 | 604 </b></dt> |
| 605 <dt><b> | |
| 593 | 606 /room invite|kick|ban|role|affil |
| 450 | 607 </b></dt> |
| 608 <dd> | |
| 609 The <b>room</b> command handles Multi-User Chat room actions. | |
| 610 <table class="hlist"> | |
| 611 <tr valign="top"> | |
| 612 <td> | |
| 660 | 613 <b>join</b> room [nick] |
| 450 | 614 </td> |
| 615 <td> | |
| 660 | 616 join "room", using "nick" as nickname. If no nickname is provided, the "nickname" option value is used (see sample configuration file) |
| 450 | 617 </td> |
| 618 </tr> | |
| 619 <tr valign="top"> | |
| 620 <td> | |
| 487 | 621 <b>leave</b> [message] |
| 450 | 622 </td> |
| 623 <td> | |
| 624 leave the current room | |
| 625 </td> | |
| 626 </tr> | |
| 627 <tr valign="top"> | |
| 628 <td> | |
| 629 <b>names</b> | |
| 630 </td> | |
| 631 <td> | |
| 632 display members of the current room | |
| 633 </td> | |
| 634 </tr> | |
| 635 <tr valign="top"> | |
| 636 <td> | |
| 470 | 637 <b>nick</b> nick |
| 638 </td> | |
| 639 <td> | |
| 640 change your nickname in the current room | |
| 641 </td> | |
| 642 </tr> | |
| 643 <tr valign="top"> | |
| 644 <td> | |
| 491 | 645 <b>privmsg</b> nick msg |
| 646 </td> | |
| 647 <td> | |
| 648 send private message "msg" to "nick" | |
| 649 </td> | |
| 650 </tr> | |
| 651 <tr valign="top"> | |
| 652 <td> | |
| 450 | 653 <b>remove</b> |
| 654 </td> | |
| 655 <td> | |
| 467 | 656 remove the current room from the roster (you must have left this room before) |
| 657 </td> | |
| 658 </tr> | |
| 659 <tr valign="top"> | |
| 660 <td> | |
|
475
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
661 <b>topic</b> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
662 </td> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
663 <td> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
664 set topic for current room |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
665 </td> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
666 </tr> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
667 <tr valign="top"> |
|
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
668 <td> |
| 467 | 669 <b>unlock</b> |
| 670 </td> | |
| 671 <td> | |
| 672 unlock current room (if you are the owner) | |
| 450 | 673 </td> |
| 674 </tr> | |
| 573 | 675 <tr valign="top"> |
| 676 <td> | |
| 601 | 677 <b>destroy</b> [reason] |
| 678 </td> | |
| 679 <td> | |
| 680 destroy the current room (use with care!) | |
| 681 </td> | |
| 682 </tr> | |
| 683 <tr valign="top"> | |
| 684 <td> | |
| 573 | 685 <b>whois</b> nick |
| 686 </td> | |
| 687 <td> | |
| 688 display MUC information about "nick" | |
| 689 </td> | |
| 690 </tr> | |
| 593 | 691 <tr valign="top"> |
| 692 <td> | |
| 693 <b>ban</b> jid [reason] | |
| 694 </td> | |
| 695 <td> | |
| 696 ban jid from the current room | |
| 697 </td> | |
| 698 </tr> | |
| 699 <tr valign="top"> | |
| 700 <td> | |
| 701 <b>invite</b> jid [reason] | |
| 702 </td> | |
| 703 <td> | |
| 704 invite jid to the current room | |
| 705 </td> | |
| 706 </tr> | |
| 707 <tr valign="top"> | |
| 708 <td> | |
| 709 <b>kick</b> nick [reason] | |
| 710 </td> | |
| 711 <td> | |
| 712 kick "nick" from the current room | |
| 713 </td> | |
| 714 </tr> | |
| 715 <tr valign="top"> | |
| 716 <td> | |
| 717 <b>role</b> jid role [reason] | |
| 718 </td> | |
| 719 <td> | |
| 720 change jid's role (role can be "none", "visitor", "participant", "moderator") | |
| 721 </td> | |
| 722 </tr> | |
| 723 <tr valign="top"> | |
| 724 <td> | |
| 725 <b>affil</b> jid affil [reason] | |
| 726 </td> | |
| 727 <td> | |
| 728 change jid's affiliation (affil can be "none", "member", "admin", "owner") | |
| 729 </td> | |
| 730 </tr> | |
| 450 | 731 </table> |
| 229 | 732 </dd> |
| 733 <dt><b> | |
|
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
734 /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
|
735 </b></dt> |
|
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
736 <dt><b> |
| 710 | 737 /roster hide|show|toggle |
| 738 </b></dt> | |
| 739 <dt><b> | |
|
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
740 /roster alternate|unread_first|unread_next |
| 265 | 741 </b></dt> |
| 742 <dt><b> | |
| 743 /roster search bud | |
| 229 | 744 </b></dt> |
| 745 <dd> | |
| 265 | 746 The <b>roster</b> command manipulates the roster/buddylist. Here are the available parameters: |
| 229 | 747 <table class="hlist"> |
| 748 <tr valign="top"> | |
| 749 <td> | |
| 265 | 750 <b>bottom</b> |
| 751 </td> | |
| 752 <td> | |
| 753 jump to the bottom of the roster | |
| 754 </td> | |
| 755 </tr> | |
| 756 <tr valign="top"> | |
| 757 <td> | |
| 758 <b>top</b> | |
| 759 </td> | |
| 760 <td> | |
| 761 jump to the top of the roster | |
| 762 </td> | |
| 763 </tr> | |
| 764 <tr valign="top"> | |
| 765 <td> | |
|
377
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
766 <b>up</b> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
767 </td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
768 <td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
769 move up in the roster |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
770 </td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
771 </tr> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
772 <tr valign="top"> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
773 <td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
774 <b>down</b> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
775 </td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
776 <td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
777 move down in the roster |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
778 </td> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
779 </tr> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
780 <tr valign="top"> |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
781 <td> |
| 229 | 782 <b>hide_offline</b> |
| 783 </td> | |
| 784 <td> | |
| 785 hide offline buddies | |
| 786 </td> | |
| 787 </tr> | |
| 788 <tr valign="top"> | |
| 789 <td> | |
| 790 <b>show_offline</b> | |
| 791 </td> | |
| 792 <td> | |
| 793 show offline buddies | |
| 794 </td> | |
| 795 </tr> | |
| 796 <tr valign="top"> | |
| 797 <td> | |
|
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
798 <b>toggle_offline</b> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
799 </td> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
800 <td> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
801 toggle display of offline buddies |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
802 </td> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
803 </tr> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
804 <tr valign="top"> |
|
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
805 <td> |
| 710 | 806 <b>hide</b> |
| 807 </td> | |
| 808 <td> | |
| 809 hide roster (full-width chat window) | |
| 810 </td> | |
| 811 </tr> | |
| 812 <tr valign="top"> | |
| 813 <td> | |
| 814 <b>show</b> | |
| 815 </td> | |
| 816 <td> | |
| 817 show roster | |
| 818 </td> | |
| 819 </tr> | |
| 820 <tr valign="top"> | |
| 821 <td> | |
| 822 <b>toggle</b> | |
| 823 </td> | |
| 824 <td> | |
| 825 toggle roster visibility | |
| 826 </td> | |
| 827 </tr> | |
| 828 <tr valign="top"> | |
| 829 <td> | |
| 265 | 830 <b>search</b> bud |
| 229 | 831 </td> |
| 832 <td> | |
| 265 | 833 search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) |
| 229 | 834 </td> |
| 835 </tr> | |
| 236 | 836 <tr valign="top"> |
| 837 <td> | |
| 330 | 838 <b>alternate</b> |
| 839 </td> | |
| 840 <td> | |
| 841 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") | |
| 842 </td> | |
| 843 </tr> | |
| 844 <tr valign="top"> | |
| 845 <td> | |
| 236 | 846 <b>unread_first</b> |
| 847 </td> | |
| 848 <td> | |
| 849 jump to the first unread message | |
| 850 </td> | |
| 851 </tr> | |
| 852 <tr valign="top"> | |
| 853 <td> | |
| 854 <b>unread_next</b> | |
| 855 </td> | |
| 856 <td> | |
| 857 jump to the next unread message | |
| 858 </td> | |
| 859 </tr> | |
| 229 | 860 </table> |
| 861 </dd> | |
| 862 <dt><b> | |
| 863 /say text | |
| 864 </b></dt> | |
| 865 <dd> | |
| 491 | 866 Send the "text" message to the currently selected buddy. Can be useful |
| 229 | 867 if you want to send a message beginning with a slash, for example. |
| 868 </dd> | |
| 869 <dt><b> | |
| 480 | 870 /say_to jid text |
| 871 </b></dt> | |
| 872 <dd> | |
| 491 | 873 Send the "text" message to the specified jid. |
| 480 | 874 Please note that this command doesn't set the default resource for |
| 875 a contact, so if you want to send several messages to a specific | |
| 876 ressource you will have to use "/say_to" for each message. | |
| 877 </dd> | |
| 878 <dt><b> | |
| 522 | 879 /status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]] |
| 229 | 880 </b></dt> |
| 881 <dd> | |
| 522 | 882 Show or set the current status.<br /> |
| 883 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
|
884 If a status message is specified, it will overrride the message* |
| 522 | 885 variables (these variables can be set in the configuration file). |
| 886 If no relevant message* variable is set and no status message provided, | |
| 887 the current status message is kept. If StatusMessage is "-", the | |
| 888 current status message is cleared. | |
| 229 | 889 </dd> |
| 450 | 890 <dt><b> |
| 891 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] | |
| 892 </b></dt> | |
| 893 <dd> | |
| 894 Send the requested status to the specified Jabber user.<br /> | |
| 660 | 895 If the specified jid is ".", the current buddy is used.<br /> |
| 450 | 896 Note: this status will be overridden by subsequent "/status" commands. |
| 897 If you are using the auto-away feature, the status will overridden | |
| 898 too.<br /> | |
| 899 Note: The jid can include a resource (i.e. user@server/resource). | |
| 900 </dd> | |
| 623 | 901 <dt><b> |
| 902 /version | |
| 903 </b></dt> | |
| 904 <dd> | |
| 905 Display mcabber version | |
| 906 </dd> | |
| 229 | 907 </dl> |
| 908 <h2>CONFIGURATION FILE</h2> | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
909 <p>See the provided sample configuration file, which should be self-documented.</p> |
| 229 | 910 <h2>FILES</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
911 <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
|
912 <div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc Default configuration file |
| 229 | 913 $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
|
914 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled</pre></div> |
| 229 | 915 <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
|
916 <p>Certainly. Please tell me if you find one! :-)</p> |
| 229 | 917 <h2>AUTHOR</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
918 <p>Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br /> |
| 229 | 919 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
|
920 consult the AUTHORS file for details.</p> |
| 229 | 921 <h2>RESOURCES</h2> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
922 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p> |
| 229 | 923 <h2>COPYING</h2> |
| 700 | 924 <p>Copyright © 2005, 2006 Mikael Berthe.<br /> |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
925 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
|
926 <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
|
927 License (GPL).</p> |
| 229 | 928 <div id="footer"> |
| 929 <p> | |
| 829 | 930 Version 0.7.7-dev<br /> |
| 931 Last updated 30-Apr-2006 14:49:22 CEST | |
| 229 | 932 </p> |
| 933 </div> | |
| 934 </div> | |
| 935 </body> | |
| 936 </html> |