Mercurial > ~mikael > mcabber > hg
comparison 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 |
comparison
equal
deleted
inserted
replaced
2303:4f3821bda633 | 2304:fa8365fb6ac2 |
---|---|
184 .sp | 184 .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\&. | 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\&. |
186 .sp | 186 .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\&. | 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 | 188 .sp |
189 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\&. | 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)\&. |
190 .sp | 190 .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\&. | 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" | 192 .SH "KEYS" |
193 .sp | 193 .sp |
194 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...)\&. | 194 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...)\&. |
290 .RS 4 | 290 .RS 4 |
291 Accept line and put the next history line in the input line (accept\-line\-and\-down\-history) | 291 Accept line and put the next history line in the input line (accept\-line\-and\-down\-history) |
292 .RE | 292 .RE |
293 .sp | 293 .sp |
294 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section\&. | 294 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section\&. |
295 .SH "VI MODE" | |
296 .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: | |
298 .PP | |
299 A | |
300 .RS 4 | |
301 Call "/roster unread_first"\&. | |
302 .RE | |
303 .PP | |
304 a | |
305 .RS 4 | |
306 Call "/roster unread_next"\&. | |
307 .RE | |
308 .PP | |
309 F | |
310 .RS 4 | |
311 Call "/roster group_prev"\&. | |
312 .RE | |
313 .PP | |
314 f | |
315 .RS 4 | |
316 Call "/roster group_next"\&. | |
317 .RE | |
318 .PP | |
319 G | |
320 .RS 4 | |
321 Call "/roster bottom"\&. | |
322 .RE | |
323 .PP | |
324 gg | |
325 .RS 4 | |
326 Call "/roster top"\&. | |
327 .RE | |
328 .PP | |
329 i | |
330 .RS 4 | |
331 Enter chat mode\&. | |
332 .RE | |
333 .PP | |
334 [\fIn\fR]j | |
335 .RS 4 | |
336 Call "/roster down [\fIn\fR]"\&. | |
337 .RE | |
338 .PP | |
339 [\fIn\fR]k | |
340 .RS 4 | |
341 Call "/roster up [\fIn\fR]"\&. | |
342 .RE | |
343 .PP | |
344 n | |
345 .RS 4 | |
346 Repeat the previous search (if any)\&. | |
347 .RE | |
348 .PP | |
349 O | |
350 .RS 4 | |
351 Call "/roster unread_first" and open chat window\&. | |
352 .RE | |
353 .PP | |
354 o | |
355 .RS 4 | |
356 Call "/roster unread_next" and open chat window\&. | |
357 .RE | |
358 .PP | |
359 ZZ | |
360 .RS 4 | |
361 Call "/quit"\&. | |
362 .RE | |
363 .PP | |
364 zM | |
365 .RS 4 | |
366 Call "/group fold" for all groups\&. | |
367 .RE | |
368 .PP | |
369 zR | |
370 .RS 4 | |
371 Call "/group unfold" for all groups\&. | |
372 .RE | |
373 .PP | |
374 \&'' | |
375 .RS 4 | |
376 Call "/roster alternate"\&. | |
377 .RE | |
378 .PP | |
379 ! | |
380 .RS 4 | |
381 Toggle attention flag for current buddy\&. | |
382 .RE | |
383 .PP | |
384 # | |
385 .RS 4 | |
386 Toggle unread messages flag for current buddy\&. | |
387 .RE | |
388 .PP | |
389 <Space> | |
390 .RS 4 | |
391 Call "/group toggle" for the current group\&. | |
392 .RE | |
393 .PP | |
394 A leading slash enables search mode: | |
395 .PP | |
396 /\fIstring\fR | |
397 .RS 4 | |
398 Call "/roster search \fIstring\fR"\&. | |
399 .RE | |
400 .PP | |
401 A leading colon enabled command-line mode: | |
402 .PP | |
403 :q | |
404 .RS 4 | |
405 Call "/quit"\&. | |
406 .RE | |
407 .PP | |
408 :\fIn\fR | |
409 .RS 4 | |
410 Jump to line \fIn\fR in the roster\&. | |
411 .RE | |
412 .PP | |
413 :\fIcommand-line\fR | |
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\&. | |
295 .SH "MCABBER\(cqS ROSTER" | 419 .SH "MCABBER\(cqS ROSTER" |
296 .sp | 420 .sp |
297 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\&. | 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\&. |
298 .sp | 422 .sp |
299 Group names are displayed above the items that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&. | 423 Group names are displayed above the items that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&. |