Mercurial > ~mikael > mcabber > hg
comparison mcabber/doc/mcabber.1.txt @ 1062:9207f2efb921
Update documentation
- /request last
- /request vcard
- /room bookmark
- /roster note
... and a few minor manpage updates.
| author | Mikael Berthe <mikael@lilotux.net> |
|---|---|
| date | Thu, 30 Nov 2006 23:50:41 +0100 |
| parents | f7ef8003fc35 |
| children | 07941d7feee9 |
comparison
equal
deleted
inserted
replaced
| 1061:da696ed4acf4 | 1062:9207f2efb921 |
|---|---|
| 22 | 22 |
| 23 Here are some of the features of `mcabber`: | 23 Here are some of the features of `mcabber`: |
| 24 | 24 |
| 25 - 'SSL support'. | 25 - 'SSL support'. |
| 26 - 'MUC support' (Multi-User Chat). | 26 - 'MUC support' (Multi-User Chat). |
| 27 - 'PGP support' | |
| 28 - 'Chat States' support (typing notifications) | |
| 27 - 'History logging:' If enabled (see the CONFIGURATION FILE section), | 29 - 'History logging:' If enabled (see the CONFIGURATION FILE section), |
| 28 `mcabber` can save discussions to history log files. | 30 `mcabber` can save discussions to history log files. |
| 29 - 'Commands completion:' If possible, `mcabber` will try to complete your | 31 - 'Commands completion:' If possible, `mcabber` will try to complete your |
| 30 command line if you hit the Tab key. | 32 command line if you hit the Tab key. |
| 31 - 'Input line history:' Any message or command entered is in the input line | 33 - 'Input line history:' Any message or command entered is in the input line |
| 84 interpreted as a command (see the COMMAND section below). Hit escape to | 86 interpreted as a command (see the COMMAND section below). Hit escape to |
| 85 leave the chat mode. | 87 leave the chat mode. |
| 86 | 88 |
| 87 Here is a quick description of the key bindings: | 89 Here is a quick description of the key bindings: |
| 88 | 90 |
| 91 Esc:: Disable chat mode | |
| 89 Ctrl-a:: Go to the beginning of the input line | 92 Ctrl-a:: Go to the beginning of the input line |
| 90 Ctrl-e:: Go to the end of the input line | 93 Ctrl-e:: Go to the end of the input line |
| 91 Ctrl-l:: Force a refresh | 94 Ctrl-l:: Force a refresh |
| 92 Up/Down:: Move in the input line history | 95 Up/Down:: Move in the input line history |
| 93 PgUp/PgDown:: Move inside the roster (buddylist) | 96 PgUp/PgDown:: Move inside the roster (buddylist) |
| 296 /rename name:: | 299 /rename name:: |
| 297 Rename current buddy or group to the given name. | 300 Rename current buddy or group to the given name. |
| 298 Please note that a group name change is only done when the server's | 301 Please note that a group name change is only done when the server's |
| 299 acknowledgment is received, so a slight delay can be noticed. | 302 acknowledgment is received, so a slight delay can be noticed. |
| 300 | 303 |
| 301 /request time|version [jid]:: | 304 /request last|time|vcard|version [jid]:: |
| 302 Send a "IQ" query to the current buddy, or to the specified Jabber | 305 Send a "IQ" query to the current buddy, or to the specified Jabber |
| 303 user. If the resource is not provided with the jid, mcabber will | 306 user. If the resource is not provided with the jid, mcabber will |
| 304 send the query to all known resources for this user. | 307 send the query to all known resources for this user. |
| 305 | 308 |
| 306 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy:: | 309 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy:: |
| 307 /room invite|kick|ban|role|affil:: | 310 /room invite|kick|ban|role|affil:: |
| 311 /room bookmark [add|del] [-autojoin|+autojoin]:: | |
| 308 The 'room' command handles Multi-User Chat room actions. | 312 The 'room' command handles Multi-User Chat room actions. |
| 309 | 313 |
| 310 'join' [room [nick [pass]]];; join "room", using "nick" as nickname. If no nickname is provided (or if it is an empty string), the "nickname" option value is used (see sample configuration file). If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "." can be used instead of the full room id. A password can be provided to enter protected rooms. If your nickname contains space characters, use quotes. | 314 'join' [room [nick [pass]]];; join "room", using "nick" as nickname. If no nickname is provided (or if it is an empty string), the "nickname" option value is used (see sample configuration file). If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "." can be used instead of the full room id. A password can be provided to enter protected rooms. If your nickname contains space characters, use quotes. |
| 311 'leave' [message];; leave the current room | 315 'leave' [message];; leave the current room |
| 312 'names';; display members of the current room | 316 'names';; display members of the current room |
| 320 'ban' jid [reason];; ban jid from the current room | 324 'ban' jid [reason];; ban jid from the current room |
| 321 'invite' jid [reason];; invite jid to the current room | 325 'invite' jid [reason];; invite jid to the current room |
| 322 'kick' nick [reason];; kick "nick" from the current room | 326 'kick' nick [reason];; kick "nick" from the current room |
| 323 'role' jid role [reason];; change jid's role (role can be "none", "visitor", "participant", "moderator") | 327 'role' jid role [reason];; change jid's role (role can be "none", "visitor", "participant", "moderator") |
| 324 'affil' jid affil [reason];; change jid's affiliation (affil can be "none", "member", "admin", "owner") | 328 'affil' jid affil [reason];; change jid's affiliation (affil can be "none", "member", "admin", "owner") |
| 329 'bookmark' add/update/remove a room bookmark, set/unset autojoin | |
| 325 | 330 |
| 326 /roster bottom|top|hide_offline|show_offline|toggle_offline:: | 331 /roster bottom|top|hide_offline|show_offline|toggle_offline:: |
| 327 /roster hide|show|toggle:: | 332 /roster hide|show|toggle:: |
| 328 /roster alternate|unread_first|unread_next:: | 333 /roster alternate|unread_first|unread_next:: |
| 329 /roster search bud:: | 334 /roster search bud:: |
| 335 /roster note [-|text]:: | |
| 330 The 'roster' command manipulates the roster/buddylist. Here are the available parameters: | 336 The 'roster' command manipulates the roster/buddylist. Here are the available parameters: |
| 331 | 337 |
| 332 'bottom';; jump to the bottom of the roster | 338 'bottom';; jump to the bottom of the roster |
| 333 'top';; jump to the top of the roster | 339 'top';; jump to the top of the roster |
| 334 'up';; move up in the roster | 340 'up';; move up in the roster |
| 343 'item_unlock' jid;; undo the effects of item_lock | 349 'item_unlock' jid;; undo the effects of item_lock |
| 344 'search' bud;; search for a buddy with a name or jid containing "bud" (only in the displayed buddylist) | 350 'search' bud;; search for a buddy with a name or jid containing "bud" (only in the displayed buddylist) |
| 345 'alternate';; 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") | 351 'alternate';; 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") |
| 346 'unread_first';; jump to the first unread message | 352 'unread_first';; jump to the first unread message |
| 347 'unread_next';; jump to the next unread message | 353 'unread_next';; jump to the next unread message |
| 354 'note' [text];; display or set an annotation (if text is "-", the annotation is deleted). In the "status" buffer, it will display all annotations. | |
| 348 | 355 |
| 349 /say text:: | 356 /say text:: |
| 350 Send the "text" message to the currently selected buddy. Can be useful | 357 Send the "text" message to the currently selected buddy. Can be useful |
| 351 if you want to send a message beginning with a slash, for example. | 358 if you want to send a message beginning with a slash, for example. |
| 352 | 359 |