Mercurial > hg
annotate mcabber/doc/mcabber.1.html @ 260:33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
"/msay verbatim" enters multi-line mode with all commands disabled
but "/msay", so that lines beginning with a slash '/' can be sent.
Note: <Tab> still do commands completion.
author | mikael@frmp8452 |
---|---|
date | Fri, 01 Jul 2005 23:47:03 +0100 |
parents | 719b87a693a9 |
children | 1bcc3eec08f0 |
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" /> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
5 <meta name="generator" content="AsciiDoc 7.0.0" /> |
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> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
26 <p>The <tt>mcabber(1)</tt> screen is divided into 4 regions. |
229 | 27 The <b>roster</b>, alias <b>buddylist</b>, is on the left. The <b>chat window</b>, or chat |
28 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
|
29 under a small <b>log window</b>.</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
30 <p>To display buddies chat buffers, you will have to enter <b>chat mode</b>. |
229 | 31 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
|
32 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
|
33 <p>Here are some of the features of <tt>mcabber</tt>:</p> |
229 | 34 <ul> |
35 <li> | |
36 <p> | |
37 <b>SSL support</b>. | |
38 </p> | |
39 </li> | |
40 <li> | |
41 <p> | |
42 <b>History logging:</b> If enabled (see the CONFIGURATION FILE section), | |
43 <tt>mcabber(1)</tt> can save discussions to history log files. | |
44 </p> | |
45 </li> | |
46 <li> | |
47 <p> | |
48 <b>Commands completion:</b> If possible, <tt>mcabber(1)</tt> will try to complete your | |
49 command line if you hit the Tab key. | |
50 </p> | |
51 </li> | |
52 <li> | |
53 <p> | |
54 <b>External actions:</b> Some events (like receiving a message) can trigger an | |
55 external action, for example a shell script (you need to enable it in your | |
56 configuration file). | |
57 </p> | |
58 </li> | |
59 </ul> | |
60 <h2>OPTIONS</h2> | |
61 <dl> | |
62 <dt><b> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
63 --help, -h |
229 | 64 </b></dt> |
65 <dd> | |
66 Quick help usage message | |
67 </dd> | |
68 <dt><b> | |
69 -f configfile | |
70 </b></dt> | |
71 <dd> | |
72 Use configuration file <b>configfile</b> | |
73 </dd> | |
74 </dl> | |
75 <h2>KEYS</h2> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
76 <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
|
77 (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
|
78 <p>PageUp and PageDown keys are used to move in the roster.</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
79 <p>To send a message, move to the choosen buddy in the buddylist, type your |
229 | 80 message and hit enter. If the line begins with a slash, this will be |
81 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
|
82 leave the chat mode.</p> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
83 <p>Here is a quick description of the key bindings:</p> |
229 | 84 <table class="hlist"> |
85 <tr valign="top"> | |
86 <td> | |
87 Ctrl-a | |
88 </td> | |
89 <td> | |
90 Go to the beginning of the input line | |
91 </td> | |
92 </tr> | |
93 <tr valign="top"> | |
94 <td> | |
95 Ctrl-e | |
96 </td> | |
97 <td> | |
98 Go to the end of the input line | |
99 </td> | |
100 </tr> | |
101 <tr valign="top"> | |
102 <td> | |
103 Ctrl-l | |
104 </td> | |
105 <td> | |
106 Force a resize | |
107 </td> | |
108 </tr> | |
109 <tr valign="top"> | |
110 <td> | |
111 PgUp/PgDown | |
112 </td> | |
113 <td> | |
114 Move inside the roster (buddylist) | |
115 </td> | |
116 </tr> | |
117 <tr valign="top"> | |
118 <td> | |
119 Tab | |
120 </td> | |
121 <td> | |
122 Complete current word, in the input line | |
123 </td> | |
124 </tr> | |
125 <tr valign="top"> | |
126 <td> | |
127 Ctrl-g | |
128 </td> | |
129 <td> | |
130 Cancel completion / ctrl-g | |
131 </td> | |
132 </tr> | |
133 <tr valign="top"> | |
134 <td> | |
135 Ctrl-p/Ctrl-n | |
136 </td> | |
137 <td> | |
138 Scroll up/down half a screen in the buffer window (chat mode) | |
139 </td> | |
140 </tr> | |
141 <tr valign="top"> | |
142 <td> | |
143 Ctrl-u | |
144 </td> | |
145 <td> | |
146 Delete from beginning of the line to the cursor | |
147 </td> | |
148 </tr> | |
149 <tr valign="top"> | |
150 <td> | |
151 Ctrl-k | |
152 </td> | |
153 <td> | |
154 Delete from the cursor to the end of line | |
155 </td> | |
156 </tr> | |
157 <tr valign="top"> | |
158 <td> | |
159 Ctrl-w | |
160 </td> | |
161 <td> | |
162 Backward kill word | |
163 </td> | |
164 </tr> | |
165 <tr valign="top"> | |
166 <td> | |
167 Ctrl-t | |
168 </td> | |
169 <td> | |
170 Transpose chars | |
171 </td> | |
172 </tr> | |
173 <tr valign="top"> | |
174 <td> | |
175 Ctrl-q | |
176 </td> | |
177 <td> | |
236 | 178 Jump to the next unread message |
229 | 179 </td> |
180 </tr> | |
181 </table> | |
182 <h2>COMMANDS</h2> | |
183 <dl> | |
184 <dt><b> | |
245 | 185 /add jid [nickname] |
229 | 186 </b></dt> |
187 <dd> | |
245 | 188 Add the <b>jid</b> Jabber user to our roster (default group), and send a |
189 notification request to this buddy. If no nickname is specified, the | |
190 jid is used. | |
229 | 191 </dd> |
192 <dt><b> | |
193 /buffer clear|top|bottom | |
194 </b></dt> | |
195 <dd> | |
196 The <b>buffer</b> command manipulates the current buddy's buffer | |
197 (chat window). | |
198 <table class="hlist"> | |
199 <tr valign="top"> | |
200 <td> | |
201 <b>clear</b> | |
202 </td> | |
203 <td> | |
204 clear the current buddy chat window | |
205 </td> | |
206 </tr> | |
207 <tr valign="top"> | |
208 <td> | |
209 <b>top</b> | |
210 </td> | |
211 <td> | |
212 jump to the top of the current buddy chat buffer | |
213 </td> | |
214 </tr> | |
215 <tr valign="top"> | |
216 <td> | |
217 <b>bottom</b> | |
218 </td> | |
219 <td> | |
220 jump to the bottom of the current buddy chat buffer | |
221 </td> | |
222 </tr> | |
223 </table> | |
224 </dd> | |
225 <dt><b> | |
226 /clear | |
227 </b></dt> | |
228 <dd> | |
229 The <b>clear</b> command is actually an alias for "/buffer clear". | |
230 </dd> | |
231 <dt><b> | |
232 /del | |
233 </b></dt> | |
234 <dd> | |
235 Delete the current buddy from our roster, unsubscribe from its presence | |
236 notification and unsubscribe it from ours. | |
237 </dd> | |
238 <dt><b> | |
240 | 239 /group fold|unfold|toggle |
229 | 240 </b></dt> |
241 <dd> | |
240 | 242 The <b>group</b> command changes the current group display. |
229 | 243 <table class="hlist"> |
244 <tr valign="top"> | |
245 <td> | |
240 | 246 <b>fold</b> |
229 | 247 </td> |
248 <td> | |
240 | 249 fold (shrink) the current group tree in the roster |
229 | 250 </td> |
251 </tr> | |
252 <tr valign="top"> | |
253 <td> | |
240 | 254 <b>unfold</b> |
229 | 255 </td> |
256 <td> | |
240 | 257 unfold (expand) the current group tree in the roster |
229 | 258 </td> |
259 </tr> | |
260 <tr valign="top"> | |
261 <td> | |
262 <b>toggle</b> | |
263 </td> | |
264 <td> | |
240 | 265 toggle the state (fold/unfold) of the current tree |
229 | 266 </td> |
267 </tr> | |
268 </table> | |
269 </dd> | |
270 <dt><b> | |
271 /info | |
272 </b></dt> | |
273 <dd> | |
274 Display info on the selected entry (user, agent, group…). | |
275 </dd> | |
276 <dt><b> | |
277 /move [groupname] | |
278 </b></dt> | |
279 <dd> | |
280 Move the current buddy to the requested group. If no group is | |
281 specified, then the buddy is moved to the default group. | |
282 This command only works with users (not agents), at the moment. | |
283 </dd> | |
284 <dt><b> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
285 /msay begin|verbatim|send|abort |
238 | 286 </b></dt> |
287 <dd> | |
288 Send a multi-line message. To write a single message with several | |
289 lines, the <b>multi-line mode</b> should be used. In multi-line mode, | |
290 each line (except command lines) typed in the input line will | |
291 be added to the multi-line message. Once the message is finished, it | |
292 can be sent to the current selected buddy with the "msay /send" | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
293 command. The <b>verbatim</b> multi-line mode disables commands, so that it |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
294 is possible to enter lines starting with a slash. Only the "/msay" |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
295 command (with send or abort parameters) can be used to exit verbatim mode. |
238 | 296 <table class="hlist"> |
297 <tr valign="top"> | |
298 <td> | |
299 <b>begin</b> | |
300 </td> | |
301 <td> | |
302 enter multi-line mode | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
303 </td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
304 </tr> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
305 <tr valign="top"> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
306 <td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
307 <b>verbatim</b> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
308 </td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
309 <td> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
310 enter verbatim multi-line mode |
238 | 311 </td> |
312 </tr> | |
313 <tr valign="top"> | |
314 <td> | |
315 <b>send</b> | |
316 </td> | |
317 <td> | |
318 send the current multi-line message to the currently selected buddy | |
319 </td> | |
320 </tr> | |
321 <tr valign="top"> | |
322 <td> | |
323 <b>abort</b> | |
324 </td> | |
325 <td> | |
326 leave multi-line mode without sending the message | |
327 </td> | |
328 </tr> | |
329 </table> | |
330 </dd> | |
331 <dt><b> | |
229 | 332 /quit |
333 </b></dt> | |
334 <dd> | |
335 Disconnect and leave <tt>mcabber(1)</tt>. | |
336 </dd> | |
337 <dt><b> | |
338 /rename nickname | |
339 </b></dt> | |
340 <dd> | |
341 Rename current buddy to the given nickname. | |
342 This command does not work for groups, at the moment (but you can move | |
343 the buddies to another group with the /move command). | |
344 </dd> | |
345 <dt><b> | |
346 /roster hide_offline|show_offline|top|bottom | |
347 </b></dt> | |
348 <dd> | |
349 The <b>roster</b> command manipulates the roster/buddylist. | |
350 <table class="hlist"> | |
351 <tr valign="top"> | |
352 <td> | |
353 <b>hide_offline</b> | |
354 </td> | |
355 <td> | |
356 hide offline buddies | |
357 </td> | |
358 </tr> | |
359 <tr valign="top"> | |
360 <td> | |
361 <b>show_offline</b> | |
362 </td> | |
363 <td> | |
364 show offline buddies | |
365 </td> | |
366 </tr> | |
367 <tr valign="top"> | |
368 <td> | |
369 <b>top</b> | |
370 </td> | |
371 <td> | |
372 jump to the top of the roster | |
373 </td> | |
374 </tr> | |
375 <tr valign="top"> | |
376 <td> | |
377 <b>bottom</b> | |
378 </td> | |
379 <td> | |
380 jump to the bottom of the roster | |
381 </td> | |
382 </tr> | |
236 | 383 <tr valign="top"> |
384 <td> | |
385 <b>unread_first</b> | |
386 </td> | |
387 <td> | |
388 jump to the first unread message | |
389 </td> | |
390 </tr> | |
391 <tr valign="top"> | |
392 <td> | |
393 <b>unread_next</b> | |
394 </td> | |
395 <td> | |
396 jump to the next unread message | |
397 </td> | |
398 </tr> | |
229 | 399 </table> |
400 </dd> | |
401 <dt><b> | |
402 /say text | |
403 </b></dt> | |
404 <dd> | |
405 Send the text message to the currently selected buddy. Can be useful | |
406 if you want to send a message beginning with a slash, for example. | |
407 </dd> | |
408 <dt><b> | |
409 /status [online|avail|invisible|free|dnd|busy|notavail|away] | |
410 </b></dt> | |
411 <dd> | |
412 Set the current status. If no status is specified, display the | |
413 current status. | |
414 </dd> | |
415 </dl> | |
416 <h2>CONFIGURATION FILE</h2> | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
417 <p>See the provided sample configuration file, which should be self-documented.</p> |
229 | 418 <h2>FILES</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
419 <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
|
420 <div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc Default configuration file |
229 | 421 $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
|
422 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled</pre></div> |
229 | 423 <h2>BUGS</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
424 <p>Certainly a lot. Please tell me if you find one! :-)</p> |
229 | 425 <h2>AUTHOR</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
426 <p>Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br /> |
229 | 427 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
|
428 consult the AUTHORS file for details.</p> |
229 | 429 <h2>RESOURCES</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
430 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p> |
229 | 431 <h2>COPYING</h2> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
432 <p>Copyright © 2005 Mikael Berthe.<br /> |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
433 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
|
434 <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
|
435 License (GPL).</p> |
229 | 436 <div id="footer"> |
437 <p> | |
254 | 438 Version 0.6.2<br /> |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
439 Last updated 02-Jul-2005 00:36:19 CEST |
229 | 440 </p> |
441 </div> | |
442 </div> | |
443 </body> | |
444 </html> |