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