annotate mcabber/doc/mcabber.1 @ 432:3a613e1d229b 0.6.8

Ready for 0.6.8 release
author Mikael Berthe <mikael@lilotux.net>
date Mon, 12 Sep 2005 20:24:16 +0200
parents 00809e3e327e
children 802da817a684
rev   line source
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
2 .de Sh \" Subsection
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
3 .br
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
4 .if t .Sp
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
5 .ne 5
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
6 .PP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
7 \fB\\$1\fR
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
8 .PP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
9 ..
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
10 .de Sp \" Vertical space (when we can't use .PP)
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
11 .if t .sp .5v
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
12 .if n .sp
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
13 ..
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
14 .de Ip \" List item
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
15 .br
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
16 .ie \\n(.$>=3 .ne \\$3
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
17 .el .ne 3
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
18 .IP "\\$1" \\$2
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
19 ..
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
20 .TH "MCABBER" 1 "" "" ""
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
21 .SH NAME
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
22 mcabber \- a simple Jabber console client
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
23 .SH "SYNOPSIS"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
24
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
25
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
26 mcabber [ \-f configfile ] [ --help | \-h ]
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
27
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
28 .SH "DESCRIPTION"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
29
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
30
227
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
31 mcabber(1) is a small Jabber console client\&. For now it needs a configuration file to start, so please copy the sample mcabberrc file and adapt your connection settings\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
32
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
33
360
20283b69db99 Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents: 330
diff changeset
34 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet\&.
20283b69db99 Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents: 330
diff changeset
35
20283b69db99 Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents: 330
diff changeset
36
227
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
37 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\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
38
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
39
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
40 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\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
41
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
42
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
43 Here are some of the features of mcabber:
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
44
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
45 .TP 3
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
46 \(bu
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
47 SSL support\&.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
48 .TP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
49 \(bu
432
3a613e1d229b Ready for 0.6.8 release
Mikael Berthe <mikael@lilotux.net>
parents: 377
diff changeset
50 History logging: If enabled (see the CONFIGURATION FILE section), mcabber can save discussions to history log files\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
51 .TP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
52 \(bu
432
3a613e1d229b Ready for 0.6.8 release
Mikael Berthe <mikael@lilotux.net>
parents: 377
diff changeset
53 Commands completion: If possible, mcabber will try to complete your command line if you hit the Tab key\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
54 .TP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
55 \(bu
432
3a613e1d229b Ready for 0.6.8 release
Mikael Berthe <mikael@lilotux.net>
parents: 377
diff changeset
56 External actions: Some events (like receiving a message) can trigger an external action, for example a shell script (you need to enable it in your configuration file)\&. A sample events script ("eventcmd") is provided with mcabber source code, in the contrib directory\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
57 .LP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
58
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
59 .SH "OPTIONS"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
60
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
61 .TP
298
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
62 \-\-help, \-h
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
63 Quick help usage message
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
64
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
65 .TP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
66 \-f configfile
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
67 Use configuration file configfile
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
68
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
69 .SH "KEYS"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
70
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
71
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
72 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
73
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
74
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
75 PageUp and PageDown keys are used to move in the roster\&.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
76
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
77
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
78 To send a message, move to the choosen buddy in the buddylist, type your message and hit enter\&. If the line begins with a slash, this will be interpreted as a command (see the COMMAND section below)\&. Hit escape to leave the chat mode\&.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
79
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
80 Here is a quick description of the key bindings:
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
81
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
82 Ctrl\-a Go to the beginning of the input line
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
83
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
84 Ctrl\-e Go to the end of the input line
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
85
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
86 Ctrl\-l Force a resize
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
87
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
88 PgUp/PgDown Move inside the roster (buddylist)
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
89
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
90 Tab Complete current word, in the input line
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
91
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
92 Ctrl\-g Cancel completion / ctrl\-g
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
93
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
94 Ctrl\-p/Ctrl\-n Scroll up/down half a screen in the buffer window (chat mode)
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
95
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
96 Ctrl\-u Delete from beginning of the line to the cursor
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
97
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
98 Ctrl\-k Delete from the cursor to the end of line
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
99
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
100 Ctrl\-w Backward kill word
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
101
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
102 Ctrl\-t Transpose chars
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
103
263
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
104 Ctrl\-o Accept line and put the next history line in the input line (accept\-line\-and\-down\-history)
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
105
236
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
106 Ctrl\-q Jump to the next unread message
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
107
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
108
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
109 .SH "COMMANDS"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
110
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
111 .TP
245
7ca7ca850270 [/trunk] Changeset 258 by mikael
mikael
parents: 240
diff changeset
112 \fB/add\fR jid [nickname]
7ca7ca850270 [/trunk] Changeset 258 by mikael
mikael
parents: 240
diff changeset
113 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\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
114
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
115 .TP
286
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
116 \fB/alias\fR name = command line
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
117 Add "name" as an alias for "command line"\&. Aliases are expanded only once, thus they can not be chained\&. "/alias name" displays the value associated with the "name" alias; "/alias name =" unsets the "name" alias\&. Example: "/alias away = status away"\&.
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
118
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
119 .TP
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
120 \fB/bind\fR keycode = command line
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
121 Bind a command line to the key with the "keycode" code number\&. Keycodes of unused keys are displayed by mcabber in the log window when pressing the key, for example "Unknown key=265"\&. "/bind keycode" displays the command line bound to the given keycode; "/bind keycode" unbinds the given keycode\&. Note: aliases can be used in key bindings\&. Example: "/bind 265 = status online" (265 is F1 for me, but it can depend on your ncurses installation)\&.
286
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
122
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
123 .TP
372
db004de6440c Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
124 \fB/buffer\fR clear|top|bottom|search_backward|search_forward
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
125 The buffer command manipulates the current buddy's buffer (chat window)\&.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
126
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
127 \fBclear\fR clear the current buddy chat window
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
128 \fBtop\fR jump to the top of the current buddy chat buffer
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
129 \fBbottom\fR jump to the bottom of the current buddy chat buffer
372
db004de6440c Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
130 \fBsearch_backward\fR text search for text in the current buddy chat buffer
db004de6440c Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents: 364
diff changeset
131 \fBsearch_forward\fR text search for text in the current buddy chat buffer
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
132
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
133 .TP
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
134 \fB/clear\fR
227
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
135 The clear command is actually an alias for "/buffer clear"\&.
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
136
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
137 .TP
298
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
138 \fB/connect\fR
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
139 Establish connection to the Jabber server\&.
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
140
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
141 .TP
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
142 \fB/del\fR
227
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
143 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
144
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
145 .TP
298
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
146 \fB/disconnect\fR
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
147 Terminate connection to the Jabber server\&. Note: the roster is only available when the connection to the server is active, so the buddylist is empty when disconnected\&.
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
148
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
149 .TP
240
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
150 \fB/group\fR fold|unfold|toggle
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
151 The group command changes the current group display\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
152
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
153 \fBfold\fR fold (shrink) the current group tree in the roster
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
154 \fBunfold\fR unfold (expand) the current group tree in the roster
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
155 \fBtoggle\fR toggle the state (fold/unfold) of the current tree
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
156
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
157 .TP
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
158 \fB/info\fR
227
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
159 Display info on the selected entry (user, agent, group...)\&.
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
160
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
161 .TP
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
162 \fB/move\fR [groupname]
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
163 Move the current buddy to the requested group\&. If no group is specified, then the buddy is moved to the default group\&. This command only works with users (not agents), at the moment\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
164
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
165 .TP
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 245
diff changeset
166 \fB/msay\fR begin|verbatim|send|abort
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 245
diff changeset
167 Send a multi\-line message\&. To write a single message with several lines, the \fImulti\-line mode\fR should be used\&. In multi\-line mode, each line (except command lines) typed in the input line will be added to the multi\-line message\&. Once the message is finished, it can be sent to the current selected buddy with the "msay /send" command\&. The \fIverbatim\fR 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\&.
238
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
168
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
169 \fBbegin\fR enter multi\-line mode
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
170 \fBverbatim\fR enter verbatim multi\-line mode
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
171 \fBsend\fR send the current multi\-line message to the currently selected buddy
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
172 \fBabort\fR leave multi\-line mode without sending the message
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
173
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
174 .TP
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
175 \fB/rename\fR nickname
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
176 Rename current buddy to the given nickname\&. This command does not work for groups, at the moment (but you can move the buddies to another group with the /move command)\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
177
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
178 .TP
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
179 \fB/roster\fR
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
180 The roster command manipulates the roster/buddylist\&. Here are the available parameters:
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
181
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
182 \fBbottom\fR jump to the bottom of the roster
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
183 \fBtop\fR jump to the top of the roster
377
00809e3e327e Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents: 372
diff changeset
184 \fBup\fR move up in the roster
00809e3e327e Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents: 372
diff changeset
185 \fBdown\fR move down in the roster
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
186 \fBhide_offline\fR hide offline buddies
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
187 \fBshow_offline\fR show offline buddies
290
f63839a4cb35 Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents: 289
diff changeset
188 \fBtoggle_offline\fR toggle display of offline buddies
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
189 \fBsearch\fR bud search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist)
330
a9013124ede6 Add "/roster alternate"
Mikael Berthe <mikael@lilotux.net>
parents: 320
diff changeset
190 \fBalternate\fR 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_first")
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
191 \fBunread_first\fR jump to the first unread message
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
192 \fBunread_next\fR jump to the next unread message
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
193
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
194 .TP
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
195 \fB/say\fR text
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
196 Send the text message to the currently selected buddy\&. Can be useful if you want to send a message beginning with a slash, for example\&.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
197
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
198 .TP
320
dce1dd4d0ca8 Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents: 300
diff changeset
199 \fB/status\fR [online|avail|invisible|free|dnd|notavail|away [StatusMessage]]
dce1dd4d0ca8 Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents: 300
diff changeset
200 Set the current status\&. If no status is specified, display the current status\&. If a status message is specified, it will overrride the message* variables\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
201
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
202 .SH "CONFIGURATION FILE"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
203
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
204
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
205 See the provided sample configuration file, which should be self\-documented\&.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
206
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
207 .SH "FILES"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
208
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
209
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
210 The following files can be used by mcabber(1):
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
211
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
212 .nf
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
213
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
214 $HOME/\&.mcabber/mcabberrc Default configuration file
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
215 $HOME/\&.mcabberrc Configuration file used if no other has been found
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
216 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
217
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
218 .fi
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
219
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
220 .SH "BUGS"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
221
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
222
360
20283b69db99 Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents: 330
diff changeset
223 Certainly\&. Please tell me if you find one! :\-)
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
224
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
225 .SH "AUTHOR"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
227
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
228 Written by Mikael BERTHE <\fImcabber@lilotux.net\fR>\&.
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
229 Originally based on cabber (Cabber homepage: <\fIhttp://cabber.sourceforge.net\fR>), please consult the AUTHORS file for details\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
230
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
231 .SH "RESOURCES"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
232
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
233
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
234 Main web site: <\fIhttp://www.lilotux.net/~mikael/mcabber/\fR>
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
235
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
236 .SH "COPYING"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
237
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
238
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
239 Copyright (C) 2005 Mikael Berthe\&.
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
240
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
241 Some portions are Copyright (C) 2002\-2004 <cabber@ajmacias\&.com>\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
242
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
243
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
244 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
245