Mercurial > ~mikael > mcabber > hg
annotate mcabber/doc/mcabber.1.txt @ 349:3f5e7962bb47
A lot of bugs? No! ;-)
| author | Mikael Berthe <mikael@lilotux.net> |
|---|---|
| date | Thu, 21 Jul 2005 21:35:49 +0100 |
| parents | 08ac3b696fad |
| children | 20283b69db99 |
| rev | line source |
|---|---|
| 198 | 1 MCABBER(1) |
| 2 =========== | |
| 222 | 3 Mikael BERTHE <mcabber@lilotux.net> |
| 347 | 4 v0.6.5-dev, July 2005 |
| 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 |
| 202 | 20 The `mcabber(1)` screen is divided into 4 regions. |
| 200 | 21 The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat |
| 22 buffer, is on the right. The 'input line' lies at the bottom of the screen, | |
| 23 under a small 'log window'. | |
| 24 | |
| 204 | 25 To display buddies chat buffers, you will have to enter 'chat mode'. |
| 26 You can enter chat mode by pressing enter, and leave chat mode with the ESC | |
| 229 | 27 key. Simply sending a message will also enable chat mode. |
| 204 | 28 |
| 29 Here are some of the features of `mcabber`: | |
| 200 | 30 |
| 204 | 31 - 'SSL support'. |
| 32 - 'History logging:' If enabled (see the CONFIGURATION FILE section), | |
| 33 `mcabber(1)` can save discussions to history log files. | |
| 34 - 'Commands completion:' If possible, `mcabber(1)` will try to complete your | |
| 229 | 35 command line if you hit the Tab key. |
| 204 | 36 - 'External actions:' Some events (like receiving a message) can trigger an |
| 37 external action, for example a shell script (you need to enable it in your | |
| 38 configuration file). | |
| 200 | 39 |
| 40 OPTIONS | |
| 41 ------- | |
| 42 --help, -h:: | |
| 202 | 43 Quick help usage message |
| 200 | 44 |
| 45 -f configfile:: | |
| 202 | 46 Use configuration file 'configfile' |
| 200 | 47 |
| 48 KEYS | |
| 49 ---- | |
| 50 | |
| 229 | 51 Text typing occurs in the 'input line'; basic operations are supported |
| 52 (left arrow, right arrow, home/end keys, insert, delete, backspace...). | |
| 200 | 53 |
| 54 PageUp and PageDown keys are used to move in the roster. | |
| 55 | |
| 56 To send a message, move to the choosen buddy in the buddylist, type your | |
| 57 message and hit enter. If the line begins with a slash, this will be | |
| 58 interpreted as a command (see the COMMAND section below). Hit escape to | |
| 59 leave the chat mode. | |
| 60 | |
| 61 Here is a quick description of the key bindings: | |
| 62 | |
| 63 Ctrl-a:: Go to the beginning of the input line | |
| 64 Ctrl-e:: Go to the end of the input line | |
| 65 Ctrl-l:: Force a resize | |
| 66 PgUp/PgDown:: Move inside the roster (buddylist) | |
| 67 Tab:: Complete current word, in the input line | |
| 68 Ctrl-g:: Cancel completion / ctrl-g | |
| 69 Ctrl-p/Ctrl-n:: Scroll up/down half a screen in the buffer window (chat mode) | |
| 70 Ctrl-u:: Delete from beginning of the line to the cursor | |
| 71 Ctrl-k:: Delete from the cursor to the end of line | |
| 72 Ctrl-w:: Backward kill word | |
| 73 Ctrl-t:: Transpose chars | |
| 263 | 74 Ctrl-o:: Accept line and put the next history line in the input line (accept-line-and-down-history) |
| 236 | 75 Ctrl-q:: Jump to the next unread message |
| 198 | 76 |
| 199 | 77 COMMANDS |
| 78 -------- | |
| 79 | |
| 245 | 80 /add jid [nickname]:: |
| 81 Add the 'jid' Jabber user to our roster (default group), and send a | |
| 82 notification request to this buddy. If no nickname is specified, the | |
| 83 jid is used. | |
| 199 | 84 |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
85 /alias name = command line:: |
| 289 | 86 Add "name" as an alias for "command line". + |
| 87 Aliases are expanded only once, thus they can not be chained. + | |
| 88 "/alias name" displays the value associated with the "name" alias; | |
| 89 "/alias name =" unsets the "name" alias. + | |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
90 Example: "/alias away = status away". |
| 289 | 91 |
| 92 /bind keycode = command line:: | |
| 93 Bind a command line to the key with the "keycode" code number. + | |
| 94 Keycodes of unused keys are displayed by mcabber in the log window | |
| 95 when pressing the key, for example "Unknown key=265". + | |
| 96 "/bind keycode" displays the command line bound to the given keycode; | |
| 97 "/bind keycode" unbinds the given keycode. + | |
| 98 Note: aliases can be used in key bindings. + | |
| 99 Example: "/bind 265 = status online" (265 is F1 for me, but it can | |
| 100 depend on your ncurses installation). | |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
101 |
| 199 | 102 /buffer clear|top|bottom:: |
| 202 | 103 The 'buffer' command manipulates the current buddy's buffer |
| 104 (chat window). | |
| 199 | 105 |
| 202 | 106 'clear';; clear the current buddy chat window |
| 107 'top';; jump to the top of the current buddy chat buffer | |
| 108 'bottom';; jump to the bottom of the current buddy chat buffer | |
| 199 | 109 |
| 110 /clear:: | |
| 206 | 111 The 'clear' command is actually an alias for "/buffer clear". |
| 199 | 112 |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
113 /connect:: |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
114 Establish connection to the Jabber server. |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
115 |
| 205 | 116 /del:: |
| 117 Delete the current buddy from our roster, unsubscribe from its presence | |
| 118 notification and unsubscribe it from ours. | |
| 119 | |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
120 /disconnect:: |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
121 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
|
122 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
|
123 buddylist is empty when disconnected. |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
124 |
| 240 | 125 /group fold|unfold|toggle:: |
| 126 The 'group' command changes the current group display. | |
| 199 | 127 |
| 240 | 128 'fold';; fold (shrink) the current group tree in the roster |
| 129 'unfold';; unfold (expand) the current group tree in the roster | |
| 130 'toggle';; toggle the state (fold/unfold) of the current tree | |
| 199 | 131 |
| 132 /info:: | |
| 208 | 133 Display info on the selected entry (user, agent, group...). |
| 199 | 134 |
| 210 | 135 /move [groupname]:: |
| 136 Move the current buddy to the requested group. If no group is | |
| 137 specified, then the buddy is moved to the default group. | |
| 229 | 138 This command only works with users (not agents), at the moment. |
| 210 | 139 |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
140 /msay begin|verbatim|send|abort:: |
| 238 | 141 Send a multi-line message. To write a single message with several |
| 289 | 142 lines, the 'multi-line mode' should be used. + |
| 143 In multi-line mode, each line (except command lines) typed in the input | |
| 144 line will be added to the multi-line message. Once the message is | |
| 145 finished, it can be sent to the current selected buddy with the "msay | |
| 146 /send" command. + | |
| 147 The 'verbatim' multi-line mode disables commands, so that it is | |
| 148 possible to enter lines starting with a slash. Only the "/msay" | |
| 149 command (with send or abort parameters) can be used to exit verbatim | |
| 150 mode. | |
| 238 | 151 |
| 152 'begin';; enter multi-line mode | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
153 'verbatim';; enter verbatim multi-line mode |
| 238 | 154 'send';; send the current multi-line message to the currently selected buddy |
| 155 'abort';; leave multi-line mode without sending the message | |
| 156 | |
| 199 | 157 /quit:: |
| 208 | 158 Disconnect and leave `mcabber(1)`. |
| 159 | |
| 160 /rename nickname:: | |
| 161 Rename current buddy to the given nickname. | |
| 229 | 162 This command does not work for groups, at the moment (but you can move |
| 210 | 163 the buddies to another group with the /move command). |
| 199 | 164 |
| 330 | 165 /roster bottom|top|hide_offline|show_offline|toggle_offline:: |
| 166 /roster alternate|unread_first|unread_next:: | |
| 265 | 167 /roster search bud:: |
| 168 The 'roster' command manipulates the roster/buddylist. Here are the available parameters: | |
| 199 | 169 |
| 265 | 170 'bottom';; jump to the bottom of the roster |
| 171 'top';; jump to the top of the roster | |
| 202 | 172 'hide_offline';; hide offline buddies |
| 173 'show_offline';; show offline buddies | |
|
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
174 'toggle_offline';; toggle display of offline buddies |
| 265 | 175 'search' bud;; search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) |
| 330 | 176 '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 | 177 'unread_first';; jump to the first unread message |
| 178 'unread_next';; jump to the next unread message | |
| 199 | 179 |
| 180 /say text:: | |
| 202 | 181 Send the text message to the currently selected buddy. Can be useful |
| 199 | 182 if you want to send a message beginning with a slash, for example. |
| 183 | |
|
320
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
310
diff
changeset
|
184 /status [online|avail|invisible|free|dnd|notavail|away [StatusMessage]]:: |
| 199 | 185 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:
310
diff
changeset
|
186 current status. + |
|
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
310
diff
changeset
|
187 If a status message is specified, it will overrride the message* |
|
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
310
diff
changeset
|
188 variables. |
| 199 | 189 |
| 190 CONFIGURATION FILE | |
| 191 ------------------ | |
| 192 See the provided sample configuration file, which should be self-documented. | |
| 198 | 193 |
| 200 | 194 FILES |
| 195 ----- | |
| 202 | 196 The following files can be used by `mcabber(1)`: |
| 200 | 197 |
| 198 $HOME/.mcabber/mcabberrc Default configuration file | |
| 199 $HOME/.mcabberrc Configuration file used if no other has been found | |
| 200 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled | |
| 201 | |
| 198 | 202 BUGS |
| 203 ---- | |
| 349 | 204 Certainly. Please tell me if you find one! :-) |
| 198 | 205 |
| 206 AUTHOR | |
| 207 ------ | |
| 222 | 208 Written by mailto:mcabber@lilotux.net[Mikael BERTHE]. + |
| 204 | 209 Originally based on http://cabber.sourceforge.net[Cabber], please |
| 198 | 210 consult the AUTHORS file for details. |
| 211 | |
| 212 RESOURCES | |
| 213 --------- | |
| 202 | 214 http://www.lilotux.net/~mikael/mcabber/[Main web site] |
| 198 | 215 |
| 216 COPYING | |
| 217 ------- | |
| 202 | 218 Copyright (C) 2005 Mikael Berthe. + |
| 219 Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[]. | |
| 198 | 220 |
| 221 Free use of this software is granted under the terms of the GNU General Public | |
| 222 License (GPL). | |
| 223 |