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