Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1 @ 854:bfaab692a683

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update manpage (pmw) This is Philip M. White's manpage update patch, slightly modified.
author Mikael Berthe <mikael@lilotux.net>
date Sat, 13 May 2006 22:26:15 +0200
parents f8c0447beec2
children 4b77a2ab18e5
comparison
equal deleted inserted replaced
853:bdd526ec62bc 854:bfaab692a683
32 32
33 33
34 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet\&. 34 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet\&.
35 35
36 36
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\&.
38
39
40 Two status lines surround the log window\&. The bottom status line is the "main status line" and reflects mcabber general status\&. The other line is the "chat status line" and shows the status of the currently selected buddy\&.
41
42
43 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\&.
44
45
46 Here are some of the features of mcabber: 37 Here are some of the features of mcabber:
47 38
48 .TP 3 39 .TP 3
49 \(bu 40 \(bu
50 SSL support\&. 41 SSL support\&.
60 .TP 51 .TP
61 \(bu 52 \(bu
62 Input line history: Any message or command entered is in the input line history and can be reused easily\&. 53 Input line history: Any message or command entered is in the input line history and can be reused easily\&.
63 .TP 54 .TP
64 \(bu 55 \(bu
65 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\&. 56 External actions: Some events (like receiving a message) can trigger an external action such as a shell script if you enable it in your configuration file\&. A sample events script ("eventcmd") is provided with mcabber source code, in the contrib directory\&.
66 .LP 57 .LP
67 58
68 .SH "OPTIONS" 59 .SH "OPTIONS"
69 60
70 .TP 61 .TP
71 \-\-help, \-h 62 \-\-help, \-h
72 Quick help usage message 63 Quick help usage message
73 64
74 .TP 65 .TP
75 \-f configfile 66 \-f configfile
76 Use configuration file configfile 67 Use configuration file configfile
68
69 .SH "WINDOWS/PANES"
70
71
72 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\&.
73
74
75 Two status lines surround the log window\&. The bottom status line is the "main status line" and reflects mcabber general status\&. The other line is the "chat status line" and shows the status of the currently selected buddy\&.
76
77
78 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\&.
79
80
81 There are several advantages to the two\-mode implementation: first, it allows accurate "unread" message functionality, as described in the next section; without this, merely scrolling to a specific buddy will "read" the new messages of all buddies in\-between\&. Second, it allows quickly hiding the conversation with a single keystroke\&. Third, it allows jumping between the few buddies with whom you are conversing with the \fI/roster alternate\fR command described in another section, without having to manually scroll back and forth\&.
77 82
78 .SH "KEYS" 83 .SH "KEYS"
79 84
80 85
81 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&. 86 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&.
87 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)\&. 92 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)\&.
88 93
89 94
90 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\&. 95 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\&.
91 96
97
92 Here is a quick description of the key bindings: 98 Here is a quick description of the key bindings:
93 99
94 Ctrl\-a Go to the beginning of the input line 100 Ctrl\-a Go to the beginning of the input line
95 101
96 Ctrl\-e Go to the end of the input line 102 Ctrl\-e Go to the end of the input line
121 127
122 Ctrl\-o Accept line and put the next history line in the input line (accept\-line\-and\-down\-history) 128 Ctrl\-o Accept line and put the next history line in the input line (accept\-line\-and\-down\-history)
123 129
124 Ctrl\-q Jump to the next unread message 130 Ctrl\-q Jump to the next unread message
125 131
126 132 Additional key bindings may be specified using the /bind command described
127 .SH "COMMANDS" 133 in the COMMANDS section\&.
128 134
129 .TP 135 .SH "MCABBER'S ROSTER"
130 \fB/add\fR [jid [nickname]] 136
131 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\&. 137
138 The first listed resource on the roster is \fI[status]\fR, which keeps a log of everything that appears in the short log window below the main chat area\&. While the log window was designed for showing the latest few elements, the dedicated \fI[status]\fR buffer allows more comfortable viewing of the log, as well as scrolling it in a standard manner\&.
139
140
141 Group names are displayed above the resources that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&.
142
143
144 For every real Jabber resource, the roster displays four pieces of information: the resource's name or alias, its online status, its authorization status, and whether there are unread messages from the resource waiting for you\&.
145
146
147 The online status is one of the following:
148
149 \fBo\fR online
150 \fBf\fR free for chat
151 \fBa\fR away
152 \fBn\fR not available (labeled \fIextended away\fR in some clients)
153 \fBd\fR do not disturb
154 \fBi\fR invisible (displayed only for your resource)
155 \fB_\fR offline (or invisible to you)
156 \fB?\fR unknown, usually meaning you are not authorized to see this resource's status
157 \fBx\fR a conference room in which you are not participating
158 \fBC\fR a conference room in which you are participating
159
160
161 The authorization status indicates whether a resource is authorized to receive your online status updates, and is displayed by the brackets surrounding the resource's online status\&. Square brackets, like \fI[o]\fR, indicate that this resource is authorized to receive your status\&. Curly braces, like \fI{o}\fR, indicate that they are not authorized to receive your status\&.
162
163
164 When there are unread messages from the resource which you have not looked at, a hash mark (\fI#\fR) appears in the leftmost section of the roster for that resource\&. The hash mark disappears once you view that resource's message log\&.
165
166
167 Examples:
168
169 \fB \-\-\- Buds\fR This is a group named \fIBuds\fR
170 \fB#[o] John\fR John is online, can see your status, and sent you a message that you did not read yet
171 \fB {?} Sally\fR Neither you nor Sally have authorized each other to see your online status
172 \fB {a} Jane\fR Jane is away, but she cannot see your online status
173 \fB#[C] x@y\&.c\fR You are participating in x@y\&.c conference room, and there are unread messages
174
175
176 .SH "COMMANDS RELATED TO MCABBER"
132 177
133 .TP 178 .TP
134 \fB/alias\fR name = command line 179 \fB/alias\fR name = command line
135 Add "name" as an alias for "command line"\&. 180 Add "name" as an alias for "command line"\&.
136 181
137 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\&. 182 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\&.
138 183
139 Example: "/alias away = status away"\&. 184 Example: "/alias away = status away"\&.
140
141 .TP
142 \fB/authorization\fR allow|cancel|request|request_unsubscribe [jid]
143 Manage the presence subscriptions\&.
144
145 If no jid is provided, the current buddy is used\&.
146
147 \fBallow\fR allow the buddy to receive your presence updates
148 \fBcancel\fR cancel the buddy' subscription to your presence updates
149 \fBrequest\fR request a subscription to the buddy's presence updates
150 \fBrequest_unsubscribe\fR request unsubscription from the buddy's presence updates
151 185
152 .TP 186 .TP
153 \fB/bind\fR keycode = command line 187 \fB/bind\fR keycode = command line
154 Bind a command line to the key with the "keycode" code number\&. 188 Bind a command line to the key with the "keycode" code number\&.
155 189
176 .TP 210 .TP
177 \fB/clear\fR 211 \fB/clear\fR
178 The clear command is actually an alias for "/buffer clear"\&. 212 The clear command is actually an alias for "/buffer clear"\&.
179 213
180 .TP 214 .TP
215 \fB/quit\fR
216 Disconnect and leave mcabber(1)\&.
217
218 .TP
219 \fB/version\fR
220 Display mcabber version
221
222 .SH "COMMANDS RELATED TO THE SERVER AND CONNECTION"
223
224 .TP
181 \fB/connect\fR 225 \fB/connect\fR
182 Establish connection to the Jabber server\&. 226 Establish connection to the Jabber server\&.
183
184 .TP
185 \fB/del\fR
186 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&.
187 227
188 .TP 228 .TP
189 \fB/disconnect\fR 229 \fB/disconnect\fR
190 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\&. 230 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\&.
191 231
195 235
196 \fBaccept\fR accept the event #n 236 \fBaccept\fR accept the event #n
197 \fBignore\fR remove the event #n from the list 237 \fBignore\fR remove the event #n from the list
198 \fBreject\fR reject the event #n 238 \fBreject\fR reject the event #n
199 \fBlist\fR list all pending events 239 \fBlist\fR list all pending events
240
241 .TP
242 \fB/rawxml\fR send
243 \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\&.
244
245 .SH "COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES"
246
247 .TP
248 \fB/add\fR [jid [nickname]]
249 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\&.
250
251 .TP
252 \fB/authorization\fR allow|cancel|request|request_unsubscribe [jid]
253 Manage the presence subscriptions\&.
254
255 If no jid is provided, the current buddy is used\&.
256
257 \fBallow\fR allow the buddy to receive your presence updates
258 \fBcancel\fR cancel the buddy' subscription to your presence updates
259 \fBrequest\fR request a subscription to the buddy's presence updates
260 \fBrequest_unsubscribe\fR request unsubscription from the buddy's presence updates
261
262 .TP
263 \fB/del\fR
264 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&.
200 265
201 .TP 266 .TP
202 \fB/group\fR fold|unfold|toggle 267 \fB/group\fR fold|unfold|toggle
203 The group command changes the current group display\&. 268 The group command changes the current group display\&.
204 269
231 \fBsend\fR send the current multi\-line message to the currently selected buddy 296 \fBsend\fR send the current multi\-line message to the currently selected buddy
232 \fBsend_to\fR jid send the current multi\-line message to "jid" 297 \fBsend_to\fR jid send the current multi\-line message to "jid"
233 \fBtoggle\fR switch to/from multi\-line mode (begin/send) 298 \fBtoggle\fR switch to/from multi\-line mode (begin/send)
234 \fBtoggle_verbatim\fR same with verbatim multi\-line mode 299 \fBtoggle_verbatim\fR same with verbatim multi\-line mode
235 \fBabort\fR leave multi\-line mode without sending the message 300 \fBabort\fR leave multi\-line mode without sending the message
236
237 .TP
238 \fB/rawxml\fR send
239 \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\&.
240 301
241 .TP 302 .TP
242 \fB/rename\fR nickname 303 \fB/rename\fR nickname
243 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)\&. 304 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)\&.
244 305
310 371
311 Note: this status will be overridden by subsequent "/status" commands\&. If you are using the auto\-away feature, the status will overridden too\&. 372 Note: this status will be overridden by subsequent "/status" commands\&. If you are using the auto\-away feature, the status will overridden too\&.
312 373
313 Note: The jid can include a resource (i\&.e\&. user@server/resource)\&. 374 Note: The jid can include a resource (i\&.e\&. user@server/resource)\&.
314 375
315 .TP
316 \fB/version\fR
317 Display mcabber version
318
319 .SH "CONFIGURATION FILE" 376 .SH "CONFIGURATION FILE"
320 377
321 378
322 See the provided sample configuration file, which should be self\-documented\&. 379 See the provided sample configuration file, which should be self\-documenting\&.
323 380
324 .SH "FILES" 381 .SH "FILES"
325 382
326 383
327 The following files can be used by mcabber(1): 384 The following files can be used by mcabber(1):
328 385
329 .nf 386 .nf
330
331 $HOME/\&.mcabber/mcabberrc Default configuration file 387 $HOME/\&.mcabber/mcabberrc Default configuration file
332 $HOME/\&.mcabberrc Configuration file used if no other has been found 388 $HOME/\&.mcabberrc Configuration file used if no other has been found
333 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled 389 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled
334
335 .fi 390 .fi
336 391
337 .SH "BUGS" 392 .SH "BUGS"
338 393
339 394