Mercurial > hg
annotate mcabber/doc/mcabber.1.html @ 774:46304b773a44
Remove useless checks before g_free() calls
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Sat, 25 Mar 2006 18:16:10 +0100 |
parents | 0311d7e2bb1c |
children | b4befb3052e5 |
rev | line source |
---|---|
229 | 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
2 <html> | |
3 <head> | |
4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> | |
506
74dcd0df532e
"/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents:
495
diff
changeset
|
5 <meta name="generator" content="AsciiDoc 7.0.2" /> |
229 | 6 <meta name="author" content="Mikael BERTHE" /> |
7 <meta name="author-email" content="mcabber@lilotux.net" /> | |
8 <link rel="stylesheet" href="./manpage.css" type="text/css" /> | |
9 <title>mcabber</title> | |
10 </head> | |
11 <body> | |
12 <div id="content"> | |
13 <h1>MCABBER(1) Manual Page</h1> | |
14 <h2>NAME</h2> | |
15 <p>mcabber - | |
16 a simple Jabber console client | |
17 </p> | |
18 <div id="synopsis"> | |
19 <h2>SYNOPSIS</h2> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
20 <p><b>mcabber</b> [ -f configfile ] [ --help | -h ]</p> |
229 | 21 </div> |
22 <h2>DESCRIPTION</h2> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
23 <p><tt>mcabber(1)</tt> is a small Jabber console client.<br /> |
229 | 24 For now it needs a configuration file to start, so please copy the sample |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
25 mcabberrc file and adapt your connection settings.</p> |
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
26 <p>You also need to have an existing Jabber account to use this software, as |
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
27 it cannot (un)register accounts yet.</p> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
28 <p>The <tt>mcabber(1)</tt> screen is divided into 4 regions. |
229 | 29 The <b>roster</b>, alias <b>buddylist</b>, is on the left. The <b>chat window</b>, or chat |
30 buffer, is on the right. The <b>input line</b> lies at the bottom of the screen, | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
31 under a small <b>log window</b>.</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
32 <p>To display buddies chat buffers, you will have to enter <b>chat mode</b>. |
229 | 33 You can enter chat mode by pressing enter, and leave chat mode with the ESC |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
34 key. Simply sending a message will also enable chat mode.</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
35 <p>Here are some of the features of <tt>mcabber</tt>:</p> |
229 | 36 <ul> |
37 <li> | |
38 <p> | |
39 <b>SSL support</b>. | |
40 </p> | |
41 </li> | |
42 <li> | |
43 <p> | |
467 | 44 <b>MUC support</b> (Multi-User Chat). |
45 </p> | |
46 </li> | |
47 <li> | |
48 <p> | |
229 | 49 <b>History logging:</b> If enabled (see the CONFIGURATION FILE section), |
432 | 50 <tt>mcabber</tt> can save discussions to history log files. |
229 | 51 </p> |
52 </li> | |
53 <li> | |
54 <p> | |
432 | 55 <b>Commands completion:</b> If possible, <tt>mcabber</tt> will try to complete your |
229 | 56 command line if you hit the Tab key. |
57 </p> | |
58 </li> | |
59 <li> | |
60 <p> | |
618 | 61 <b>Input line history:</b> Any message or command entered is in the input line |
62 history and can be reused easily. | |
63 </p> | |
64 </li> | |
65 <li> | |
66 <p> | |
229 | 67 <b>External actions:</b> Some events (like receiving a message) can trigger an |
68 external action, for example a shell script (you need to enable it in your | |
432 | 69 configuration file). A sample events script ("eventcmd") is provided with |
70 <tt>mcabber</tt> source code, in the contrib directory. | |
229 | 71 </p> |
72 </li> | |
73 </ul> | |
74 <h2>OPTIONS</h2> | |
75 <dl> | |
76 <dt><b> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
77 --help, -h |
229 | 78 </b></dt> |
79 <dd> | |
80 Quick help usage message | |
81 </dd> | |
82 <dt><b> | |
83 -f configfile | |
84 </b></dt> | |
85 <dd> | |
86 Use configuration file <b>configfile</b> | |
87 </dd> | |
88 </dl> | |
89 <h2>KEYS</h2> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
90 <p>Text typing occurs in the <b>input line</b>; basic operations are supported |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
91 (left arrow, right arrow, home/end keys, insert, delete, backspace…).</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
92 <p>PageUp and PageDown keys are used to move in the roster.</p> |
618 | 93 <p>Up and Down arrow keys can be used to move in the input line history; they |
94 jump to the previous/next line from the history beginning with the same string | |
95 (from first column to the cursor column).</p> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
96 <p>To send a message, move to the choosen buddy in the buddylist, type your |
229 | 97 message and hit enter. If the line begins with a slash, this will be |
98 interpreted as a command (see the COMMAND section below). Hit escape to | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
99 leave the chat mode.</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
100 <p>Here is a quick description of the key bindings:</p> |
229 | 101 <table class="hlist"> |
102 <tr valign="top"> | |
103 <td> | |
104 Ctrl-a | |
105 </td> | |
106 <td> | |
107 Go to the beginning of the input line | |
108 </td> | |
109 </tr> | |
110 <tr valign="top"> | |
111 <td> | |
112 Ctrl-e | |
113 </td> | |
114 <td> | |
115 Go to the end of the input line | |
116 </td> | |
117 </tr> | |
118 <tr valign="top"> | |
119 <td> | |
120 Ctrl-l | |
121 </td> | |
122 <td> | |
618 | 123 Force a refresh |
124 </td> | |
125 </tr> | |
126 <tr valign="top"> | |
127 <td> | |
128 Up/Down | |
129 </td> | |
130 <td> | |
131 Move in the input line history | |
229 | 132 </td> |
133 </tr> | |
134 <tr valign="top"> | |
135 <td> | |
136 PgUp/PgDown | |
137 </td> | |
138 <td> | |
139 Move inside the roster (buddylist) | |
140 </td> | |
141 </tr> | |
142 <tr valign="top"> | |
143 <td> | |
144 Tab | |
145 </td> | |
146 <td> | |
147 Complete current word, in the input line | |
148 </td> | |
149 </tr> | |
150 <tr valign="top"> | |
151 <td> | |
152 Ctrl-g | |
153 </td> | |
154 <td> | |
155 Cancel completion / ctrl-g | |
156 </td> | |
157 </tr> | |
158 <tr valign="top"> | |
159 <td> | |
160 Ctrl-p/Ctrl-n | |
161 </td> | |
162 <td> | |
163 Scroll up/down half a screen in the buffer window (chat mode) | |
164 </td> | |
165 </tr> | |
166 <tr valign="top"> | |
167 <td> | |
168 Ctrl-u | |
169 </td> | |
170 <td> | |
171 Delete from beginning of the line to the cursor | |
172 </td> | |
173 </tr> | |
174 <tr valign="top"> | |
175 <td> | |
176 Ctrl-k | |
177 </td> | |
178 <td> | |
179 Delete from the cursor to the end of line | |
180 </td> | |
181 </tr> | |
182 <tr valign="top"> | |
183 <td> | |
184 Ctrl-w | |
185 </td> | |
186 <td> | |
187 Backward kill word | |
188 </td> | |
189 </tr> | |
190 <tr valign="top"> | |
191 <td> | |
192 Ctrl-t | |
193 </td> | |
194 <td> | |
195 Transpose chars | |
196 </td> | |
197 </tr> | |
198 <tr valign="top"> | |
199 <td> | |
263 | 200 Ctrl-o |
201 </td> | |
202 <td> | |
203 Accept line and put the next history line in the input line (accept-line-and-down-history) | |
204 </td> | |
205 </tr> | |
206 <tr valign="top"> | |
207 <td> | |
229 | 208 Ctrl-q |
209 </td> | |
210 <td> | |
236 | 211 Jump to the next unread message |
229 | 212 </td> |
213 </tr> | |
214 </table> | |
215 <h2>COMMANDS</h2> | |
216 <dl> | |
217 <dt><b> | |
639 | 218 /add [jid [nickname]] |
229 | 219 </b></dt> |
220 <dd> | |
491 | 221 Add the "jid" Jabber user to our roster (default group), and send a |
245 | 222 notification request to this buddy. If no nickname is specified, the |
660 | 223 jid is used. If no jid (or an empty string "") is provided or if jid |
224 is ".", the current buddy is used. | |
229 | 225 </dd> |
226 <dt><b> | |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
227 /alias name = command line |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
228 </b></dt> |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
229 <dd> |
289 | 230 Add "name" as an alias for "command line".<br /> |
231 Aliases are expanded only once, thus they can not be chained.<br /> | |
232 "/alias name" displays the value associated with the "name" alias; | |
233 "/alias name =" unsets the "name" alias.<br /> | |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
234 Example: "/alias away = status away". |
289 | 235 </dd> |
236 <dt><b> | |
618 | 237 /authorization allow|cancel|request [jid] |
238 </b></dt> | |
239 <dd> | |
240 Manage the presence subscriptions.<br /> | |
241 If no jid is provided, the current buddy is used. | |
242 <table class="hlist"> | |
243 <tr valign="top"> | |
244 <td> | |
245 <b>allow</b> | |
246 </td> | |
247 <td> | |
248 allow the buddy to receive your presence updates | |
249 </td> | |
250 </tr> | |
251 <tr valign="top"> | |
252 <td> | |
253 <b>cancel</b> | |
254 </td> | |
255 <td> | |
256 cancel the buddy' subscription to your presence updates | |
257 </td> | |
258 </tr> | |
259 <tr valign="top"> | |
260 <td> | |
261 <b>request</b> | |
262 </td> | |
263 <td> | |
264 request a subscription to the buddy's presence updates | |
265 </td> | |
266 </tr> | |
267 </table> | |
268 </dd> | |
269 <dt><b> | |
289 | 270 /bind keycode = command line |
271 </b></dt> | |
272 <dd> | |
273 Bind a command line to the key with the "keycode" code number.<br /> | |
432 | 274 Keycodes of unused keys are displayed by <tt>mcabber</tt> in the log window |
289 | 275 when pressing the key, for example "Unknown key=265".<br /> |
276 "/bind keycode" displays the command line bound to the given keycode; | |
277 "/bind keycode" unbinds the given keycode.<br /> | |
278 Note: aliases can be used in key bindings.<br /> | |
450 | 279 Example: "/bind 265 = status online" (265 is F1 for me, but it may |
289 | 280 depend on your ncurses installation). |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
281 </dd> |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
282 <dt><b> |
618 | 283 /buffer clear|top|bottom|date|%|search_backward|search_forward |
229 | 284 </b></dt> |
285 <dd> | |
286 The <b>buffer</b> command manipulates the current buddy's buffer | |
287 (chat window). | |
288 <table class="hlist"> | |
289 <tr valign="top"> | |
290 <td> | |
291 <b>clear</b> | |
292 </td> | |
293 <td> | |
294 clear the current buddy chat window | |
295 </td> | |
296 </tr> | |
297 <tr valign="top"> | |
298 <td> | |
511 | 299 <b>bottom</b> |
300 </td> | |
301 <td> | |
302 jump to the bottom of the current buddy chat buffer | |
303 </td> | |
304 </tr> | |
305 <tr valign="top"> | |
306 <td> | |
229 | 307 <b>top</b> |
308 </td> | |
309 <td> | |
310 jump to the top of the current buddy chat buffer | |
311 </td> | |
312 </tr> | |
313 <tr valign="top"> | |
314 <td> | |
511 | 315 <b>up</b> [n] |
229 | 316 </td> |
317 <td> | |
511 | 318 scroll the buffer up n lines (default: half a screen) |
319 </td> | |
320 </tr> | |
321 <tr valign="top"> | |
322 <td> | |
323 <b>down</b> [n] | |
324 </td> | |
325 <td> | |
326 scroll the buffer down n lines (default: half a screen) | |
229 | 327 </td> |
328 </tr> | |
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
329 <tr valign="top"> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
330 <td> |
618 | 331 <b>date</b> date |
332 </td> | |
333 <td> | |
334 jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional) | |
335 </td> | |
336 </tr> | |
337 <tr valign="top"> | |
338 <td> | |
339 <b>%</b> n | |
340 </td> | |
341 <td> | |
342 jump to position %n of the buddy chat buffer | |
343 </td> | |
344 </tr> | |
345 <tr valign="top"> | |
346 <td> | |
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
347 <b>search_backward</b> text |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
348 </td> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
349 <td> |
491 | 350 search for "text" in the current buddy chat buffer |
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
351 </td> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
352 </tr> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
353 <tr valign="top"> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
354 <td> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
355 <b>search_forward</b> text |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
356 </td> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
357 <td> |
491 | 358 search for "text" in the current buddy chat buffer |
372
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
359 </td> |
db004de6440c
Add documentation for /buffer search_*
Mikael Berthe <mikael@lilotux.net>
parents:
364
diff
changeset
|
360 </tr> |
229 | 361 </table> |
362 </dd> | |
363 <dt><b> | |
364 /clear | |
365 </b></dt> | |
366 <dd> | |
367 The <b>clear</b> command is actually an alias for "/buffer clear". | |
368 </dd> | |
369 <dt><b> | |
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
370 /connect |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
371 </b></dt> |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
372 <dd> |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
373 Establish connection to the Jabber server. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
374 </dd> |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
375 <dt><b> |
229 | 376 /del |
377 </b></dt> | |
378 <dd> | |
379 Delete the current buddy from our roster, unsubscribe from its presence | |
380 notification and unsubscribe it from ours. | |
381 </dd> | |
382 <dt><b> | |
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
383 /disconnect |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
384 </b></dt> |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
385 <dd> |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
386 Terminate connection to the Jabber server. Note: the roster is only |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
387 available when the connection to the server is active, so the |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
388 buddylist is empty when disconnected. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
389 </dd> |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
390 <dt><b> |
240 | 391 /group fold|unfold|toggle |
229 | 392 </b></dt> |
393 <dd> | |
240 | 394 The <b>group</b> command changes the current group display. |
229 | 395 <table class="hlist"> |
396 <tr valign="top"> | |
397 <td> | |
240 | 398 <b>fold</b> |
229 | 399 </td> |
400 <td> | |
240 | 401 fold (shrink) the current group tree in the roster |
229 | 402 </td> |
403 </tr> | |
404 <tr valign="top"> | |
405 <td> | |
240 | 406 <b>unfold</b> |
229 | 407 </td> |
408 <td> | |
240 | 409 unfold (expand) the current group tree in the roster |
229 | 410 </td> |
411 </tr> | |
412 <tr valign="top"> | |
413 <td> | |
414 <b>toggle</b> | |
415 </td> | |
416 <td> | |
240 | 417 toggle the state (fold/unfold) of the current tree |
229 | 418 </td> |
419 </tr> | |
420 </table> | |
421 </dd> | |
422 <dt><b> | |
423 /info | |
424 </b></dt> | |
425 <dd> | |
440
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
426 Display info on the selected entry (user, agent, group…).<br /> |
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
427 For users, resources are displayed with the status, priority and |
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
428 status message (if available) of each resource. |
229 | 429 </dd> |
430 <dt><b> | |
431 /move [groupname] | |
432 </b></dt> | |
433 <dd> | |
434 Move the current buddy to the requested group. If no group is | |
623 | 435 specified, then the buddy is moved to the default group.<br /> |
506
74dcd0df532e
"/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents:
495
diff
changeset
|
436 Tip: if the chatmode is enabled, you can use "/roster alternate" |
74dcd0df532e
"/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents:
495
diff
changeset
|
437 to jump to the moved buddy. |
229 | 438 </dd> |
439 <dt><b> | |
637 | 440 /msay begin|verbatim|send|send_to|abort |
238 | 441 </b></dt> |
442 <dd> | |
443 Send a multi-line message. To write a single message with several | |
289 | 444 lines, the <b>multi-line mode</b> should be used.<br /> |
445 In multi-line mode, each line (except command lines) typed in the input | |
446 line will be added to the multi-line message. Once the message is | |
450 | 447 finished, it can be sent to the current selected buddy with the "/msay |
448 send" command.<br /> | |
289 | 449 The <b>verbatim</b> multi-line mode disables commands, so that it is |
450 possible to enter lines starting with a slash. Only the "/msay" | |
451 command (with send or abort parameters) can be used to exit verbatim | |
452 mode. | |
238 | 453 <table class="hlist"> |
454 <tr valign="top"> | |
455 <td> | |
456 <b>begin</b> | |
457 </td> | |
458 <td> | |
459 enter multi-line mode | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
460 </td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
461 </tr> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
462 <tr valign="top"> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
463 <td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
464 <b>verbatim</b> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
465 </td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
466 <td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
467 enter verbatim multi-line mode |
238 | 468 </td> |
469 </tr> | |
470 <tr valign="top"> | |
471 <td> | |
472 <b>send</b> | |
473 </td> | |
474 <td> | |
475 send the current multi-line message to the currently selected buddy | |
476 </td> | |
477 </tr> | |
478 <tr valign="top"> | |
479 <td> | |
637 | 480 <b>send_to</b> jid |
481 </td> | |
482 <td> | |
483 send the current multi-line message to "jid" | |
484 </td> | |
485 </tr> | |
486 <tr valign="top"> | |
487 <td> | |
238 | 488 <b>abort</b> |
489 </td> | |
490 <td> | |
491 leave multi-line mode without sending the message | |
492 </td> | |
493 </tr> | |
494 </table> | |
495 </dd> | |
496 <dt><b> | |
229 | 497 /quit |
498 </b></dt> | |
499 <dd> | |
500 Disconnect and leave <tt>mcabber(1)</tt>. | |
501 </dd> | |
502 <dt><b> | |
436 | 503 /rawxml send |
504 </b></dt> | |
505 <dd> | |
506 <b>send</b> string: send string (raw XML format) to the Jabber server. No check is done on the string provided. BEWARE! Use this only if you know what you are doing, or you could terminate the connection. | |
507 </dd> | |
508 <dt><b> | |
229 | 509 /rename nickname |
510 </b></dt> | |
511 <dd> | |
512 Rename current buddy to the given nickname. | |
513 This command does not work for groups, at the moment (but you can move | |
450 | 514 the buddies to another group with the "/move" command). |
515 </dd> | |
516 <dt><b> | |
700 | 517 /request time|version [jid] |
518 </b></dt> | |
519 <dd> | |
520 Send a "IQ" query to the current buddy, or to the specified Jabber | |
521 user. If the resource is not provided with the jid, mcabber will | |
522 send the query to all known resources for this user. | |
523 </dd> | |
524 <dt><b> | |
601 | 525 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy |
573 | 526 </b></dt> |
527 <dt><b> | |
593 | 528 /room invite|kick|ban|role|affil |
450 | 529 </b></dt> |
530 <dd> | |
531 The <b>room</b> command handles Multi-User Chat room actions. | |
532 <table class="hlist"> | |
533 <tr valign="top"> | |
534 <td> | |
660 | 535 <b>join</b> room [nick] |
450 | 536 </td> |
537 <td> | |
660 | 538 join "room", using "nick" as nickname. If no nickname is provided, the "nickname" option value is used (see sample configuration file) |
450 | 539 </td> |
540 </tr> | |
541 <tr valign="top"> | |
542 <td> | |
487 | 543 <b>leave</b> [message] |
450 | 544 </td> |
545 <td> | |
546 leave the current room | |
547 </td> | |
548 </tr> | |
549 <tr valign="top"> | |
550 <td> | |
551 <b>names</b> | |
552 </td> | |
553 <td> | |
554 display members of the current room | |
555 </td> | |
556 </tr> | |
557 <tr valign="top"> | |
558 <td> | |
470 | 559 <b>nick</b> nick |
560 </td> | |
561 <td> | |
562 change your nickname in the current room | |
563 </td> | |
564 </tr> | |
565 <tr valign="top"> | |
566 <td> | |
491 | 567 <b>privmsg</b> nick msg |
568 </td> | |
569 <td> | |
570 send private message "msg" to "nick" | |
571 </td> | |
572 </tr> | |
573 <tr valign="top"> | |
574 <td> | |
450 | 575 <b>remove</b> |
576 </td> | |
577 <td> | |
467 | 578 remove the current room from the roster (you must have left this room before) |
579 </td> | |
580 </tr> | |
581 <tr valign="top"> | |
582 <td> | |
475
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
583 <b>topic</b> |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
584 </td> |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
585 <td> |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
586 set topic for current room |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
587 </td> |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
588 </tr> |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
589 <tr valign="top"> |
fa49ac0bb8f3
Add "/room topic", and display topic changes
Mikael Berthe <mikael@lilotux.net>
parents:
470
diff
changeset
|
590 <td> |
467 | 591 <b>unlock</b> |
592 </td> | |
593 <td> | |
594 unlock current room (if you are the owner) | |
450 | 595 </td> |
596 </tr> | |
573 | 597 <tr valign="top"> |
598 <td> | |
601 | 599 <b>destroy</b> [reason] |
600 </td> | |
601 <td> | |
602 destroy the current room (use with care!) | |
603 </td> | |
604 </tr> | |
605 <tr valign="top"> | |
606 <td> | |
573 | 607 <b>whois</b> nick |
608 </td> | |
609 <td> | |
610 display MUC information about "nick" | |
611 </td> | |
612 </tr> | |
593 | 613 <tr valign="top"> |
614 <td> | |
615 <b>ban</b> jid [reason] | |
616 </td> | |
617 <td> | |
618 ban jid from the current room | |
619 </td> | |
620 </tr> | |
621 <tr valign="top"> | |
622 <td> | |
623 <b>invite</b> jid [reason] | |
624 </td> | |
625 <td> | |
626 invite jid to the current room | |
627 </td> | |
628 </tr> | |
629 <tr valign="top"> | |
630 <td> | |
631 <b>kick</b> nick [reason] | |
632 </td> | |
633 <td> | |
634 kick "nick" from the current room | |
635 </td> | |
636 </tr> | |
637 <tr valign="top"> | |
638 <td> | |
639 <b>role</b> jid role [reason] | |
640 </td> | |
641 <td> | |
642 change jid's role (role can be "none", "visitor", "participant", "moderator") | |
643 </td> | |
644 </tr> | |
645 <tr valign="top"> | |
646 <td> | |
647 <b>affil</b> jid affil [reason] | |
648 </td> | |
649 <td> | |
650 change jid's affiliation (affil can be "none", "member", "admin", "owner") | |
651 </td> | |
652 </tr> | |
450 | 653 </table> |
229 | 654 </dd> |
655 <dt><b> | |
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
656 /roster bottom|top|hide_offline|show_offline|toggle_offline |
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
657 </b></dt> |
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
658 <dt><b> |
710 | 659 /roster hide|show|toggle |
660 </b></dt> | |
661 <dt><b> | |
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
662 /roster alternate|unread_first|unread_next |
265 | 663 </b></dt> |
664 <dt><b> | |
665 /roster search bud | |
229 | 666 </b></dt> |
667 <dd> | |
265 | 668 The <b>roster</b> command manipulates the roster/buddylist. Here are the available parameters: |
229 | 669 <table class="hlist"> |
670 <tr valign="top"> | |
671 <td> | |
265 | 672 <b>bottom</b> |
673 </td> | |
674 <td> | |
675 jump to the bottom of the roster | |
676 </td> | |
677 </tr> | |
678 <tr valign="top"> | |
679 <td> | |
680 <b>top</b> | |
681 </td> | |
682 <td> | |
683 jump to the top of the roster | |
684 </td> | |
685 </tr> | |
686 <tr valign="top"> | |
687 <td> | |
377
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
688 <b>up</b> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
689 </td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
690 <td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
691 move up in the roster |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
692 </td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
693 </tr> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
694 <tr valign="top"> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
695 <td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
696 <b>down</b> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
697 </td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
698 <td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
699 move down in the roster |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
700 </td> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
701 </tr> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
702 <tr valign="top"> |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
703 <td> |
229 | 704 <b>hide_offline</b> |
705 </td> | |
706 <td> | |
707 hide offline buddies | |
708 </td> | |
709 </tr> | |
710 <tr valign="top"> | |
711 <td> | |
712 <b>show_offline</b> | |
713 </td> | |
714 <td> | |
715 show offline buddies | |
716 </td> | |
717 </tr> | |
718 <tr valign="top"> | |
719 <td> | |
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
720 <b>toggle_offline</b> |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
721 </td> |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
722 <td> |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
723 toggle display of offline buddies |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
724 </td> |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
725 </tr> |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
726 <tr valign="top"> |
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
727 <td> |
710 | 728 <b>hide</b> |
729 </td> | |
730 <td> | |
731 hide roster (full-width chat window) | |
732 </td> | |
733 </tr> | |
734 <tr valign="top"> | |
735 <td> | |
736 <b>show</b> | |
737 </td> | |
738 <td> | |
739 show roster | |
740 </td> | |
741 </tr> | |
742 <tr valign="top"> | |
743 <td> | |
744 <b>toggle</b> | |
745 </td> | |
746 <td> | |
747 toggle roster visibility | |
748 </td> | |
749 </tr> | |
750 <tr valign="top"> | |
751 <td> | |
265 | 752 <b>search</b> bud |
229 | 753 </td> |
754 <td> | |
265 | 755 search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) |
229 | 756 </td> |
757 </tr> | |
236 | 758 <tr valign="top"> |
759 <td> | |
330 | 760 <b>alternate</b> |
761 </td> | |
762 <td> | |
763 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") | |
764 </td> | |
765 </tr> | |
766 <tr valign="top"> | |
767 <td> | |
236 | 768 <b>unread_first</b> |
769 </td> | |
770 <td> | |
771 jump to the first unread message | |
772 </td> | |
773 </tr> | |
774 <tr valign="top"> | |
775 <td> | |
776 <b>unread_next</b> | |
777 </td> | |
778 <td> | |
779 jump to the next unread message | |
780 </td> | |
781 </tr> | |
229 | 782 </table> |
783 </dd> | |
784 <dt><b> | |
785 /say text | |
786 </b></dt> | |
787 <dd> | |
491 | 788 Send the "text" message to the currently selected buddy. Can be useful |
229 | 789 if you want to send a message beginning with a slash, for example. |
790 </dd> | |
791 <dt><b> | |
480 | 792 /say_to jid text |
793 </b></dt> | |
794 <dd> | |
491 | 795 Send the "text" message to the specified jid. |
480 | 796 Please note that this command doesn't set the default resource for |
797 a contact, so if you want to send several messages to a specific | |
798 ressource you will have to use "/say_to" for each message. | |
799 </dd> | |
800 <dt><b> | |
522 | 801 /status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]] |
229 | 802 </b></dt> |
803 <dd> | |
522 | 804 Show or set the current status.<br /> |
805 If no status is specified, display the current status.<br /> | |
320
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
305
diff
changeset
|
806 If a status message is specified, it will overrride the message* |
522 | 807 variables (these variables can be set in the configuration file). |
808 If no relevant message* variable is set and no status message provided, | |
809 the current status message is kept. If StatusMessage is "-", the | |
810 current status message is cleared. | |
229 | 811 </dd> |
450 | 812 <dt><b> |
813 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] | |
814 </b></dt> | |
815 <dd> | |
816 Send the requested status to the specified Jabber user.<br /> | |
660 | 817 If the specified jid is ".", the current buddy is used.<br /> |
450 | 818 Note: this status will be overridden by subsequent "/status" commands. |
819 If you are using the auto-away feature, the status will overridden | |
820 too.<br /> | |
821 Note: The jid can include a resource (i.e. user@server/resource). | |
822 </dd> | |
623 | 823 <dt><b> |
824 /version | |
825 </b></dt> | |
826 <dd> | |
827 Display mcabber version | |
828 </dd> | |
229 | 829 </dl> |
830 <h2>CONFIGURATION FILE</h2> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
831 <p>See the provided sample configuration file, which should be self-documented.</p> |
229 | 832 <h2>FILES</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
833 <p>The following files can be used by <tt>mcabber(1)</tt>:</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
834 <div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc Default configuration file |
229 | 835 $HOME/.mcabberrc Configuration file used if no other has been found |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
836 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled</pre></div> |
229 | 837 <h2>BUGS</h2> |
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
345
diff
changeset
|
838 <p>Certainly. Please tell me if you find one! :-)</p> |
229 | 839 <h2>AUTHOR</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
840 <p>Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br /> |
229 | 841 Originally based on <a href="http://cabber.sourceforge.net">Cabber</a>, please |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
842 consult the AUTHORS file for details.</p> |
229 | 843 <h2>RESOURCES</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
844 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p> |
229 | 845 <h2>COPYING</h2> |
700 | 846 <p>Copyright © 2005, 2006 Mikael Berthe.<br /> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
847 Some portions are Copyright © 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
848 <p>Free use of this software is granted under the terms of the GNU General Public |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
849 License (GPL).</p> |
229 | 850 <div id="footer"> |
851 <p> | |
700 | 852 Version 0.7.5-dev<br /> |
710 | 853 Last updated 25-Feb-2006 23:01:21 CEST |
229 | 854 </p> |
855 </div> | |
856 </div> | |
857 </body> | |
858 </html> |