Mercurial > ~mikael > mcabber > hg
annotate mcabber/doc/mcabber.1.txt @ 639:3edd3687c38d
Update documentation
| author | Mikael Berthe <mikael@lilotux.net> |
|---|---|
| date | Wed, 28 Dec 2005 11:09:01 +0100 |
| parents | aff6df4b408b |
| children | ef7f0b58a159 |
| rev | line source |
|---|---|
| 198 | 1 MCABBER(1) |
| 2 =========== | |
| 222 | 3 Mikael BERTHE <mcabber@lilotux.net> |
| 630 | 4 v0.7.3-dev, January 2006 |
| 198 | 5 |
| 6 NAME | |
| 7 ---- | |
| 200 | 8 mcabber - a simple Jabber console client |
| 198 | 9 |
| 10 SYNOPSIS | |
| 11 -------- | |
| 12 'mcabber' [ -f configfile ] [ --help | -h ] | |
| 13 | |
| 14 DESCRIPTION | |
| 15 ----------- | |
| 204 | 16 `mcabber(1)` is a small Jabber console client. + |
| 200 | 17 For now it needs a configuration file to start, so please copy the sample |
| 208 | 18 mcabberrc file and adapt your connection settings. |
| 200 | 19 |
|
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
349
diff
changeset
|
20 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:
349
diff
changeset
|
21 it cannot (un)register accounts yet. |
|
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
349
diff
changeset
|
22 |
| 202 | 23 The `mcabber(1)` screen is divided into 4 regions. |
| 200 | 24 The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat |
| 25 buffer, is on the right. The 'input line' lies at the bottom of the screen, | |
| 26 under a small 'log window'. | |
| 27 | |
| 204 | 28 To display buddies chat buffers, you will have to enter 'chat mode'. |
| 29 You can enter chat mode by pressing enter, and leave chat mode with the ESC | |
| 229 | 30 key. Simply sending a message will also enable chat mode. |
| 204 | 31 |
| 32 Here are some of the features of `mcabber`: | |
| 200 | 33 |
| 204 | 34 - 'SSL support'. |
| 467 | 35 - 'MUC support' (Multi-User Chat). |
| 204 | 36 - 'History logging:' If enabled (see the CONFIGURATION FILE section), |
| 432 | 37 `mcabber` can save discussions to history log files. |
| 38 - 'Commands completion:' If possible, `mcabber` will try to complete your | |
| 229 | 39 command line if you hit the Tab key. |
| 618 | 40 - 'Input line history:' Any message or command entered is in the input line |
| 41 history and can be reused easily. | |
| 204 | 42 - 'External actions:' Some events (like receiving a message) can trigger an |
| 43 external action, for example a shell script (you need to enable it in your | |
| 432 | 44 configuration file). A sample events script ("eventcmd") is provided with |
| 45 `mcabber` source code, in the contrib directory. | |
| 200 | 46 |
| 47 OPTIONS | |
| 48 ------- | |
| 49 --help, -h:: | |
| 202 | 50 Quick help usage message |
| 200 | 51 |
| 52 -f configfile:: | |
| 202 | 53 Use configuration file 'configfile' |
| 200 | 54 |
| 55 KEYS | |
| 56 ---- | |
| 57 | |
| 229 | 58 Text typing occurs in the 'input line'; basic operations are supported |
| 59 (left arrow, right arrow, home/end keys, insert, delete, backspace...). | |
| 200 | 60 |
| 61 PageUp and PageDown keys are used to move in the roster. | |
| 62 | |
| 618 | 63 Up and Down arrow keys can be used to move in the input line history; they |
| 64 jump to the previous/next line from the history beginning with the same string | |
| 65 (from first column to the cursor column). | |
| 66 | |
| 200 | 67 To send a message, move to the choosen buddy in the buddylist, type your |
| 68 message and hit enter. If the line begins with a slash, this will be | |
| 69 interpreted as a command (see the COMMAND section below). Hit escape to | |
| 70 leave the chat mode. | |
| 71 | |
| 72 Here is a quick description of the key bindings: | |
| 73 | |
| 74 Ctrl-a:: Go to the beginning of the input line | |
| 75 Ctrl-e:: Go to the end of the input line | |
| 618 | 76 Ctrl-l:: Force a refresh |
| 77 Up/Down:: Move in the input line history | |
| 200 | 78 PgUp/PgDown:: Move inside the roster (buddylist) |
| 79 Tab:: Complete current word, in the input line | |
| 80 Ctrl-g:: Cancel completion / ctrl-g | |
| 81 Ctrl-p/Ctrl-n:: Scroll up/down half a screen in the buffer window (chat mode) | |
| 82 Ctrl-u:: Delete from beginning of the line to the cursor | |
| 83 Ctrl-k:: Delete from the cursor to the end of line | |
| 84 Ctrl-w:: Backward kill word | |
| 85 Ctrl-t:: Transpose chars | |
| 263 | 86 Ctrl-o:: Accept line and put the next history line in the input line (accept-line-and-down-history) |
| 236 | 87 Ctrl-q:: Jump to the next unread message |
| 198 | 88 |
| 199 | 89 COMMANDS |
| 90 -------- | |
| 91 | |
| 639 | 92 /add [jid [nickname]]:: |
| 491 | 93 Add the "jid" Jabber user to our roster (default group), and send a |
| 245 | 94 notification request to this buddy. If no nickname is specified, the |
| 639 | 95 jid is used. If no jid is provided (or jid is empty ""), the |
| 96 current buddy is used. | |
| 199 | 97 |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
98 /alias name = command line:: |
| 289 | 99 Add "name" as an alias for "command line". + |
| 100 Aliases are expanded only once, thus they can not be chained. + | |
| 101 "/alias name" displays the value associated with the "name" alias; | |
| 102 "/alias name =" unsets the "name" alias. + | |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
103 Example: "/alias away = status away". |
| 289 | 104 |
| 618 | 105 /authorization allow|cancel|request [jid]:: |
| 106 Manage the presence subscriptions. + | |
| 107 If no jid is provided, the current buddy is used. | |
| 108 | |
| 109 'allow';; allow the buddy to receive your presence updates | |
| 110 'cancel';; cancel the buddy' subscription to your presence updates | |
| 111 'request';; request a subscription to the buddy's presence updates | |
| 112 | |
| 289 | 113 /bind keycode = command line:: |
| 114 Bind a command line to the key with the "keycode" code number. + | |
| 432 | 115 Keycodes of unused keys are displayed by `mcabber` in the log window |
| 289 | 116 when pressing the key, for example "Unknown key=265". + |
| 117 "/bind keycode" displays the command line bound to the given keycode; | |
| 118 "/bind keycode" unbinds the given keycode. + | |
| 119 Note: aliases can be used in key bindings. + | |
| 450 | 120 Example: "/bind 265 = status online" (265 is F1 for me, but it may |
| 289 | 121 depend on your ncurses installation). |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
122 |
| 618 | 123 /buffer clear|top|bottom|date|%|search_backward|search_forward:: |
| 202 | 124 The 'buffer' command manipulates the current buddy's buffer |
| 125 (chat window). | |
| 199 | 126 |
|
465
52171a3dc199
Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents:
450
diff
changeset
|
127 'clear';; clear the current buddy chat window |
| 511 | 128 'bottom';; jump to the bottom of the current buddy chat buffer |
|
465
52171a3dc199
Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents:
450
diff
changeset
|
129 'top';; jump to the top of the current buddy chat buffer |
| 511 | 130 'up' [n];; scroll the buffer up n lines (default: half a screen) |
| 131 'down' [n];; scroll the buffer down n lines (default: half a screen) | |
| 618 | 132 'date' date;; jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional) |
| 133 '%' n;; jump to position %n of the buddy chat buffer | |
| 491 | 134 'search_backward' text;; search for "text" in the current buddy chat buffer |
| 135 'search_forward' text;; search for "text" in the current buddy chat buffer | |
| 199 | 136 |
| 137 /clear:: | |
| 206 | 138 The 'clear' command is actually an alias for "/buffer clear". |
| 199 | 139 |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
140 /connect:: |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
141 Establish connection to the Jabber server. |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
142 |
| 205 | 143 /del:: |
| 144 Delete the current buddy from our roster, unsubscribe from its presence | |
| 145 notification and unsubscribe it from ours. | |
| 146 | |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
147 /disconnect:: |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
148 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
|
149 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
|
150 buddylist is empty when disconnected. |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
151 |
| 240 | 152 /group fold|unfold|toggle:: |
| 153 The 'group' command changes the current group display. | |
| 199 | 154 |
| 637 | 155 'fold';; fold (shrink) the current group tree in the roster |
| 240 | 156 'unfold';; unfold (expand) the current group tree in the roster |
| 157 'toggle';; toggle the state (fold/unfold) of the current tree | |
| 199 | 158 |
| 159 /info:: | |
|
440
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
160 Display info on the selected entry (user, agent, group...). + |
|
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
161 For users, resources are displayed with the status, priority and |
|
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
162 status message (if available) of each resource. |
| 199 | 163 |
| 210 | 164 /move [groupname]:: |
| 165 Move the current buddy to the requested group. If no group is | |
| 623 | 166 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:
497
diff
changeset
|
167 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:
497
diff
changeset
|
168 to jump to the moved buddy. |
| 210 | 169 |
| 637 | 170 /msay begin|verbatim|send|send_to|abort:: |
| 238 | 171 Send a multi-line message. To write a single message with several |
| 289 | 172 lines, the 'multi-line mode' should be used. + |
| 173 In multi-line mode, each line (except command lines) typed in the input | |
| 174 line will be added to the multi-line message. Once the message is | |
| 450 | 175 finished, it can be sent to the current selected buddy with the "/msay |
| 176 send" command. + | |
| 289 | 177 The 'verbatim' multi-line mode disables commands, so that it is |
| 178 possible to enter lines starting with a slash. Only the "/msay" | |
| 179 command (with send or abort parameters) can be used to exit verbatim | |
| 180 mode. | |
| 238 | 181 |
| 637 | 182 'begin';; enter multi-line mode |
| 183 'verbatim';; enter verbatim multi-line mode | |
| 184 'send';; send the current multi-line message to the currently selected buddy | |
| 185 'send_to' jid;; send the current multi-line message to "jid" | |
| 186 'abort';; leave multi-line mode without sending the message | |
| 238 | 187 |
| 199 | 188 /quit:: |
| 208 | 189 Disconnect and leave `mcabber(1)`. |
| 190 | |
| 436 | 191 /rawxml send:: |
| 192 'send' 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. | |
| 193 | |
| 208 | 194 /rename nickname:: |
| 195 Rename current buddy to the given nickname. | |
| 229 | 196 This command does not work for groups, at the moment (but you can move |
| 450 | 197 the buddies to another group with the "/move" command). |
| 198 | |
| 601 | 199 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy:: |
| 593 | 200 /room invite|kick|ban|role|affil:: |
| 450 | 201 The 'room' command handles Multi-User Chat room actions. |
| 202 | |
| 487 | 203 'join' room nick;; join "room", using "nick" as nickname |
| 204 'leave' [message];; leave the current room | |
| 205 'names';; display members of the current room | |
| 206 'nick' nick;; change your nickname in the current room | |
| 491 | 207 'privmsg' nick msg;; send private message "msg" to "nick" |
| 487 | 208 'remove';; remove the current room from the roster (you must have left this room before) |
| 209 'topic';; set topic for current room | |
| 210 'unlock';; unlock current room (if you are the owner) | |
| 601 | 211 'destroy' [reason];; destroy the current room (use with care!) |
| 573 | 212 'whois' nick;; display MUC information about "nick" |
| 593 | 213 'ban' jid [reason];; ban jid from the current room |
| 214 'invite' jid [reason];; invite jid to the current room | |
| 215 'kick' nick [reason];; kick "nick" from the current room | |
| 216 'role' jid role [reason];; change jid's role (role can be "none", "visitor", "participant", "moderator") | |
| 217 'affil' jid affil [reason];; change jid's affiliation (affil can be "none", "member", "admin", "owner") | |
| 199 | 218 |
| 330 | 219 /roster bottom|top|hide_offline|show_offline|toggle_offline:: |
| 220 /roster alternate|unread_first|unread_next:: | |
| 265 | 221 /roster search bud:: |
| 222 The 'roster' command manipulates the roster/buddylist. Here are the available parameters: | |
| 199 | 223 |
| 265 | 224 'bottom';; jump to the bottom of the roster |
| 225 'top';; jump to the top of the roster | |
|
377
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
226 'up';; move up in the roster |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
227 'down';; move down in the roster |
| 202 | 228 'hide_offline';; hide offline buddies |
| 229 'show_offline';; show offline buddies | |
|
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
230 'toggle_offline';; toggle display of offline buddies |
| 265 | 231 'search' bud;; search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) |
| 330 | 232 '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") |
| 236 | 233 'unread_first';; jump to the first unread message |
| 234 'unread_next';; jump to the next unread message | |
| 199 | 235 |
| 236 /say text:: | |
| 491 | 237 Send the "text" message to the currently selected buddy. Can be useful |
| 199 | 238 if you want to send a message beginning with a slash, for example. |
| 239 | |
| 480 | 240 /say_to jid text:: |
| 491 | 241 Send the "text" message to the specified jid. |
| 480 | 242 Please note that this command doesn't set the default resource for |
| 243 a contact, so if you want to send several messages to a specific | |
| 244 ressource you will have to use "/say_to" for each message. | |
| 245 | |
| 522 | 246 /status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]]:: |
| 247 Show or set the current status. + | |
| 248 If no status is specified, display the current status. + | |
|
320
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
310
diff
changeset
|
249 If a status message is specified, it will overrride the message* |
| 522 | 250 variables (these variables can be set in the configuration file). |
| 251 If no relevant message* variable is set and no status message provided, | |
| 252 the current status message is kept. If StatusMessage is "-", the | |
| 253 current status message is cleared. | |
| 199 | 254 |
| 450 | 255 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]:: |
| 256 Send the requested status to the specified Jabber user. + | |
| 257 Note: this status will be overridden by subsequent "/status" commands. | |
| 258 If you are using the auto-away feature, the status will overridden | |
| 259 too. + | |
| 260 Note: The jid can include a resource (i.e. user@server/resource). | |
| 261 | |
| 623 | 262 /version:: |
| 263 Display mcabber version | |
| 264 | |
| 199 | 265 CONFIGURATION FILE |
| 266 ------------------ | |
| 267 See the provided sample configuration file, which should be self-documented. | |
| 198 | 268 |
| 200 | 269 FILES |
| 270 ----- | |
| 202 | 271 The following files can be used by `mcabber(1)`: |
| 200 | 272 |
| 273 $HOME/.mcabber/mcabberrc Default configuration file | |
| 274 $HOME/.mcabberrc Configuration file used if no other has been found | |
| 275 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled | |
| 276 | |
| 198 | 277 BUGS |
| 278 ---- | |
| 349 | 279 Certainly. Please tell me if you find one! :-) |
| 198 | 280 |
| 281 AUTHOR | |
| 282 ------ | |
| 222 | 283 Written by mailto:mcabber@lilotux.net[Mikael BERTHE]. + |
| 204 | 284 Originally based on http://cabber.sourceforge.net[Cabber], please |
| 198 | 285 consult the AUTHORS file for details. |
| 286 | |
| 287 RESOURCES | |
| 288 --------- | |
| 202 | 289 http://www.lilotux.net/~mikael/mcabber/[Main web site] |
| 198 | 290 |
| 291 COPYING | |
| 292 ------- | |
| 202 | 293 Copyright (C) 2005 Mikael Berthe. + |
| 294 Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[]. | |
| 198 | 295 |
| 296 Free use of this software is granted under the terms of the GNU General Public | |
| 297 License (GPL). | |
| 298 |