Mercurial > ~mikael > mcabber > hg
annotate mcabber/doc/mcabber.1 @ 2304:fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
If the new vi_mode option is set to 1, let MCabber's non-chat mode
accept a few commands loosely based on those available in vi(1)'s normal
mode, e.g.:
A Call "/roster unread_first".
a Call "/roster unread_next".
F Call "/roster group_prev".
f Call "/roster group_next".
G Call "/roster bottom".
gg Call "/roster top".
i Enter chat mode.
[<n>]j Call "/roster down [<n>]".
[<n>]k Call "/roster up [<n>]".
n Repeat the previous search (if any).
O Call "/roster unread_first" and open chat window.
o Call "/roster unread_next" and open chat window.
ZZ Call "/quit".
zM Call "/group fold" for all groups.
zR Call "/group unfold" for all groups.
<Space> Call "/group toggle" for the current group.
'' Call "/roster alternate".
! Toggle attention flag for current buddy.
# Toggle unread messages flag for current buddy.
/<str> Call "/roster search <str>".
:q Call "/quit".
:wq Call "/quit".
:x Call "/quit".
:<n> Jump to line <n> in the roster.
:<cmd> Call "/<cmd>" (unless <cmd> matches one of the above commands).
| author | Holger Weiß <holger@zedat.fu-berlin.de> |
|---|---|
| date | Wed, 22 Jul 2015 19:25:22 +0200 |
| parents | 245ec6d73380 |
| children | 0d5660c6b4aa |
| rev | line source |
|---|---|
| 1759 | 1 '\" t |
| 1096 | 2 .\" Title: mcabber |
| 1759 | 3 .\" Author: [see the "AUTHOR" section] |
| 4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> | |
|
2275
3d6986784dae
Ready for release 1.0.3
Mikael Berthe <mikael@lilotux.net>
parents:
2271
diff
changeset
|
5 .\" Date: 09/18/2016 |
| 1759 | 6 .\" Manual: \ \& |
| 2302 | 7 .\" Source: \ \& 1.0.6-dev |
| 1759 | 8 .\" Language: English |
| 1096 | 9 .\" |
| 2302 | 10 .TH "MCABBER" "1" "09/18/2016" "v1\&.0\&.6\-dev" |
| 1759 | 11 .\" ----------------------------------------------------------------- |
| 12 .\" * Define some portability stuff | |
| 13 .\" ----------------------------------------------------------------- | |
| 14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 15 .\" http://bugs.debian.org/507673 | |
| 16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html | |
| 17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 18 .ie \n(.g .ds Aq \(aq | |
| 19 .el .ds Aq ' | |
| 20 .\" ----------------------------------------------------------------- | |
| 21 .\" * set default formatting | |
| 22 .\" ----------------------------------------------------------------- | |
| 1096 | 23 .\" disable hyphenation |
| 24 .nh | |
| 25 .\" disable justification (adjust text to left margin only) | |
| 26 .ad l | |
| 1759 | 27 .\" ----------------------------------------------------------------- |
| 28 .\" * MAIN CONTENT STARTS HERE * | |
| 29 .\" ----------------------------------------------------------------- | |
| 1096 | 30 .SH "NAME" |
| 1759 | 31 mcabber \- a simple Jabber (XMPP) console client |
| 226 | 32 .SH "SYNOPSIS" |
| 1242 | 33 .sp |
| 1759 | 34 \fImcabber\fR [ \-h | \-V | \-f configfile ] |
| 226 | 35 .SH "DESCRIPTION" |
| 1242 | 36 .sp |
| 1759 | 37 mcabber(1) is a small Jabber (XMPP) console client\&. For now it needs a configuration file to start, so please copy the sample mcabberrc file and adapt your connection settings\&. |
| 38 .sp | |
| 39 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet\&. | |
| 1242 | 40 .sp |
| 226 | 41 Here are some of the features of mcabber: |
| 1242 | 42 .sp |
| 43 .RS 4 | |
| 1759 | 44 .ie n \{\ |
| 45 \h'-04'\(bu\h'+03'\c | |
| 46 .\} | |
| 47 .el \{\ | |
| 48 .sp -1 | |
| 49 .IP \(bu 2.3 | |
| 50 .\} | |
| 51 | |
| 52 \fISASL/SSL/TLS support\fR\&. | |
| 1242 | 53 .RE |
| 54 .sp | |
| 55 .RS 4 | |
| 1759 | 56 .ie n \{\ |
| 57 \h'-04'\(bu\h'+03'\c | |
| 58 .\} | |
| 59 .el \{\ | |
| 60 .sp -1 | |
| 61 .IP \(bu 2.3 | |
| 62 .\} | |
| 63 | |
| 1096 | 64 \fIMUC support\fR |
| 1759 | 65 (Multi\-User Chat)\&. |
| 1242 | 66 .RE |
| 67 .sp | |
| 68 .RS 4 | |
| 1759 | 69 .ie n \{\ |
| 70 \h'-04'\(bu\h'+03'\c | |
| 71 .\} | |
| 72 .el \{\ | |
| 73 .sp -1 | |
| 74 .IP \(bu 2.3 | |
| 75 .\} | |
| 76 | |
| 77 \fIPGP, OTR support\fR | |
| 1242 | 78 .RE |
| 79 .sp | |
| 80 .RS 4 | |
| 1759 | 81 .ie n \{\ |
| 82 \h'-04'\(bu\h'+03'\c | |
| 83 .\} | |
| 84 .el \{\ | |
| 85 .sp -1 | |
| 86 .IP \(bu 2.3 | |
| 87 .\} | |
| 88 | |
| 1096 | 89 \fIChat States\fR |
| 90 support (typing notifications) | |
| 1242 | 91 .RE |
| 92 .sp | |
| 93 .RS 4 | |
| 1759 | 94 .ie n \{\ |
| 95 \h'-04'\(bu\h'+03'\c | |
| 96 .\} | |
| 97 .el \{\ | |
| 98 .sp -1 | |
| 99 .IP \(bu 2.3 | |
| 100 .\} | |
| 101 | |
| 1096 | 102 \fIHistory logging:\fR |
| 103 If enabled (see the CONFIGURATION FILE section), | |
| 104 mcabber | |
| 1759 | 105 can save discussions to text history log files\&. |
| 1242 | 106 .RE |
| 107 .sp | |
| 108 .RS 4 | |
| 1759 | 109 .ie n \{\ |
| 110 \h'-04'\(bu\h'+03'\c | |
| 111 .\} | |
| 112 .el \{\ | |
| 113 .sp -1 | |
| 114 .IP \(bu 2.3 | |
| 115 .\} | |
| 116 | |
| 1096 | 117 \fICommands completion:\fR |
| 118 If possible, | |
| 119 mcabber | |
| 1759 | 120 will try to complete your command line if you hit the Tab key\&. |
| 1242 | 121 .RE |
| 122 .sp | |
| 123 .RS 4 | |
| 1759 | 124 .ie n \{\ |
| 125 \h'-04'\(bu\h'+03'\c | |
| 126 .\} | |
| 127 .el \{\ | |
| 128 .sp -1 | |
| 129 .IP \(bu 2.3 | |
| 130 .\} | |
| 131 | |
| 1096 | 132 \fIInput line history:\fR |
| 1759 | 133 Any message or command entered is in the input line history and can be reused easily\&. |
| 1242 | 134 .RE |
| 135 .sp | |
| 136 .RS 4 | |
| 1759 | 137 .ie n \{\ |
| 138 \h'-04'\(bu\h'+03'\c | |
| 139 .\} | |
| 140 .el \{\ | |
| 141 .sp -1 | |
| 142 .IP \(bu 2.3 | |
| 143 .\} | |
| 144 | |
| 1096 | 145 \fIExternal actions:\fR |
| 1759 | 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 |
| 1096 | 147 mcabber |
| 1759 | 148 source code, in the contrib directory\&. |
| 149 .RE | |
| 150 .sp | |
| 151 .RS 4 | |
| 152 .ie n \{\ | |
| 153 \h'-04'\(bu\h'+03'\c | |
| 154 .\} | |
| 155 .el \{\ | |
| 156 .sp -1 | |
| 157 .IP \(bu 2.3 | |
| 158 .\} | |
| 159 | |
| 160 \fIModules:\fR | |
| 161 mcabber | |
| 162 can load modules (a\&.k\&.a\&. plugins) at runtime that extend its features\&. | |
| 1242 | 163 .RE |
| 1096 | 164 .SH "OPTIONS" |
| 165 .PP | |
| 1759 | 166 \-h |
| 1242 | 167 .RS 4 |
| 1096 | 168 Quick help usage message |
| 169 .RE | |
| 170 .PP | |
| 1759 | 171 \-V |
| 172 .RS 4 | |
| 173 Displays | |
| 174 mcabber | |
| 175 version and compile\-time definitions\&. | |
| 176 .RE | |
| 177 .PP | |
| 1096 | 178 \-f configfile |
| 1242 | 179 .RS 4 |
| 1096 | 180 Use configuration file |
| 181 \fIconfigfile\fR | |
| 182 .RE | |
| 183 .SH "WINDOWS/PANES" | |
| 1242 | 184 .sp |
| 1759 | 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\&. |
| 1242 | 186 .sp |
| 1759 | 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\&. |
| 188 .sp | |
|
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
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)\&. |
| 1242 | 190 .sp |
| 1759 | 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\&. |
| 192 .SH "KEYS" | |
| 1242 | 193 .sp |
| 1759 | 194 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...)\&. |
| 1242 | 195 .sp |
| 1759 | 196 PageUp and PageDown keys are used to move in the roster\&. |
| 1242 | 197 .sp |
| 1759 | 198 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)\&. |
| 1242 | 199 .sp |
| 1759 | 200 To send a message, move to the chosen 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\&. |
| 1242 | 201 .sp |
| 1759 | 202 Here is a quick description of the default key bindings: |
| 203 .PP | |
| 204 Esc | |
| 205 .RS 4 | |
| 206 Disable chat mode | |
| 207 .RE | |
| 208 .PP | |
| 209 Ctrl\-a | |
| 210 .RS 4 | |
| 211 Go to the beginning of the input line | |
| 212 .RE | |
| 213 .PP | |
| 214 Ctrl\-e | |
| 215 .RS 4 | |
| 216 Go to the end of the input line | |
| 217 .RE | |
| 218 .PP | |
| 219 Ctrl\-l | |
| 220 .RS 4 | |
| 221 Force a refresh | |
| 222 .RE | |
| 223 .PP | |
| 224 Up/Down | |
| 225 .RS 4 | |
| 226 Move in the input line history | |
| 227 .RE | |
| 228 .PP | |
| 229 PgUp/PgDown | |
| 230 .RS 4 | |
| 231 Move inside the roster (buddylist) | |
| 232 .RE | |
| 233 .PP | |
| 234 Tab | |
| 235 .RS 4 | |
| 236 Complete current word, in the input line | |
| 237 .RE | |
| 238 .PP | |
| 239 Ctrl\-g | |
| 240 .RS 4 | |
| 241 Cancel completion | |
| 242 .RE | |
| 243 .PP | |
| 244 Ctrl\-c | |
| 245 .RS 4 | |
| 246 Abort multi\-line messages and completions | |
| 247 .RE | |
| 248 .PP | |
| 249 Ctrl\-d | |
| 250 .RS 4 | |
| 251 Send/terminate a multi\-line message | |
| 252 .RE | |
| 253 .PP | |
| 254 Ctrl\-p/Ctrl\-n | |
| 255 .RS 4 | |
| 256 Scroll up/down half a screen in the buffer window (chat mode) | |
| 257 .RE | |
| 258 .PP | |
| 259 Ctrl\-Left | |
| 260 .RS 4 | |
| 261 Move the cursor back to the start of the current or previous word | |
| 262 .RE | |
| 263 .PP | |
| 264 Ctrl\-Right | |
| 265 .RS 4 | |
| 266 Move the cursor forward to the end of the current or next word | |
| 267 .RE | |
| 268 .PP | |
| 269 Ctrl\-u | |
| 270 .RS 4 | |
| 271 Delete from beginning of the line to the cursor | |
| 272 .RE | |
| 273 .PP | |
| 274 Ctrl\-k | |
| 275 .RS 4 | |
| 276 Delete from the cursor to the end of line | |
| 277 .RE | |
| 278 .PP | |
| 1096 | 279 Ctrl\-w |
| 1759 | 280 .RS 4 |
| 1096 | 281 Backward kill word |
| 1759 | 282 .RE |
| 283 .PP | |
| 1096 | 284 Ctrl\-t |
| 1759 | 285 .RS 4 |
| 1096 | 286 Transpose chars |
| 1759 | 287 .RE |
| 288 .PP | |
| 1096 | 289 Ctrl\-o |
| 1759 | 290 .RS 4 |
| 1096 | 291 Accept line and put the next history line in the input line (accept\-line\-and\-down\-history) |
| 1759 | 292 .RE |
| 1242 | 293 .sp |
| 1759 | 294 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section\&. |
|
2304
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
295 .SH "VI MODE" |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
296 .sp |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
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: |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
298 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
299 A |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
300 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
301 Call "/roster unread_first"\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
302 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
303 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
304 a |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
305 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
306 Call "/roster unread_next"\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
307 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
308 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
309 F |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
310 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
311 Call "/roster group_prev"\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
312 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
313 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
314 f |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
315 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
316 Call "/roster group_next"\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
317 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
318 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
319 G |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
320 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
321 Call "/roster bottom"\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
322 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
323 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
324 gg |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
325 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
326 Call "/roster top"\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
327 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
328 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
329 i |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
330 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
331 Enter chat mode\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
332 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
333 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
334 [\fIn\fR]j |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
335 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
336 Call "/roster down [\fIn\fR]"\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
337 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
338 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
339 [\fIn\fR]k |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
340 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
341 Call "/roster up [\fIn\fR]"\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
342 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
343 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
344 n |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
345 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
346 Repeat the previous search (if any)\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
347 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
348 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
349 O |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
350 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
351 Call "/roster unread_first" and open chat window\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
352 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
353 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
354 o |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
355 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
356 Call "/roster unread_next" and open chat window\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
357 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
358 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
359 ZZ |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
360 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
361 Call "/quit"\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
362 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
363 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
364 zM |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
365 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
366 Call "/group fold" for all groups\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
367 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
368 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
369 zR |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
370 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
371 Call "/group unfold" for all groups\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
372 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
373 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
374 \&'' |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
375 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
376 Call "/roster alternate"\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
377 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
378 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
379 ! |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
380 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
381 Toggle attention flag for current buddy\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
382 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
383 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
384 # |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
385 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
386 Toggle unread messages flag for current buddy\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
387 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
388 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
389 <Space> |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
390 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
391 Call "/group toggle" for the current group\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
392 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
393 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
394 A leading slash enables search mode: |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
395 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
396 /\fIstring\fR |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
397 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
398 Call "/roster search \fIstring\fR"\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
399 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
400 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
401 A leading colon enabled command-line mode: |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
402 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
403 :q |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
404 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
405 Call "/quit"\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
406 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
407 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
408 :\fIn\fR |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
409 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
410 Jump to line \fIn\fR in the roster\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
411 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
412 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
413 :\fIcommand-line\fR |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
414 .RS 4 |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
415 Call "/\fIcommand-line\fR" (unless the \fIcommand-line\fR matches one of the above commands)\&. |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
416 .RE |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
417 .PP |
|
fa8365fb6ac2
[PATCH 1/3] New option: vi_mode
Holger Weiß <holger@zedat.fu-berlin.de>
parents:
2302
diff
changeset
|
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\&. |
| 1759 | 419 .SH "MCABBER\(cqS ROSTER" |
| 1242 | 420 .sp |
| 1842 | 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\&. |
| 1242 | 422 .sp |
| 1842 | 423 Group names are displayed above the items that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&. |
| 1242 | 424 .sp |
| 1842 | 425 For every real Jabber contact, the roster displays four pieces of information: the buddy\(cqs name or alias, its online status, its authorization status, and whether there are unread messages from the buddy waiting for you\&. |
| 1242 | 426 .sp |
| 854 | 427 The online status is one of the following: |
| 1759 | 428 .PP |
| 1096 | 429 \fIo\fR |
| 1759 | 430 .RS 4 |
| 1096 | 431 online |
| 1759 | 432 .RE |
| 433 .PP | |
| 434 \fIf\fR | |
| 435 .RS 4 | |
| 436 free for chat | |
| 437 .RE | |
| 438 .PP | |
| 439 \fIa\fR | |
| 440 .RS 4 | |
| 441 away | |
| 442 .RE | |
| 443 .PP | |
| 444 \fIn\fR | |
| 445 .RS 4 | |
| 446 not available (labeled | |
| 447 \fIextended away\fR | |
| 448 in some clients) | |
| 449 .RE | |
| 450 .PP | |
| 451 \fId\fR | |
| 452 .RS 4 | |
| 453 do not disturb | |
| 454 .RE | |
| 455 .PP | |
| 456 \fI_\fR | |
| 457 .RS 4 | |
| 458 offline (or invisible to you) | |
| 459 .RE | |
| 460 .PP | |
| 461 \fI?\fR | |
| 462 .RS 4 | |
| 1842 | 463 unknown, usually meaning you are not authorized to see this buddy\(cqs status |
| 1759 | 464 .RE |
| 465 .PP | |
| 466 \fIx\fR | |
| 467 .RS 4 | |
| 468 a conference room in which you are not participating | |
| 469 .RE | |
| 470 .PP | |
| 1096 | 471 \fIC\fR |
| 1759 | 472 .RS 4 |
| 1096 | 473 a conference room in which you are participating |
| 1759 | 474 .RE |
| 1242 | 475 .sp |
| 1842 | 476 The authorization status indicates whether a buddy is authorized to receive your online status updates, and is displayed by the brackets surrounding the buddy\(cqs online status\&. Square brackets, like \fI[o]\fR, indicate that this buddy is authorized to receive your status\&. Curly braces, like \fI{o}\fR, indicate that they are not authorized to receive your status\&. |
| 1242 | 477 .sp |
| 1842 | 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)\&. |
| 1242 | 479 .sp |
| 854 | 480 Examples: |
| 1759 | 481 .PP |
| 482 \fI\-\-\- Buds\fR | |
| 483 .RS 4 | |
| 484 This is a group named | |
| 485 \fIBuds\fR | |
| 486 .RE | |
| 487 .PP | |
| 1096 | 488 \fI#[o] John\fR |
| 1759 | 489 .RS 4 |
| 1096 | 490 John is online, can see your status, and sent you a message that you did not read yet |
| 1759 | 491 .RE |
| 492 .PP | |
| 493 \fI{?} Sally\fR | |
| 494 .RS 4 | |
| 495 Neither you nor Sally have authorized each other to see your online status | |
| 496 .RE | |
| 497 .PP | |
| 498 \fI{a} Jane\fR | |
| 499 .RS 4 | |
| 500 Jane is away, but she cannot see your online status | |
| 501 .RE | |
| 502 .PP | |
| 503 \fI#[C] x@y\&.c\fR | |
| 504 .RS 4 | |
| 505 You are participating in x@y\&.c conference room, and there are unread messages | |
| 506 .RE | |
| 507 .SH "COMMANDS" | |
| 1242 | 508 .sp |
| 1759 | 509 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\&. |
| 510 .SH "COMMANDS RELATED TO MCABBER" | |
| 511 .PP | |
| 512 /add [jid [nickname]] | |
| 513 .RS 4 | |
| 514 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\&. | |
| 515 .PP | |
| 516 [\fIjid\fR [nickname]] | |
| 517 .RS 4 | |
| 518 Add to our roster "jid" as "nickname" | |
| 1242 | 519 .sp |
| 1759 | 520 .if n \{\ |
| 521 .RS 4 | |
| 522 .\} | |
| 523 .nf | |
| 524 Example: "/add somebody@jabber\&.server\&.com Somebody" | |
| 525 .fi | |
| 526 .if n \{\ | |
| 527 .RE | |
| 528 .\} | |
| 529 .RE | |
| 530 .RE | |
| 1096 | 531 .PP |
| 532 /alias [name [= command line]] | |
| 1242 | 533 .RS 4 |
| 1759 | 534 This command let you to add aliases which can simplify sophisticated commands\&. |
| 535 | |
| 536 You can manage your aliases by: | |
| 537 .PP | |
| 538 (without arguments) | |
| 539 .RS 4 | |
| 540 Print list of currently defined aliases | |
| 541 .RE | |
| 542 .PP | |
| 543 \fIname\fR | |
| 544 .RS 4 | |
| 545 Print the value of alias called "name" | |
| 546 .RE | |
| 547 .PP | |
| 548 \fIname\fR= | |
| 549 .RS 4 | |
| 550 Unset alias called "name" | |
| 551 .RE | |
| 552 .PP | |
| 553 \fIname\fR = command line | |
| 554 .RS 4 | |
| 555 Set alias called "name" with value "command line" | |
| 556 .sp | |
| 557 .if n \{\ | |
| 558 .RS 4 | |
| 559 .\} | |
| 560 .nf | |
| 561 Example: "/alias away = status away" | |
| 562 .fi | |
| 563 .if n \{\ | |
| 564 .RE | |
| 565 .\} | |
| 566 .RE | |
| 567 .RE | |
| 568 .PP | |
| 569 /authorization allow|cancel|request|request_unsubscribe [jid] | |
| 570 .RS 4 | |
| 571 This command manages presence subscriptions: it allows you to request presence subscriptions from others on your roster, and allows you to control who receives your presence notifications\&. | |
| 572 | |
| 573 If no JID is provided, the currently\-selected buddy is used\&. | |
| 574 .PP | |
| 575 \fIallow\fR | |
| 576 .RS 4 | |
| 577 Allow the buddy to receive your presence updates | |
| 578 .RE | |
| 579 .PP | |
| 580 \fIcancel\fR | |
| 581 .RS 4 | |
| 582 Cancel the buddy\(cqs subscription to your presence updates | |
| 583 .RE | |
| 584 .PP | |
| 585 \fIrequest\fR | |
| 586 .RS 4 | |
| 587 Request a subscription to the buddy\(cqs presence updates | |
| 588 .RE | |
| 589 .PP | |
| 590 \fIrequest_unsubscribe\fR | |
| 591 .RS 4 | |
| 592 Request unsubscription from the buddy\(cqs presence updates | |
| 593 .RE | |
| 1096 | 594 .RE |
| 595 .PP | |
| 596 /bind [keycode [= command line]] | |
| 1242 | 597 .RS 4 |
| 1759 | 598 Bind the command to the key given as "keycode"\&. To examine which keys are currently not used look at |
| 599 mcabber | |
| 600 log window and press examined key\&. For example: "Unknown key=265" means that you can bind some command to key #265\&. | |
| 601 .PP | |
| 602 (without arguments) | |
| 603 .RS 4 | |
| 604 Display list of current bindings | |
| 605 .RE | |
| 606 .PP | |
| 607 \fIkeycode\fR | |
| 608 .RS 4 | |
| 609 Display the command line bound to this key | |
| 610 .RE | |
| 611 .PP | |
| 612 \fIkeycode\fR= | |
| 613 .RS 4 | |
| 614 Unbind key with code "keycode" | |
| 615 .RE | |
| 616 .PP | |
| 617 \fIkeycode\fR = command line | |
| 618 .RS 4 | |
| 619 Bind "command line" to the key with code "keycode" | |
| 620 .sp | |
| 621 .if n \{\ | |
| 622 .RS 4 | |
| 623 .\} | |
| 624 .nf | |
| 625 Example: "/bind 265 = status away" (265 is F1)\&. + | |
| 626 Note: keycodes can be different depending on your ncurses configuration\&. + | |
| 627 Tip: aliases also can be used instead of commands\&. | |
| 628 .fi | |
| 629 .if n \{\ | |
| 630 .RE | |
| 631 .\} | |
| 632 .RE | |
| 633 .RE | |
| 634 .PP | |
| 635 /buffer clear|close|close_all|purge|list, /buffer top|bottom|date|%|search_backward|search_forward, /buffer scroll_lock|scroll_unlock|scroll_toggle, /buffer save filename | |
| 636 .RS 4 | |
| 1842 | 637 Buddy\(cqs buffer manipulation command\&. E\&.g\&. you can search through buffer for "text", clear chat window etc\&. |
| 1759 | 638 .PP |
| 639 \fIclear\fR | |
| 640 .RS 4 | |
| 641 Clear the current buddy chat window | |
| 642 .RE | |
| 643 .PP | |
| 644 \fIclose\fR [jid] | |
| 645 .RS 4 | |
| 646 Empty all contents of the buffer and close the current buddy chat window | |
| 647 .RE | |
| 648 .PP | |
| 649 \fIclose_all\fR | |
| 650 .RS 4 | |
| 651 Empty all contents of the chat buffers and close the chat windows | |
| 652 .RE | |
| 653 .PP | |
| 654 \fIpurge\fR [jid] | |
| 655 .RS 4 | |
| 656 Clear the current buddy chat window and empty all contents of the chat buffer | |
| 657 .RE | |
| 658 .PP | |
| 659 \fIlist\fR | |
| 660 .RS 4 | |
| 661 Display the list of existing buffers, with their length (lines/blocks) | |
| 1096 | 662 .RE |
| 663 .PP | |
| 1759 | 664 \fItop\fR |
| 1242 | 665 .RS 4 |
| 1759 | 666 Jump to the top of the current buddy chat buffer |
| 667 .RE | |
| 668 .PP | |
| 1096 | 669 \fIbottom\fR |
| 1759 | 670 .RS 4 |
| 671 Jump to the bottom of the current buddy chat buffer | |
| 672 .RE | |
| 673 .PP | |
| 674 \fIup\fR [n] | |
| 675 .RS 4 | |
| 676 Scroll the buffer up [n] lines (default: half a screen) | |
| 677 .RE | |
| 678 .PP | |
| 679 \fIdown\fR [n] | |
| 680 .RS 4 | |
| 681 Scroll the buffer down [n] lines (default: half a screen) | |
| 682 .RE | |
| 683 .PP | |
| 684 \fIdate\fR [date] | |
| 685 .RS 4 | |
| 686 Jump to the first line after the specified [date] in the chat buffer (date format: "YYYY\-mm\-dd") | |
| 687 .RE | |
| 688 .PP | |
| 689 % n | |
| 690 .RS 4 | |
| 691 Jump to position %n of the buddy chat buffer | |
| 692 .RE | |
| 693 .PP | |
| 694 \fIsearch_backward\fR text | |
| 695 .RS 4 | |
| 696 Search for [text] in the current buddy chat buffer | |
| 697 .RE | |
| 698 .PP | |
| 699 \fIsearch_forward\fR text | |
| 700 .RS 4 | |
| 701 Search for [text] in the current buddy chat buffer | |
| 702 .RE | |
| 703 .PP | |
| 1139 | 704 \fIscroll_lock\fR |
| 1759 | 705 .RS 4 |
| 706 Lock buffer scrolling | |
| 707 .RE | |
| 708 .PP | |
| 1139 | 709 \fIscroll_unlock\fR |
| 1759 | 710 .RS 4 |
| 711 Unlock buffer scrolling | |
| 712 .RE | |
| 713 .PP | |
| 1139 | 714 \fIscroll_toggle\fR |
| 1759 | 715 .RS 4 |
| 716 Toggle buffer scrolling (lock/unlock) | |
| 717 .RE | |
| 718 .PP | |
| 719 \fIsave\fR filename | |
| 720 .RS 4 | |
| 721 Save the contents of the current buffer to the file "filename" | |
| 722 .RE | |
| 723 .RE | |
| 724 .PP | |
| 725 /chat_disable [\-\-show\-roster] | |
| 726 .RS 4 | |
| 727 Disable chat mode\&. | |
| 728 | |
| 729 With \-\-show\-roster, the fullscreen mode will be disabled\&. | |
| 1096 | 730 .RE |
| 731 .PP | |
| 732 /clear | |
| 1242 | 733 .RS 4 |
| 1759 | 734 This command is actually an alias for "/buffer clear"\&. It clears the current buddy chat window\&. |
| 735 .RE | |
| 736 .PP | |
| 737 /color roster (status wildcard (color|\-)|clear), /color mucnick nick (color|\-), /color muc (jid|\&.|*) [on|preset|off|\-] | |
| 738 .RS 4 | |
| 1096 | 739 The |
| 1759 | 740 \fIcolor\fR |
| 741 command allows setting dynamic color properties of the screen\&. | |
| 742 .PP | |
| 743 \fIroster\fR clear | |
| 744 .RS 4 | |
| 745 Remove all color rules for the roster\&. All roster items will get its default color\&. | |
| 746 .RE | |
| 747 .PP | |
| 748 \fIroster\fR status wildcard color | |
| 749 .RS 4 | |
| 750 Set a color rule (or overwrite, if it already exists)\&. The status is string containing all statuses the roster item can have for the rule to match, or * if any status is OK\&. Wildcard is the file\-matching wildcard that will be applied to JID\&. Color is the wanted color\&. If color is \-, the rule is removed\&. If more than one rule matches, the color from the last created (not overwritten) is used\&. | |
| 751 .RE | |
| 752 .PP | |
| 753 \fImucnick\fR nick (color|\-) | |
| 754 .RS 4 | |
| 755 Marks the nick to be colored by given color\&. If a MUC has colored nicks, this one will be used\&. If color is \-, the color is marked as chosen automatically, which means it will not be used in | |
| 756 \fIpreset\fR | |
| 757 coloring mode, but will stay the same in | |
| 758 \fIon\fR | |
| 759 coloring mode\&. | |
| 760 .RE | |
| 761 .PP | |
| 762 \fImuc\fR (jid|\&.|*) [on|preset|off|\-] | |
| 763 .RS 4 | |
| 764 Sets a MUC nick coloring mode\&. If a jid (\&. means currently selected jid) is provided, the mode will apply to this specific MUC\&. If * is used, it will be applied to all MUCs, except the ones set by their jid\&. Mode | |
| 765 \fIon\fR | |
| 766 colors all nicks, | |
| 767 \fIpreset\fR | |
| 768 only the ones manually set by /color mucnick command and | |
| 769 \fIoff\fR | |
| 770 colors none\&. If not specified, defaults to | |
| 771 \fIon\fR\&. Mode | |
| 772 \fI\-\fR | |
| 773 removes the mode from given JID, which means the global one will apply\&. You can not remove the global mode\&. Default global coloring mode is | |
| 774 \fIoff\fR\&. | |
| 775 .RE | |
| 776 .RE | |
| 777 .PP | |
| 778 /connect | |
| 779 .RS 4 | |
| 780 Establish connection to the Jabber server\&. | |
| 781 .RE | |
| 782 .PP | |
| 783 /del | |
| 784 .RS 4 | |
| 785 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&. | |
| 786 .RE | |
| 787 .PP | |
| 788 /disconnect | |
| 789 .RS 4 | |
| 790 Terminate the connection to the Jabber server\&. | |
| 791 | |
| 792 Note: the roster is only available when the connection to the server is active, so the buddylist is empty when disconnected\&. | |
| 793 .RE | |
| 794 .PP | |
| 795 /echo message | |
| 796 .RS 4 | |
| 797 Display "message" in the log window\&. | |
| 798 .RE | |
| 799 .PP | |
| 800 /event #n|* accept|ignore|reject [event\-specific arguments], /event list | |
| 801 .RS 4 | |
| 802 Tell mcabber what to do about pending events\&. | |
| 803 | |
| 804 If the first parameter is | |
| 805 \fI*\fR, the command will apply to all queued events\&. | |
| 806 | |
| 807 Event\-specific arguments will be interpreted on event\-to event basis\&. The only built\-in case, when argument is used is MUC invitation reject \- argument, if present, will be interpreted as reject reason\&. | |
| 808 .PP | |
| 809 #N|* accept [event\-specific arguments] | |
| 810 .RS 4 | |
| 811 Event number #N/All events will be accepted | |
| 812 .RE | |
| 813 .PP | |
| 814 #N|* ignore [event\-specific arguments] | |
| 815 .RS 4 | |
| 816 Event number #N/All events will be ignored | |
| 817 .RE | |
| 818 .PP | |
| 819 #N|* reject [event\-specific arguments] | |
| 820 .RS 4 | |
| 821 Event number #N/All events will be rejected | |
| 822 .RE | |
| 823 .PP | |
| 824 \fIlist\fR | |
| 825 .RS 4 | |
| 826 List all pending events | |
| 827 .RE | |
| 828 .RE | |
| 829 .PP | |
| 830 /group fold|unfold|toggle [groupname] | |
| 831 .RS 4 | |
| 832 This command changes the current group display\&. | |
| 833 .PP | |
| 834 \fIfold\fR [groupname] | |
| 835 .RS 4 | |
| 836 Fold (shrink) the current/specified group tree in the roster | |
| 837 .RE | |
| 838 .PP | |
| 839 \fIunfold\fR [groupname] | |
| 840 .RS 4 | |
| 841 Unfold (expand) the current/specified group tree in the roster | |
| 842 .RE | |
| 843 .PP | |
| 844 \fItoggle\fR [groupname] | |
| 845 .RS 4 | |
| 846 Toggle the state (fold/unfold) of the current/specified tree | |
| 847 .RE | |
| 848 .RE | |
| 849 .PP | |
| 850 /help [command|+topic] | |
| 851 .RS 4 | |
| 852 Display help for command "command" or topic "topic"\&. | |
| 853 | |
| 854 Example: "/help buffer" | |
| 855 .RE | |
| 856 .PP | |
| 857 /iline fchar|bchar|char_fdel|char_bdel|char_swap, /iline fword|bword|word_bdel|word_fdel, /iline word_upcase|word_downcase|word_capit, /iline hist_beginning_search_bwd|hist_beginning_search_fwd, /iline hist_prev|hist_next, /iline iline_start|iline_end|iline_fdel|iline_bdel, /iline iline_accept|iline_accept_down_hist, /iline compl_do|compl_cancel, /iline send_multiline | |
| 858 .RS 4 | |
| 859 Input line commands | |
| 860 .PP | |
| 861 \fIfchar\fR | |
| 862 .RS 4 | |
| 863 Move to the next letter | |
| 864 .RE | |
| 865 .PP | |
| 866 \fIbchar\fR | |
| 867 .RS 4 | |
| 868 Move to the previous letter | |
| 869 .RE | |
| 870 .PP | |
| 871 \fIchar_fdel\fR | |
| 872 .RS 4 | |
| 873 Delete the letter at cursor position | |
| 874 .RE | |
| 875 .PP | |
| 876 \fIchar_bdel\fR | |
| 877 .RS 4 | |
| 878 Delete the letter before cursor position | |
| 879 .RE | |
| 880 .PP | |
| 881 \fIchar_swap\fR | |
| 882 .RS 4 | |
| 883 Transpose chars | |
| 884 .RE | |
| 885 .PP | |
| 886 \fIfword\fR | |
| 887 .RS 4 | |
| 888 Move the cursor forward to the end of the current or next word | |
| 889 .RE | |
| 890 .PP | |
| 891 \fIbword\fR | |
| 892 .RS 4 | |
| 893 Move the cursor back to the start of the current or previous word | |
| 894 .RE | |
| 895 .PP | |
| 896 \fIword_bdel\fR | |
| 897 .RS 4 | |
| 898 Delete the word from cursor position to its start | |
| 899 .RE | |
| 900 .PP | |
| 901 \fIword_fdel\fR | |
| 902 .RS 4 | |
| 903 Delete the word from cursor position to its end | |
| 904 .RE | |
| 905 .PP | |
| 906 \fIword_upcase\fR | |
| 907 .RS 4 | |
| 908 Convert the word from cursor position to its end to upper case | |
| 909 .RE | |
| 910 .PP | |
| 911 \fIword_downcase\fR | |
| 912 .RS 4 | |
| 913 Convert the word from cursor position to its end to down case | |
| 914 .RE | |
| 915 .PP | |
| 916 \fIword_capit\fR | |
| 917 .RS 4 | |
| 918 Capitalize the word from cursor position to its end | |
| 919 .RE | |
| 920 .PP | |
| 921 \fIhist_beginning_search_bwd\fR | |
| 922 .RS 4 | |
| 923 Search backward in the history for a line beginning with the current line up to the cursor (this leaves the cursor in its original position) | |
| 924 .RE | |
| 925 .PP | |
| 926 \fIhist_beginning_search_fwd\fR | |
| 927 .RS 4 | |
| 928 Search forward in the history for a line beginning with the current line up to the cursor (this leaves the cursor in its original position) | |
| 929 .RE | |
| 930 .PP | |
| 931 \fIhist_prev\fR | |
| 932 .RS 4 | |
| 933 Previous line of input line history | |
| 934 .RE | |
| 935 .PP | |
| 936 \fIhist_next\fR | |
| 937 .RS 4 | |
| 938 Next line of input line history | |
| 939 .RE | |
| 940 .PP | |
| 941 \fIiline_start\fR | |
| 942 .RS 4 | |
| 943 Go to the beginning of the input line | |
| 944 .RE | |
| 945 .PP | |
| 946 \fIiline_end\fR | |
| 947 .RS 4 | |
| 948 Go to the end of the input line | |
| 949 .RE | |
| 950 .PP | |
| 951 \fIiline_fdel\fR | |
| 952 .RS 4 | |
| 953 Delete from the cursor to the end of line | |
| 1096 | 954 .RE |
| 955 .PP | |
| 1759 | 956 \fIiline_bdel\fR |
| 957 .RS 4 | |
| 958 Delete from beginning of the line to the cursor | |
| 959 .RE | |
| 960 .PP | |
| 961 \fIiline_accept\fR | |
| 962 .RS 4 | |
| 963 Accept line | |
| 964 .RE | |
| 965 .PP | |
| 966 \fIiline_accept_down_hist\fR | |
| 967 .RS 4 | |
| 968 Accept line and put the next history line in the input line | |
| 969 .RE | |
| 970 .PP | |
| 971 \fIcompl_do\fR | |
| 972 .RS 4 | |
| 973 Complete current word, in the input line | |
| 974 .RE | |
| 975 .PP | |
| 976 \fIcompl_cancel\fR | |
| 977 .RS 4 | |
| 978 Cancel completion | |
| 979 .RE | |
| 980 .PP | |
| 981 \fIsend_multiline\fR | |
| 982 .RS 4 | |
| 983 Send/terminate a multi\-line message | |
| 984 .RE | |
| 985 .RE | |
| 986 .PP | |
| 987 /info | |
| 988 .RS 4 | |
| 989 Display info on the selected entry (user, agent, group\&...)\&. | |
| 990 | |
| 991 For users, resources are displayed with the status, priority and status message (if available) of each resource\&. | |
| 992 .RE | |
| 993 .PP | |
| 994 /module load|unload [\-f] module, /module info module, /module [list] | |
| 995 .RS 4 | |
| 996 Load, unload or show info on module\&. | |
| 997 .PP | |
| 998 \fIload\fR [\-f] module | |
| 999 .RS 4 | |
| 1000 Loads specified module\&. If \-f flag is specified, most of module loading errors will be ignored\&. | |
| 1001 .RE | |
| 1002 .PP | |
| 1003 \fIunload\fR [\-f] module | |
| 1004 .RS 4 | |
| 1842 | 1005 Unloads specified module\&. Note: The force flag will not remove any dependency on this module! |
| 1759 | 1006 .RE |
| 1007 .PP | |
| 1008 \fIinfo\fR module | |
| 1009 .RS 4 | |
| 1010 Shows available information about this module\&. | |
| 1011 .RE | |
| 1012 .PP | |
| 1013 [\fIlist\fR] | |
| 1014 .RS 4 | |
| 1015 Lists modules in a format: [modulename] [reference count] ([Manually/Automatically loaded]) [any extra info, like version or dependencies] | |
| 1016 .RE | |
| 1017 .RE | |
| 1018 .PP | |
| 1019 /move [groupname] | |
| 1020 .RS 4 | |
| 1021 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\(cqt exist, it is created\&. | |
| 1022 | |
| 1023 Tip: if the chatmode is enabled, you can use "/roster alternate" to jump to the moved buddy\&. | |
| 1024 .RE | |
| 1025 .PP | |
| 1026 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort | |
| 1027 .RS 4 | |
| 1028 Send a multi\-line message\&. To write a single message with several lines, the | |
| 1029 \fImulti\-line mode\fR | |
| 1030 should be used\&. | |
| 1031 | |
| 1032 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\&. | |
| 1033 | |
| 1034 The | |
| 1035 \fIbegin\fR | |
| 1036 subcommand enables multi\-line mode\&. Note that it allows a message subject to be specified\&. | |
| 1037 | |
| 1038 The | |
| 1039 \fIverbatim\fR | |
| 1040 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\&. | |
| 1041 | |
| 1042 The | |
| 1043 \fItoggle\fR | |
| 1044 subcommand can be bound to a key to use the multi\-line mode quickly (for example, "bind M13 = msay toggle" to switch using the Meta\-Enter combination)\&. | |
| 1045 .PP | |
| 1046 \fIbegin\fR [subject] | |
| 1047 .RS 4 | |
| 1048 Enter multi\-line mode | |
| 1049 .RE | |
| 1050 .PP | |
| 1051 \fIverbatim\fR | |
| 1052 .RS 4 | |
| 1053 Enter verbatim multi\-line mode | |
| 1054 .RE | |
| 1055 .PP | |
| 1056 \fIsend\fR [\-n|\-h] | |
| 1057 .RS 4 | |
| 1058 Send the current multi\-line message to the currently selected buddy | |
| 1059 .RE | |
| 1060 .PP | |
| 1061 \fIsend_to\fR [\-n|\-h] jid | |
| 1242 | 1062 .RS 4 |
| 1759 | 1063 Send the current multi\-line message to "jid" |
| 1064 .RE | |
| 1065 .PP | |
| 1066 \fItoggle\fR|\fItoggle_verbatim\fR | |
| 1067 .RS 4 | |
| 1068 Switch to/from multi\-line mode (begin/send) | |
| 1069 .RE | |
| 1070 .PP | |
| 1071 \fIabort\fR | |
| 1072 .RS 4 | |
| 1073 Leave multi\-line mode without sending the message | |
| 1074 .sp | |
| 1075 .if n \{\ | |
| 1076 .RS 4 | |
| 1077 .\} | |
| 1078 .nf | |
| 1079 The \-n or \-h flags turn the message to "normal" or "headline" accordingly, as opposed to default "chat" message\&. | |
| 1080 .fi | |
| 1081 .if n \{\ | |
| 1082 .RE | |
| 1083 .\} | |
| 1084 .RE | |
| 1085 .RE | |
| 1086 .PP | |
| 1087 /otr key, /otr start|stop|info [jid], /otr fingerprint [jid [fpr]], /otr smpq|smpr [jid] secret, /otr smpa [jid] | |
| 1088 .RS 4 | |
| 1089 You can use the shortcut\-jid "\&." for the currently selected contact\&. | |
| 1090 .PP | |
| 1091 \fIkey\fR | |
| 1092 .RS 4 | |
| 1093 Print the fingerprint of your private key to the Status Buffer | |
| 1094 .RE | |
| 1095 .PP | |
| 1096 \fIstart\fR [jid] | |
| 1097 .RS 4 | |
| 1098 Open an OTR channel to the specified jid (or the currently selected contact) | |
| 1099 .RE | |
| 1100 .PP | |
| 1101 \fIstop\fR [jid] | |
| 1102 .RS 4 | |
| 1103 Close the OTR channel to the specified jid (or the currently selected contact) | |
| 1104 .RE | |
| 1105 .PP | |
| 1106 \fIinfo\fR [jid] | |
| 1107 .RS 4 | |
| 1108 Show current OTR status for the specified jid (or the currently selected contact) | |
| 1109 .RE | |
| 1110 .PP | |
| 1111 \fIfingerprint\fR [jid [fpr]] | |
| 1112 .RS 4 | |
| 1113 Show the active fingerprint of an OTR channel\&. If the fingerprint is provided instead of "fpr", the fingerprint will become trusted\&. If you replace "fpr" by some bogus string the fingerprint will loose the trusted status\&. | |
| 1114 .RE | |
| 1115 .PP | |
| 1116 \fIsmpq\fR [jid] secret | |
| 1117 .RS 4 | |
| 1118 Initiate the Socialist Millionaires Protocol with the secret and the buddy | |
| 1119 .RE | |
| 1120 .PP | |
| 1121 \fIsmpr\fR [jid] secret | |
| 1122 .RS 4 | |
| 1123 Respond to the Initiation of the jid with the secret | |
| 1124 .RE | |
| 1125 .PP | |
| 1126 \fIsmpa\fR [jid] | |
| 1127 .RS 4 | |
| 1128 Abort the running Socialist Millionaires Protocol | |
| 1129 .RE | |
| 1130 .RE | |
| 1131 .PP | |
| 1132 /otrpolicy, /otrpolicy (default|jid) (plain|manual|opportunistic|always) | |
| 1133 .RS 4 | |
| 1134 You can use the shortcut\-jid "\&." for the currently selected contact\&. | |
| 1135 .PP | |
| 1136 (without arguments) | |
| 1137 .RS 4 | |
| 1138 Prints all OTR policies to the status buffer | |
| 1139 .RE | |
| 1140 .PP | |
| 1141 (\fIdefault\fR|\fIjid\fR) (plain|manual|opportunistic|always) | |
| 1142 .RS 4 | |
| 1143 Sets either the default policy or the policy for the given jid The plain policy should never be used, because you won\(cqt be able to receive or send any OTR encrypted messages\&. If you set the policy to manual, you or your chat partner have to start the OTR encryption by hand (e\&.g\&. with /otr start)\&. The policy "opportunistic" does that itself by sending a special whitespace\-sequence at the end of unencrypted messages\&. So the other OTR\-enabled chat client knows, that you want to use OTR\&. Note that the first message will always be unencryted, if you use this policy\&. With the policy "always" no message will be sent in plain text\&. If you try to sent the first message unencrypted, mcabber will try to establish an OTR channel\&. Please resend your message, when you get the information that the channel was established\&. If someone sends you plaintext messages while the policy is set to "always", you\(cqll be able to read the message but it won\(cqt be saved to the history\&. | |
| 1144 .RE | |
| 1145 .RE | |
| 1146 .PP | |
| 1147 /pgp disable|enable|force|info [jid], /pgp setkey [jid [key]] | |
| 1148 .RS 4 | |
| 1149 This command manipulates PGP settings for the specified jid (by default the currently selected contact)\&. | |
| 1150 | |
| 1151 Please note that PGP encryption won\(cqt be used if no remote PGP support is detected, even if PGP is enabled with this command\&. You can force PGP encryption with the "force" subcommand\&. | |
| 1152 .PP | |
| 1153 \fIdisable\fR [jid] | |
| 1154 .RS 4 | |
| 1155 Disable PGP encryption for jid (or the currently selected contact) | |
| 1156 .RE | |
| 1157 .PP | |
| 1158 \fIenable\fR [jid] | |
| 1159 .RS 4 | |
| 1160 Enable PGP encryption for jid (or the currently selected contact) | |
| 1161 .RE | |
| 1162 .PP | |
| 1163 \fIforce\fR [jid] | |
| 1164 .RS 4 | |
| 1165 Enforce PGP encryption, even for offline messages, and always assume the recipient has PGP support\&. If a message can\(cqt be encrypted (missing key or key id), the messages won\(cqt be sent at all\&. This option is ignored when PGP is disabled\&. | |
| 1166 .RE | |
| 1167 .PP | |
| 1168 \fIinfo\fR [jid] | |
| 1169 .RS 4 | |
| 1170 Show current PGP settings for the contact | |
| 1171 .RE | |
| 1172 .PP | |
| 1173 \fIsetkey\fR [jid [key]] | |
| 1174 .RS 4 | |
| 1175 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\&. | |
| 1176 .RE | |
| 1096 | 1177 .RE |
| 1178 .PP | |
| 1179 /quit | |
| 1242 | 1180 .RS 4 |
| 1759 | 1181 This command closes all connections and quit mcabber\&. |
| 1096 | 1182 .RE |
| 1183 .PP | |
| 1184 /rawxml send string | |
| 1242 | 1185 .RS 4 |
| 1759 | 1186 Send "string" (raw XML format) to the Jabber server\&. |
| 829 | 1187 |
| 1759 | 1188 No check is done on the string provided\&. |
| 1189 | |
| 1190 BEWARE! Use this only if you know what you are doing, or you could terminate the connection\&. | |
| 1191 | |
| 1192 Example: "/rawxml send <presence><show>away</show></presence>" | |
| 1096 | 1193 .RE |
| 1194 .PP | |
| 1195 /rename name | |
| 1242 | 1196 .RS 4 |
| 1759 | 1197 Rename the current buddy or group to the given "name"\&. If "name" is \-, the name is removed from the roster (and mcabber will display the JID or username)\&. |
| 1198 .RE | |
| 1199 .PP | |
| 1200 /request last|ping|time|vcard|version [jid] | |
| 1201 .RS 4 | |
| 1202 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\&. | |
| 1203 .PP | |
| 1204 \fIlast\fR | |
| 1205 .RS 4 | |
| 1206 Request "last" information (usually idle time) | |
| 1207 .RE | |
| 1208 .PP | |
| 1209 \fIping\fR | |
| 1210 .RS 4 | |
| 1211 Send an XMPP Ping request\&. Note that you should use the full JID since a ping sent to a bare JID will be handled by the server\&. | |
| 1096 | 1212 .RE |
| 1213 .PP | |
| 1759 | 1214 \fItime\fR |
| 1242 | 1215 .RS 4 |
| 1759 | 1216 Request time from the buddy |
| 1096 | 1217 .RE |
| 1218 .PP | |
| 1759 | 1219 \fIvcard\fR |
| 1220 .RS 4 | |
| 1221 Request VCard from the buddy | |
| 1222 .RE | |
| 1223 .PP | |
| 1224 \fIversion\fR | |
| 1225 .RS 4 | |
| 1226 Request version from the buddy | |
| 1227 .RE | |
| 1228 .RE | |
| 1229 .PP | |
| 1230 /room join|leave|names|nick|remove|topic|unlock|destroy, /room privmsg|invite|whois|kick|ban|unban|role|affil, /room setopt print_status|auto_whois [value], /room bookmark [add|del] [\-autojoin|+autojoin] [\-|nick] | |
| 1242 | 1231 .RS 4 |
| 1096 | 1232 The |
| 1233 \fIroom\fR | |
| 1759 | 1234 command handles Multi\-User Chat room actions\&. |
| 1235 .PP | |
| 1236 \fIjoin\fR [room [nick [pass]]] | |
| 1237 .RS 4 | |
| 1238 Join "room", using "nick" as nickname\&. If no nickname is provided (or if it is an empty string), the "nickname" option value is used (see sample configuration file)\&. If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "\&." can be used instead of the full room id\&. A password can be provided to enter protected rooms\&. If your nickname contains space characters, use quotes\&. | |
| 1239 .RE | |
| 1240 .PP | |
| 1241 \fIleave\fR [message] | |
| 1242 .RS 4 | |
| 1243 Leave the current room | |
| 1244 .RE | |
| 1245 .PP | |
| 1246 \fInames\fR [\-\-detail|\-\-short|\-\-quiet|\-\-compact] | |
| 1247 .RS 4 | |
| 1248 Display members of the current room | |
| 1249 .RE | |
| 1250 .PP | |
| 1251 \fInick\fR newnick | |
| 1252 .RS 4 | |
| 1253 Change your nickname in the current room | |
| 1254 .RE | |
| 1255 .PP | |
| 1256 \fIprivmsg\fR nick msg | |
| 1257 .RS 4 | |
| 1258 Send private message "msg" to "nick" | |
| 1259 .RE | |
| 1260 .PP | |
| 1096 | 1261 \fIremove\fR |
| 1759 | 1262 .RS 4 |
| 1263 Remove the current room from the roster (you must have left this room before) | |
| 1264 .RE | |
| 1265 .PP | |
| 1266 \fItopic\fR \-|newtopic | |
| 1267 .RS 4 | |
| 1268 Set topic for current room | |
| 1269 .RE | |
| 1270 .PP | |
| 1096 | 1271 \fIunlock\fR |
| 1759 | 1272 .RS 4 |
| 1273 Unlock current room (if you are the owner) | |
| 1274 .RE | |
| 1275 .PP | |
| 1276 \fIdestroy\fR [reason] | |
| 1277 .RS 4 | |
| 1278 Destroy the current room (use with care!) | |
| 1096 | 1279 .RE |
| 1280 .PP | |
| 1759 | 1281 \fIwhois\fR nick |
| 1282 .RS 4 | |
| 1283 Display MUC information about "nick" | |
| 1284 .RE | |
| 1285 .PP | |
| 1286 \fIban\fR jid [reason] | |
| 1287 .RS 4 | |
| 1288 Ban jid from the current room | |
| 1289 .RE | |
| 1290 .PP | |
| 1291 \fIunban\fR jid | |
| 1292 .RS 4 | |
| 1293 Unban jid from the current room | |
| 1294 .RE | |
| 1295 .PP | |
| 1296 \fIinvite\fR jid [reason] | |
| 1297 .RS 4 | |
| 1298 Invite jid to the current room | |
| 1299 .RE | |
| 1300 .PP | |
| 1301 \fIkick\fR nick [reason] | |
| 1302 .RS 4 | |
| 1303 Kick "nick" from the current room | |
| 1304 .RE | |
| 1305 .PP | |
|
2271
8e4e91c5cf6b
Update manpage wrt latest change
Mikael Berthe <mikael@lilotux.net>
parents:
2257
diff
changeset
|
1306 \fIrole\fR nick role [reason] |
| 1759 | 1307 .RS 4 |
|
2271
8e4e91c5cf6b
Update manpage wrt latest change
Mikael Berthe <mikael@lilotux.net>
parents:
2257
diff
changeset
|
1308 Change nick\(cqs role (role can be "none", "visitor", "participant", "moderator") |
| 1759 | 1309 .RE |
| 1310 .PP | |
| 1311 \fIaffil\fR jid affil [reason] | |
| 1312 .RS 4 | |
| 1313 Change jid\(cqs affiliation (affil can be "none", "member", "admin", "owner") | |
| 1314 .RE | |
| 1315 .PP | |
| 1316 \fIsetopt\fR print_status|auto_whois [value] | |
| 1317 .RS 4 | |
| 1318 Change settings for the current room For print_status, the possible values are "default", "none", "in_and_out", "all"\&. For auto_whois, the possible values are "default", "off", "on"\&. When the value is "default", the options muc_print_status / muc_auto_whois is used\&. | |
| 1319 .RE | |
| 1320 .PP | |
| 1321 \fIbookmark\fR [add|del] [\-autojoin|+autojoin] [\-|nick] | |
| 1322 .RS 4 | |
| 1323 Add, remove or update a bookmark (default is add)\&. If autojoin is set, mcabber will automatically join the MUC room when it connects to the server\&. To see the list of bookmarks, use /room bookmark in the status buffer\&. | |
| 1324 .RE | |
| 1325 .RE | |
| 1326 .PP | |
| 1327 /roster bottom|top|up|down|group_prev|group_next, /roster alternate|unread_first|unread_next, /roster search bud, /roster display|hide_offline|show_offline|toggle_offline, /roster item_lock|item_unlock|item_toggle_lock, /roster hide|show|toggle, /roster note [\-|text] | |
| 1242 | 1328 .RS 4 |
| 1096 | 1329 The |
| 1330 \fIroster\fR | |
| 1759 | 1331 command manipulates the roster/buddylist\&. |
| 1332 | |
| 1333 Here are the available parameters: | |
| 1334 .PP | |
| 1096 | 1335 \fIbottom\fR |
| 1759 | 1336 .RS 4 |
| 1337 Jump to the bottom of the roster | |
| 1338 .RE | |
| 1339 .PP | |
| 1340 \fItop\fR | |
| 1341 .RS 4 | |
| 1342 Jump to the top of the roster | |
| 1343 .RE | |
| 1344 .PP | |
| 1345 \fIup\fR [n] | |
| 1346 .RS 4 | |
| 1347 Move up [n lines] in the roster | |
| 1348 .RE | |
| 1349 .PP | |
| 1350 \fIdown\fR [n] | |
| 1351 .RS 4 | |
| 1352 Move down [n lines] in the roster | |
| 1353 .RE | |
| 1354 .PP | |
| 1355 \fIgroup_prev\fR | |
| 1356 .RS 4 | |
| 1357 Jump to the previous group in the roster | |
| 1358 .RE | |
| 1359 .PP | |
| 1360 \fIgroup_next\fR | |
| 1361 .RS 4 | |
| 1362 Jump to the next group in the roster | |
| 1363 .RE | |
| 1364 .PP | |
| 1365 \fIalternate\fR | |
| 1366 .RS 4 | |
| 1367 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_next" (Ctrl\-q)\&. | |
| 1368 .RE | |
| 1369 .PP | |
| 1370 \fIunread_first\fR | |
| 1371 .RS 4 | |
| 1372 Jump to the first unread message | |
| 1373 .RE | |
| 1374 .PP | |
| 1375 \fIunread_next\fR | |
| 1376 .RS 4 | |
| 1377 Jump to the next unread message | |
| 1378 .RE | |
| 1379 .PP | |
| 1380 \fIsearch\fR bud | |
| 1381 .RS 4 | |
| 1382 Search for a buddy with a name or jid containing "bud" (only in the displayed buddylist) | |
| 1383 .RE | |
| 1384 .PP | |
| 1385 \fIdisplay\fR [mask] | |
| 1386 .RS 4 | |
| 1387 See or update the roster filter\&. The mask should contain the shortcut letters of the status you want to see ([o]nline, [f]ree_for_chat, [d]o_not_disturb, [n]ot_available, [a]way, [_]offline)\&. For example "ofdna" to display only connected buddies\&. | |
| 1388 .RE | |
| 1389 .PP | |
| 1096 | 1390 \fIhide_offline\fR |
| 1759 | 1391 .RS 4 |
| 1392 Hide offline buddies (same as /roster display ofdna) | |
| 1393 .RE | |
| 1394 .PP | |
| 1096 | 1395 \fIshow_offline\fR |
| 1759 | 1396 .RS 4 |
| 1397 Show offline buddies (same as /roster display ofdna_) | |
| 1398 .RE | |
| 1399 .PP | |
| 1096 | 1400 \fItoggle_offline\fR |
| 1759 | 1401 .RS 4 |
| 1402 Toggle display of offline buddies | |
| 1403 .RE | |
| 1404 .PP | |
| 1405 \fIitem_lock\fR [jid] | |
| 1406 .RS 4 | |
| 1407 Lock the roster item so it remains visible regardless of its status | |
| 1408 .RE | |
| 1409 .PP | |
| 1410 \fIitem_unlock\fR [jid] | |
| 1411 .RS 4 | |
| 1412 Undo the effects of item_lock | |
| 1413 .RE | |
| 1414 .PP | |
| 1415 \fIitem_toggle_lock\fR [jid] | |
| 1416 .RS 4 | |
| 1417 Invert the current lock flag | |
| 1418 .RE | |
| 1419 .PP | |
| 1096 | 1420 \fIhide\fR |
| 1759 | 1421 .RS 4 |
| 1422 Hide roster (full\-width chat window) | |
| 1423 .RE | |
| 1424 .PP | |
| 1096 | 1425 \fIshow\fR |
| 1759 | 1426 .RS 4 |
| 1427 Show roster | |
| 1428 .RE | |
| 1429 .PP | |
| 1096 | 1430 \fItoggle\fR |
| 1759 | 1431 .RS 4 |
| 1432 Toggle roster visibility | |
| 1096 | 1433 .RE |
| 1434 .PP | |
| 1759 | 1435 \fInote\fR [\-|text] |
| 1242 | 1436 .RS 4 |
| 1759 | 1437 Set/update/delete an annotation\&. If there is no text, the current item\(cqs annotation is displayed \(em if you are in the status buffer, all notes are displayed\&. If text is "\-", the note is erased\&. |
| 1438 .RE | |
| 1439 .RE | |
| 1440 .PP | |
| 1441 /say [\-n|\-h|\-\-] text | |
| 1442 .RS 4 | |
| 1443 Send the "text" message to the currently selected buddy\&. It can be useful if you want to send a message beginning with a slash, for example\&. | |
| 1444 | |
| 1445 The "\-n" flag turns the message to "normal" type, "\-h" to "headline"\&. "\-\-" can be used to send chat message beginning with \-n or \-h\&. | |
| 1096 | 1446 .RE |
| 1447 .PP | |
| 1759 | 1448 /say_to [\-n|\-h] [\-q] [\-f file] jid text |
| 1242 | 1449 .RS 4 |
| 1759 | 1450 Send the "text" message to the specified jid\&. |
| 1451 | |
| 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\&. | |
| 1453 | |
|
1924
57c352ed37f9
Update help/documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1891
diff
changeset
|
1454 You can send a message to a specific resource of the currently selected contact by using /say_to ./resourcename message\&. |
|
57c352ed37f9
Update help/documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1891
diff
changeset
|
1455 |
| 1759 | 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\&. |
| 1457 | |
| 1458 When "\-q" is used, the message will be sent in the background and will not change the current active window\&. | |
| 1459 | |
| 1460 A text file can be provided with the "\-f" switch (in which case there\(cqs no need to pass a text argument after the jid, of course)\&. | |
| 1461 .RE | |
| 1462 .PP | |
| 1463 /screen_refresh | |
| 1464 .RS 4 | |
| 1465 Refresh the mcabber screen\&. | |
| 1096 | 1466 .RE |
| 1467 .PP | |
| 1842 | 1468 /set [option [= value]] |
| 1242 | 1469 .RS 4 |
| 1759 | 1470 Display or set an option value\&. |
| 1842 | 1471 |
| 1472 Without arguments prints a list of all set options with their values | |
| 1759 | 1473 .RE |
| 1474 .PP | |
| 1475 /source pattern | |
| 1476 .RS 4 | |
| 1477 Read configuration files, that match glob pattern (sorted in alphabetical order)\&. | |
| 1096 | 1478 .RE |
| 1479 .PP | |
| 1973 | 1480 /status [online|avail|free|dnd|notavail|away [\-|statusmessage]], /status message \-|statusmessage |
| 1242 | 1481 .RS 4 |
| 1759 | 1482 Show or set the current status\&. |
| 1483 | |
| 1484 If no status is specified, display the current status\&. | |
| 1485 | |
| 1486 If a status message is specified, it will overrride the message* variables (these variables can be set in the configuration file)\&. | |
| 1487 | |
| 1488 If no relevant message* variable is set and no status message provided, the current status message is kept\&. | |
| 1489 | |
| 1490 If StatusMessage is "\-", the current status message is cleared\&. | |
| 1491 | |
| 1492 With the "/status message" command, mcabber will update the message while preserving the status\&. | |
| 1493 .RE | |
| 1494 .PP | |
| 1973 | 1495 /status_to jid online|avail|free|dnd|notavail|away [statusmessage], /status_to jid message statusmessage |
| 1759 | 1496 .RS 4 |
| 1497 Send the requested status to the specified Jabber user\&. | |
| 1498 | |
| 1499 If the specified jid is "\&.", the current buddy is used\&. | |
| 1500 | |
| 1501 Note: this status will be overridden by subsequent "/status" commands\&. If you are using the auto\-away feature, the status will overridden too\&. | |
| 1502 | |
| 1503 Note: The jid can include a resource (i\&.e\&. user@server/resource)\&. | |
| 1504 .RE | |
| 1505 .PP | |
| 1506 /version | |
| 1507 .RS 4 | |
| 1508 Display current version of mcabber\&. | |
| 1096 | 1509 .RE |
| 226 | 1510 .SH "CONFIGURATION FILE" |
| 1242 | 1511 .sp |
| 1759 | 1512 See the provided sample configuration file, which should be self\-documenting\&. |
| 226 | 1513 .SH "FILES" |
| 1759 | 1514 .sp |
| 226 | 1515 The following files can be used by mcabber(1): |
| 1242 | 1516 .sp |
| 1759 | 1517 .if n \{\ |
| 1242 | 1518 .RS 4 |
| 1759 | 1519 .\} |
| 226 | 1520 .nf |
| 1759 | 1521 $HOME/\&.mcabber/mcabberrc Default configuration file |
| 1522 $HOME/\&.mcabberrc Configuration file used if no other has been found | |
| 1523 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled | |
| 1524 /usr/share/mcabber/help/ Default directory for online help files | |
| 1525 /usr/lib/mcabber/ Default directory for modules | |
| 226 | 1526 .fi |
| 1759 | 1527 .if n \{\ |
| 1096 | 1528 .RE |
| 1759 | 1529 .\} |
| 226 | 1530 .SH "BUGS" |
| 1242 | 1531 .sp |
| 1759 | 1532 Certainly\&. Please tell me if you find one! :\-) Please visit our website to find out about the MUC room and the bug tracker\&. |
| 226 | 1533 .SH "AUTHOR" |
| 1242 | 1534 .sp |
| 1759 | 1535 Written by \m[blue]\fBMikael BERTHE\fR\m[]\&\s-2\u[1]\d\s+2 and others (see AUTHORS file)\&. |
| 226 | 1536 .SH "RESOURCES" |
| 1242 | 1537 .sp |
| 1759 | 1538 \m[blue]\fBMain web site\fR\m[]\&\s-2\u[2]\d\s+2 |
| 1842 | 1539 .sp |
| 1540 \m[blue]\fBOfficial wiki\fR\m[]\&\s-2\u[3]\d\s+2 | |
| 1541 .sp | |
| 1542 \m[blue]\fBMCabber MUC room\fR\m[]\&\s-2\u[4]\d\s+2 | |
| 226 | 1543 .SH "COPYING" |
| 1759 | 1544 .sp |
| 2302 | 1545 Copyright (C) 2005\-2017 Mikael Berthe and others\&. |
| 1242 | 1546 .sp |
| 1759 | 1547 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. |
| 1548 .SH "NOTES" | |
| 1242 | 1549 .IP " 1." 4 |
| 1550 Mikael BERTHE | |
| 1551 .RS 4 | |
| 1759 | 1552 \%mailto:mikael@lilotux.net |
| 1242 | 1553 .RE |
| 1554 .IP " 2." 4 | |
| 1555 Main web site | |
| 1556 .RS 4 | |
| 1759 | 1557 \%http://mcabber.com/ |
| 1242 | 1558 .RE |
| 1842 | 1559 .IP " 3." 4 |
| 1560 Official wiki | |
| 1561 .RS 4 | |
| 1562 \%http://wiki.mcabber.com/ | |
| 1563 .RE | |
| 1564 .IP " 4." 4 | |
| 1565 MCabber MUC room | |
| 1566 .RS 4 | |
| 1567 \%xmpp:mcabber@conf.lilotux.net | |
| 1568 .RE |