Mercurial > ~mikael > mcabber > hg
annotate mcabber/doc/mcabber.1 @ 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 | 00809e3e327e |
| children | 802da817a684 |
| 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 | |
| 432 | 50 History logging: If enabled (see the CONFIGURATION FILE section), mcabber can save discussions to history log files\&. |
| 226 | 51 .TP |
| 52 \(bu | |
| 432 | 53 Commands completion: If possible, mcabber will try to complete your command line if you hit the Tab key\&. |
| 226 | 54 .TP |
| 55 \(bu | |
| 432 | 56 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 | 57 .LP |
| 58 | |
| 59 .SH "OPTIONS" | |
| 60 | |
| 61 .TP | |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
62 \-\-help, \-h |
| 226 | 63 Quick help usage message |
| 64 | |
| 65 .TP | |
| 66 \-f configfile | |
| 67 Use configuration file configfile | |
| 68 | |
| 69 .SH "KEYS" | |
| 70 | |
| 71 | |
| 229 | 72 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&. |
| 226 | 73 |
| 74 | |
| 75 PageUp and PageDown keys are used to move in the roster\&. | |
| 76 | |
| 77 | |
| 78 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\&. | |
| 79 | |
| 80 Here is a quick description of the key bindings: | |
| 81 | |
| 229 | 82 Ctrl\-a Go to the beginning of the input line |
| 226 | 83 |
| 229 | 84 Ctrl\-e Go to the end of the input line |
| 226 | 85 |
| 229 | 86 Ctrl\-l Force a resize |
| 226 | 87 |
| 229 | 88 PgUp/PgDown Move inside the roster (buddylist) |
| 226 | 89 |
| 229 | 90 Tab Complete current word, in the input line |
| 226 | 91 |
| 229 | 92 Ctrl\-g Cancel completion / ctrl\-g |
| 226 | 93 |
| 229 | 94 Ctrl\-p/Ctrl\-n Scroll up/down half a screen in the buffer window (chat mode) |
| 226 | 95 |
| 229 | 96 Ctrl\-u Delete from beginning of the line to the cursor |
| 226 | 97 |
| 229 | 98 Ctrl\-k Delete from the cursor to the end of line |
| 226 | 99 |
| 229 | 100 Ctrl\-w Backward kill word |
| 226 | 101 |
| 229 | 102 Ctrl\-t Transpose chars |
| 226 | 103 |
| 263 | 104 Ctrl\-o Accept line and put the next history line in the input line (accept\-line\-and\-down\-history) |
| 105 | |
| 236 | 106 Ctrl\-q Jump to the next unread message |
| 226 | 107 |
| 108 | |
| 109 .SH "COMMANDS" | |
| 110 | |
| 111 .TP | |
| 245 | 112 \fB/add\fR jid [nickname] |
| 113 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 | 114 |
| 115 .TP | |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
116 \fB/alias\fR name = command line |
| 289 | 117 Add "name" as an alias for "command line"\&. 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\&. Example: "/alias away = status away"\&. |
| 118 | |
| 119 .TP | |
| 120 \fB/bind\fR keycode = command line | |
| 121 Bind a command line to the key with the "keycode" code number\&. 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\&. Note: aliases can be used in key bindings\&. Example: "/bind 265 = status online" (265 is F1 for me, but it can depend on your ncurses installation)\&. | |
|
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
122 |
|
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
123 .TP |
|
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
124 \fB/buffer\fR clear|top|bottom|search_backward|search_forward |
| 226 | 125 The buffer command manipulates the current buddy's buffer (chat window)\&. |
| 126 | |
| 229 | 127 \fBclear\fR clear the current buddy chat window |
| 265 | 128 \fBtop\fR jump to the top of the current buddy chat buffer |
| 229 | 129 \fBbottom\fR jump to the bottom of the current buddy chat buffer |
|
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
130 \fBsearch_backward\fR 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
|
131 \fBsearch_forward\fR text search for text in the current buddy chat buffer |
| 226 | 132 |
| 133 .TP | |
| 229 | 134 \fB/clear\fR |
| 227 | 135 The clear command is actually an alias for "/buffer clear"\&. |
| 136 | |
| 137 .TP | |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
138 \fB/connect\fR |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
139 Establish connection to the Jabber server\&. |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
140 |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
141 .TP |
| 229 | 142 \fB/del\fR |
| 227 | 143 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&. |
| 226 | 144 |
| 145 .TP | |
|
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
146 \fB/disconnect\fR |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
147 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
|
148 |
|
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
149 .TP |
| 240 | 150 \fB/group\fR fold|unfold|toggle |
| 151 The group command changes the current group display\&. | |
| 226 | 152 |
| 265 | 153 \fBfold\fR fold (shrink) the current group tree in the roster |
| 154 \fBunfold\fR unfold (expand) the current group tree in the roster | |
| 155 \fBtoggle\fR toggle the state (fold/unfold) of the current tree | |
| 226 | 156 |
| 157 .TP | |
| 229 | 158 \fB/info\fR |
| 227 | 159 Display info on the selected entry (user, agent, group...)\&. |
| 160 | |
| 161 .TP | |
| 229 | 162 \fB/move\fR [groupname] |
| 163 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\&. | |
| 226 | 164 |
| 165 .TP | |
|
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
245
diff
changeset
|
166 \fB/msay\fR begin|verbatim|send|abort |
|
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
245
diff
changeset
|
167 Send a multi\-line message\&. To write a single message with several lines, the \fImulti\-line mode\fR should be used\&. 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\&. 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 | 168 |
| 265 | 169 \fBbegin\fR enter multi\-line mode |
| 170 \fBverbatim\fR enter verbatim multi\-line mode | |
| 171 \fBsend\fR send the current multi\-line message to the currently selected buddy | |
| 172 \fBabort\fR leave multi\-line mode without sending the message | |
| 226 | 173 |
| 174 .TP | |
| 229 | 175 \fB/rename\fR nickname |
| 176 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)\&. | |
| 226 | 177 |
| 178 .TP | |
| 265 | 179 \fB/roster\fR |
| 180 The roster command manipulates the roster/buddylist\&. Here are the available parameters: | |
| 229 | 181 |
| 265 | 182 \fBbottom\fR jump to the bottom of the roster |
| 183 \fBtop\fR jump to the top of the roster | |
|
377
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
184 \fBup\fR move up in the roster |
|
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
185 \fBdown\fR move down in the roster |
| 265 | 186 \fBhide_offline\fR hide offline buddies |
| 187 \fBshow_offline\fR show offline buddies | |
|
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
188 \fBtoggle_offline\fR toggle display of offline buddies |
| 265 | 189 \fBsearch\fR bud search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) |
| 330 | 190 \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 | 191 \fBunread_first\fR jump to the first unread message |
| 192 \fBunread_next\fR jump to the next unread message | |
| 229 | 193 |
| 194 .TP | |
| 195 \fB/say\fR text | |
| 226 | 196 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\&. |
| 197 | |
| 198 .TP | |
|
320
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
300
diff
changeset
|
199 \fB/status\fR [online|avail|invisible|free|dnd|notavail|away [StatusMessage]] |
|
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
300
diff
changeset
|
200 Set the current status\&. If no status is specified, display the current status\&. If a status message is specified, it will overrride the message* variables\&. |
| 226 | 201 |
| 202 .SH "CONFIGURATION FILE" | |
| 203 | |
| 204 | |
| 205 See the provided sample configuration file, which should be self\-documented\&. | |
| 206 | |
| 207 .SH "FILES" | |
| 208 | |
| 209 | |
| 210 The following files can be used by mcabber(1): | |
| 211 | |
| 212 .nf | |
| 213 | |
| 214 $HOME/\&.mcabber/mcabberrc Default configuration file | |
| 215 $HOME/\&.mcabberrc Configuration file used if no other has been found | |
| 216 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled | |
| 217 | |
| 218 .fi | |
| 219 | |
| 220 .SH "BUGS" | |
| 221 | |
| 222 | |
|
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
330
diff
changeset
|
223 Certainly\&. Please tell me if you find one! :\-) |
| 226 | 224 |
| 225 .SH "AUTHOR" | |
| 226 | |
| 227 | |
| 229 | 228 Written by Mikael BERTHE <\fImcabber@lilotux.net\fR>\&. |
| 229 Originally based on cabber (Cabber homepage: <\fIhttp://cabber.sourceforge.net\fR>), please consult the AUTHORS file for details\&. | |
| 226 | 230 |
| 231 .SH "RESOURCES" | |
| 232 | |
| 233 | |
| 229 | 234 Main web site: <\fIhttp://www.lilotux.net/~mikael/mcabber/\fR> |
| 226 | 235 |
| 236 .SH "COPYING" | |
| 237 | |
| 238 | |
| 229 | 239 Copyright (C) 2005 Mikael Berthe\&. |
| 240 | |
| 241 Some portions are Copyright (C) 2002\-2004 <cabber@ajmacias\&.com>\&. | |
| 226 | 242 |
| 243 | |
| 244 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. | |
| 245 |