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