Mercurial > hg
annotate mcabber/doc/mcabber.1 @ 700:3f3c5765a459
Update documentation
Add /request documentation to the manual page.
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Sun, 12 Feb 2006 11:40:11 +0100 |
parents | ef7f0b58a159 |
children | 0311d7e2bb1c |
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 | |
618 | 59 Input line history: Any message or command entered is in the input line history and can be reused easily\&. |
60 .TP | |
61 \(bu | |
432 | 62 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 | 63 .LP |
64 | |
65 .SH "OPTIONS" | |
66 | |
67 .TP | |
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
68 \-\-help, \-h |
226 | 69 Quick help usage message |
70 | |
71 .TP | |
72 \-f configfile | |
73 Use configuration file configfile | |
74 | |
75 .SH "KEYS" | |
76 | |
77 | |
229 | 78 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&. |
226 | 79 |
80 | |
81 PageUp and PageDown keys are used to move in the roster\&. | |
82 | |
83 | |
618 | 84 Up and Down arrow keys can be used to move in the input line history; they jump to the previous/next line from the history beginning with the same string (from first column to the cursor column)\&. |
85 | |
86 | |
226 | 87 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\&. |
88 | |
89 Here is a quick description of the key bindings: | |
90 | |
229 | 91 Ctrl\-a Go to the beginning of the input line |
226 | 92 |
229 | 93 Ctrl\-e Go to the end of the input line |
226 | 94 |
618 | 95 Ctrl\-l Force a refresh |
96 | |
97 Up/Down Move in the input line history | |
226 | 98 |
229 | 99 PgUp/PgDown Move inside the roster (buddylist) |
226 | 100 |
618 | 101 Tab Complete current word, in the input line |
226 | 102 |
229 | 103 Ctrl\-g Cancel completion / ctrl\-g |
226 | 104 |
229 | 105 Ctrl\-p/Ctrl\-n Scroll up/down half a screen in the buffer window (chat mode) |
226 | 106 |
229 | 107 Ctrl\-u Delete from beginning of the line to the cursor |
226 | 108 |
229 | 109 Ctrl\-k Delete from the cursor to the end of line |
226 | 110 |
229 | 111 Ctrl\-w Backward kill word |
226 | 112 |
229 | 113 Ctrl\-t Transpose chars |
226 | 114 |
263 | 115 Ctrl\-o Accept line and put the next history line in the input line (accept\-line\-and\-down\-history) |
116 | |
236 | 117 Ctrl\-q Jump to the next unread message |
226 | 118 |
119 | |
120 .SH "COMMANDS" | |
121 | |
122 .TP | |
639 | 123 \fB/add\fR [jid [nickname]] |
660 | 124 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\&. If no jid (or an empty string "") is provided or if jid is "\&.", the current buddy is used\&. |
226 | 125 |
126 .TP | |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
127 \fB/alias\fR name = command line |
450 | 128 Add "name" as an alias for "command line"\&. |
129 | |
130 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\&. | |
131 | |
132 Example: "/alias away = status away"\&. | |
289 | 133 |
134 .TP | |
618 | 135 \fB/authorization\fR allow|cancel|request [jid] |
136 Manage the presence subscriptions\&. | |
137 | |
138 If no jid is provided, the current buddy is used\&. | |
139 | |
140 \fBallow\fR allow the buddy to receive your presence updates | |
141 \fBcancel\fR cancel the buddy' subscription to your presence updates | |
142 \fBrequest\fR request a subscription to the buddy's presence updates | |
143 | |
144 .TP | |
289 | 145 \fB/bind\fR keycode = command line |
450 | 146 Bind a command line to the key with the "keycode" code number\&. |
147 | |
148 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\&. | |
149 | |
150 Note: aliases can be used in key bindings\&. | |
151 | |
152 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
|
153 |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
154 .TP |
618 | 155 \fB/buffer\fR clear|top|bottom|date|%|search_backward|search_forward |
226 | 156 The buffer command manipulates the current buddy's buffer (chat window)\&. |
157 | |
618 | 158 \fBclear\fR clear the current buddy chat window |
159 \fBbottom\fR jump to the bottom of the current buddy chat buffer | |
160 \fBtop\fR jump to the top of the current buddy chat buffer | |
161 \fBup\fR [n] scroll the buffer up n lines (default: half a screen) | |
162 \fBdown\fR [n] scroll the buffer down n lines (default: half a screen) | |
163 \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) | |
164 \fB%\fR n jump to position %n of the buddy chat buffer | |
491 | 165 \fBsearch_backward\fR text search for "text" in the current buddy chat buffer |
166 \fBsearch_forward\fR text search for "text" in the current buddy chat buffer | |
226 | 167 |
168 .TP | |
229 | 169 \fB/clear\fR |
227 | 170 The clear command is actually an alias for "/buffer clear"\&. |
171 | |
172 .TP | |
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
173 \fB/connect\fR |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
174 Establish connection to the Jabber server\&. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
175 |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
176 .TP |
229 | 177 \fB/del\fR |
227 | 178 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&. |
226 | 179 |
180 .TP | |
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
181 \fB/disconnect\fR |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
182 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
|
183 |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
184 .TP |
240 | 185 \fB/group\fR fold|unfold|toggle |
186 The group command changes the current group display\&. | |
226 | 187 |
637 | 188 \fBfold\fR fold (shrink) the current group tree in the roster |
265 | 189 \fBunfold\fR unfold (expand) the current group tree in the roster |
190 \fBtoggle\fR toggle the state (fold/unfold) of the current tree | |
226 | 191 |
192 .TP | |
229 | 193 \fB/info\fR |
440
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
194 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 | 195 |
196 .TP | |
229 | 197 \fB/move\fR [groupname] |
623 | 198 Move the current buddy to the requested group\&. If no group is specified, then the buddy is moved to the default group\&. Tip: if the chatmode is enabled, you can use "/roster alternate" to jump to the moved buddy\&. |
226 | 199 |
200 .TP | |
637 | 201 \fB/msay\fR begin|verbatim|send|send_to|abort |
450 | 202 Send a multi\-line message\&. To write a single message with several lines, the \fImulti\-line mode\fR should be used\&. |
203 | |
204 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\&. | |
205 | |
206 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 | 207 |
637 | 208 \fBbegin\fR enter multi\-line mode |
209 \fBverbatim\fR enter verbatim multi\-line mode | |
210 \fBsend\fR send the current multi\-line message to the currently selected buddy | |
211 \fIsend_to\fR jid send the current multi\-line message to "jid" | |
212 \fBabort\fR leave multi\-line mode without sending the message | |
226 | 213 |
214 .TP | |
436 | 215 \fB/rawxml\fR send |
216 \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\&. | |
217 | |
218 .TP | |
229 | 219 \fB/rename\fR nickname |
450 | 220 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)\&. |
221 | |
700 | 222 .TP |
223 \fB/request\fR time|version [jid] | |
224 Send a "IQ" query to the current buddy, or to the specified Jabber user\&. If the resource is not provided with the jid, mcabber will send the query to all known resources for this user\&. | |
450 | 225 |
226 .TP | |
573 | 227 \fB/room\fR |
450 | 228 The room command handles Multi\-User Chat room actions\&. |
229 | |
660 | 230 \fBjoin\fR room nick join "room", using "nick" as nickname\&. If no nickname is provided, the "nickname" option value is used (see sample configuration file) |
487 | 231 \fBleave\fR [message] leave the current room |
232 \fBnames\fR display members of the current room | |
233 \fBnick\fR nick change your nickname in the current room | |
491 | 234 \fBprivmsg\fR nick msg send private message "msg" to "nick" |
487 | 235 \fBremove\fR remove the current room from the roster (you must have left this room before) |
236 \fBtopic\fR set topic for current room | |
237 \fBunlock\fR unlock current room (if you are the owner) | |
601 | 238 \fBdestroy\fR [reason] destroy the current room (use with care!) |
573 | 239 \fBwhois\fR nick display MUC information about "nick" |
226 | 240 |
593 | 241 \fBinvite\fR jid [reason] invite jid to the current room |
242 \fBkick\fR nick [reason] kick "nick" from the current room | |
243 \fBban\fR jid [reason] ban jid from the current room | |
244 \fBrole\fR jid role [reason] change jid's role (role can be "none", "visitor", "participant", "moderator") | |
245 \fBaffil\fR jid affil [reason] change jid's affiliation (affil can be "none", "member", "admin", "owner") | |
246 | |
226 | 247 .TP |
265 | 248 \fB/roster\fR |
249 The roster command manipulates the roster/buddylist\&. Here are the available parameters: | |
229 | 250 |
491 | 251 \fBbottom\fR jump to the bottom of the roster |
252 \fBtop\fR jump to the top of the roster | |
253 \fBup\fR move up in the roster | |
254 \fBdown\fR move down in the roster | |
265 | 255 \fBhide_offline\fR hide offline buddies |
256 \fBshow_offline\fR show offline buddies | |
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
257 \fBtoggle_offline\fR toggle display of offline buddies |
265 | 258 \fBsearch\fR bud search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) |
618 | 259 \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 | 260 \fBunread_first\fR jump to the first unread message |
261 \fBunread_next\fR jump to the next unread message | |
229 | 262 |
263 .TP | |
264 \fB/say\fR text | |
491 | 265 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 | 266 |
267 .TP | |
480 | 268 \fB/say_to\fR jid text |
491 | 269 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 | 270 |
271 .TP | |
522 | 272 \fB/status\fR [online|avail|invisible|free|dnd|notavail|away [\-|StatusMessage]] |
273 Show or set the current status\&. | |
274 | |
275 If no status is specified, display the current status\&. | |
276 | |
277 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 | 278 |
450 | 279 .TP |
280 \fB/status_to\fR jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] | |
281 Send the requested status to the specified Jabber user\&. | |
282 | |
660 | 283 If the specified jid is "\&.", the current buddy is used\&. |
284 | |
450 | 285 Note: this status will be overridden by subsequent "/status" commands\&. If you are using the auto\-away feature, the status will overridden too\&. |
286 | |
287 Note: The jid can include a resource (i\&.e\&. user@server/resource)\&. | |
288 | |
623 | 289 .TP |
290 \fB/version\fR | |
291 Display mcabber version | |
292 | |
226 | 293 .SH "CONFIGURATION FILE" |
294 | |
295 | |
296 See the provided sample configuration file, which should be self\-documented\&. | |
297 | |
298 .SH "FILES" | |
299 | |
300 | |
301 The following files can be used by mcabber(1): | |
302 | |
303 .nf | |
304 | |
305 $HOME/\&.mcabber/mcabberrc Default configuration file | |
306 $HOME/\&.mcabberrc Configuration file used if no other has been found | |
307 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled | |
308 | |
309 .fi | |
310 | |
311 .SH "BUGS" | |
312 | |
313 | |
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
330
diff
changeset
|
314 Certainly\&. Please tell me if you find one! :\-) |
226 | 315 |
316 .SH "AUTHOR" | |
317 | |
318 | |
229 | 319 Written by Mikael BERTHE <\fImcabber@lilotux.net\fR>\&. |
320 Originally based on cabber (Cabber homepage: <\fIhttp://cabber.sourceforge.net\fR>), please consult the AUTHORS file for details\&. | |
226 | 321 |
322 .SH "RESOURCES" | |
323 | |
324 | |
229 | 325 Main web site: <\fIhttp://www.lilotux.net/~mikael/mcabber/\fR> |
226 | 326 |
327 .SH "COPYING" | |
328 | |
329 | |
700 | 330 Copyright © 2005, 2006 Mikael Berthe\&. |
229 | 331 |
700 | 332 Some portions are Copyright © 2002\-2004 <cabber@ajmacias\&.com>\&. |
226 | 333 |
334 | |
335 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. | |
336 |