Mercurial > hg
annotate mcabber/doc/mcabber.1 @ 450:fa93f47a08fe
Update manual page
* Add /room and /status_to documentation
* Some other corrections
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Mon, 26 Sep 2005 00:24:22 +0200 |
parents | 264f40222872 |
children | 52171a3dc199 |
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 |
450 | 117 Add "name" as an alias for "command line"\&. |
118 | |
119 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\&. | |
120 | |
121 Example: "/alias away = status away"\&. | |
289 | 122 |
123 .TP | |
124 \fB/bind\fR keycode = command line | |
450 | 125 Bind a command line to the key with the "keycode" code number\&. |
126 | |
127 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\&. | |
128 | |
129 Note: aliases can be used in key bindings\&. | |
130 | |
131 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
|
132 |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
133 .TP |
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
134 \fB/buffer\fR clear|top|bottom|search_backward|search_forward |
226 | 135 The buffer command manipulates the current buddy's buffer (chat window)\&. |
136 | |
229 | 137 \fBclear\fR clear the current buddy chat window |
265 | 138 \fBtop\fR jump to the top of the current buddy chat buffer |
229 | 139 \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
|
140 \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
|
141 \fBsearch_forward\fR text search for text in the current buddy chat buffer |
226 | 142 |
143 .TP | |
229 | 144 \fB/clear\fR |
227 | 145 The clear command is actually an alias for "/buffer clear"\&. |
146 | |
147 .TP | |
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
148 \fB/connect\fR |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
149 Establish connection to the Jabber server\&. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
150 |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
151 .TP |
229 | 152 \fB/del\fR |
227 | 153 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&. |
226 | 154 |
155 .TP | |
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
156 \fB/disconnect\fR |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
157 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
|
158 |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
159 .TP |
240 | 160 \fB/group\fR fold|unfold|toggle |
161 The group command changes the current group display\&. | |
226 | 162 |
265 | 163 \fBfold\fR fold (shrink) the current group tree in the roster |
164 \fBunfold\fR unfold (expand) the current group tree in the roster | |
165 \fBtoggle\fR toggle the state (fold/unfold) of the current tree | |
226 | 166 |
167 .TP | |
229 | 168 \fB/info\fR |
440
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
169 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 | 170 |
171 .TP | |
229 | 172 \fB/move\fR [groupname] |
173 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 | 174 |
175 .TP | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
245
diff
changeset
|
176 \fB/msay\fR begin|verbatim|send|abort |
450 | 177 Send a multi\-line message\&. To write a single message with several lines, the \fImulti\-line mode\fR should be used\&. |
178 | |
179 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\&. | |
180 | |
181 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 | 182 |
265 | 183 \fBbegin\fR enter multi\-line mode |
184 \fBverbatim\fR enter verbatim multi\-line mode | |
185 \fBsend\fR send the current multi\-line message to the currently selected buddy | |
186 \fBabort\fR leave multi\-line mode without sending the message | |
226 | 187 |
188 .TP | |
436 | 189 \fB/rawxml\fR send |
190 \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\&. | |
191 | |
192 .TP | |
229 | 193 \fB/rename\fR nickname |
450 | 194 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)\&. |
195 | |
196 | |
197 .TP | |
198 \fB/room\fR join|leave|names|remove | |
199 The room command handles Multi\-User Chat room actions\&. | |
200 | |
201 \fBjoin\fR room nick join "room", using "nick" as nickname | |
202 \fBleave\fR leave the current room | |
203 \fBnames\fR display members of the current room | |
204 \fBremove\fR remove the current room from the roster\&. You must have left this room before\&. | |
226 | 205 |
206 .TP | |
265 | 207 \fB/roster\fR |
208 The roster command manipulates the roster/buddylist\&. Here are the available parameters: | |
229 | 209 |
265 | 210 \fBbottom\fR jump to the bottom of the roster |
211 \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
|
212 \fBup\fR move up in the roster |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
213 \fBdown\fR move down in the roster |
265 | 214 \fBhide_offline\fR hide offline buddies |
215 \fBshow_offline\fR show offline buddies | |
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
216 \fBtoggle_offline\fR toggle display of offline buddies |
265 | 217 \fBsearch\fR bud search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) |
330 | 218 \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 | 219 \fBunread_first\fR jump to the first unread message |
220 \fBunread_next\fR jump to the next unread message | |
229 | 221 |
222 .TP | |
223 \fB/say\fR text | |
226 | 224 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\&. |
225 | |
226 .TP | |
320
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
300
diff
changeset
|
227 \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
|
228 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 | 229 |
450 | 230 .TP |
231 \fB/status_to\fR jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] | |
232 Send the requested status to the specified Jabber user\&. | |
233 | |
234 Note: this status will be overridden by subsequent "/status" commands\&. If you are using the auto\-away feature, the status will overridden too\&. | |
235 | |
236 Note: The jid can include a resource (i\&.e\&. user@server/resource)\&. | |
237 | |
226 | 238 .SH "CONFIGURATION FILE" |
239 | |
240 | |
241 See the provided sample configuration file, which should be self\-documented\&. | |
242 | |
243 .SH "FILES" | |
244 | |
245 | |
246 The following files can be used by mcabber(1): | |
247 | |
248 .nf | |
249 | |
250 $HOME/\&.mcabber/mcabberrc Default configuration file | |
251 $HOME/\&.mcabberrc Configuration file used if no other has been found | |
252 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled | |
253 | |
254 .fi | |
255 | |
256 .SH "BUGS" | |
257 | |
258 | |
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
330
diff
changeset
|
259 Certainly\&. Please tell me if you find one! :\-) |
226 | 260 |
261 .SH "AUTHOR" | |
262 | |
263 | |
229 | 264 Written by Mikael BERTHE <\fImcabber@lilotux.net\fR>\&. |
265 Originally based on cabber (Cabber homepage: <\fIhttp://cabber.sourceforge.net\fR>), please consult the AUTHORS file for details\&. | |
226 | 266 |
267 .SH "RESOURCES" | |
268 | |
269 | |
229 | 270 Main web site: <\fIhttp://www.lilotux.net/~mikael/mcabber/\fR> |
226 | 271 |
272 .SH "COPYING" | |
273 | |
274 | |
229 | 275 Copyright (C) 2005 Mikael Berthe\&. |
276 | |
277 Some portions are Copyright (C) 2002\-2004 <cabber@ajmacias\&.com>\&. | |
226 | 278 |
279 | |
280 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. | |
281 |