mcabber: comparison mcabber/doc/mcabber.1

equal deleted inserted replaced

-:70f8ae7d690e
+:0d5660c6b4aa
 '\" t
 .\"     Title: mcabber
-.\"    Author: [see the "AUTHOR" section]
+.\"    Author: Mikael BERTHE <mcabber@lilotux.net>
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 09/18/2016
+.\"      Date: May 2017
 .\"    Manual: \ \&
 .\"    Source: \ \& 1.0.6-dev
 .\"  Language: English
 .\"
-.TH "MCABBER" "1" "09/18/2016" "v1\&.0\&.6\-dev"
+.TH "MCABBER" "1" "May 2017" "\ \& 1\&.0\&.6\-dev" "\ \&"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .\" http://bugs.debian.org/507673
 .\}
 .el \{\
 .sp -1
 .IP \(bu 2.3
 .\}
 \fISASL/SSL/TLS support\fR\&.
 .RE
 .sp
 .RS 4
 .ie n \{\
 .\}
 .el \{\
 .sp -1
 .IP \(bu 2.3
 .\}
 \fIMUC support\fR
 (Multi\-User Chat)\&.
 .RE
 .sp
 .RS 4
 .\}
 .el \{\
 .sp -1
 .IP \(bu 2.3
 .\}
 \fIPGP, OTR support\fR
 .RE
 .sp
 .RS 4
 .ie n \{\
 .\}
 .el \{\
 .sp -1
 .IP \(bu 2.3
 .\}
 \fIChat States\fR
 support (typing notifications)
 .RE
 .sp
 .RS 4
 .\}
 .el \{\
 .sp -1
 .IP \(bu 2.3
 .\}
 \fIHistory logging:\fR
 If enabled (see the CONFIGURATION FILE section),
 mcabber
 can save discussions to text history log files\&.
 .RE
 .\}
 .el \{\
 .sp -1
 .IP \(bu 2.3
 .\}
 \fICommands completion:\fR
 If possible,
 mcabber
 will try to complete your command line if you hit the Tab key\&.
 .RE
 .\}
 .el \{\
 .sp -1
 .IP \(bu 2.3
 .\}
 \fIInput line history:\fR
 Any message or command entered is in the input line history and can be reused easily\&.
 .RE
 .sp
 .RS 4
 .\}
 .el \{\
 .sp -1
 .IP \(bu 2.3
 .\}
 \fIExternal actions:\fR
 Some events (like receiving a message) can trigger an external action such as a shell script if you enable it in your configuration file\&. A sample events script ("eventcmd") is provided with
 mcabber
 source code, in the contrib directory\&.
 .RE
 .\}
 .el \{\
 .sp -1
 .IP \(bu 2.3
 .\}
+\fIModules:\fRmcabber
-\fIModules:\fR
-mcabber
 can load modules (a\&.k\&.a\&. plugins) at runtime that extend its features\&.
 .RE
 .SH "OPTIONS"
 .PP
 \-h
 .sp
 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\&.
 .sp
 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\&.
 .sp
-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)\&.
+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)\&.
 .sp
 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\&.
 .SH "KEYS"
 .sp
 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace\&...)\&.
 .RE
 .sp
 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section\&.
 .SH "VI MODE"
 .sp
-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:
+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:
 .PP
 A
 .RS 4
 Call "/roster unread_first"\&.
 .RE
 i
 .RS 4
 Enter chat mode\&.
 .RE
 .PP
-[\fIn\fR]j
+[N]j
 .RS 4
-Call "/roster down [\fIn\fR]"\&.
+Call "/roster down [N]"\&.
 .RE
 .PP
-[\fIn\fR]k
+[N]k
 .RS 4
-Call "/roster up [\fIn\fR]"\&.
+Call "/roster up [N]"\&.
 .RE
 .PP
 n
 .RS 4
 Repeat the previous search (if any)\&.
 zR
 .RS 4
 Call "/group unfold" for all groups\&.
 .RE
 .PP
-\&''
+\*(Aq\*(Aq
 .RS 4
 Call "/roster alternate"\&.
 .RE
 .PP
 !
 .PP
 <Space>
 .RS 4
 Call "/group toggle" for the current group\&.
 .RE
-.PP
+.sp
 A leading slash enables search mode:
 .PP
-/\fIstring\fR
+/string
 .RS 4
-Call "/roster search \fIstring\fR"\&.
+Call "/roster search string"\&.
 .RE
-.PP
+.sp
-A leading colon enabled command-line mode:
+A leading colon enabled command\-line mode:
-.PP
+.sp
-:q
+.if n \{\
 .RS 4
-Call "/quit"\&.
+.\}
-.RE
+.nf
-.PP
+above commands)\&.
-:\fIn\fR
+.fi
-.RS 4
+.if n \{\
-Jump to line \fIn\fR in the roster\&.
+.RE
-.RE
+.\}
-.PP
+.sp
-:\fIcommand-line\fR
+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\&.
-.RS 4
-Call "/\fIcommand-line\fR" (unless the \fIcommand-line\fR matches one of the above commands)\&.
-.RE
-.PP
-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\&.
 .SH "MCABBER\(cqS ROSTER"
 .sp
 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\&.
 .sp
 Group names are displayed above the items that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&.
 .sp
 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)\&.
 .sp
 Examples:
 .PP
-\fI\-\-\- Buds\fR
+\*(Aq \-\-\- Buds\*(Aq
 .RS 4
 This is a group named
 \fIBuds\fR
 .RE
 .PP
 \fI#[o] John\fR
 .RS 4
 John is online, can see your status, and sent you a message that you did not read yet
 .RE
 .PP
-\fI{?} Sally\fR
+\*(Aq {?} Sally\*(Aq
 .RS 4
 Neither you nor Sally have authorized each other to see your online status
 .RE
 .PP
-\fI{a} Jane\fR
+\*(Aq {a} Jane\*(Aq
 .RS 4
 Jane is away, but she cannot see your online status
 .RE
 .PP
 \fI#[C] x@y\&.c\fR
 .RS 4
 Send the "text" message to the specified jid\&.
 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\&.
-You can send a message to a specific resource of the currently selected contact by using /say_to ./resourcename message\&.
+You can send a message to a specific resource of the currently selected contact by using /say_to \&./resourcename message\&.
 The "\-n" flag turns the message to "normal" type, "\-h" to "headline"\&. "\-\-" can be used to send chat messages beginning with \-n or \-h\&.
 When "\-q" is used, the message will be sent in the background and will not change the current active window\&.
 .if n \{\
 .RS 4
 .\}
 .nf
 $HOME/\&.mcabber/mcabberrc    Default configuration file
+$HOME/\&.config/mcabber/mcabberrc Alternate location (can use XDG_CONFIG_HOME)
 $HOME/\&.mcabberrc            Configuration file used if no other has been found
 $HOME/\&.mcabber/histo/       Default directory for storing chat history files, if enabled
 /usr/share/mcabber/help/    Default directory for online help files
 /usr/lib/mcabber/           Default directory for modules
 .fi
 .SH "COPYING"
 .sp
 Copyright (C) 2005\-2017 Mikael Berthe and others\&.
 .sp
 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.
+.SH "AUTHOR"
+.PP
+\fBMikael BERTHE\fR <\&mcabber@lilotux\&.net\&>
+.RS 4
+Author.
+.RE
 .SH "NOTES"
 .IP " 1." 4
 Mikael BERTHE
 .RS 4
 \%mailto:mikael@lilotux.net

changeset 2314	0d5660c6b4aa
parent 2304	fa8365fb6ac2
child 2316	90b3e9876641