Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1 @ 2314:0d5660c6b4aa

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 Thu, 11 May 2017 14:32:24 +0200
parents fa8365fb6ac2
children 90b3e9876641
comparison
equal deleted inserted replaced
2313:70f8ae7d690e 2314:0d5660c6b4aa
1 '\" t 1 '\" t
2 .\" Title: mcabber 2 .\" Title: mcabber
3 .\" Author: [see the "AUTHOR" section] 3 .\" Author: Mikael BERTHE <mcabber@lilotux.net>
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> 4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5 .\" Date: 09/18/2016 5 .\" Date: May 2017
6 .\" Manual: \ \& 6 .\" Manual: \ \&
7 .\" Source: \ \& 1.0.6-dev 7 .\" Source: \ \& 1.0.6-dev
8 .\" Language: English 8 .\" Language: English
9 .\" 9 .\"
10 .TH "MCABBER" "1" "09/18/2016" "v1\&.0\&.6\-dev" 10 .TH "MCABBER" "1" "May 2017" "\ \& 1\&.0\&.6\-dev" "\ \&"
11 .\" ----------------------------------------------------------------- 11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff 12 .\" * Define some portability stuff
13 .\" ----------------------------------------------------------------- 13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673 15 .\" http://bugs.debian.org/507673
46 .\} 46 .\}
47 .el \{\ 47 .el \{\
48 .sp -1 48 .sp -1
49 .IP \(bu 2.3 49 .IP \(bu 2.3
50 .\} 50 .\}
51
52 \fISASL/SSL/TLS support\fR\&. 51 \fISASL/SSL/TLS support\fR\&.
53 .RE 52 .RE
54 .sp 53 .sp
55 .RS 4 54 .RS 4
56 .ie n \{\ 55 .ie n \{\
58 .\} 57 .\}
59 .el \{\ 58 .el \{\
60 .sp -1 59 .sp -1
61 .IP \(bu 2.3 60 .IP \(bu 2.3
62 .\} 61 .\}
63
64 \fIMUC support\fR 62 \fIMUC support\fR
65 (Multi\-User Chat)\&. 63 (Multi\-User Chat)\&.
66 .RE 64 .RE
67 .sp 65 .sp
68 .RS 4 66 .RS 4
71 .\} 69 .\}
72 .el \{\ 70 .el \{\
73 .sp -1 71 .sp -1
74 .IP \(bu 2.3 72 .IP \(bu 2.3
75 .\} 73 .\}
76
77 \fIPGP, OTR support\fR 74 \fIPGP, OTR support\fR
78 .RE 75 .RE
79 .sp 76 .sp
80 .RS 4 77 .RS 4
81 .ie n \{\ 78 .ie n \{\
83 .\} 80 .\}
84 .el \{\ 81 .el \{\
85 .sp -1 82 .sp -1
86 .IP \(bu 2.3 83 .IP \(bu 2.3
87 .\} 84 .\}
88
89 \fIChat States\fR 85 \fIChat States\fR
90 support (typing notifications) 86 support (typing notifications)
91 .RE 87 .RE
92 .sp 88 .sp
93 .RS 4 89 .RS 4
96 .\} 92 .\}
97 .el \{\ 93 .el \{\
98 .sp -1 94 .sp -1
99 .IP \(bu 2.3 95 .IP \(bu 2.3
100 .\} 96 .\}
101
102 \fIHistory logging:\fR 97 \fIHistory logging:\fR
103 If enabled (see the CONFIGURATION FILE section), 98 If enabled (see the CONFIGURATION FILE section),
104 mcabber 99 mcabber
105 can save discussions to text history log files\&. 100 can save discussions to text history log files\&.
106 .RE 101 .RE
111 .\} 106 .\}
112 .el \{\ 107 .el \{\
113 .sp -1 108 .sp -1
114 .IP \(bu 2.3 109 .IP \(bu 2.3
115 .\} 110 .\}
116
117 \fICommands completion:\fR 111 \fICommands completion:\fR
118 If possible, 112 If possible,
119 mcabber 113 mcabber
120 will try to complete your command line if you hit the Tab key\&. 114 will try to complete your command line if you hit the Tab key\&.
121 .RE 115 .RE
126 .\} 120 .\}
127 .el \{\ 121 .el \{\
128 .sp -1 122 .sp -1
129 .IP \(bu 2.3 123 .IP \(bu 2.3
130 .\} 124 .\}
131
132 \fIInput line history:\fR 125 \fIInput line history:\fR
133 Any message or command entered is in the input line history and can be reused easily\&. 126 Any message or command entered is in the input line history and can be reused easily\&.
134 .RE 127 .RE
135 .sp 128 .sp
136 .RS 4 129 .RS 4
139 .\} 132 .\}
140 .el \{\ 133 .el \{\
141 .sp -1 134 .sp -1
142 .IP \(bu 2.3 135 .IP \(bu 2.3
143 .\} 136 .\}
144
145 \fIExternal actions:\fR 137 \fIExternal actions:\fR
146 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 138 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
147 mcabber 139 mcabber
148 source code, in the contrib directory\&. 140 source code, in the contrib directory\&.
149 .RE 141 .RE
154 .\} 146 .\}
155 .el \{\ 147 .el \{\
156 .sp -1 148 .sp -1
157 .IP \(bu 2.3 149 .IP \(bu 2.3
158 .\} 150 .\}
159 151 \fIModules:\fRmcabber
160 \fIModules:\fR
161 mcabber
162 can load modules (a\&.k\&.a\&. plugins) at runtime that extend its features\&. 152 can load modules (a\&.k\&.a\&. plugins) at runtime that extend its features\&.
163 .RE 153 .RE
164 .SH "OPTIONS" 154 .SH "OPTIONS"
165 .PP 155 .PP
166 \-h 156 \-h
184 .sp 174 .sp
185 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\&. 175 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\&.
186 .sp 176 .sp
187 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\&. 177 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\&.
188 .sp 178 .sp
189 To display buddies chat buffers, you will have to enter \fIchat mode\fR\&. You can enter chat mode by pressing enter (unless \fIvi_mode\fR is enabled), and leave chat mode with the ESC key\&. Simply sending a message will also enable chat mode (unless \fIvi_mode\fR is enabled)\&. 179 To display buddies chat buffers, you will have to enter \fIchat mode\fR\&. You can enter chat mode by pressing enter (unless \fIvi mode\fR is enabled), and leave chat mode with the ESC key\&. Simply sending a message will also enable chat mode (unless \fIvi mode\fR is enabled)\&.
190 .sp 180 .sp
191 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\&. 181 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\&.
192 .SH "KEYS" 182 .SH "KEYS"
193 .sp 183 .sp
194 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...)\&. 184 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...)\&.
292 .RE 282 .RE
293 .sp 283 .sp
294 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section\&. 284 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section\&.
295 .SH "VI MODE" 285 .SH "VI MODE"
296 .sp 286 .sp
297 If the \fIvi_mode\fR option is set to \fI1\fR, MCabber accepts a few commands loosely based on those available in \fBvi\fR(1)'s normal mode\&. In this case, chat mode can \fInot\fR be entered by pressing enter, and messages cannot be composed outside of the chat mode\&. The following commands are accepted: 287 If the "vi_mode" option is set to 1, mcabber(1) accepts a few commands loosely based on those available in vi(1)\*(Aqs normal mode\&. In this case, chat mode is not entered by pressing enter, and messages cannot be composed outside of the chat mode\&. The following commands are accepted:
298 .PP 288 .PP
299 A 289 A
300 .RS 4 290 .RS 4
301 Call "/roster unread_first"\&. 291 Call "/roster unread_first"\&.
302 .RE 292 .RE
329 i 319 i
330 .RS 4 320 .RS 4
331 Enter chat mode\&. 321 Enter chat mode\&.
332 .RE 322 .RE
333 .PP 323 .PP
334 [\fIn\fR]j 324 [N]j
335 .RS 4 325 .RS 4
336 Call "/roster down [\fIn\fR]"\&. 326 Call "/roster down [N]"\&.
337 .RE 327 .RE
338 .PP 328 .PP
339 [\fIn\fR]k 329 [N]k
340 .RS 4 330 .RS 4
341 Call "/roster up [\fIn\fR]"\&. 331 Call "/roster up [N]"\&.
342 .RE 332 .RE
343 .PP 333 .PP
344 n 334 n
345 .RS 4 335 .RS 4
346 Repeat the previous search (if any)\&. 336 Repeat the previous search (if any)\&.
369 zR 359 zR
370 .RS 4 360 .RS 4
371 Call "/group unfold" for all groups\&. 361 Call "/group unfold" for all groups\&.
372 .RE 362 .RE
373 .PP 363 .PP
374 \&'' 364 \*(Aq\*(Aq
375 .RS 4 365 .RS 4
376 Call "/roster alternate"\&. 366 Call "/roster alternate"\&.
377 .RE 367 .RE
378 .PP 368 .PP
379 ! 369 !
388 .PP 378 .PP
389 <Space> 379 <Space>
390 .RS 4 380 .RS 4
391 Call "/group toggle" for the current group\&. 381 Call "/group toggle" for the current group\&.
392 .RE 382 .RE
393 .PP 383 .sp
394 A leading slash enables search mode: 384 A leading slash enables search mode:
395 .PP 385 .PP
396 /\fIstring\fR 386 /string
397 .RS 4 387 .RS 4
398 Call "/roster search \fIstring\fR"\&. 388 Call "/roster search string"\&.
399 .RE 389 .RE
400 .PP 390 .sp
401 A leading colon enabled command-line mode: 391 A leading colon enabled command\-line mode:
402 .PP 392 .sp
403 :q 393 .if n \{\
404 .RS 4 394 .RS 4
405 Call "/quit"\&. 395 .\}
406 .RE 396 .nf
407 .PP 397 above commands)\&.
408 :\fIn\fR 398 .fi
409 .RS 4 399 .if n \{\
410 Jump to line \fIn\fR in the roster\&. 400 .RE
411 .RE 401 .\}
412 .PP 402 .sp
413 :\fIcommand-line\fR 403 Commands entered with a leading colon and searches are either submitted by pressing enter or aborted by hitting escape\&. In either case, mcabber(1) returns to the normal (non\-chat) mode\&. History editing is supported in command\-line mode and in search mode\&. In command\-line mode, tab completion is supported as well\&.
414 .RS 4
415 Call "/\fIcommand-line\fR" (unless the \fIcommand-line\fR matches one of the above commands)\&.
416 .RE
417 .PP
418 Commands entered with a leading colon and searches are either submitted by pressing enter or aborted by hitting escape\&. In either case, MCabber returns to the normal (non-chat) mode\&. History editing is supported in command-line mode and in search mode\&. In command-line mode, tab completion is supported as well\&.
419 .SH "MCABBER\(cqS ROSTER" 404 .SH "MCABBER\(cqS ROSTER"
420 .sp 405 .sp
421 The first listed item 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\&. 406 The first listed item 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\&.
422 .sp 407 .sp
423 Group names are displayed above the items that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&. 408 Group names are displayed above the items that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&.
477 .sp 462 .sp
478 When there are unread messages from a buddy which you have not looked at, a hash mark (\fI#\fR) appears in the leftmost section of the roster for that buddy\&. The hash mark disappears once you view that buddy\(cqs message buffer\&. When the user attention is requested (or when you receive a message containing your nickname in a MUC room), the hash mark is replaced with the \fIattention sign\fR, an exclamation mark (\fI!\fR)\&. 463 When there are unread messages from a buddy which you have not looked at, a hash mark (\fI#\fR) appears in the leftmost section of the roster for that buddy\&. The hash mark disappears once you view that buddy\(cqs message buffer\&. When the user attention is requested (or when you receive a message containing your nickname in a MUC room), the hash mark is replaced with the \fIattention sign\fR, an exclamation mark (\fI!\fR)\&.
479 .sp 464 .sp
480 Examples: 465 Examples:
481 .PP 466 .PP
482 \fI\-\-\- Buds\fR 467 \*(Aq \-\-\- Buds\*(Aq
483 .RS 4 468 .RS 4
484 This is a group named 469 This is a group named
485 \fIBuds\fR 470 \fIBuds\fR
486 .RE 471 .RE
487 .PP 472 .PP
488 \fI#[o] John\fR 473 \fI#[o] John\fR
489 .RS 4 474 .RS 4
490 John is online, can see your status, and sent you a message that you did not read yet 475 John is online, can see your status, and sent you a message that you did not read yet
491 .RE 476 .RE
492 .PP 477 .PP
493 \fI{?} Sally\fR 478 \*(Aq {?} Sally\*(Aq
494 .RS 4 479 .RS 4
495 Neither you nor Sally have authorized each other to see your online status 480 Neither you nor Sally have authorized each other to see your online status
496 .RE 481 .RE
497 .PP 482 .PP
498 \fI{a} Jane\fR 483 \*(Aq {a} Jane\*(Aq
499 .RS 4 484 .RS 4
500 Jane is away, but she cannot see your online status 485 Jane is away, but she cannot see your online status
501 .RE 486 .RE
502 .PP 487 .PP
503 \fI#[C] x@y\&.c\fR 488 \fI#[C] x@y\&.c\fR
1449 .RS 4 1434 .RS 4
1450 Send the "text" message to the specified jid\&. 1435 Send the "text" message to the specified jid\&.
1451 1436
1452 Please note that this command doesn\(cqt 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\&. 1437 Please note that this command doesn\(cqt 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\&.
1453 1438
1454 You can send a message to a specific resource of the currently selected contact by using /say_to ./resourcename message\&. 1439 You can send a message to a specific resource of the currently selected contact by using /say_to \&./resourcename message\&.
1455 1440
1456 The "\-n" flag turns the message to "normal" type, "\-h" to "headline"\&. "\-\-" can be used to send chat messages beginning with \-n or \-h\&. 1441 The "\-n" flag turns the message to "normal" type, "\-h" to "headline"\&. "\-\-" can be used to send chat messages beginning with \-n or \-h\&.
1457 1442
1458 When "\-q" is used, the message will be sent in the background and will not change the current active window\&. 1443 When "\-q" is used, the message will be sent in the background and will not change the current active window\&.
1459 1444
1517 .if n \{\ 1502 .if n \{\
1518 .RS 4 1503 .RS 4
1519 .\} 1504 .\}
1520 .nf 1505 .nf
1521 $HOME/\&.mcabber/mcabberrc Default configuration file 1506 $HOME/\&.mcabber/mcabberrc Default configuration file
1507 $HOME/\&.config/mcabber/mcabberrc Alternate location (can use XDG_CONFIG_HOME)
1522 $HOME/\&.mcabberrc Configuration file used if no other has been found 1508 $HOME/\&.mcabberrc Configuration file used if no other has been found
1523 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled 1509 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled
1524 /usr/share/mcabber/help/ Default directory for online help files 1510 /usr/share/mcabber/help/ Default directory for online help files
1525 /usr/lib/mcabber/ Default directory for modules 1511 /usr/lib/mcabber/ Default directory for modules
1526 .fi 1512 .fi
1543 .SH "COPYING" 1529 .SH "COPYING"
1544 .sp 1530 .sp
1545 Copyright (C) 2005\-2017 Mikael Berthe and others\&. 1531 Copyright (C) 2005\-2017 Mikael Berthe and others\&.
1546 .sp 1532 .sp
1547 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. 1533 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.
1534 .SH "AUTHOR"
1535 .PP
1536 \fBMikael BERTHE\fR <\&mcabber@lilotux\&.net\&>
1537 .RS 4
1538 Author.
1539 .RE
1548 .SH "NOTES" 1540 .SH "NOTES"
1549 .IP " 1." 4 1541 .IP " 1." 4
1550 Mikael BERTHE 1542 Mikael BERTHE
1551 .RS 4 1543 .RS 4
1552 \%mailto:mikael@lilotux.net 1544 \%mailto:mikael@lilotux.net