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