Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1 @ 1242:b335d30881bd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update manpage
author Mikael Berthe <mikael@lilotux.net>
date Mon, 18 Jun 2007 19:18:48 +0200
parents 104676e3389b
children 05dc45e7c7bb
comparison
equal deleted inserted replaced
1241:3a4018f18bdf 1242:b335d30881bd
1 .\" Title: mcabber 1 .\" Title: mcabber
2 .\" Author: Mikael BERTHE 2 .\" Author: Mikael BERTHE
3 .\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/> 3 .\" Date: 06/17/2007
4 .\" Date: 02/04/2007 4 .\" Manual:
5 .\" Manual: 5 .\" Source:
6 .\" Source:
7 .\" 6 .\"
8 .TH "MCABBER" "1" "02/04/2007" "" "" 7 .TH "MCABBER" "1" "06/17/2007" "" ""
9 .\" disable hyphenation 8 .\" disable hyphenation
10 .nh 9 .nh
11 .\" disable justification (adjust text to left margin only) 10 .\" disable justification (adjust text to left margin only)
12 .ad l 11 .ad l
13 .SH "NAME" 12 .SH "NAME"
14 mcabber \- a simple Jabber console client 13 mcabber \- a simple Jabber console client
15 .SH "SYNOPSIS" 14 .SH "SYNOPSIS"
16 \fImcabber\fR [ \-f configfile ] [ \-\-help | \-h ] 15 \fImcabber\fR [ \-f configfile ] [ \-\-help | \-h ]
16 .sp
17 .SH "DESCRIPTION" 17 .SH "DESCRIPTION"
18 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. 18 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.
19 .sp
19 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet. 20 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet.
21 .sp
20 Here are some of the features of mcabber: 22 Here are some of the features of mcabber:
21 .TP 3n 23 .sp
22 \(bu 24 .sp
23 25 .RS 4
26 \h'-04'\(bu\h'+03'
24 \fISSL support\fR. 27 \fISSL support\fR.
25 .TP 3n 28 .RE
26 \(bu 29 .sp
27 30 .RS 4
31 \h'-04'\(bu\h'+03'
28 \fIMUC support\fR 32 \fIMUC support\fR
29 (Multi\-User Chat). 33 (Multi\-User Chat).
30 .TP 3n 34 .RE
31 \(bu 35 .sp
32 36 .RS 4
37 \h'-04'\(bu\h'+03'
33 \fIPGP support\fR 38 \fIPGP support\fR
34 .TP 3n 39 .RE
35 \(bu 40 .sp
36 41 .RS 4
42 \h'-04'\(bu\h'+03'
37 \fIChat States\fR 43 \fIChat States\fR
38 support (typing notifications) 44 support (typing notifications)
39 .TP 3n 45 .RE
40 \(bu 46 .sp
41 47 .RS 4
48 \h'-04'\(bu\h'+03'
42 \fIHistory logging:\fR 49 \fIHistory logging:\fR
43 If enabled (see the CONFIGURATION FILE section), 50 If enabled (see the CONFIGURATION FILE section),
44 mcabber 51 mcabber
45 can save discussions to history log files. 52 can save discussions to history log files.
46 .TP 3n 53 .RE
47 \(bu 54 .sp
48 55 .RS 4
56 \h'-04'\(bu\h'+03'
49 \fICommands completion:\fR 57 \fICommands completion:\fR
50 If possible, 58 If possible,
51 mcabber 59 mcabber
52 will try to complete your command line if you hit the Tab key. 60 will try to complete your command line if you hit the Tab key.
53 .TP 3n 61 .RE
54 \(bu 62 .sp
55 63 .RS 4
64 \h'-04'\(bu\h'+03'
56 \fIInput line history:\fR 65 \fIInput line history:\fR
57 Any message or command entered is in the input line history and can be reused easily. 66 Any message or command entered is in the input line history and can be reused easily.
58 .TP 3n 67 .RE
59 \(bu 68 .sp
60 69 .RS 4
70 \h'-04'\(bu\h'+03'
61 \fIExternal actions:\fR 71 \fIExternal actions:\fR
62 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 72 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
63 mcabber 73 mcabber
64 source code, in the contrib directory. 74 source code, in the contrib directory.
75 .RE
65 .SH "OPTIONS" 76 .SH "OPTIONS"
66 .PP 77 .PP
67 \-\-help, \-h 78 \-\-help, \-h
68 .RS 3n 79 .RS 4
69 Quick help usage message 80 Quick help usage message
70 .RE 81 .RE
71 .PP 82 .PP
72 \-f configfile 83 \-f configfile
73 .RS 3n 84 .RS 4
74 Use configuration file 85 Use configuration file
75 \fIconfigfile\fR 86 \fIconfigfile\fR
76 .RE 87 .RE
77 .SH "WINDOWS/PANES" 88 .SH "WINDOWS/PANES"
78 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. 89 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.
90 .sp
79 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. 91 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.
92 .sp
80 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. 93 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.
94 .sp
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. 95 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.
96 .sp
82 .SH "KEYS" 97 .SH "KEYS"
83 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...). 98 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...).
99 .sp
84 PageUp and PageDown keys are used to move in the roster. 100 PageUp and PageDown keys are used to move in the roster.
101 .sp
85 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). 102 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).
103 .sp
86 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. 104 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.
105 .sp
87 Here is a quick description of the key bindings: 106 Here is a quick description of the key bindings:
107 .sp
88 .TS 108 .TS
89 tab(:); 109 tab(:);
90 l l 110 l l
91 l l 111 l l
92 l l 112 l l
102 l l 122 l l
103 l l 123 l l
104 l l 124 l l
105 l l 125 l l
106 l l 126 l l
107 l l
108 l l. 127 l l.
109 T{ 128 T{
110 Esc 129 Esc
130 .sp
111 T}:T{ 131 T}:T{
112 Disable chat mode 132 Disable chat mode
133 .sp
113 T} 134 T}
114 T{ 135 T{
115 Ctrl\-d 136 Ctrl\-d
137 .sp
116 T}:T{ 138 T}:T{
117 Send/terminate a multi\-line message 139 Send/terminate a multi\-line message
140 .sp
118 T} 141 T}
119 T{ 142 T{
120 Ctrl\-p/Ctrl\-n 143 Ctrl\-p/Ctrl\-n
144 .sp
121 T}:T{ 145 T}:T{
122 Scroll up/down half a screen in the buffer window (chat mode) 146 Scroll up/down half a screen in the buffer window (chat mode)
147 .sp
123 T} 148 T}
124 T{ 149 T{
125 Ctrl\-Left 150 Ctrl\-Left
151 .sp
126 T}:T{ 152 T}:T{
127 Move the cursor back to the start of the current or previous word 153 Move the cursor back to the start of the current or previous word
154 .sp
128 T} 155 T}
129 T{ 156 T{
130 Ctrl\-Right 157 Ctrl\-Right
158 .sp
131 T}:T{ 159 T}:T{
132 Move the cursor forward to the end of the current or next word 160 Move the cursor forward to the end of the current or next word
161 .sp
133 T} 162 T}
134 T{ 163 T{
135 Ctrl\-u 164 Ctrl\-u
165 .sp
136 T}:T{ 166 T}:T{
137 Delete from beginning of the line to the cursor 167 Delete from beginning of the line to the cursor
168 .sp
138 T} 169 T}
139 T{ 170 T{
140 Ctrl\-k 171 Ctrl\-k
172 .sp
141 T}:T{ 173 T}:T{
142 Delete from the cursor to the end of line 174 Delete from the cursor to the end of line
175 .sp
143 T} 176 T}
144 T{ 177 T{
145 Ctrl\-w 178 Ctrl\-w
179 .sp
146 T}:T{ 180 T}:T{
147 Backward kill word 181 Backward kill word
182 .sp
148 T} 183 T}
149 T{ 184 T{
150 Ctrl\-t 185 Ctrl\-t
186 .sp
151 T}:T{ 187 T}:T{
152 Transpose chars 188 Transpose chars
189 .sp
153 T} 190 T}
154 T{ 191 T{
155 Ctrl\-o 192 Ctrl\-o
193 .sp
156 T}:T{ 194 T}:T{
157 Accept line and put the next history line in the input line (accept\-line\-and\-down\-history) 195 Accept line and put the next history line in the input line (accept\-line\-and\-down\-history)
196 .sp
158 T} 197 T}
159 T{ 198 T{
160 Ctrl\-a 199 Ctrl\-a
200 .sp
161 T}:T{ 201 T}:T{
162 Go to the beginning of the input line 202 Go to the beginning of the input line
203 .sp
163 T} 204 T}
164 T{ 205 T{
165 Ctrl\-e 206 Ctrl\-e
207 .sp
166 T}:T{ 208 T}:T{
167 Go to the end of the input line 209 Go to the end of the input line
210 .sp
168 T} 211 T}
169 T{ 212 T{
170 Ctrl\-l 213 Ctrl\-l
214 .sp
171 T}:T{ 215 T}:T{
172 Force a refresh 216 Force a refresh
217 .sp
173 T} 218 T}
174 T{ 219 T{
175 Up/Down 220 Up/Down
221 .sp
176 T}:T{ 222 T}:T{
177 Move in the input line history 223 Move in the input line history
224 .sp
178 T} 225 T}
179 T{ 226 T{
180 PgUp/PgDown 227 PgUp/PgDown
228 .sp
181 T}:T{ 229 T}:T{
182 Move inside the roster (buddylist) 230 Move inside the roster (buddylist)
231 .sp
183 T} 232 T}
184 T{ 233 T{
185 Tab 234 Tab
235 .sp
186 T}:T{ 236 T}:T{
187 Complete current word, in the input line 237 Complete current word, in the input line
238 .sp
188 T} 239 T}
189 T{ 240 T{
190 Ctrl\-g 241 Ctrl\-g
242 .sp
191 T}:T{ 243 T}:T{
192 Cancel completion 244 Cancel completion
245 .sp
193 T} 246 T}
194 T{ 247 T{
195 Ctrl\-c 248 Ctrl\-c
249 .sp
196 T}:T{ 250 T}:T{
197 Abort multi\-line messages and completions 251 Abort multi\-line messages and completions
252 .sp
198 T} 253 T}
199 .TE 254 .TE
200 255 .sp
201 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section. 256 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section.
257 .sp
202 .SH "MCABBER'S ROSTER" 258 .SH "MCABBER'S ROSTER"
203 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. 259 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.
260 .sp
204 Group names are displayed above the resources that are within them, and are indicated by \fI\-\-\-\fR to the left of the name. 261 Group names are displayed above the resources that are within them, and are indicated by \fI\-\-\-\fR to the left of the name.
262 .sp
205 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. 263 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.
264 .sp
206 The online status is one of the following: 265 The online status is one of the following:
266 .sp
207 .TS 267 .TS
208 tab(:); 268 tab(:);
209 l l 269 l l
210 l l 270 l l
211 l l 271 l l
216 l l 276 l l
217 l l 277 l l
218 l l. 278 l l.
219 T{ 279 T{
220 \fIo\fR 280 \fIo\fR
281 .sp
221 T}:T{ 282 T}:T{
222 online 283 online
284 .sp
223 T} 285 T}
224 T{ 286 T{
225 \fIC\fR 287 \fIC\fR
288 .sp
226 T}:T{ 289 T}:T{
227 a conference room in which you are participating 290 a conference room in which you are participating
291 .sp
228 T} 292 T}
229 T{ 293 T{
230 \fIf\fR 294 \fIf\fR
295 .sp
231 T}:T{ 296 T}:T{
232 free for chat 297 free for chat
298 .sp
233 T} 299 T}
234 T{ 300 T{
235 \fIa\fR 301 \fIa\fR
302 .sp
236 T}:T{ 303 T}:T{
237 away 304 away
305 .sp
238 T} 306 T}
239 T{ 307 T{
240 \fIn\fR 308 \fIn\fR
309 .sp
241 T}:T{ 310 T}:T{
242 not available (labeled \fIextended away\fR in some clients) 311 not available (labeled \fIextended away\fR in some clients)
312 .sp
243 T} 313 T}
244 T{ 314 T{
245 \fId\fR 315 \fId\fR
316 .sp
246 T}:T{ 317 T}:T{
247 do not disturb 318 do not disturb
319 .sp
248 T} 320 T}
249 T{ 321 T{
250 \fIi\fR 322 \fIi\fR
323 .sp
251 T}:T{ 324 T}:T{
252 invisible (displayed only for your resource) 325 invisible (displayed only for your resource)
326 .sp
253 T} 327 T}
254 T{ 328 T{
255 \fI_\fR 329 \fI_\fR
330 .sp
256 T}:T{ 331 T}:T{
257 offline (or invisible to you) 332 offline (or invisible to you)
333 .sp
258 T} 334 T}
259 T{ 335 T{
260 \fI?\fR 336 \fI?\fR
337 .sp
261 T}:T{ 338 T}:T{
262 unknown, usually meaning you are not authorized to see this resource's status 339 unknown, usually meaning you are not authorized to see this resource's status
340 .sp
263 T} 341 T}
264 T{ 342 T{
265 \fIx\fR 343 \fIx\fR
344 .sp
266 T}:T{ 345 T}:T{
267 a conference room in which you are not participating 346 a conference room in which you are not participating
347 .sp
268 T} 348 T}
269 .TE 349 .TE
270 350 .sp
271 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. 351 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.
352 .sp
272 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. 353 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.
354 .sp
273 Examples: 355 Examples:
356 .sp
274 .TS 357 .TS
275 tab(:); 358 tab(:);
276 l l 359 l l
277 l l 360 l l
278 l l 361 l l
279 l l 362 l l
280 l l. 363 l l.
281 T{ 364 T{
282 \fI \-\-\- Buds\fR 365 \fI \-\-\- Buds\fR
366 .sp
283 T}:T{ 367 T}:T{
284 This is a group named \fIBuds\fR 368 This is a group named \fIBuds\fR
369 .sp
285 T} 370 T}
286 T{ 371 T{
287 \fI#[o] John\fR 372 \fI#[o] John\fR
373 .sp
288 T}:T{ 374 T}:T{
289 John is online, can see your status, and sent you a message that you did not read yet 375 John is online, can see your status, and sent you a message that you did not read yet
376 .sp
290 T} 377 T}
291 T{ 378 T{
292 \fI {?} Sally\fR 379 \fI {?} Sally\fR
380 .sp
293 T}:T{ 381 T}:T{
294 Neither you nor Sally have authorized each other to see your online status 382 Neither you nor Sally have authorized each other to see your online status
383 .sp
295 T} 384 T}
296 T{ 385 T{
297 \fI {a} Jane\fR 386 \fI {a} Jane\fR
387 .sp
298 T}:T{ 388 T}:T{
299 Jane is away, but she cannot see your online status 389 Jane is away, but she cannot see your online status
390 .sp
300 T} 391 T}
301 T{ 392 T{
302 \fI#[C] x@y.c\fR 393 \fI#[C] x@y.c\fR
394 .sp
303 T}:T{ 395 T}:T{
304 You are participating in x@y.c conference room, and there are unread messages 396 You are participating in x@y.c conference room, and there are unread messages
397 .sp
305 T} 398 T}
306 .TE 399 .TE
307 400 .sp
401 .SH "COMMANDS"
402 Please refer to the online help (command /help), it is probably more up\-to\-date than this manpage. Furthermore, help files have been translated into several languages. You will find an overview of the mcabber commands in this manual.
403 .sp
308 .SH "COMMANDS RELATED TO MCABBER" 404 .SH "COMMANDS RELATED TO MCABBER"
309 .PP 405 .PP
310 /alias [name [= command line]] 406 /alias [name [= command line]]
311 .RS 3n 407 .RS 4
312 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. "/alias" displays a list of the existing aliases. Example: "/alias away = status away". 408 Add "name" as an alias for "command line".
409 Aliases are expanded only once, thus they can not be chained.
410 "/alias name" displays the value associated with the "name" alias;
411 "/alias name =" unsets the "name" alias.
412 "/alias" displays a list of the existing aliases. Example: "/alias away = status away".
313 .RE 413 .RE
314 .PP 414 .PP
315 /bind [keycode [= command line]] 415 /bind [keycode [= command line]]
316 .RS 3n 416 .RS 4
317 Bind a command line to the key with the "keycode" code number. Keycodes of unused keys are displayed by 417 Bind a command line to the key with the "keycode" code number.
318 mcabber 418 Keycodes of unused keys are displayed by mcabber in the log window when pressing the key, for example "Unknown key=265".
319 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. "/bind" displays a list of the bound keycodes. Note: aliases can be used in key bindings. Example: "/bind 265 = status online" (265 is F1 for me, but it may depend on your ncurses installation). 419 "/bind keycode" displays the command line bound to the given keycode;
420 "/bind keycode =" unbinds the given keycode.
421 "/bind" displays a list of the bound keycodes.
422 Note: aliases can be used in key bindings.
423 Example: "/bind 265 = status online" (265 is F1 for me, but it may depend on your ncurses installation).
320 .RE 424 .RE
321 .PP 425 .PP
322 /buffer clear|close|close_all|purge, /buffer top|bottom|date|%|search_backward|search_forward, /buffer scroll_lock|scroll_unlock|scroll_toggle 426 /buffer clear|close|close_all|purge, /buffer top|bottom|date|%|search_backward|search_forward, /buffer scroll_lock|scroll_unlock|scroll_toggle
323 .RS 3n 427 .RS 4
324 The 428 The
325 \fIbuffer\fR 429 \fIbuffer\fR
326 command manipulates the current buddy's buffer (chat window). 430 command manipulates the current buddy's buffer (chat window).
327 .TS 431 .TS
328 tab(:); 432 tab(:);
419 \fIscroll_toggle\fR 523 \fIscroll_toggle\fR
420 T}:T{ 524 T}:T{
421 toggle buffer scrolling (lock/unlock) 525 toggle buffer scrolling (lock/unlock)
422 T} 526 T}
423 .TE 527 .TE
424 528 .sp
425 .RE 529 .RE
426 .PP 530 .PP
427 /clear 531 /clear
428 .RS 3n 532 .RS 4
429 The 533 The
430 \fIclear\fR 534 \fIclear\fR
431 command is actually an alias for "/buffer clear". 535 command is actually an alias for "/buffer clear".
432 .RE 536 .RE
433 .PP 537 .PP
434 /help [command] 538 /help [command]
435 .RS 3n 539 .RS 4
436 Display generic help or help about a specific mcabber command. 540 Display generic help or help about a specific mcabber command.
437 .RE 541 .RE
438 .PP 542 .PP
439 /quit 543 /quit
440 .RS 3n 544 .RS 4
441 Disconnect and leave 545 Disconnect and leave
442 mcabber(1). 546 mcabber(1).
443 .RE 547 .RE
444 .PP 548 .PP
549 /set option[=value]
550 .RS 4
551 Display or set an option value.
552 .RE
553 .PP
554 /source [file]
555 .RS 4
556 Read a configuration file.
557 .RE
558 .PP
445 /version 559 /version
446 .RS 3n 560 .RS 4
447 Display mcabber version 561 Display mcabber version
448 .RE 562 .RE
449 .SH "COMMANDS RELATED TO THE SERVER AND CONNECTION" 563 .SH "COMMANDS RELATED TO THE SERVER AND CONNECTION"
450 .PP 564 .PP
451 /connect 565 /connect
452 .RS 3n 566 .RS 4
453 Establish connection to the Jabber server. 567 Establish connection to the Jabber server.
454 .RE 568 .RE
455 .PP 569 .PP
456 /disconnect 570 /disconnect
457 .RS 3n 571 .RS 4
458 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. 572 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.
459 .RE 573 .RE
460 .PP 574 .PP
461 /event #n|* accept|ignore|reject, /event list 575 /event #n|* accept|ignore|reject, /event list
462 .RS 3n 576 .RS 4
463 Tell mcabber what to do about a pending event. If the first parameter is "*", the command will apply to all queued events. 577 Tell mcabber what to do about a pending event. If the first parameter is "*", the command will apply to all queued events.
464 .TS 578 .TS
465 tab(:); 579 tab(:);
466 l l 580 l l
467 l l 581 l l
486 \fIlist\fR 600 \fIlist\fR
487 T}:T{ 601 T}:T{
488 list all pending events 602 list all pending events
489 T} 603 T}
490 .TE 604 .TE
491 605 .sp
492 .RE 606 .RE
493 .PP 607 .PP
494 /rawxml send string 608 /rawxml send string
495 .RS 3n 609 .RS 4
496 610
497 \fIsend\fR 611 \fIsend\fR
498 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. 612 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.
499 .RE 613 .RE
500 .SH "COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES" 614 .SH "COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES"
501 .PP 615 .PP
502 /add [jid [nickname]] 616 /add [jid [nickname]]
503 .RS 3n 617 .RS 4
504 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. 618 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.
505 .RE 619 .RE
506 .PP 620 .PP
507 /authorization allow|cancel|request|request_unsubscribe [jid] 621 /authorization allow|cancel|request|request_unsubscribe [jid]
508 .RS 3n 622 .RS 4
509 Manage the presence subscriptions. If no jid is provided, the current buddy is used. 623 Manage the presence subscriptions. If no jid is provided, the current buddy is used.
510 .TS 624 .TS
511 tab(:); 625 tab(:);
512 l l 626 l l
513 l l 627 l l
532 \fIrequest_unsubscribe\fR 646 \fIrequest_unsubscribe\fR
533 T}:T{ 647 T}:T{
534 request unsubscription from the buddy's presence updates 648 request unsubscription from the buddy's presence updates
535 T} 649 T}
536 .TE 650 .TE
537 651 .sp
538 .RE 652 .RE
539 .PP 653 .PP
540 /del 654 /del
541 .RS 3n 655 .RS 4
542 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours. 656 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours.
543 .RE 657 .RE
544 .PP 658 .PP
545 /group fold|unfold|toggle 659 /group fold|unfold|toggle
546 .RS 3n 660 .RS 4
547 The 661 The
548 \fIgroup\fR 662 \fIgroup\fR
549 command changes the current group display. 663 command changes the current group display.
550 .TS 664 .TS
551 tab(:); 665 tab(:);
566 \fItoggle\fR 680 \fItoggle\fR
567 T}:T{ 681 T}:T{
568 toggle the state (fold/unfold) of the current tree 682 toggle the state (fold/unfold) of the current tree
569 T} 683 T}
570 .TE 684 .TE
571 685 .sp
572 .RE 686 .RE
573 .PP 687 .PP
574 /info 688 /info
575 .RS 3n 689 .RS 4
576 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. 690 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.
577 .RE 691 .RE
578 .PP 692 .PP
579 /move [groupname] 693 /move [groupname]
580 .RS 3n 694 .RS 4
581 Move the current buddy to the requested group. If no group is specified, then the buddy is moved to the default group. If the group groupname doesn't exist, it is created. Tip: if the chatmode is enabled, you can use "/roster alternate" to jump to the moved buddy. 695 Move the current buddy to the requested group. If no group is specified, then the buddy is moved to the default group. If the group groupname doesn't exist, it is created. Tip: if the chatmode is enabled, you can use "/roster alternate" to jump to the moved buddy.
582 .RE 696 .RE
583 .PP 697 .PP
584 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort 698 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort
585 .RS 3n 699 .RS 4
586 Send a multi\-line message. To write a single message with several lines, the 700 Send a multi\-line message. To write a single message with several lines, the
587 \fImulti\-line mode\fR 701 \fImulti\-line mode\fR
588 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 (or Ctrl\-d). The 702 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 (or Ctrl\-d). The
589 \fIbegin\fR 703 \fIbegin\fR
590 subcommand enables multi\-line mode. Note that it allows a message subject to be specified. The 704 subcommand enables multi\-line mode. Note that it allows a message subject to be specified. The
639 \fIabort\fR 753 \fIabort\fR
640 T}:T{ 754 T}:T{
641 leave multi\-line mode without sending the message 755 leave multi\-line mode without sending the message
642 T} 756 T}
643 .TE 757 .TE
644 758 .sp
645 .RE 759 .RE
646 .PP 760 .PP
647 /pgp disable|enable|info [jid], /pgp setkey [jid [key]] 761 /pgp disable|enable|force|info [jid], /pgp setkey [jid [key]]
648 .RS 3n 762 .RS 4
649 Manipulate PGP settings for the specified jid (by default the currently selected contact). Please note that PGP encryption won't be used if no remote PGP support is detected, even if PGP is enabled with this command. 763 Manipulate PGP settings for the specified jid (by default the currently selected contact). Please note that PGP encryption won't be used if no remote PGP support is detected, even if PGP is enabled with this command.
650 .TS 764 .TS
651 tab(:); 765 tab(:);
652 l l 766 l l
653 l l 767 l l
654 l l 768 l l
769 l l
655 l l. 770 l l.
656 T{ 771 T{
657 \fIdisable\fR 772 \fIdisable\fR
658 [jid] 773 [jid]
659 T}:T{ 774 T}:T{
664 [jid] 779 [jid]
665 T}:T{ 780 T}:T{
666 enable PGP encryption for jid (or the currently selected contact) 781 enable PGP encryption for jid (or the currently selected contact)
667 T} 782 T}
668 T{ 783 T{
784 \fIforce\fR
785 [jid]
786 T}:T{
787 enforce PGP encryption, even for offline messages, and always assume the recipient has PGP support
788 T}
789 T{
669 \fIinfo\fR 790 \fIinfo\fR
670 [jid] 791 [jid]
671 T}:T{ 792 T}:T{
672 show current PGP settings for the contact 793 show current PGP settings for the contact
673 T} 794 T}
676 [jid [key]] 797 [jid [key]]
677 T}:T{ 798 T}:T{
678 set the PGP key to be used to encrypt message for this contact. If no key is provided, the current key is erased. You can use the shortcut\-jid "." for the currently selected contact. 799 set the PGP key to be used to encrypt message for this contact. If no key is provided, the current key is erased. You can use the shortcut\-jid "." for the currently selected contact.
679 T} 800 T}
680 .TE 801 .TE
681 802 .sp
682 .RE 803 .RE
683 .PP 804 .PP
684 /rename name 805 /rename name
685 .RS 3n 806 .RS 4
686 Rename current buddy or group to the given name. Please note that a group name change is only done when the server's acknowledgment is received, so a slight delay can be noticed. 807 Rename current buddy or group to the given name. Please note that a group name change is only done when the server's acknowledgment is received, so a slight delay can be noticed.
687 .RE 808 .RE
688 .PP 809 .PP
689 /request last|time|vcard|version [jid] 810 /request last|time|vcard|version [jid]
690 .RS 3n 811 .RS 4
691 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. 812 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.
692 .RE 813 .RE
693 .PP 814 .PP
694 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy, /room invite|kick|ban|role|affil, /room bookmark [add|del] [\-autojoin|+autojoin] 815 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy, /room invite|kick|ban|role|affil, /room bookmark [add|del] [\-autojoin|+autojoin]
695 .RS 3n 816 .RS 4
696 The 817 The
697 \fIroom\fR 818 \fIroom\fR
698 command handles Multi\-User Chat room actions. 819 command handles Multi\-User Chat room actions.
699 .TS 820 .TS
700 tab(:); 821 tab(:);
763 T}:T{ 884 T}:T{
764 leave the current room 885 leave the current room
765 T} 886 T}
766 T{ 887 T{
767 \fInames\fR 888 \fInames\fR
768 T}:T{ 889 [\-\-short|\-\-quiet]
769 display members of the current room 890 T}:T{
891 display the members of the current room
770 T} 892 T}
771 T{ 893 T{
772 \fInick\fR 894 \fInick\fR
773 nick 895 nick
774 T}:T{ 896 T}:T{
800 [reason] 922 [reason]
801 T}:T{ 923 T}:T{
802 destroy the current room (use with care!) 924 destroy the current room (use with care!)
803 T} 925 T}
804 .TE 926 .TE
805 927 .sp
806 .RE 928 .RE
807 .PP 929 .PP
808 /roster bottom|top|up|down|group_prev|group_next, /roster alternate|unread_first|unread_next, /roster search bud, /roster hide_offline|show_offline|toggle_offline, /roster item_lock|item_unlock, /roster hide|show|toggle, /roster note [\-|text] 930 /roster bottom|top|up|down|group_prev|group_next, /roster alternate|unread_first|unread_next, /roster search bud, /roster hide_offline|show_offline|toggle_offline, /roster item_lock|item_unlock, /roster hide|show|toggle, /roster note [\-|text]
809 .RS 3n 931 .RS 4
810 The 932 The
811 \fIroster\fR 933 \fIroster\fR
812 command manipulates the roster/buddylist. Here are the available parameters: 934 command manipulates the roster/buddylist. Here are the available parameters:
813 .TS 935 .TS
814 tab(:); 936 tab(:);
929 \fIunread_next\fR 1051 \fIunread_next\fR
930 T}:T{ 1052 T}:T{
931 jump to the next unread message 1053 jump to the next unread message
932 T} 1054 T}
933 .TE 1055 .TE
934 1056 .sp
935 .RE 1057 .RE
936 .PP 1058 .PP
937 /say text 1059 /say text
938 .RS 3n 1060 .RS 4
939 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. 1061 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.
940 .RE 1062 .RE
941 .PP 1063 .PP
942 /say_to jid text 1064 /say_to jid text
943 .RS 3n 1065 .RS 4
944 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 resource you will have to use "/say_to" for each message. 1066 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 resource you will have to use "/say_to" for each message.
945 .RE 1067 .RE
946 .PP 1068 .PP
947 /status [online|avail|invisible|free|dnd|notavail|away [\-|StatusMessage]] 1069 /status [online|avail|invisible|free|dnd|notavail|away [\-|StatusMessage]]
948 .RS 3n 1070 .RS 4
949 Show or 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 (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. 1071 Show or set the current status.
1072 If no status is specified, display the current status.
1073 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.
950 .RE 1074 .RE
951 .PP 1075 .PP
952 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] 1076 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]
953 .RS 3n 1077 .RS 4
954 Send the requested status to the specified Jabber user. If the specified jid is ".", the current buddy is used. Note: this status will be overridden by subsequent "/status" commands. If you are using the auto\-away feature, the status will overridden too. Note: The jid can include a resource (i.e. user@server/resource). 1078 Send the requested status to the specified Jabber user.
1079 If the specified jid is ".", the current buddy is used.
1080 Note: this status will be overridden by subsequent "/status" commands. If you are using the auto\-away feature, the status will overridden too. Note: The jid can include a resource (i.e. user@server/resource).
955 .RE 1081 .RE
956 .SH "CONFIGURATION FILE" 1082 .SH "CONFIGURATION FILE"
957 See the provided sample configuration file, which should be self\-documenting. 1083 See the provided sample configuration file, which should be self\-documenting.
1084 .sp
958 .SH "FILES" 1085 .SH "FILES"
959 The following files can be used by mcabber(1): 1086 The following files can be used by mcabber(1):
960 1087 .sp
961 .RS 3n 1088 .sp
1089 .RS 4
962 .nf 1090 .nf
963 $HOME/.mcabber/mcabberrc Default configuration file 1091 $HOME/.mcabber/mcabberrc Default configuration file
964 $HOME/.mcabberrc Configuration file used if no other has been found 1092 $HOME/.mcabberrc Configuration file used if no other has been found
965 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled 1093 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled
966 .fi 1094 .fi
967 .RE 1095 .RE
968 .SH "BUGS" 1096 .SH "BUGS"
969 Certainly. Please tell me if you find one! :\-) 1097 Certainly. Please tell me if you find one! :\-)
1098 .sp
970 .SH "AUTHOR" 1099 .SH "AUTHOR"
971 Written by [1]\&\fIMikael BERTHE\fR. Originally based on [2]\&\fICabber\fR, please consult the AUTHORS file for details. 1100 Written by \fIMikael BERTHE\fR\&[1]. Originally based on \fICabber\fR\&[2], please consult the AUTHORS file for details.
1101 .sp
972 .SH "RESOURCES" 1102 .SH "RESOURCES"
973 [3]\&\fIMain web site\fR 1103 \fIMain web site\fR\&[3]
1104 .sp
974 .SH "COPYING" 1105 .SH "COPYING"
975 Copyright (C) 2005, 2006 Mikael Berthe. Some portions are Copyright (C) 2002\-2004 [4]\&\fIcabber@ajmacias.com\fR. 1106 Copyright (C) 2005, 2006, 2007 Mikael Berthe. Some portions are Copyright (C) 2002\-2004 \fIcabber@ajmacias.com\fR\&[4].
1107 .sp
976 Free use of this software is granted under the terms of the GNU General Public License (GPL). 1108 Free use of this software is granted under the terms of the GNU General Public License (GPL).
1109 .sp
977 .SH "REFERENCES" 1110 .SH "REFERENCES"
978 .TP 3 1111 .IP " 1." 4
979 1.\ Mikael BERTHE 1112 Mikael BERTHE
1113 .RS 4
980 \%mailto:mcabber@lilotux.net 1114 \%mailto:mcabber@lilotux.net
981 .TP 3 1115 .RE
982 2.\ Cabber 1116 .IP " 2." 4
1117 Cabber
1118 .RS 4
983 \%http://cabber.sourceforge.net 1119 \%http://cabber.sourceforge.net
984 .TP 3 1120 .RE
985 3.\ Main web site 1121 .IP " 3." 4
1122 Main web site
1123 .RS 4
986 \%http://www.lilotux.net/~mikael/mcabber/ 1124 \%http://www.lilotux.net/~mikael/mcabber/
987 .TP 3 1125 .RE
988 4.\ cabber@ajmacias.com 1126 .IP " 4." 4
1127 cabber@ajmacias.com
1128 .RS 4
989 \%mailto:cabber@ajmacias.com 1129 \%mailto:cabber@ajmacias.com
1130 .RE