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