Mercurial > ~mikael > mcabber > hg
comparison mcabber/doc/mcabber.1.html @ 1759:921429804e20
Update documentation
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Sat, 13 Mar 2010 18:05:07 +0100 |
parents | d7f26538c24c |
children | cec7cbeb1c2e |
comparison
equal
deleted
inserted
replaced
1758:499d3ec34188 | 1759:921429804e20 |
---|---|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" |
2 <html> | 2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> | |
3 <head> | 4 <head> |
4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> | 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
5 <meta name="generator" content="AsciiDoc 8.2.1" /> | 6 <meta name="generator" content="AsciiDoc 8.5.2" /> |
6 <meta name="author" content="Mikael BERTHE" /> | 7 <title>MCABBER(1)</title> |
7 <meta name="author-email" content="mcabber@lilotux.net" /> | 8 <style type="text/css"> |
8 <link rel="stylesheet" href="./manpage.css" type="text/css" /> | 9 /* Debug borders */ |
9 <title>mcabber</title> | 10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { |
11 /* | |
12 border: 1px solid red; | |
13 */ | |
14 } | |
15 | |
16 body { | |
17 margin: 1em 5% 1em 5%; | |
18 } | |
19 | |
20 a { | |
21 color: blue; | |
22 text-decoration: underline; | |
23 } | |
24 a:visited { | |
25 color: fuchsia; | |
26 } | |
27 | |
28 em { | |
29 font-style: italic; | |
30 color: navy; | |
31 } | |
32 | |
33 strong { | |
34 font-weight: bold; | |
35 color: #083194; | |
36 } | |
37 | |
38 tt { | |
39 color: navy; | |
40 } | |
41 | |
42 h1, h2, h3, h4, h5, h6 { | |
43 color: #527bbd; | |
44 font-family: sans-serif; | |
45 margin-top: 1.2em; | |
46 margin-bottom: 0.5em; | |
47 line-height: 1.3; | |
48 } | |
49 | |
50 h1, h2, h3 { | |
51 border-bottom: 2px solid silver; | |
52 } | |
53 h2 { | |
54 padding-top: 0.5em; | |
55 } | |
56 h3 { | |
57 float: left; | |
58 } | |
59 h3 + * { | |
60 clear: left; | |
61 } | |
62 | |
63 div.sectionbody { | |
64 font-family: serif; | |
65 margin-left: 0; | |
66 } | |
67 | |
68 hr { | |
69 border: 1px solid silver; | |
70 } | |
71 | |
72 p { | |
73 margin-top: 0.5em; | |
74 margin-bottom: 0.5em; | |
75 } | |
76 | |
77 ul, ol, li > p { | |
78 margin-top: 0; | |
79 } | |
80 | |
81 pre { | |
82 padding: 0; | |
83 margin: 0; | |
84 } | |
85 | |
86 span#author { | |
87 color: #527bbd; | |
88 font-family: sans-serif; | |
89 font-weight: bold; | |
90 font-size: 1.1em; | |
91 } | |
92 span#email { | |
93 } | |
94 span#revnumber, span#revdate, span#revremark { | |
95 font-family: sans-serif; | |
96 } | |
97 | |
98 div#footer { | |
99 font-family: sans-serif; | |
100 font-size: small; | |
101 border-top: 2px solid silver; | |
102 padding-top: 0.5em; | |
103 margin-top: 4.0em; | |
104 } | |
105 div#footer-text { | |
106 float: left; | |
107 padding-bottom: 0.5em; | |
108 } | |
109 div#footer-badges { | |
110 float: right; | |
111 padding-bottom: 0.5em; | |
112 } | |
113 | |
114 div#preamble { | |
115 margin-top: 1.5em; | |
116 margin-bottom: 1.5em; | |
117 } | |
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock, | |
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, | |
120 div.admonitionblock { | |
121 margin-top: 1.0em; | |
122 margin-bottom: 1.5em; | |
123 } | |
124 div.admonitionblock { | |
125 margin-top: 2.0em; | |
126 margin-bottom: 2.0em; | |
127 margin-right: 10%; | |
128 color: #606060; | |
129 } | |
130 | |
131 div.content { /* Block element content. */ | |
132 padding: 0; | |
133 } | |
134 | |
135 /* Block element titles. */ | |
136 div.title, caption.title { | |
137 color: #527bbd; | |
138 font-family: sans-serif; | |
139 font-weight: bold; | |
140 text-align: left; | |
141 margin-top: 1.0em; | |
142 margin-bottom: 0.5em; | |
143 } | |
144 div.title + * { | |
145 margin-top: 0; | |
146 } | |
147 | |
148 td div.title:first-child { | |
149 margin-top: 0.0em; | |
150 } | |
151 div.content div.title:first-child { | |
152 margin-top: 0.0em; | |
153 } | |
154 div.content + div.title { | |
155 margin-top: 0.0em; | |
156 } | |
157 | |
158 div.sidebarblock > div.content { | |
159 background: #ffffee; | |
160 border: 1px solid silver; | |
161 padding: 0.5em; | |
162 } | |
163 | |
164 div.listingblock > div.content { | |
165 border: 1px solid silver; | |
166 background: #f4f4f4; | |
167 padding: 0.5em; | |
168 } | |
169 | |
170 div.quoteblock, div.verseblock { | |
171 padding-left: 1.0em; | |
172 margin-left: 1.0em; | |
173 margin-right: 10%; | |
174 border-left: 5px solid #dddddd; | |
175 color: #777777; | |
176 } | |
177 | |
178 div.quoteblock > div.attribution { | |
179 padding-top: 0.5em; | |
180 text-align: right; | |
181 } | |
182 | |
183 div.verseblock > div.content { | |
184 white-space: pre; | |
185 } | |
186 div.verseblock > div.attribution { | |
187 padding-top: 0.75em; | |
188 text-align: left; | |
189 } | |
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */ | |
191 div.verseblock + div.attribution { | |
192 text-align: left; | |
193 } | |
194 | |
195 div.admonitionblock .icon { | |
196 vertical-align: top; | |
197 font-size: 1.1em; | |
198 font-weight: bold; | |
199 text-decoration: underline; | |
200 color: #527bbd; | |
201 padding-right: 0.5em; | |
202 } | |
203 div.admonitionblock td.content { | |
204 padding-left: 0.5em; | |
205 border-left: 3px solid #dddddd; | |
206 } | |
207 | |
208 div.exampleblock > div.content { | |
209 border-left: 3px solid #dddddd; | |
210 padding-left: 0.5em; | |
211 } | |
212 | |
213 div.imageblock div.content { padding-left: 0; } | |
214 span.image img { border-style: none; } | |
215 a.image:visited { color: white; } | |
216 | |
217 dl { | |
218 margin-top: 0.8em; | |
219 margin-bottom: 0.8em; | |
220 } | |
221 dt { | |
222 margin-top: 0.5em; | |
223 margin-bottom: 0; | |
224 font-style: normal; | |
225 color: navy; | |
226 } | |
227 dd > *:first-child { | |
228 margin-top: 0.1em; | |
229 } | |
230 | |
231 ul, ol { | |
232 list-style-position: outside; | |
233 } | |
234 ol.arabic { | |
235 list-style-type: decimal; | |
236 } | |
237 ol.loweralpha { | |
238 list-style-type: lower-alpha; | |
239 } | |
240 ol.upperalpha { | |
241 list-style-type: upper-alpha; | |
242 } | |
243 ol.lowerroman { | |
244 list-style-type: lower-roman; | |
245 } | |
246 ol.upperroman { | |
247 list-style-type: upper-roman; | |
248 } | |
249 | |
250 div.compact ul, div.compact ol, | |
251 div.compact p, div.compact p, | |
252 div.compact div, div.compact div { | |
253 margin-top: 0.1em; | |
254 margin-bottom: 0.1em; | |
255 } | |
256 | |
257 div.tableblock > table { | |
258 border: 3px solid #527bbd; | |
259 } | |
260 thead, p.table.header { | |
261 font-family: sans-serif; | |
262 font-weight: bold; | |
263 } | |
264 tfoot { | |
265 font-weight: bold; | |
266 } | |
267 td > div.verse { | |
268 white-space: pre; | |
269 } | |
270 p.table { | |
271 margin-top: 0; | |
272 } | |
273 /* Because the table frame attribute is overriden by CSS in most browsers. */ | |
274 div.tableblock > table[frame="void"] { | |
275 border-style: none; | |
276 } | |
277 div.tableblock > table[frame="hsides"] { | |
278 border-left-style: none; | |
279 border-right-style: none; | |
280 } | |
281 div.tableblock > table[frame="vsides"] { | |
282 border-top-style: none; | |
283 border-bottom-style: none; | |
284 } | |
285 | |
286 | |
287 div.hdlist { | |
288 margin-top: 0.8em; | |
289 margin-bottom: 0.8em; | |
290 } | |
291 div.hdlist tr { | |
292 padding-bottom: 15px; | |
293 } | |
294 dt.hdlist1.strong, td.hdlist1.strong { | |
295 font-weight: bold; | |
296 } | |
297 td.hdlist1 { | |
298 vertical-align: top; | |
299 font-style: normal; | |
300 padding-right: 0.8em; | |
301 color: navy; | |
302 } | |
303 td.hdlist2 { | |
304 vertical-align: top; | |
305 } | |
306 div.hdlist.compact tr { | |
307 margin: 0; | |
308 padding-bottom: 0; | |
309 } | |
310 | |
311 .comment { | |
312 background: yellow; | |
313 } | |
314 | |
315 .footnote, .footnoteref { | |
316 font-size: 0.8em; | |
317 } | |
318 | |
319 span.footnote, span.footnoteref { | |
320 vertical-align: super; | |
321 } | |
322 | |
323 #footnotes { | |
324 margin: 20px 0 20px 0; | |
325 padding: 7px 0 0 0; | |
326 } | |
327 | |
328 #footnotes div.footnote { | |
329 margin: 0 0 5px 0; | |
330 } | |
331 | |
332 #footnotes hr { | |
333 border: none; | |
334 border-top: 1px solid silver; | |
335 height: 1px; | |
336 text-align: left; | |
337 margin-left: 0; | |
338 width: 20%; | |
339 min-width: 100px; | |
340 } | |
341 | |
342 | |
343 @media print { | |
344 div#footer-badges { display: none; } | |
345 } | |
346 | |
347 div#toc { | |
348 margin-bottom: 2.5em; | |
349 } | |
350 | |
351 div#toctitle { | |
352 color: #527bbd; | |
353 font-family: sans-serif; | |
354 font-size: 1.1em; | |
355 font-weight: bold; | |
356 margin-top: 1.0em; | |
357 margin-bottom: 0.1em; | |
358 } | |
359 | |
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { | |
361 margin-top: 0; | |
362 margin-bottom: 0; | |
363 } | |
364 div.toclevel2 { | |
365 margin-left: 2em; | |
366 font-size: 0.9em; | |
367 } | |
368 div.toclevel3 { | |
369 margin-left: 4em; | |
370 font-size: 0.9em; | |
371 } | |
372 div.toclevel4 { | |
373 margin-left: 6em; | |
374 font-size: 0.9em; | |
375 } | |
376 /* Overrides for manpage documents */ | |
377 h1 { | |
378 padding-top: 0.5em; | |
379 padding-bottom: 0.5em; | |
380 border-top: 2px solid silver; | |
381 border-bottom: 2px solid silver; | |
382 } | |
383 h2 { | |
384 border-style: none; | |
385 } | |
386 div.sectionbody { | |
387 margin-left: 5%; | |
388 } | |
389 | |
390 @media print { | |
391 div#toc { display: none; } | |
392 } | |
393 | |
394 /* Workarounds for IE6's broken and incomplete CSS2. */ | |
395 | |
396 div.sidebar-content { | |
397 background: #ffffee; | |
398 border: 1px solid silver; | |
399 padding: 0.5em; | |
400 } | |
401 div.sidebar-title, div.image-title { | |
402 color: #527bbd; | |
403 font-family: sans-serif; | |
404 font-weight: bold; | |
405 margin-top: 0.0em; | |
406 margin-bottom: 0.5em; | |
407 } | |
408 | |
409 div.listingblock div.content { | |
410 border: 1px solid silver; | |
411 background: #f4f4f4; | |
412 padding: 0.5em; | |
413 } | |
414 | |
415 div.quoteblock-attribution { | |
416 padding-top: 0.5em; | |
417 text-align: right; | |
418 } | |
419 | |
420 div.verseblock-content { | |
421 white-space: pre; | |
422 } | |
423 div.verseblock-attribution { | |
424 padding-top: 0.75em; | |
425 text-align: left; | |
426 } | |
427 | |
428 div.exampleblock-content { | |
429 border-left: 3px solid #dddddd; | |
430 padding-left: 0.5em; | |
431 } | |
432 | |
433 /* IE6 sets dynamically generated links as visited. */ | |
434 div#toc a:visited { color: blue; } | |
435 </style> | |
436 <script type="text/javascript"> | |
437 /*<![CDATA[*/ | |
438 window.onload = function(){asciidoc.footnotes();} | |
439 var asciidoc = { // Namespace. | |
440 | |
441 ///////////////////////////////////////////////////////////////////// | |
442 // Table Of Contents generator | |
443 ///////////////////////////////////////////////////////////////////// | |
444 | |
445 /* Author: Mihai Bazon, September 2002 | |
446 * http://students.infoiasi.ro/~mishoo | |
447 * | |
448 * Table Of Content generator | |
449 * Version: 0.4 | |
450 * | |
451 * Feel free to use this script under the terms of the GNU General Public | |
452 * License, as long as you do not remove or alter this notice. | |
453 */ | |
454 | |
455 /* modified by Troy D. Hanson, September 2006. License: GPL */ | |
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */ | |
457 | |
458 // toclevels = 1..4. | |
459 toc: function (toclevels) { | |
460 | |
461 function getText(el) { | |
462 var text = ""; | |
463 for (var i = el.firstChild; i != null; i = i.nextSibling) { | |
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants. | |
465 text += i.data; | |
466 else if (i.firstChild != null) | |
467 text += getText(i); | |
468 } | |
469 return text; | |
470 } | |
471 | |
472 function TocEntry(el, text, toclevel) { | |
473 this.element = el; | |
474 this.text = text; | |
475 this.toclevel = toclevel; | |
476 } | |
477 | |
478 function tocEntries(el, toclevels) { | |
479 var result = new Array; | |
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])'); | |
481 // Function that scans the DOM tree for header elements (the DOM2 | |
482 // nodeIterator API would be a better technique but not supported by all | |
483 // browsers). | |
484 var iterate = function (el) { | |
485 for (var i = el.firstChild; i != null; i = i.nextSibling) { | |
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { | |
487 var mo = re.exec(i.tagName); | |
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { | |
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1); | |
490 } | |
491 iterate(i); | |
492 } | |
493 } | |
494 } | |
495 iterate(el); | |
496 return result; | |
497 } | |
498 | |
499 var toc = document.getElementById("toc"); | |
500 var entries = tocEntries(document.getElementById("content"), toclevels); | |
501 for (var i = 0; i < entries.length; ++i) { | |
502 var entry = entries[i]; | |
503 if (entry.element.id == "") | |
504 entry.element.id = "_toc_" + i; | |
505 var a = document.createElement("a"); | |
506 a.href = "#" + entry.element.id; | |
507 a.appendChild(document.createTextNode(entry.text)); | |
508 var div = document.createElement("div"); | |
509 div.appendChild(a); | |
510 div.className = "toclevel" + entry.toclevel; | |
511 toc.appendChild(div); | |
512 } | |
513 if (entries.length == 0) | |
514 toc.parentNode.removeChild(toc); | |
515 }, | |
516 | |
517 | |
518 ///////////////////////////////////////////////////////////////////// | |
519 // Footnotes generator | |
520 ///////////////////////////////////////////////////////////////////// | |
521 | |
522 /* Based on footnote generation code from: | |
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html | |
524 */ | |
525 | |
526 footnotes: function () { | |
527 var cont = document.getElementById("content"); | |
528 var noteholder = document.getElementById("footnotes"); | |
529 var spans = cont.getElementsByTagName("span"); | |
530 var refs = {}; | |
531 var n = 0; | |
532 for (i=0; i<spans.length; i++) { | |
533 if (spans[i].className == "footnote") { | |
534 n++; | |
535 // Use [\s\S] in place of . so multi-line matches work. | |
536 // Because JavaScript has no s (dotall) regex flag. | |
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; | |
538 noteholder.innerHTML += | |
539 "<div class='footnote' id='_footnote_" + n + "'>" + | |
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" + | |
541 n + "</a>. " + note + "</div>"; | |
542 spans[i].innerHTML = | |
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + | |
544 "' title='View footnote' class='footnote'>" + n + "</a>]"; | |
545 var id =spans[i].getAttribute("id"); | |
546 if (id != null) refs["#"+id] = n; | |
547 } | |
548 } | |
549 if (n == 0) | |
550 noteholder.parentNode.removeChild(noteholder); | |
551 else { | |
552 // Process footnoterefs. | |
553 for (i=0; i<spans.length; i++) { | |
554 if (spans[i].className == "footnoteref") { | |
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); | |
556 href = href.match(/#.*/)[0]; // Because IE return full URL. | |
557 n = refs[href]; | |
558 spans[i].innerHTML = | |
559 "[<a href='#_footnote_" + n + | |
560 "' title='View footnote' class='footnote'>" + n + "</a>]"; | |
561 } | |
562 } | |
563 } | |
564 } | |
565 | |
566 } | |
567 /*]]>*/ | |
568 </script> | |
10 </head> | 569 </head> |
11 <body> | 570 <body> |
571 <div id="header"> | |
572 <h1> | |
573 MCABBER(1) Manual Page | |
574 </h1> | |
575 <h2>NAME</h2> | |
576 <div class="sectionbody"> | |
577 <p>mcabber - | |
578 a simple Jabber (XMPP) console client | |
579 </p> | |
580 </div> | |
581 </div> | |
12 <div id="content"> | 582 <div id="content"> |
13 <h1>MCABBER(1) Manual Page</h1> | 583 <h2 id="_synopsis">SYNOPSIS</h2> |
14 <h2>NAME</h2> | 584 <div class="sectionbody"> |
15 <p>mcabber - | 585 <div class="paragraph"><p><em>mcabber</em> [ -h | -V | -f configfile ]</p></div> |
16 a simple Jabber console client | |
17 </p> | |
18 <div id="synopsis"> | |
19 <h2>SYNOPSIS</h2> | |
20 <p><b>mcabber</b> [ -h | -V | -f configfile ]</p> | |
21 </div> | 586 </div> |
22 <h2>DESCRIPTION</h2> | 587 <h2 id="_description">DESCRIPTION</h2> |
23 <p><tt>mcabber(1)</tt> is a small Jabber console client.<br /> | 588 <div class="sectionbody"> |
589 <div class="paragraph"><p><tt>mcabber(1)</tt> is a small Jabber (XMPP) console client.<br /> | |
24 For now it needs a configuration file to start, so please copy the sample | 590 For now it needs a configuration file to start, so please copy the sample |
25 mcabberrc file and adapt your connection settings.</p> | 591 mcabberrc file and adapt your connection settings.</p></div> |
26 <p>You also need to have an existing Jabber account to use this software, as | 592 <div class="paragraph"><p>You also need to have an existing Jabber account to use this software, as |
27 it cannot (un)register accounts yet.</p> | 593 it cannot (un)register accounts yet.</p></div> |
28 <p>Here are some of the features of <tt>mcabber</tt>:</p> | 594 <div class="paragraph"><p>Here are some of the features of <tt>mcabber</tt>:</p></div> |
29 <ul> | 595 <div class="ulist"><ul> |
30 <li> | 596 <li> |
31 <p> | 597 <p> |
32 <b>SSL/TLS support</b>. | 598 <em>SASL/SSL/TLS support</em>. |
33 </p> | 599 </p> |
34 </li> | 600 </li> |
35 <li> | 601 <li> |
36 <p> | 602 <p> |
37 <b>MUC support</b> (Multi-User Chat). | 603 <em>MUC support</em> (Multi-User Chat). |
38 </p> | 604 </p> |
39 </li> | 605 </li> |
40 <li> | 606 <li> |
41 <p> | 607 <p> |
42 <b>PGP support</b> | 608 <em>PGP, OTR support</em> |
43 </p> | 609 </p> |
44 </li> | 610 </li> |
45 <li> | 611 <li> |
46 <p> | 612 <p> |
47 <b>Chat States</b> support (typing notifications) | 613 <em>Chat States</em> support (typing notifications) |
48 </p> | 614 </p> |
49 </li> | 615 </li> |
50 <li> | 616 <li> |
51 <p> | 617 <p> |
52 <b>History logging:</b> If enabled (see the CONFIGURATION FILE section), | 618 <em>History logging:</em> If enabled (see the CONFIGURATION FILE section), |
53 <tt>mcabber</tt> can save discussions to history log files. | 619 <tt>mcabber</tt> can save discussions to text history log files. |
54 </p> | 620 </p> |
55 </li> | 621 </li> |
56 <li> | 622 <li> |
57 <p> | 623 <p> |
58 <b>Commands completion:</b> If possible, <tt>mcabber</tt> will try to complete your | 624 <em>Commands completion:</em> If possible, <tt>mcabber</tt> will try to complete your |
59 command line if you hit the Tab key. | 625 command line if you hit the Tab key. |
60 </p> | 626 </p> |
61 </li> | 627 </li> |
62 <li> | 628 <li> |
63 <p> | 629 <p> |
64 <b>Input line history:</b> Any message or command entered is in the input line | 630 <em>Input line history:</em> Any message or command entered is in the input line |
65 history and can be reused easily. | 631 history and can be reused easily. |
66 </p> | 632 </p> |
67 </li> | 633 </li> |
68 <li> | 634 <li> |
69 <p> | 635 <p> |
70 <b>External actions:</b> Some events (like receiving a message) can trigger an | 636 <em>External actions:</em> Some events (like receiving a message) can trigger an |
71 external action such as a shell script if you enable it in your | 637 external action such as a shell script if you enable it in your |
72 configuration file. A sample events script ("eventcmd") is provided with | 638 configuration file. A sample events script ("eventcmd") is provided with |
73 <tt>mcabber</tt> source code, in the contrib directory. | 639 <tt>mcabber</tt> source code, in the contrib directory. |
74 </p> | 640 </p> |
75 </li> | 641 </li> |
76 </ul> | 642 <li> |
77 <h2>OPTIONS</h2> | 643 <p> |
78 <dl> | 644 <em>Modules:</em> <tt>mcabber</tt> can load modules (a.k.a. plugins) at runtime that |
79 <dt><b> | 645 extend its features. |
80 --help, -h | 646 </p> |
81 </b></dt> | 647 </li> |
82 <dd> | 648 </ul></div> |
649 </div> | |
650 <h2 id="_options">OPTIONS</h2> | |
651 <div class="sectionbody"> | |
652 <div class="dlist"><dl> | |
653 <dt class="hdlist1"> | |
654 -h | |
655 </dt> | |
656 <dd> | |
657 <p> | |
83 Quick help usage message | 658 Quick help usage message |
84 </dd> | 659 </p> |
85 <dt><b> | 660 </dd> |
661 <dt class="hdlist1"> | |
662 -V | |
663 </dt> | |
664 <dd> | |
665 <p> | |
666 Displays <tt>mcabber</tt> version and compile-time definitions. | |
667 </p> | |
668 </dd> | |
669 <dt class="hdlist1"> | |
86 -f configfile | 670 -f configfile |
87 </b></dt> | 671 </dt> |
88 <dd> | 672 <dd> |
89 Use configuration file <b>configfile</b> | 673 <p> |
90 </dd> | 674 Use configuration file <em>configfile</em> |
91 </dl> | 675 </p> |
92 <h2>WINDOWS/PANES</h2> | 676 </dd> |
93 <p>The <tt>mcabber(1)</tt> screen is divided into 4 regions. | 677 </dl></div> |
94 The <b>roster</b>, alias <b>buddylist</b>, is on the left. The <b>chat window</b>, or chat | 678 </div> |
95 buffer, is on the right. The <b>input line</b> lies at the bottom of the screen, | 679 <h2 id="_windows_panes">WINDOWS/PANES</h2> |
96 under a small <b>log window</b>.</p> | 680 <div class="sectionbody"> |
97 <p>Two status lines surround the log window. The bottom status line is the | 681 <div class="paragraph"><p>The <tt>mcabber(1)</tt> screen is divided into 4 regions. |
682 The <em>roster</em>, alias <em>buddylist</em>, is on the left. The <em>chat window</em>, or chat | |
683 buffer, is on the right. The <em>input line</em> lies at the bottom of the screen, | |
684 under a small <em>log window</em>.</p></div> | |
685 <div class="paragraph"><p>Two status lines surround the log window. The bottom status line is the | |
98 "main status line" and reflects mcabber general status. The other line | 686 "main status line" and reflects mcabber general status. The other line |
99 is the "chat status line" and shows the status of the currently selected | 687 is the "chat status line" and shows the status of the currently selected |
100 buddy.</p> | 688 buddy.</p></div> |
101 <p>To display buddies chat buffers, you will have to enter <b>chat mode</b>. | 689 <div class="paragraph"><p>To display buddies chat buffers, you will have to enter <em>chat mode</em>. |
102 You can enter chat mode by pressing enter, and leave chat mode with the ESC | 690 You can enter chat mode by pressing enter, and leave chat mode with the ESC |
103 key. Simply sending a message will also enable chat mode.</p> | 691 key. Simply sending a message will also enable chat mode.</p></div> |
104 <p>There are several advantages to the two-mode implementation: first, it allows | 692 <div class="paragraph"><p>There are several advantages to the two-mode implementation: first, it allows |
105 accurate "unread" message functionality, as described in the next section; | 693 accurate "unread" message functionality, as described in the next section; |
106 without this, merely scrolling to a specific buddy will "read" the new | 694 without this, merely scrolling to a specific buddy will "read" the new |
107 messages of all buddies in-between. Second, it allows quickly hiding the | 695 messages of all buddies in-between. Second, it allows quickly hiding the |
108 conversation with a single keystroke. Third, it allows jumping between | 696 conversation with a single keystroke. Third, it allows jumping between |
109 the few buddies with whom you are conversing with the <b>/roster alternate</b> | 697 the few buddies with whom you are conversing with the <em>/roster alternate</em> |
110 command described in another section, without having to manually scroll | 698 command described in another section, without having to manually scroll |
111 back and forth.</p> | 699 back and forth.</p></div> |
112 <h2>KEYS</h2> | 700 </div> |
113 <p>Text typing occurs in the <b>input line</b>; basic operations are supported | 701 <h2 id="_keys">KEYS</h2> |
114 (left arrow, right arrow, home/end keys, insert, delete, backspace…).</p> | 702 <div class="sectionbody"> |
115 <p>PageUp and PageDown keys are used to move in the roster.</p> | 703 <div class="paragraph"><p>Text typing occurs in the <em>input line</em>; basic operations are supported |
116 <p>Up and Down arrow keys can be used to move in the input line history; they | 704 (left arrow, right arrow, home/end keys, insert, delete, backspace…).</p></div> |
705 <div class="paragraph"><p>PageUp and PageDown keys are used to move in the roster.</p></div> | |
706 <div class="paragraph"><p>Up and Down arrow keys can be used to move in the input line history; they | |
117 jump to the previous/next line from the history beginning with the same string | 707 jump to the previous/next line from the history beginning with the same string |
118 (from first column to the cursor column).</p> | 708 (from first column to the cursor column).</p></div> |
119 <p>To send a message, move to the choosen buddy in the buddylist, type your | 709 <div class="paragraph"><p>To send a message, move to the chosen buddy in the buddylist, type your |
120 message and hit enter. If the line begins with a slash, this will be | 710 message and hit enter. If the line begins with a slash, this will be |
121 interpreted as a command (see the COMMAND section below). Hit escape to | 711 interpreted as a command (see the COMMAND section below). Hit escape to |
122 leave the chat mode.</p> | 712 leave the chat mode.</p></div> |
123 <p>Here is a quick description of the key bindings:</p> | 713 <div class="paragraph"><p>Here is a quick description of the default key bindings:</p></div> |
124 <table class="hlist"> | 714 <div class="dlist"><dl> |
125 <tr valign="top"> | 715 <dt class="hdlist1"> |
126 <td> | |
127 Esc | 716 Esc |
128 </td> | 717 </dt> |
129 <td> | 718 <dd> |
719 <p> | |
130 Disable chat mode | 720 Disable chat mode |
131 </td> | 721 </p> |
132 </tr> | 722 </dd> |
133 <tr valign="top"> | 723 <dt class="hdlist1"> |
134 <td> | |
135 Ctrl-a | 724 Ctrl-a |
136 </td> | 725 </dt> |
137 <td> | 726 <dd> |
727 <p> | |
138 Go to the beginning of the input line | 728 Go to the beginning of the input line |
139 </td> | 729 </p> |
140 </tr> | 730 </dd> |
141 <tr valign="top"> | 731 <dt class="hdlist1"> |
142 <td> | |
143 Ctrl-e | 732 Ctrl-e |
144 </td> | 733 </dt> |
145 <td> | 734 <dd> |
735 <p> | |
146 Go to the end of the input line | 736 Go to the end of the input line |
147 </td> | 737 </p> |
148 </tr> | 738 </dd> |
149 <tr valign="top"> | 739 <dt class="hdlist1"> |
150 <td> | |
151 Ctrl-l | 740 Ctrl-l |
152 </td> | 741 </dt> |
153 <td> | 742 <dd> |
743 <p> | |
154 Force a refresh | 744 Force a refresh |
155 </td> | 745 </p> |
156 </tr> | 746 </dd> |
157 <tr valign="top"> | 747 <dt class="hdlist1"> |
158 <td> | |
159 Up/Down | 748 Up/Down |
160 </td> | 749 </dt> |
161 <td> | 750 <dd> |
751 <p> | |
162 Move in the input line history | 752 Move in the input line history |
163 </td> | 753 </p> |
164 </tr> | 754 </dd> |
165 <tr valign="top"> | 755 <dt class="hdlist1"> |
166 <td> | |
167 PgUp/PgDown | 756 PgUp/PgDown |
168 </td> | 757 </dt> |
169 <td> | 758 <dd> |
759 <p> | |
170 Move inside the roster (buddylist) | 760 Move inside the roster (buddylist) |
171 </td> | 761 </p> |
172 </tr> | 762 </dd> |
173 <tr valign="top"> | 763 <dt class="hdlist1"> |
174 <td> | |
175 Tab | 764 Tab |
176 </td> | 765 </dt> |
177 <td> | 766 <dd> |
767 <p> | |
178 Complete current word, in the input line | 768 Complete current word, in the input line |
179 </td> | 769 </p> |
180 </tr> | 770 </dd> |
181 <tr valign="top"> | 771 <dt class="hdlist1"> |
182 <td> | |
183 Ctrl-g | 772 Ctrl-g |
184 </td> | 773 </dt> |
185 <td> | 774 <dd> |
775 <p> | |
186 Cancel completion | 776 Cancel completion |
187 </td> | 777 </p> |
188 </tr> | 778 </dd> |
189 <tr valign="top"> | 779 <dt class="hdlist1"> |
190 <td> | |
191 Ctrl-c | 780 Ctrl-c |
192 </td> | 781 </dt> |
193 <td> | 782 <dd> |
783 <p> | |
194 Abort multi-line messages and completions | 784 Abort multi-line messages and completions |
195 </td> | 785 </p> |
196 </tr> | 786 </dd> |
197 <tr valign="top"> | 787 <dt class="hdlist1"> |
198 <td> | |
199 Ctrl-d | 788 Ctrl-d |
200 </td> | 789 </dt> |
201 <td> | 790 <dd> |
791 <p> | |
202 Send/terminate a multi-line message | 792 Send/terminate a multi-line message |
203 </td> | 793 </p> |
204 </tr> | 794 </dd> |
205 <tr valign="top"> | 795 <dt class="hdlist1"> |
206 <td> | |
207 Ctrl-p/Ctrl-n | 796 Ctrl-p/Ctrl-n |
208 </td> | 797 </dt> |
209 <td> | 798 <dd> |
799 <p> | |
210 Scroll up/down half a screen in the buffer window (chat mode) | 800 Scroll up/down half a screen in the buffer window (chat mode) |
211 </td> | 801 </p> |
212 </tr> | 802 </dd> |
213 <tr valign="top"> | 803 <dt class="hdlist1"> |
214 <td> | |
215 Ctrl-Left | 804 Ctrl-Left |
216 </td> | 805 </dt> |
217 <td> | 806 <dd> |
807 <p> | |
218 Move the cursor back to the start of the current or previous word | 808 Move the cursor back to the start of the current or previous word |
219 </td> | 809 </p> |
220 </tr> | 810 </dd> |
221 <tr valign="top"> | 811 <dt class="hdlist1"> |
222 <td> | |
223 Ctrl-Right | 812 Ctrl-Right |
224 </td> | 813 </dt> |
225 <td> | 814 <dd> |
815 <p> | |
226 Move the cursor forward to the end of the current or next word | 816 Move the cursor forward to the end of the current or next word |
227 </td> | 817 </p> |
228 </tr> | 818 </dd> |
229 <tr valign="top"> | 819 <dt class="hdlist1"> |
230 <td> | |
231 Ctrl-u | 820 Ctrl-u |
232 </td> | 821 </dt> |
233 <td> | 822 <dd> |
823 <p> | |
234 Delete from beginning of the line to the cursor | 824 Delete from beginning of the line to the cursor |
235 </td> | 825 </p> |
236 </tr> | 826 </dd> |
237 <tr valign="top"> | 827 <dt class="hdlist1"> |
238 <td> | |
239 Ctrl-k | 828 Ctrl-k |
240 </td> | 829 </dt> |
241 <td> | 830 <dd> |
831 <p> | |
242 Delete from the cursor to the end of line | 832 Delete from the cursor to the end of line |
243 </td> | 833 </p> |
244 </tr> | 834 </dd> |
245 <tr valign="top"> | 835 <dt class="hdlist1"> |
246 <td> | |
247 Ctrl-w | 836 Ctrl-w |
248 </td> | 837 </dt> |
249 <td> | 838 <dd> |
839 <p> | |
250 Backward kill word | 840 Backward kill word |
251 </td> | 841 </p> |
252 </tr> | 842 </dd> |
253 <tr valign="top"> | 843 <dt class="hdlist1"> |
254 <td> | |
255 Ctrl-t | 844 Ctrl-t |
256 </td> | 845 </dt> |
257 <td> | 846 <dd> |
847 <p> | |
258 Transpose chars | 848 Transpose chars |
259 </td> | 849 </p> |
260 </tr> | 850 </dd> |
261 <tr valign="top"> | 851 <dt class="hdlist1"> |
262 <td> | |
263 Ctrl-o | 852 Ctrl-o |
264 </td> | 853 </dt> |
265 <td> | 854 <dd> |
855 <p> | |
266 Accept line and put the next history line in the input line (accept-line-and-down-history) | 856 Accept line and put the next history line in the input line (accept-line-and-down-history) |
267 </td> | 857 </p> |
268 </tr> | 858 </dd> |
269 </table> | 859 </dl></div> |
270 <p>Additional key bindings may be specified using the <b>/bind</b> command described | 860 <div class="paragraph"><p>Additional key bindings may be specified using the <em>/bind</em> command described |
271 in the COMMANDS section.</p> | 861 in the COMMANDS section.</p></div> |
272 <h2>MCABBER'S ROSTER</h2> | 862 </div> |
273 <p>The first listed resource on the roster is <b>[status]</b>, which keeps a log of | 863 <h2 id="_mcabber_8217_s_roster">MCABBER’S ROSTER</h2> |
864 <div class="sectionbody"> | |
865 <div class="paragraph"><p>The first listed resource on the roster is <em>[status]</em>, which keeps a log of | |
274 everything that appears in the short log window below the main chat area. | 866 everything that appears in the short log window below the main chat area. |
275 While the log window was designed for showing the latest few elements, the | 867 While the log window was designed for showing the latest few elements, the |
276 dedicated <b>[status]</b> buffer allows more comfortable viewing of the log, as | 868 dedicated <em>[status]</em> buffer allows more comfortable viewing of the log, as |
277 well as scrolling it in a standard manner.</p> | 869 well as scrolling it in a standard manner.</p></div> |
278 <p>Group names are displayed above the resources that are within them, and are | 870 <div class="paragraph"><p>Group names are displayed above the resources that are within them, and are |
279 indicated by <b>---</b> to the left of the name.</p> | 871 indicated by <em>---</em> to the left of the name.</p></div> |
280 <p>For every real Jabber resource, the roster displays four pieces of information: | 872 <div class="paragraph"><p>For every real Jabber resource, the roster displays four pieces of information: |
281 the resource's name or alias, its online status, its authorization status, and | 873 the resource’s name or alias, its online status, its authorization status, and |
282 whether there are unread messages from the resource waiting for you.</p> | 874 whether there are unread messages from the resource waiting for you.</p></div> |
283 <p>The online status is one of the following:</p> | 875 <div class="paragraph"><p>The online status is one of the following:</p></div> |
284 <table class="hlist"> | 876 <div class="dlist"><dl> |
285 <tr valign="top"> | 877 <dt class="hdlist1"> |
286 <td> | 878 <em>o</em> |
287 <b>o</b> | 879 </dt> |
288 </td> | 880 <dd> |
289 <td> | 881 <p> |
290 online | 882 online |
291 </td> | 883 </p> |
292 </tr> | 884 </dd> |
293 <tr valign="top"> | 885 <dt class="hdlist1"> |
294 <td> | 886 <em>f</em> |
295 <b>f</b> | 887 </dt> |
296 </td> | 888 <dd> |
297 <td> | 889 <p> |
298 free for chat | 890 free for chat |
299 </td> | 891 </p> |
300 </tr> | 892 </dd> |
301 <tr valign="top"> | 893 <dt class="hdlist1"> |
302 <td> | 894 <em>a</em> |
303 <b>a</b> | 895 </dt> |
304 </td> | 896 <dd> |
305 <td> | 897 <p> |
306 away | 898 away |
307 </td> | 899 </p> |
308 </tr> | 900 </dd> |
309 <tr valign="top"> | 901 <dt class="hdlist1"> |
310 <td> | 902 <em>n</em> |
311 <b>n</b> | 903 </dt> |
312 </td> | 904 <dd> |
313 <td> | 905 <p> |
314 not available (labeled <b>extended away</b> in some clients) | 906 not available (labeled <em>extended away</em> in some clients) |
315 </td> | 907 </p> |
316 </tr> | 908 </dd> |
317 <tr valign="top"> | 909 <dt class="hdlist1"> |
318 <td> | 910 <em>d</em> |
319 <b>d</b> | 911 </dt> |
320 </td> | 912 <dd> |
321 <td> | 913 <p> |
322 do not disturb | 914 do not disturb |
323 </td> | 915 </p> |
324 </tr> | 916 </dd> |
325 <tr valign="top"> | 917 <dt class="hdlist1"> |
326 <td> | 918 <em>i</em> |
327 <b>i</b> | 919 </dt> |
328 </td> | 920 <dd> |
329 <td> | 921 <p> |
330 invisible (displayed only for your resource) | 922 invisible (displayed only for your resource) |
331 </td> | 923 </p> |
332 </tr> | 924 </dd> |
333 <tr valign="top"> | 925 <dt class="hdlist1"> |
334 <td> | 926 <em>_</em> |
335 <b>_</b> | 927 </dt> |
336 </td> | 928 <dd> |
337 <td> | 929 <p> |
338 offline (or invisible to you) | 930 offline (or invisible to you) |
339 </td> | 931 </p> |
340 </tr> | 932 </dd> |
341 <tr valign="top"> | 933 <dt class="hdlist1"> |
342 <td> | 934 <em>?</em> |
343 <b>?</b> | 935 </dt> |
344 </td> | 936 <dd> |
345 <td> | 937 <p> |
346 unknown, usually meaning you are not authorized to see this resource's status | 938 unknown, usually meaning you are not authorized to see this resource’s status |
347 </td> | 939 </p> |
348 </tr> | 940 </dd> |
349 <tr valign="top"> | 941 <dt class="hdlist1"> |
350 <td> | 942 <em>x</em> |
351 <b>x</b> | 943 </dt> |
352 </td> | 944 <dd> |
353 <td> | 945 <p> |
354 a conference room in which you are not participating | 946 a conference room in which you are not participating |
355 </td> | 947 </p> |
356 </tr> | 948 </dd> |
357 <tr valign="top"> | 949 <dt class="hdlist1"> |
358 <td> | 950 <em>C</em> |
359 <b>C</b> | 951 </dt> |
360 </td> | 952 <dd> |
361 <td> | 953 <p> |
362 a conference room in which you are participating | 954 a conference room in which you are participating |
363 </td> | 955 </p> |
364 </tr> | 956 </dd> |
365 </table> | 957 </dl></div> |
366 <p>The authorization status indicates whether a resource is authorized to receive | 958 <div class="paragraph"><p>The authorization status indicates whether a resource is authorized to receive |
367 your online status updates, and is displayed by the brackets surrounding the | 959 your online status updates, and is displayed by the brackets surrounding the |
368 resource's online status. Square brackets, like <b>[o]</b>, indicate that this | 960 resource’s online status. Square brackets, like <em>[o]</em>, indicate that this |
369 resource is authorized to receive your status. Curly braces, like <b>{o}</b>, | 961 resource is authorized to receive your status. Curly braces, like <em>{o}</em>, |
370 indicate that they are not authorized to receive your status.</p> | 962 indicate that they are not authorized to receive your status.</p></div> |
371 <p>When there are unread messages from the resource which you have not looked at, | 963 <div class="paragraph"><p>When there are unread messages from the resource which you have not looked at, |
372 a hash mark (<b>#</b>) appears in the leftmost section of the roster for that | 964 a hash mark (<em>#</em>) appears in the leftmost section of the roster for that |
373 resource. The hash mark disappears once you view that resource's message log.</p> | 965 resource. The hash mark disappears once you view that resource’s message log.</p></div> |
374 <p>Examples:</p> | 966 <div class="paragraph"><p>Examples:</p></div> |
375 <table class="hlist"> | 967 <div class="dlist"><dl> |
376 <tr valign="top"> | 968 <dt class="hdlist1"> |
377 <td> | 969 <em>--- Buds</em> |
378 <b> --- Buds</b> | 970 </dt> |
379 </td> | 971 <dd> |
380 <td> | 972 <p> |
381 This is a group named <b>Buds</b> | 973 This is a group named <em>Buds</em> |
382 </td> | 974 </p> |
383 </tr> | 975 </dd> |
384 <tr valign="top"> | 976 <dt class="hdlist1"> |
385 <td> | 977 <em>#[o] John</em> |
386 <b>#[o] John</b> | 978 </dt> |
387 </td> | 979 <dd> |
388 <td> | 980 <p> |
389 John is online, can see your status, and sent you a message that you did not read yet | 981 John is online, can see your status, and sent you a message that you did not read yet |
390 </td> | 982 </p> |
391 </tr> | 983 </dd> |
392 <tr valign="top"> | 984 <dt class="hdlist1"> |
393 <td> | 985 <em>{?} Sally</em> |
394 <b> {?} Sally</b> | 986 </dt> |
395 </td> | 987 <dd> |
396 <td> | 988 <p> |
397 Neither you nor Sally have authorized each other to see your online status | 989 Neither you nor Sally have authorized each other to see your online status |
398 </td> | 990 </p> |
399 </tr> | 991 </dd> |
400 <tr valign="top"> | 992 <dt class="hdlist1"> |
401 <td> | 993 <em>{a} Jane</em> |
402 <b> {a} Jane</b> | 994 </dt> |
403 </td> | 995 <dd> |
404 <td> | 996 <p> |
405 Jane is away, but she cannot see your online status | 997 Jane is away, but she cannot see your online status |
406 </td> | 998 </p> |
407 </tr> | 999 </dd> |
408 <tr valign="top"> | 1000 <dt class="hdlist1"> |
409 <td> | 1001 <em>#[C] x@y.c</em> |
410 <b>#[C] x@y.c</b> | 1002 </dt> |
411 </td> | 1003 <dd> |
412 <td> | 1004 <p> |
413 You are participating in x@y.c conference room, and there are unread messages | 1005 You are participating in x@y.c conference room, and there are unread messages |
414 </td> | 1006 </p> |
415 </tr> | 1007 </dd> |
416 </table> | 1008 </dl></div> |
417 <h2>COMMANDS</h2> | 1009 </div> |
418 <p>Please refer to the online help (command /help), it is probably more up-to-date than this manpage. Furthermore, help files have been translated into several languages.<br /> | 1010 <h2 id="_commands">COMMANDS</h2> |
419 You will find an overview of the <tt>mcabber</tt> commands in this manual.</p> | 1011 <div class="sectionbody"> |
420 <h2>COMMANDS RELATED TO MCABBER</h2> | 1012 <div class="paragraph"><p>Please refer to the online help (command /help), it is probably more up-to-date than this manpage. Furthermore, help files have been translated into several languages.<br /> |
421 <dl> | 1013 You will find an overview of the <tt>mcabber</tt> commands in this manual.</p></div> |
422 <dt><b> | 1014 </div> |
1015 <h2 id="_commands_related_to_mcabber">COMMANDS RELATED TO MCABBER</h2> | |
1016 <div class="sectionbody"> | |
1017 <div class="dlist"><dl> | |
1018 <dt class="hdlist1"> | |
1019 /add [jid [nickname]] | |
1020 </dt> | |
1021 <dd> | |
1022 <p> | |
1023 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. If no jid (or an empty string "") is provided or if jid is ".", the current buddy is used. | |
1024 </p> | |
1025 <div class="dlist"><dl> | |
1026 <dt class="hdlist1"> | |
1027 [<em>jid</em> [nickname]] | |
1028 </dt> | |
1029 <dd> | |
1030 <p> | |
1031 Add to our roster "jid" as "nickname" | |
1032 </p> | |
1033 <div class="literalblock"> | |
1034 <div class="content"> | |
1035 <pre><tt>Example: "/add somebody@jabber.server.com Somebody"</tt></pre> | |
1036 </div></div> | |
1037 </dd> | |
1038 </dl></div> | |
1039 </dd> | |
1040 <dt class="hdlist1"> | |
423 /alias [name [= command line]] | 1041 /alias [name [= command line]] |
424 </b></dt> | 1042 </dt> |
425 <dd> | 1043 <dd> |
426 Add "name" as an alias for "command line". <tt> | 1044 <p> |
427 Aliases are expanded only once, thus they can not be chained. </tt> | 1045 This command let you to add aliases which can simplify sophisticated commands.<br /> |
428 "/alias name" displays the value associated with the "name" alias; <tt> | 1046 You can manage your aliases by: |
429 "/alias name =" unsets the "name" alias. </tt> | 1047 </p> |
430 "/alias" displays a list of the existing aliases.<br /> | 1048 <div class="dlist"><dl> |
431 Example: "/alias away = status away". | 1049 <dt class="hdlist1"> |
432 </dd> | 1050 (without arguments) |
433 <dt><b> | 1051 </dt> |
1052 <dd> | |
1053 <p> | |
1054 Print list of currently defined aliases | |
1055 </p> | |
1056 </dd> | |
1057 <dt class="hdlist1"> | |
1058 <em>name</em> | |
1059 </dt> | |
1060 <dd> | |
1061 <p> | |
1062 Print the value of alias called "name" | |
1063 </p> | |
1064 </dd> | |
1065 <dt class="hdlist1"> | |
1066 <em>name</em>= | |
1067 </dt> | |
1068 <dd> | |
1069 <p> | |
1070 Unset alias called "name" | |
1071 </p> | |
1072 </dd> | |
1073 <dt class="hdlist1"> | |
1074 <em>name</em> = command line | |
1075 </dt> | |
1076 <dd> | |
1077 <p> | |
1078 Set alias called "name" with value "command line" | |
1079 </p> | |
1080 <div class="literalblock"> | |
1081 <div class="content"> | |
1082 <pre><tt>Example: "/alias away = status away"</tt></pre> | |
1083 </div></div> | |
1084 </dd> | |
1085 </dl></div> | |
1086 </dd> | |
1087 <dt class="hdlist1"> | |
1088 /authorization allow|cancel|request|request_unsubscribe [jid] | |
1089 </dt> | |
1090 <dd> | |
1091 <p> | |
1092 This command manages presence subscriptions: it allows you to request presence subscriptions from others on your roster, and allows you to control who receives your presence notifications.<br /> | |
1093 If no JID is provided, the currently-selected buddy is used. | |
1094 </p> | |
1095 <div class="dlist"><dl> | |
1096 <dt class="hdlist1"> | |
1097 <em>allow</em> | |
1098 </dt> | |
1099 <dd> | |
1100 <p> | |
1101 Allow the buddy to receive your presence updates | |
1102 </p> | |
1103 </dd> | |
1104 <dt class="hdlist1"> | |
1105 <em>cancel</em> | |
1106 </dt> | |
1107 <dd> | |
1108 <p> | |
1109 Cancel the buddy’s subscription to your presence updates | |
1110 </p> | |
1111 </dd> | |
1112 <dt class="hdlist1"> | |
1113 <em>request</em> | |
1114 </dt> | |
1115 <dd> | |
1116 <p> | |
1117 Request a subscription to the buddy’s presence updates | |
1118 </p> | |
1119 </dd> | |
1120 <dt class="hdlist1"> | |
1121 <em>request_unsubscribe</em> | |
1122 </dt> | |
1123 <dd> | |
1124 <p> | |
1125 Request unsubscription from the buddy’s presence updates | |
1126 </p> | |
1127 </dd> | |
1128 </dl></div> | |
1129 </dd> | |
1130 <dt class="hdlist1"> | |
434 /bind [keycode [= command line]] | 1131 /bind [keycode [= command line]] |
435 </b></dt> | 1132 </dt> |
436 <dd> | 1133 <dd> |
437 Bind a command line to the key with the "keycode" code number. <tt> | 1134 <p> |
438 Keycodes of unused keys are displayed by <tt>mcabber</tt> in the log window | 1135 Bind the command to the key given as "keycode". To examine which keys are currently not used look at <tt>mcabber</tt> log window and press examined key. For example: "Unknown key=265" means that you can bind some command to key #265. |
439 when pressing the key, for example "Unknown key=265". </tt> | 1136 </p> |
440 "/bind keycode" displays the command line bound to the given keycode; <tt> | 1137 <div class="dlist"><dl> |
441 "/bind keycode =" unbinds the given keycode. </tt> | 1138 <dt class="hdlist1"> |
442 "/bind" displays a list of the bound keycodes. <tt> | 1139 (without arguments) |
443 Note: aliases can be used in key bindings. </tt> | 1140 </dt> |
444 Example: "/bind 265 = status online" (265 is F1 for me, but it may | 1141 <dd> |
445 depend on your ncurses installation). | 1142 <p> |
446 </dd> | 1143 Display list of current bindings |
447 <dt><b> | 1144 </p> |
448 /buffer clear|close|close_all|purge | 1145 </dd> |
449 </b></dt> | 1146 <dt class="hdlist1"> |
450 <dt><b> | 1147 <em>keycode</em> |
1148 </dt> | |
1149 <dd> | |
1150 <p> | |
1151 Display the command line bound to this key | |
1152 </p> | |
1153 </dd> | |
1154 <dt class="hdlist1"> | |
1155 <em>keycode</em>= | |
1156 </dt> | |
1157 <dd> | |
1158 <p> | |
1159 Unbind key with code "keycode" | |
1160 </p> | |
1161 </dd> | |
1162 <dt class="hdlist1"> | |
1163 <em>keycode</em> = command line | |
1164 </dt> | |
1165 <dd> | |
1166 <p> | |
1167 Bind "command line" to the key with code "keycode" | |
1168 </p> | |
1169 <div class="literalblock"> | |
1170 <div class="content"> | |
1171 <pre><tt>Example: "/bind 265 = status away" (265 is F1). + | |
1172 Note: keycodes can be different depending on your ncurses configuration. + | |
1173 Tip: aliases also can be used instead of commands.</tt></pre> | |
1174 </div></div> | |
1175 </dd> | |
1176 </dl></div> | |
1177 </dd> | |
1178 <dt class="hdlist1"> | |
1179 /buffer clear|close|close_all|purge|list | |
1180 </dt> | |
1181 <dt class="hdlist1"> | |
451 /buffer top|bottom|date|%|search_backward|search_forward | 1182 /buffer top|bottom|date|%|search_backward|search_forward |
452 </b></dt> | 1183 </dt> |
453 <dt><b> | 1184 <dt class="hdlist1"> |
454 /buffer scroll_lock|scroll_unlock|scroll_toggle | 1185 /buffer scroll_lock|scroll_unlock|scroll_toggle |
455 </b></dt> | 1186 </dt> |
456 <dd> | 1187 <dt class="hdlist1"> |
457 The <b>buffer</b> command manipulates the current buddy's buffer | 1188 /buffer save filename |
458 (chat window). | 1189 </dt> |
459 <table class="hlist"> | 1190 <dd> |
460 <tr valign="top"> | 1191 <p> |
461 <td> | 1192 Buddy’s buffer manipulation command. Eg. you can search through buffer for "text", clear chat window etc. |
462 <b>clear</b> | 1193 </p> |
463 </td> | 1194 <div class="dlist"><dl> |
464 <td> | 1195 <dt class="hdlist1"> |
465 clear the current buddy chat window | 1196 <em>clear</em> |
466 </td> | 1197 </dt> |
467 </tr> | 1198 <dd> |
468 <tr valign="top"> | 1199 <p> |
469 <td> | 1200 Clear the current buddy chat window |
470 <b>close</b> | 1201 </p> |
471 </td> | 1202 </dd> |
472 <td> | 1203 <dt class="hdlist1"> |
473 empty all contents of the buffer and close the current buddy chat window | 1204 <em>close</em> [jid] |
474 </td> | 1205 </dt> |
475 </tr> | 1206 <dd> |
476 <tr valign="top"> | 1207 <p> |
477 <td> | 1208 Empty all contents of the buffer and close the current buddy chat window |
478 <b>close_all</b> | 1209 </p> |
479 </td> | 1210 </dd> |
480 <td> | 1211 <dt class="hdlist1"> |
481 empty all contents of the chat buffers and close the chat windows | 1212 <em>close_all</em> |
482 </td> | 1213 </dt> |
483 </tr> | 1214 <dd> |
484 <tr valign="top"> | 1215 <p> |
485 <td> | 1216 Empty all contents of the chat buffers and close the chat windows |
486 <b>purge</b> | 1217 </p> |
487 </td> | 1218 </dd> |
488 <td> | 1219 <dt class="hdlist1"> |
489 clear the current buddy chat window and empty all contents of the chat buffer | 1220 <em>purge</em> [jid] |
490 </td> | 1221 </dt> |
491 </tr> | 1222 <dd> |
492 <tr valign="top"> | 1223 <p> |
493 <td> | 1224 Clear the current buddy chat window and empty all contents of the chat buffer |
494 <b>top</b> | 1225 </p> |
495 </td> | 1226 </dd> |
496 <td> | 1227 <dt class="hdlist1"> |
497 jump to the top of the current buddy chat buffer | 1228 <em>list</em> |
498 </td> | 1229 </dt> |
499 </tr> | 1230 <dd> |
500 <tr valign="top"> | 1231 <p> |
501 <td> | 1232 Display the list of existing buffers, with their length (lines/blocks) |
502 <b>bottom</b> | 1233 </p> |
503 </td> | 1234 </dd> |
504 <td> | 1235 <dt class="hdlist1"> |
505 jump to the bottom of the current buddy chat buffer | 1236 <em>top</em> |
506 </td> | 1237 </dt> |
507 </tr> | 1238 <dd> |
508 <tr valign="top"> | 1239 <p> |
509 <td> | 1240 Jump to the top of the current buddy chat buffer |
510 <b>up</b> [n] | 1241 </p> |
511 </td> | 1242 </dd> |
512 <td> | 1243 <dt class="hdlist1"> |
513 scroll the buffer up n lines (default: half a screen) | 1244 <em>bottom</em> |
514 </td> | 1245 </dt> |
515 </tr> | 1246 <dd> |
516 <tr valign="top"> | 1247 <p> |
517 <td> | 1248 Jump to the bottom of the current buddy chat buffer |
518 <b>down</b> [n] | 1249 </p> |
519 </td> | 1250 </dd> |
520 <td> | 1251 <dt class="hdlist1"> |
521 scroll the buffer down n lines (default: half a screen) | 1252 <em>up</em> [n] |
522 </td> | 1253 </dt> |
523 </tr> | 1254 <dd> |
524 <tr valign="top"> | 1255 <p> |
525 <td> | 1256 Scroll the buffer up [n] lines (default: half a screen) |
526 <b>date</b> date | 1257 </p> |
527 </td> | 1258 </dd> |
528 <td> | 1259 <dt class="hdlist1"> |
529 jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional) | 1260 <em>down</em> [n] |
530 </td> | 1261 </dt> |
531 </tr> | 1262 <dd> |
532 <tr valign="top"> | 1263 <p> |
533 <td> | 1264 Scroll the buffer down [n] lines (default: half a screen) |
534 <b>%</b> n | 1265 </p> |
535 </td> | 1266 </dd> |
536 <td> | 1267 <dt class="hdlist1"> |
537 jump to position %n of the buddy chat buffer | 1268 <em>date</em> [date] |
538 </td> | 1269 </dt> |
539 </tr> | 1270 <dd> |
540 <tr valign="top"> | 1271 <p> |
541 <td> | 1272 Jump to the first line after the specified [date] in the chat buffer (date format: "YYYY-mm-dd") |
542 <b>search_backward</b> text | 1273 </p> |
543 </td> | 1274 </dd> |
544 <td> | 1275 <dt class="hdlist1"> |
545 search for "text" in the current buddy chat buffer | 1276 % n |
546 </td> | 1277 </dt> |
547 </tr> | 1278 <dd> |
548 <tr valign="top"> | 1279 <p> |
549 <td> | 1280 Jump to position %n of the buddy chat buffer |
550 <b>search_forward</b> text | 1281 </p> |
551 </td> | 1282 </dd> |
552 <td> | 1283 <dt class="hdlist1"> |
553 search for "text" in the current buddy chat buffer | 1284 <em>search_backward</em> text |
554 </td> | 1285 </dt> |
555 </tr> | 1286 <dd> |
556 <tr valign="top"> | 1287 <p> |
557 <td> | 1288 Search for [text] in the current buddy chat buffer |
558 <b>scroll_lock</b> | 1289 </p> |
559 </td> | 1290 </dd> |
560 <td> | 1291 <dt class="hdlist1"> |
561 lock buffer scrolling | 1292 <em>search_forward</em> text |
562 </td> | 1293 </dt> |
563 </tr> | 1294 <dd> |
564 <tr valign="top"> | 1295 <p> |
565 <td> | 1296 Search for [text] in the current buddy chat buffer |
566 <b>scroll_unlock</b> | 1297 </p> |
567 </td> | 1298 </dd> |
568 <td> | 1299 <dt class="hdlist1"> |
569 unlock buffer scrolling | 1300 <em>scroll_lock</em> |
570 </td> | 1301 </dt> |
571 </tr> | 1302 <dd> |
572 <tr valign="top"> | 1303 <p> |
573 <td> | 1304 Lock buffer scrolling |
574 <b>scroll_toggle</b> | 1305 </p> |
575 </td> | 1306 </dd> |
576 <td> | 1307 <dt class="hdlist1"> |
577 toggle buffer scrolling (lock/unlock) | 1308 <em>scroll_unlock</em> |
578 </td> | 1309 </dt> |
579 </tr> | 1310 <dd> |
580 </table> | 1311 <p> |
581 </dd> | 1312 Unlock buffer scrolling |
582 <dt><b> | 1313 </p> |
1314 </dd> | |
1315 <dt class="hdlist1"> | |
1316 <em>scroll_toggle</em> | |
1317 </dt> | |
1318 <dd> | |
1319 <p> | |
1320 Toggle buffer scrolling (lock/unlock) | |
1321 </p> | |
1322 </dd> | |
1323 <dt class="hdlist1"> | |
1324 <em>save</em> filename | |
1325 </dt> | |
1326 <dd> | |
1327 <p> | |
1328 Save the contents of the current buffer to the file "filename" | |
1329 </p> | |
1330 </dd> | |
1331 </dl></div> | |
1332 </dd> | |
1333 <dt class="hdlist1"> | |
1334 /chat_disable [--show-roster] | |
1335 </dt> | |
1336 <dd> | |
1337 <p> | |
1338 Disable chat mode.<br /> | |
1339 With --show-roster, the fullscreen mode will be disabled. | |
1340 </p> | |
1341 </dd> | |
1342 <dt class="hdlist1"> | |
583 /clear | 1343 /clear |
584 </b></dt> | 1344 </dt> |
585 <dd> | 1345 <dd> |
586 The <b>clear</b> command is actually an alias for "/buffer clear". | 1346 <p> |
587 </dd> | 1347 This command is actually an alias for "/buffer clear". It clears the current buddy chat window. |
588 <dt><b> | 1348 </p> |
589 /help [command] | 1349 </dd> |
590 </b></dt> | 1350 <dt class="hdlist1"> |
591 <dd> | 1351 /color roster (status wildcard (color|-)|clear) |
592 Display generic help or help about a specific mcabber command. | 1352 </dt> |
593 </dd> | 1353 <dt class="hdlist1"> |
594 <dt><b> | 1354 /color mucnick nick (color|-) |
1355 </dt> | |
1356 <dt class="hdlist1"> | |
1357 /color muc (jid|.|*) [on|preset|off|-] | |
1358 </dt> | |
1359 <dd> | |
1360 <p> | |
1361 The <em>color</em> command allows setting dynamic color properties of the screen. | |
1362 </p> | |
1363 <div class="dlist"><dl> | |
1364 <dt class="hdlist1"> | |
1365 <em>roster</em> clear | |
1366 </dt> | |
1367 <dd> | |
1368 <p> | |
1369 Remove all color rules for the roster. All roster items will get its default color. | |
1370 </p> | |
1371 </dd> | |
1372 <dt class="hdlist1"> | |
1373 <em>roster</em> status wildcard color | |
1374 </dt> | |
1375 <dd> | |
1376 <p> | |
1377 Set a color rule (or overwrite, if it already exists). The status is string containing all statuses the roster item can have for the rule to match, or * if any status is OK. Wildcard is the file-matching wildcard that will be applied to JID. Color is the wanted color. If color is -, the rule is removed. If more than one rule matches, the color from the last created (not overwritten) is used. | |
1378 </p> | |
1379 </dd> | |
1380 <dt class="hdlist1"> | |
1381 <em>mucnick</em> nick (color|-) | |
1382 </dt> | |
1383 <dd> | |
1384 <p> | |
1385 Marks the nick to be colored by given color. If a MUC has colored nicks, this one will be used. If color is -, the color is marked as chosen automatically, which means it will not be used in <em>preset</em> coloring mode, but will stay the same in <em>on</em> coloring mode. | |
1386 </p> | |
1387 </dd> | |
1388 <dt class="hdlist1"> | |
1389 <em>muc</em> (jid|.|*) [on|preset|off|-] | |
1390 </dt> | |
1391 <dd> | |
1392 <p> | |
1393 Sets a MUC nick coloring mode. If a jid (. means currently selected jid) is provided, the mode will apply to this specific MUC. If * is used, it will be applied to all MUCs, except the ones set by their jid. Mode <em>on</em> colors all nicks, <em>preset</em> only the ones manually set by /color mucnick command and <em>off</em> colors none. If not specified, defaults to <em>on</em>. Mode <em>-</em> removes the mode from given JID, which means the global one will apply. You can not remove the global mode. Default global coloring mode is <em>off</em>. | |
1394 </p> | |
1395 </dd> | |
1396 </dl></div> | |
1397 </dd> | |
1398 <dt class="hdlist1"> | |
1399 /connect | |
1400 </dt> | |
1401 <dd> | |
1402 <p> | |
1403 Establish connection to the Jabber server. | |
1404 </p> | |
1405 </dd> | |
1406 <dt class="hdlist1"> | |
1407 /del | |
1408 </dt> | |
1409 <dd> | |
1410 <p> | |
1411 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours. | |
1412 </p> | |
1413 </dd> | |
1414 <dt class="hdlist1"> | |
1415 /disconnect | |
1416 </dt> | |
1417 <dd> | |
1418 <p> | |
1419 Terminate the connection to the Jabber server.<br /> | |
1420 Note: the roster is only available when the connection to the server is active, so the buddylist is empty when disconnected. | |
1421 </p> | |
1422 </dd> | |
1423 <dt class="hdlist1"> | |
1424 /echo message | |
1425 </dt> | |
1426 <dd> | |
1427 <p> | |
1428 Display "message" in the log window. | |
1429 </p> | |
1430 </dd> | |
1431 <dt class="hdlist1"> | |
1432 /event #n|* accept|ignore|reject [event-specific arguments] | |
1433 </dt> | |
1434 <dt class="hdlist1"> | |
1435 /event list | |
1436 </dt> | |
1437 <dd> | |
1438 <p> | |
1439 Tell mcabber what to do about pending events.<br /> | |
1440 If the first parameter is <em>*</em>, the command will apply to all queued events.<br /> | |
1441 Event-specific arguments will be interpreted on event-to event basis. The only built-in case, when argument is used is MUC invitation reject - argument, if present, will be interpreted as reject reason. | |
1442 </p> | |
1443 <div class="dlist"><dl> | |
1444 <dt class="hdlist1"> | |
1445 #N|* accept [event-specific arguments] | |
1446 </dt> | |
1447 <dd> | |
1448 <p> | |
1449 Event number #N/All events will be accepted | |
1450 </p> | |
1451 </dd> | |
1452 <dt class="hdlist1"> | |
1453 #N|* ignore [event-specific arguments] | |
1454 </dt> | |
1455 <dd> | |
1456 <p> | |
1457 Event number #N/All events will be ignored | |
1458 </p> | |
1459 </dd> | |
1460 <dt class="hdlist1"> | |
1461 #N|* reject [event-specific arguments] | |
1462 </dt> | |
1463 <dd> | |
1464 <p> | |
1465 Event number #N/All events will be rejected | |
1466 </p> | |
1467 </dd> | |
1468 <dt class="hdlist1"> | |
1469 <em>list</em> | |
1470 </dt> | |
1471 <dd> | |
1472 <p> | |
1473 List all pending events | |
1474 </p> | |
1475 </dd> | |
1476 </dl></div> | |
1477 </dd> | |
1478 <dt class="hdlist1"> | |
1479 /group fold|unfold|toggle [groupname] | |
1480 </dt> | |
1481 <dd> | |
1482 <p> | |
1483 This command changes the current group display. | |
1484 </p> | |
1485 <div class="dlist"><dl> | |
1486 <dt class="hdlist1"> | |
1487 <em>fold</em> [groupname] | |
1488 </dt> | |
1489 <dd> | |
1490 <p> | |
1491 Fold (shrink) the current/specified group tree in the roster | |
1492 </p> | |
1493 </dd> | |
1494 <dt class="hdlist1"> | |
1495 <em>unfold</em> [groupname] | |
1496 </dt> | |
1497 <dd> | |
1498 <p> | |
1499 Unfold (expand) the current/specified group tree in the roster | |
1500 </p> | |
1501 </dd> | |
1502 <dt class="hdlist1"> | |
1503 <em>toggle</em> [groupname] | |
1504 </dt> | |
1505 <dd> | |
1506 <p> | |
1507 Toggle the state (fold/unfold) of the current/specified tree | |
1508 </p> | |
1509 </dd> | |
1510 </dl></div> | |
1511 </dd> | |
1512 <dt class="hdlist1"> | |
1513 /help [command|+topic] | |
1514 </dt> | |
1515 <dd> | |
1516 <p> | |
1517 Display help for command "command" or topic "topic".<br /> | |
1518 Example: "/help buffer" | |
1519 </p> | |
1520 </dd> | |
1521 <dt class="hdlist1"> | |
1522 /iline fchar|bchar|char_fdel|char_bdel|char_swap | |
1523 </dt> | |
1524 <dt class="hdlist1"> | |
1525 /iline fword|bword|word_bdel|word_fdel | |
1526 </dt> | |
1527 <dt class="hdlist1"> | |
1528 /iline word_upcase|word_downcase|word_capit | |
1529 </dt> | |
1530 <dt class="hdlist1"> | |
1531 /iline hist_beginning_search_bwd|hist_beginning_search_fwd | |
1532 </dt> | |
1533 <dt class="hdlist1"> | |
1534 /iline hist_prev|hist_next | |
1535 </dt> | |
1536 <dt class="hdlist1"> | |
1537 /iline iline_start|iline_end|iline_fdel|iline_bdel | |
1538 </dt> | |
1539 <dt class="hdlist1"> | |
1540 /iline iline_accept|iline_accept_down_hist | |
1541 </dt> | |
1542 <dt class="hdlist1"> | |
1543 /iline compl_do|compl_cancel | |
1544 </dt> | |
1545 <dt class="hdlist1"> | |
1546 /iline send_multiline | |
1547 </dt> | |
1548 <dd> | |
1549 <p> | |
1550 Input line commands | |
1551 </p> | |
1552 <div class="dlist"><dl> | |
1553 <dt class="hdlist1"> | |
1554 <em>fchar</em> | |
1555 </dt> | |
1556 <dd> | |
1557 <p> | |
1558 Move to the next letter | |
1559 </p> | |
1560 </dd> | |
1561 <dt class="hdlist1"> | |
1562 <em>bchar</em> | |
1563 </dt> | |
1564 <dd> | |
1565 <p> | |
1566 Move to the previous letter | |
1567 </p> | |
1568 </dd> | |
1569 <dt class="hdlist1"> | |
1570 <em>char_fdel</em> | |
1571 </dt> | |
1572 <dd> | |
1573 <p> | |
1574 Delete the letter at cursor position | |
1575 </p> | |
1576 </dd> | |
1577 <dt class="hdlist1"> | |
1578 <em>char_bdel</em> | |
1579 </dt> | |
1580 <dd> | |
1581 <p> | |
1582 Delete the letter before cursor position | |
1583 </p> | |
1584 </dd> | |
1585 <dt class="hdlist1"> | |
1586 <em>char_swap</em> | |
1587 </dt> | |
1588 <dd> | |
1589 <p> | |
1590 Transpose chars | |
1591 </p> | |
1592 </dd> | |
1593 <dt class="hdlist1"> | |
1594 <em>fword</em> | |
1595 </dt> | |
1596 <dd> | |
1597 <p> | |
1598 Move the cursor forward to the end of the current or next word | |
1599 </p> | |
1600 </dd> | |
1601 <dt class="hdlist1"> | |
1602 <em>bword</em> | |
1603 </dt> | |
1604 <dd> | |
1605 <p> | |
1606 Move the cursor back to the start of the current or previous word | |
1607 </p> | |
1608 </dd> | |
1609 <dt class="hdlist1"> | |
1610 <em>word_bdel</em> | |
1611 </dt> | |
1612 <dd> | |
1613 <p> | |
1614 Delete the word from cursor position to its start | |
1615 </p> | |
1616 </dd> | |
1617 <dt class="hdlist1"> | |
1618 <em>word_fdel</em> | |
1619 </dt> | |
1620 <dd> | |
1621 <p> | |
1622 Delete the word from cursor position to its end | |
1623 </p> | |
1624 </dd> | |
1625 <dt class="hdlist1"> | |
1626 <em>word_upcase</em> | |
1627 </dt> | |
1628 <dd> | |
1629 <p> | |
1630 Convert the word from cursor position to its end to upper case | |
1631 </p> | |
1632 </dd> | |
1633 <dt class="hdlist1"> | |
1634 <em>word_downcase</em> | |
1635 </dt> | |
1636 <dd> | |
1637 <p> | |
1638 Convert the word from cursor position to its end to down case | |
1639 </p> | |
1640 </dd> | |
1641 <dt class="hdlist1"> | |
1642 <em>word_capit</em> | |
1643 </dt> | |
1644 <dd> | |
1645 <p> | |
1646 Capitalize the word from cursor position to its end | |
1647 </p> | |
1648 </dd> | |
1649 <dt class="hdlist1"> | |
1650 <em>hist_beginning_search_bwd</em> | |
1651 </dt> | |
1652 <dd> | |
1653 <p> | |
1654 Search backward in the history for a line beginning with the current line up to the cursor (this leaves the cursor in its original position) | |
1655 </p> | |
1656 </dd> | |
1657 <dt class="hdlist1"> | |
1658 <em>hist_beginning_search_fwd</em> | |
1659 </dt> | |
1660 <dd> | |
1661 <p> | |
1662 Search forward in the history for a line beginning with the current line up to the cursor (this leaves the cursor in its original position) | |
1663 </p> | |
1664 </dd> | |
1665 <dt class="hdlist1"> | |
1666 <em>hist_prev</em> | |
1667 </dt> | |
1668 <dd> | |
1669 <p> | |
1670 Previous line of input line history | |
1671 </p> | |
1672 </dd> | |
1673 <dt class="hdlist1"> | |
1674 <em>hist_next</em> | |
1675 </dt> | |
1676 <dd> | |
1677 <p> | |
1678 Next line of input line history | |
1679 </p> | |
1680 </dd> | |
1681 <dt class="hdlist1"> | |
1682 <em>iline_start</em> | |
1683 </dt> | |
1684 <dd> | |
1685 <p> | |
1686 Go to the beginning of the input line | |
1687 </p> | |
1688 </dd> | |
1689 <dt class="hdlist1"> | |
1690 <em>iline_end</em> | |
1691 </dt> | |
1692 <dd> | |
1693 <p> | |
1694 Go to the end of the input line | |
1695 </p> | |
1696 </dd> | |
1697 <dt class="hdlist1"> | |
1698 <em>iline_fdel</em> | |
1699 </dt> | |
1700 <dd> | |
1701 <p> | |
1702 Delete from the cursor to the end of line | |
1703 </p> | |
1704 </dd> | |
1705 <dt class="hdlist1"> | |
1706 <em>iline_bdel</em> | |
1707 </dt> | |
1708 <dd> | |
1709 <p> | |
1710 Delete from beginning of the line to the cursor | |
1711 </p> | |
1712 </dd> | |
1713 <dt class="hdlist1"> | |
1714 <em>iline_accept</em> | |
1715 </dt> | |
1716 <dd> | |
1717 <p> | |
1718 Accept line | |
1719 </p> | |
1720 </dd> | |
1721 <dt class="hdlist1"> | |
1722 <em>iline_accept_down_hist</em> | |
1723 </dt> | |
1724 <dd> | |
1725 <p> | |
1726 Accept line and put the next history line in the input line | |
1727 </p> | |
1728 </dd> | |
1729 <dt class="hdlist1"> | |
1730 <em>compl_do</em> | |
1731 </dt> | |
1732 <dd> | |
1733 <p> | |
1734 Complete current word, in the input line | |
1735 </p> | |
1736 </dd> | |
1737 <dt class="hdlist1"> | |
1738 <em>compl_cancel</em> | |
1739 </dt> | |
1740 <dd> | |
1741 <p> | |
1742 Cancel completion | |
1743 </p> | |
1744 </dd> | |
1745 <dt class="hdlist1"> | |
1746 <em>send_multiline</em> | |
1747 </dt> | |
1748 <dd> | |
1749 <p> | |
1750 Send/terminate a multi-line message | |
1751 </p> | |
1752 </dd> | |
1753 </dl></div> | |
1754 </dd> | |
1755 <dt class="hdlist1"> | |
1756 /info | |
1757 </dt> | |
1758 <dd> | |
1759 <p> | |
1760 Display info on the selected entry (user, agent, group…).<br /> | |
1761 For users, resources are displayed with the status, priority and status message (if available) of each resource. | |
1762 </p> | |
1763 </dd> | |
1764 <dt class="hdlist1"> | |
1765 /module load|unload [-f] module | |
1766 </dt> | |
1767 <dt class="hdlist1"> | |
1768 /module info module | |
1769 </dt> | |
1770 <dt class="hdlist1"> | |
1771 /module [list] | |
1772 </dt> | |
1773 <dd> | |
1774 <p> | |
1775 Load, unload or show info on module. | |
1776 </p> | |
1777 <div class="dlist"><dl> | |
1778 <dt class="hdlist1"> | |
1779 <em>load</em> [-f] module | |
1780 </dt> | |
1781 <dd> | |
1782 <p> | |
1783 Loads specified module. If -f flag is specified, most of module loading errors will be ignored. | |
1784 </p> | |
1785 </dd> | |
1786 <dt class="hdlist1"> | |
1787 <em>unload</em> [-f] module | |
1788 </dt> | |
1789 <dd> | |
1790 <p> | |
1791 Unloads specified module. Note: The force flag will not remove any dependent on this modules! | |
1792 </p> | |
1793 </dd> | |
1794 <dt class="hdlist1"> | |
1795 <em>info</em> module | |
1796 </dt> | |
1797 <dd> | |
1798 <p> | |
1799 Shows available information about this module. | |
1800 </p> | |
1801 </dd> | |
1802 <dt class="hdlist1"> | |
1803 [<em>list</em>] | |
1804 </dt> | |
1805 <dd> | |
1806 <p> | |
1807 Lists modules in a format: [modulename] [reference count] ([Manually/Automatically loaded]) [any extra info, like version or dependencies] | |
1808 </p> | |
1809 </dd> | |
1810 </dl></div> | |
1811 </dd> | |
1812 <dt class="hdlist1"> | |
1813 /move [groupname] | |
1814 </dt> | |
1815 <dd> | |
1816 <p> | |
1817 Move the current buddy to the requested group. If no group is specified, then the buddy is moved to the default group. If the group "groupname" doesn’t exist, it is created.<br /> | |
1818 Tip: if the chatmode is enabled, you can use "/roster alternate" to jump to the moved buddy. | |
1819 </p> | |
1820 </dd> | |
1821 <dt class="hdlist1"> | |
1822 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort | |
1823 </dt> | |
1824 <dd> | |
1825 <p> | |
1826 Send a multi-line message. To write a single message with several lines, the <em>multi-line mode</em> should be used.<br /> | |
1827 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.<br /> | |
1828 The <em>begin</em> subcommand enables multi-line mode. Note that it allows a message subject to be specified.<br /> | |
1829 The <em>verbatim</em> 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.<br /> | |
1830 The <em>toggle</em> subcommand can be bound to a key to use the multi-line mode quickly (for example, "bind M13 = msay toggle" to switch using the Meta-Enter combination). | |
1831 </p> | |
1832 <div class="dlist"><dl> | |
1833 <dt class="hdlist1"> | |
1834 <em>begin</em> [subject] | |
1835 </dt> | |
1836 <dd> | |
1837 <p> | |
1838 Enter multi-line mode | |
1839 </p> | |
1840 </dd> | |
1841 <dt class="hdlist1"> | |
1842 <em>verbatim</em> | |
1843 </dt> | |
1844 <dd> | |
1845 <p> | |
1846 Enter verbatim multi-line mode | |
1847 </p> | |
1848 </dd> | |
1849 <dt class="hdlist1"> | |
1850 <em>send</em> [-n|-h] | |
1851 </dt> | |
1852 <dd> | |
1853 <p> | |
1854 Send the current multi-line message to the currently selected buddy | |
1855 </p> | |
1856 </dd> | |
1857 <dt class="hdlist1"> | |
1858 <em>send_to</em> [-n|-h] jid | |
1859 </dt> | |
1860 <dd> | |
1861 <p> | |
1862 Send the current multi-line message to "jid" | |
1863 </p> | |
1864 </dd> | |
1865 <dt class="hdlist1"> | |
1866 <em>toggle</em>|<em>toggle_verbatim</em> | |
1867 </dt> | |
1868 <dd> | |
1869 <p> | |
1870 Switch to/from multi-line mode (begin/send) | |
1871 </p> | |
1872 </dd> | |
1873 <dt class="hdlist1"> | |
1874 <em>abort</em> | |
1875 </dt> | |
1876 <dd> | |
1877 <p> | |
1878 Leave multi-line mode without sending the message | |
1879 </p> | |
1880 <div class="literalblock"> | |
1881 <div class="content"> | |
1882 <pre><tt>The -n or -h flags turn the message to "normal" or "headline" accordingly, as opposed to default "chat" message.</tt></pre> | |
1883 </div></div> | |
1884 </dd> | |
1885 </dl></div> | |
1886 </dd> | |
1887 <dt class="hdlist1"> | |
1888 /otr key | |
1889 </dt> | |
1890 <dt class="hdlist1"> | |
1891 /otr start|stop|info [jid] | |
1892 </dt> | |
1893 <dt class="hdlist1"> | |
1894 /otr fingerprint [jid [fpr]] | |
1895 </dt> | |
1896 <dt class="hdlist1"> | |
1897 /otr smpq|smpr [jid] secret | |
1898 </dt> | |
1899 <dt class="hdlist1"> | |
1900 /otr smpa [jid] | |
1901 </dt> | |
1902 <dd> | |
1903 <p> | |
1904 You can use the shortcut-jid "." for the currently selected contact. | |
1905 </p> | |
1906 <div class="dlist"><dl> | |
1907 <dt class="hdlist1"> | |
1908 <em>key</em> | |
1909 </dt> | |
1910 <dd> | |
1911 <p> | |
1912 Print the fingerprint of your private key to the Status Buffer | |
1913 </p> | |
1914 </dd> | |
1915 <dt class="hdlist1"> | |
1916 <em>start</em> [jid] | |
1917 </dt> | |
1918 <dd> | |
1919 <p> | |
1920 Open an OTR channel to the specified jid (or the currently selected contact) | |
1921 </p> | |
1922 </dd> | |
1923 <dt class="hdlist1"> | |
1924 <em>stop</em> [jid] | |
1925 </dt> | |
1926 <dd> | |
1927 <p> | |
1928 Close the OTR channel to the specified jid (or the currently selected contact) | |
1929 </p> | |
1930 </dd> | |
1931 <dt class="hdlist1"> | |
1932 <em>info</em> [jid] | |
1933 </dt> | |
1934 <dd> | |
1935 <p> | |
1936 Show current OTR status for the specified jid (or the currently selected contact) | |
1937 </p> | |
1938 </dd> | |
1939 <dt class="hdlist1"> | |
1940 <em>fingerprint</em> [jid [fpr]] | |
1941 </dt> | |
1942 <dd> | |
1943 <p> | |
1944 Show the active fingerprint of an OTR channel. If the fingerprint is provided instead of "fpr", the fingerprint will become trusted. If you replace "fpr" by some bogus string the fingerprint will loose the trusted status. | |
1945 </p> | |
1946 </dd> | |
1947 <dt class="hdlist1"> | |
1948 <em>smpq</em> [jid] secret | |
1949 </dt> | |
1950 <dd> | |
1951 <p> | |
1952 Initiate the Socialist Millionaires Protocol with the secret and the buddy | |
1953 </p> | |
1954 </dd> | |
1955 <dt class="hdlist1"> | |
1956 <em>smpr</em> [jid] secret | |
1957 </dt> | |
1958 <dd> | |
1959 <p> | |
1960 Respond to the Initiation of the jid with the secret | |
1961 </p> | |
1962 </dd> | |
1963 <dt class="hdlist1"> | |
1964 <em>smpa</em> [jid] | |
1965 </dt> | |
1966 <dd> | |
1967 <p> | |
1968 Abort the running Socialist Millionaires Protocol | |
1969 </p> | |
1970 </dd> | |
1971 </dl></div> | |
1972 </dd> | |
1973 <dt class="hdlist1"> | |
1974 /otrpolicy | |
1975 </dt> | |
1976 <dt class="hdlist1"> | |
1977 /otrpolicy (default|jid) (plain|manual|opportunistic|always) | |
1978 </dt> | |
1979 <dd> | |
1980 <p> | |
1981 You can use the shortcut-jid "." for the currently selected contact. | |
1982 </p> | |
1983 <div class="dlist"><dl> | |
1984 <dt class="hdlist1"> | |
1985 (without arguments) | |
1986 </dt> | |
1987 <dd> | |
1988 <p> | |
1989 Prints all OTR policies to the status buffer | |
1990 </p> | |
1991 </dd> | |
1992 <dt class="hdlist1"> | |
1993 (<em>default</em>|<em>jid</em>) (plain|manual|opportunistic|always) | |
1994 </dt> | |
1995 <dd> | |
1996 <p> | |
1997 Sets either the default policy or the policy for the given jid The plain policy should never be used, because you won’t be able to receive or send any OTR encrypted messages. If you set the policy to manual, you or your chat partner have to start the OTR encryption by hand (e.g. with /otr start). The policy "opportunistic" does that itself by sending a special whitespace-sequence at the end of unencrypted messages. So the other OTR-enabled chat client knows, that you want to use OTR. Note that the first message will always be unencryted, if you use this policy. With the policy "always" no message will be sent in plain text. If you try to sent the first message unencrypted, mcabber will try to establish an OTR channel. Please resend your message, when you get the information that the channel was established. If someone sends you plaintext messages while the policy is set to "always", you’ll be able to read the message but it won’t be saved to the history. | |
1998 </p> | |
1999 </dd> | |
2000 </dl></div> | |
2001 </dd> | |
2002 <dt class="hdlist1"> | |
2003 /pgp disable|enable|force|info [jid] | |
2004 </dt> | |
2005 <dt class="hdlist1"> | |
2006 /pgp setkey [jid [key]] | |
2007 </dt> | |
2008 <dd> | |
2009 <p> | |
2010 This command manipulates PGP settings for the specified jid (by default the currently selected contact).<br /> | |
2011 Please note that PGP encryption won’t be used if no remote PGP support is detected, even if PGP is enabled with this command. You can force PGP encryption with the "force" subcommand. | |
2012 </p> | |
2013 <div class="dlist"><dl> | |
2014 <dt class="hdlist1"> | |
2015 <em>disable</em> [jid] | |
2016 </dt> | |
2017 <dd> | |
2018 <p> | |
2019 Disable PGP encryption for jid (or the currently selected contact) | |
2020 </p> | |
2021 </dd> | |
2022 <dt class="hdlist1"> | |
2023 <em>enable</em> [jid] | |
2024 </dt> | |
2025 <dd> | |
2026 <p> | |
2027 Enable PGP encryption for jid (or the currently selected contact) | |
2028 </p> | |
2029 </dd> | |
2030 <dt class="hdlist1"> | |
2031 <em style="color:+|-;">force</em> [jid] | |
2032 </dt> | |
2033 <dd> | |
2034 <p> | |
2035 Enforce PGP encryption, even for offline messages, and always assume the recipient has PGP support. If a message can’t be encrypted (missing key or key id), the messages won’t be sent at all. This option is ignored when PGP is disabled. | |
2036 </p> | |
2037 </dd> | |
2038 <dt class="hdlist1"> | |
2039 <em>info</em> [jid] | |
2040 </dt> | |
2041 <dd> | |
2042 <p> | |
2043 Show current PGP settings for the contact | |
2044 </p> | |
2045 </dd> | |
2046 <dt class="hdlist1"> | |
2047 <em>setkey</em> [jid [key]] | |
2048 </dt> | |
2049 <dd> | |
2050 <p> | |
2051 Set the PGP key to be used to encrypt message for this contact. If no key is provided, the current key is erased. You can use the shortcut-jid "." for the currently selected contact. | |
2052 </p> | |
2053 </dd> | |
2054 </dl></div> | |
2055 </dd> | |
2056 <dt class="hdlist1"> | |
595 /quit | 2057 /quit |
596 </b></dt> | 2058 </dt> |
597 <dd> | 2059 <dd> |
598 Disconnect and leave <tt>mcabber(1)</tt>. | 2060 <p> |
599 </dd> | 2061 This command closes all connections and quit mcabber. |
600 <dt><b> | 2062 </p> |
601 /set option[=value] | 2063 </dd> |
602 </b></dt> | 2064 <dt class="hdlist1"> |
603 <dd> | 2065 /rawxml send string |
2066 </dt> | |
2067 <dd> | |
2068 <p> | |
2069 Send "string" (raw XML format) to the Jabber server.<br /> | |
2070 No check is done on the string provided.<br /> | |
2071 BEWARE! | |
2072 Use this only if you know what you are doing, or you could terminate the connection.<br /> | |
2073 Example: "/rawxml send <presence><show>away</show></presence>" | |
2074 </p> | |
2075 </dd> | |
2076 <dt class="hdlist1"> | |
2077 /rename name | |
2078 </dt> | |
2079 <dd> | |
2080 <p> | |
2081 Rename the current buddy or group to the given "name". If "name" is -, the name is removed from the roster (and mcabber will display the JID or username). | |
2082 </p> | |
2083 </dd> | |
2084 <dt class="hdlist1"> | |
2085 /request last|ping|time|vcard|version [jid] | |
2086 </dt> | |
2087 <dd> | |
2088 <p> | |
2089 Send a "IQ" query to the current buddy, or to the specified Jabber user. If the resource is not provided with the jid, mcabber will send the query to all known resources for this user. | |
2090 </p> | |
2091 <div class="dlist"><dl> | |
2092 <dt class="hdlist1"> | |
2093 <em>last</em> | |
2094 </dt> | |
2095 <dd> | |
2096 <p> | |
2097 Request "last" information (usually idle time) | |
2098 </p> | |
2099 </dd> | |
2100 <dt class="hdlist1"> | |
2101 <em>ping</em> | |
2102 </dt> | |
2103 <dd> | |
2104 <p> | |
2105 Send an XMPP Ping request. Note that you should use the full JID since a ping sent to a bare JID will be handled by the server. | |
2106 </p> | |
2107 </dd> | |
2108 <dt class="hdlist1"> | |
2109 <em>time</em> | |
2110 </dt> | |
2111 <dd> | |
2112 <p> | |
2113 Request time from the buddy | |
2114 </p> | |
2115 </dd> | |
2116 <dt class="hdlist1"> | |
2117 <em>vcard</em> | |
2118 </dt> | |
2119 <dd> | |
2120 <p> | |
2121 Request VCard from the buddy | |
2122 </p> | |
2123 </dd> | |
2124 <dt class="hdlist1"> | |
2125 <em>version</em> | |
2126 </dt> | |
2127 <dd> | |
2128 <p> | |
2129 Request version from the buddy | |
2130 </p> | |
2131 </dd> | |
2132 </dl></div> | |
2133 </dd> | |
2134 <dt class="hdlist1"> | |
2135 /room join|leave|names|nick|remove|topic|unlock|destroy | |
2136 </dt> | |
2137 <dt class="hdlist1"> | |
2138 /room privmsg|invite|whois|kick|ban|unban|role|affil | |
2139 </dt> | |
2140 <dt class="hdlist1"> | |
2141 /room setopt print_status|auto_whois [value] | |
2142 </dt> | |
2143 <dt class="hdlist1"> | |
2144 /room bookmark [add|del] [-autojoin|+autojoin] [-|nick] | |
2145 </dt> | |
2146 <dd> | |
2147 <p> | |
2148 The <em>room</em> command handles Multi-User Chat room actions. | |
2149 </p> | |
2150 <div class="dlist"><dl> | |
2151 <dt class="hdlist1"> | |
2152 <em>join</em> [room [nick [pass]]] | |
2153 </dt> | |
2154 <dd> | |
2155 <p> | |
2156 Join "room", using "nick" as nickname. If no nickname is provided (or if it is an empty string), the "nickname" option value is used (see sample configuration file). If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "." can be used instead of the full room id. A password can be provided to enter protected rooms. If your nickname contains space characters, use quotes. | |
2157 </p> | |
2158 </dd> | |
2159 <dt class="hdlist1"> | |
2160 <em>leave</em> [message] | |
2161 </dt> | |
2162 <dd> | |
2163 <p> | |
2164 Leave the current room | |
2165 </p> | |
2166 </dd> | |
2167 <dt class="hdlist1"> | |
2168 <em>names</em> [--detail|--short|--quiet|--compact] | |
2169 </dt> | |
2170 <dd> | |
2171 <p> | |
2172 Display members of the current room | |
2173 </p> | |
2174 </dd> | |
2175 <dt class="hdlist1"> | |
2176 <em>nick</em> newnick | |
2177 </dt> | |
2178 <dd> | |
2179 <p> | |
2180 Change your nickname in the current room | |
2181 </p> | |
2182 </dd> | |
2183 <dt class="hdlist1"> | |
2184 <em>privmsg</em> nick msg | |
2185 </dt> | |
2186 <dd> | |
2187 <p> | |
2188 Send private message "msg" to "nick" | |
2189 </p> | |
2190 </dd> | |
2191 <dt class="hdlist1"> | |
2192 <em>remove</em> | |
2193 </dt> | |
2194 <dd> | |
2195 <p> | |
2196 Remove the current room from the roster (you must have left this room before) | |
2197 </p> | |
2198 </dd> | |
2199 <dt class="hdlist1"> | |
2200 <em>topic</em> -|newtopic | |
2201 </dt> | |
2202 <dd> | |
2203 <p> | |
2204 Set topic for current room | |
2205 </p> | |
2206 </dd> | |
2207 <dt class="hdlist1"> | |
2208 <em>unlock</em> | |
2209 </dt> | |
2210 <dd> | |
2211 <p> | |
2212 Unlock current room (if you are the owner) | |
2213 </p> | |
2214 </dd> | |
2215 <dt class="hdlist1"> | |
2216 <em>destroy</em> [reason] | |
2217 </dt> | |
2218 <dd> | |
2219 <p> | |
2220 Destroy the current room (use with care!) | |
2221 </p> | |
2222 </dd> | |
2223 <dt class="hdlist1"> | |
2224 <em>whois</em> nick | |
2225 </dt> | |
2226 <dd> | |
2227 <p> | |
2228 Display MUC information about "nick" | |
2229 </p> | |
2230 </dd> | |
2231 <dt class="hdlist1"> | |
2232 <em>ban</em> jid [reason] | |
2233 </dt> | |
2234 <dd> | |
2235 <p> | |
2236 Ban jid from the current room | |
2237 </p> | |
2238 </dd> | |
2239 <dt class="hdlist1"> | |
2240 <em>unban</em> jid | |
2241 </dt> | |
2242 <dd> | |
2243 <p> | |
2244 Unban jid from the current room | |
2245 </p> | |
2246 </dd> | |
2247 <dt class="hdlist1"> | |
2248 <em>invite</em> jid [reason] | |
2249 </dt> | |
2250 <dd> | |
2251 <p> | |
2252 Invite jid to the current room | |
2253 </p> | |
2254 </dd> | |
2255 <dt class="hdlist1"> | |
2256 <em>kick</em> nick [reason] | |
2257 </dt> | |
2258 <dd> | |
2259 <p> | |
2260 Kick "nick" from the current room | |
2261 </p> | |
2262 </dd> | |
2263 <dt class="hdlist1"> | |
2264 <em>role</em> jid role [reason] | |
2265 </dt> | |
2266 <dd> | |
2267 <p> | |
2268 Change jid’s role (role can be "none", "visitor", "participant", "moderator") | |
2269 </p> | |
2270 </dd> | |
2271 <dt class="hdlist1"> | |
2272 <em>affil</em> jid affil [reason] | |
2273 </dt> | |
2274 <dd> | |
2275 <p> | |
2276 Change jid’s affiliation (affil can be "none", "member", "admin", "owner") | |
2277 </p> | |
2278 </dd> | |
2279 <dt class="hdlist1"> | |
2280 <em>setopt</em> print_status|auto_whois [value] | |
2281 </dt> | |
2282 <dd> | |
2283 <p> | |
2284 Change settings for the current room For print_status, the possible values are "default", "none", "in_and_out", "all". For auto_whois, the possible values are "default", "off", "on". When the value is "default", the options muc_print_status / muc_auto_whois is used. | |
2285 </p> | |
2286 </dd> | |
2287 <dt class="hdlist1"> | |
2288 <em>bookmark</em> [add|del] [-autojoin|+autojoin] [-|nick] | |
2289 </dt> | |
2290 <dd> | |
2291 <p> | |
2292 Add, remove or update a bookmark (default is add). If autojoin is set, mcabber will automatically join the MUC room when it connects to the server. To see the list of bookmarks, use /room bookmark in the status buffer. | |
2293 </p> | |
2294 </dd> | |
2295 </dl></div> | |
2296 </dd> | |
2297 <dt class="hdlist1"> | |
2298 /roster bottom|top|up|down|group_prev|group_next | |
2299 </dt> | |
2300 <dt class="hdlist1"> | |
2301 /roster alternate|unread_first|unread_next | |
2302 </dt> | |
2303 <dt class="hdlist1"> | |
2304 /roster search bud | |
2305 </dt> | |
2306 <dt class="hdlist1"> | |
2307 /roster display|hide_offline|show_offline|toggle_offline | |
2308 </dt> | |
2309 <dt class="hdlist1"> | |
2310 /roster item_lock|item_unlock|item_toggle_lock | |
2311 </dt> | |
2312 <dt class="hdlist1"> | |
2313 /roster hide|show|toggle | |
2314 </dt> | |
2315 <dt class="hdlist1"> | |
2316 /roster note [-|text] | |
2317 </dt> | |
2318 <dd> | |
2319 <p> | |
2320 The <em>roster</em> command manipulates the roster/buddylist.<br /> | |
2321 Here are the available parameters: | |
2322 </p> | |
2323 <div class="dlist"><dl> | |
2324 <dt class="hdlist1"> | |
2325 <em>bottom</em> | |
2326 </dt> | |
2327 <dd> | |
2328 <p> | |
2329 Jump to the bottom of the roster | |
2330 </p> | |
2331 </dd> | |
2332 <dt class="hdlist1"> | |
2333 <em>top</em> | |
2334 </dt> | |
2335 <dd> | |
2336 <p> | |
2337 Jump to the top of the roster | |
2338 </p> | |
2339 </dd> | |
2340 <dt class="hdlist1"> | |
2341 <em>up</em> [n] | |
2342 </dt> | |
2343 <dd> | |
2344 <p> | |
2345 Move up [n lines] in the roster | |
2346 </p> | |
2347 </dd> | |
2348 <dt class="hdlist1"> | |
2349 <em>down</em> [n] | |
2350 </dt> | |
2351 <dd> | |
2352 <p> | |
2353 Move down [n lines] in the roster | |
2354 </p> | |
2355 </dd> | |
2356 <dt class="hdlist1"> | |
2357 <em>group_prev</em> | |
2358 </dt> | |
2359 <dd> | |
2360 <p> | |
2361 Jump to the previous group in the roster | |
2362 </p> | |
2363 </dd> | |
2364 <dt class="hdlist1"> | |
2365 <em>group_next</em> | |
2366 </dt> | |
2367 <dd> | |
2368 <p> | |
2369 Jump to the next group in the roster | |
2370 </p> | |
2371 </dd> | |
2372 <dt class="hdlist1"> | |
2373 <em>alternate</em> | |
2374 </dt> | |
2375 <dd> | |
2376 <p> | |
2377 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_next" (Ctrl-q). | |
2378 </p> | |
2379 </dd> | |
2380 <dt class="hdlist1"> | |
2381 <em>unread_first</em> | |
2382 </dt> | |
2383 <dd> | |
2384 <p> | |
2385 Jump to the first unread message | |
2386 </p> | |
2387 </dd> | |
2388 <dt class="hdlist1"> | |
2389 <em>unread_next</em> | |
2390 </dt> | |
2391 <dd> | |
2392 <p> | |
2393 Jump to the next unread message | |
2394 </p> | |
2395 </dd> | |
2396 <dt class="hdlist1"> | |
2397 <em>search</em> bud | |
2398 </dt> | |
2399 <dd> | |
2400 <p> | |
2401 Search for a buddy with a name or jid containing "bud" (only in the displayed buddylist) | |
2402 </p> | |
2403 </dd> | |
2404 <dt class="hdlist1"> | |
2405 <em>display</em> [mask] | |
2406 </dt> | |
2407 <dd> | |
2408 <p> | |
2409 See or update the roster filter. The mask should contain the shortcut letters of the status you want to see ([o]nline, [f]ree_for_chat, [d]o_not_disturb, [n]ot_available, [a]way, [_]offline). For example "ofdna" to display only connected buddies. | |
2410 </p> | |
2411 </dd> | |
2412 <dt class="hdlist1"> | |
2413 <em>hide_offline</em> | |
2414 </dt> | |
2415 <dd> | |
2416 <p> | |
2417 Hide offline buddies (same as /roster display ofdna) | |
2418 </p> | |
2419 </dd> | |
2420 <dt class="hdlist1"> | |
2421 <em>show_offline</em> | |
2422 </dt> | |
2423 <dd> | |
2424 <p> | |
2425 Show offline buddies (same as /roster display ofdna_) | |
2426 </p> | |
2427 </dd> | |
2428 <dt class="hdlist1"> | |
2429 <em>toggle_offline</em> | |
2430 </dt> | |
2431 <dd> | |
2432 <p> | |
2433 Toggle display of offline buddies | |
2434 </p> | |
2435 </dd> | |
2436 <dt class="hdlist1"> | |
2437 <em>item_lock</em> [jid] | |
2438 </dt> | |
2439 <dd> | |
2440 <p> | |
2441 Lock the roster item so it remains visible regardless of its status | |
2442 </p> | |
2443 </dd> | |
2444 <dt class="hdlist1"> | |
2445 <em>item_unlock</em> [jid] | |
2446 </dt> | |
2447 <dd> | |
2448 <p> | |
2449 Undo the effects of item_lock | |
2450 </p> | |
2451 </dd> | |
2452 <dt class="hdlist1"> | |
2453 <em>item_toggle_lock</em> [jid] | |
2454 </dt> | |
2455 <dd> | |
2456 <p> | |
2457 Invert the current lock flag | |
2458 </p> | |
2459 </dd> | |
2460 <dt class="hdlist1"> | |
2461 <em>hide</em> | |
2462 </dt> | |
2463 <dd> | |
2464 <p> | |
2465 Hide roster (full-width chat window) | |
2466 </p> | |
2467 </dd> | |
2468 <dt class="hdlist1"> | |
2469 <em>show</em> | |
2470 </dt> | |
2471 <dd> | |
2472 <p> | |
2473 Show roster | |
2474 </p> | |
2475 </dd> | |
2476 <dt class="hdlist1"> | |
2477 <em>toggle</em> | |
2478 </dt> | |
2479 <dd> | |
2480 <p> | |
2481 Toggle roster visibility | |
2482 </p> | |
2483 </dd> | |
2484 <dt class="hdlist1"> | |
2485 <em>note</em> [-|text] | |
2486 </dt> | |
2487 <dd> | |
2488 <p> | |
2489 Set/update/delete an annotation. If there is no text, the current item’s annotation is displayed — if you are in the status buffer, all notes are displayed. If text is "-", the note is erased. | |
2490 </p> | |
2491 </dd> | |
2492 </dl></div> | |
2493 </dd> | |
2494 <dt class="hdlist1"> | |
2495 /say [-n|-h|--] text | |
2496 </dt> | |
2497 <dd> | |
2498 <p> | |
2499 Send the "text" message to the currently selected buddy. It can be useful if you want to send a message beginning with a slash, for example.<br /> | |
2500 The "-n" flag turns the message to "normal" type, "-h" to "headline". "--" can be used to send chat message beginning with -n or -h. | |
2501 </p> | |
2502 </dd> | |
2503 <dt class="hdlist1"> | |
2504 /say_to [-n|-h] [-q] [-f file] jid text | |
2505 </dt> | |
2506 <dd> | |
2507 <p> | |
2508 Send the "text" message to the specified jid.<br /> | |
2509 Please note that this command doesn’t 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.<br /> | |
2510 The "-n" flag turns the message to "normal" type, "-h" to "headline". "--" can be used to send chat messages beginning with -n or -h.<br /> | |
2511 When "-q" is used, the message will be sent in the background and will not change the current active window.<br /> | |
2512 A text file can be provided with the "-f" switch (in which case there’s no need to pass a text argument after the jid, of course). | |
2513 </p> | |
2514 </dd> | |
2515 <dt class="hdlist1"> | |
2516 /screen_refresh | |
2517 </dt> | |
2518 <dd> | |
2519 <p> | |
2520 Refresh the mcabber screen. | |
2521 </p> | |
2522 </dd> | |
2523 <dt class="hdlist1"> | |
2524 /set option [= value] | |
2525 </dt> | |
2526 <dd> | |
2527 <p> | |
604 Display or set an option value. | 2528 Display or set an option value. |
605 </dd> | 2529 </p> |
606 <dt><b> | 2530 </dd> |
607 /source [file] | 2531 <dt class="hdlist1"> |
608 </b></dt> | 2532 /source pattern |
609 <dd> | 2533 </dt> |
610 Read a configuration file. | 2534 <dd> |
611 </dd> | 2535 <p> |
612 <dt><b> | 2536 Read configuration files, that match glob pattern (sorted in alphabetical order). |
2537 </p> | |
2538 </dd> | |
2539 <dt class="hdlist1"> | |
2540 /status [online|avail|invisible|free|dnd|notavail|away [-|statusmessage]] | |
2541 </dt> | |
2542 <dt class="hdlist1"> | |
2543 /status message -|statusmessage | |
2544 </dt> | |
2545 <dd> | |
2546 <p> | |
2547 Show or set the current status.<br /> | |
2548 If no status is specified, display the current status.<br /> | |
2549 If a status message is specified, it will overrride the message* variables (these variables can be set in the configuration file).<br /> | |
2550 If no relevant message* variable is set and no status message provided, the current status message is kept.<br /> | |
2551 If StatusMessage is "-", the current status message is cleared.<br /> | |
2552 With the "/status message" command, mcabber will update the message while preserving the status. | |
2553 </p> | |
2554 </dd> | |
2555 <dt class="hdlist1"> | |
2556 /status_to jid online|avail|invisible|free|dnd|notavail|away [statusmessage] | |
2557 </dt> | |
2558 <dt class="hdlist1"> | |
2559 /status_to jid message statusmessage | |
2560 </dt> | |
2561 <dd> | |
2562 <p> | |
2563 Send the requested status to the specified Jabber user.<br /> | |
2564 If the specified jid is ".", the current buddy is used.<br /> | |
2565 Note: this status will be overridden by subsequent "/status" commands. If you are using the auto-away feature, the status will overridden too.<br /> | |
2566 Note: The jid can include a resource (i.e. user@server/resource). | |
2567 </p> | |
2568 </dd> | |
2569 <dt class="hdlist1"> | |
613 /version | 2570 /version |
614 </b></dt> | 2571 </dt> |
615 <dd> | 2572 <dd> |
616 Display mcabber version | 2573 <p> |
617 </dd> | 2574 Display current version of mcabber. |
618 </dl> | 2575 </p> |
619 <h2>COMMANDS RELATED TO THE SERVER AND CONNECTION</h2> | 2576 </dd> |
620 <dl> | 2577 </dl></div> |
621 <dt><b> | 2578 </div> |
622 /connect | 2579 <h2 id="_configuration_file">CONFIGURATION FILE</h2> |
623 </b></dt> | 2580 <div class="sectionbody"> |
624 <dd> | 2581 <div class="paragraph"><p>See the provided sample configuration file, which should be self-documenting.</p></div> |
625 Establish connection to the Jabber server. | 2582 </div> |
626 </dd> | 2583 <h2 id="_files">FILES</h2> |
627 <dt><b> | 2584 <div class="sectionbody"> |
628 /disconnect | 2585 <div class="paragraph"><p>The following files can be used by <tt>mcabber(1)</tt>:</p></div> |
629 </b></dt> | 2586 <div class="literalblock"> |
630 <dd> | 2587 <div class="content"> |
631 Terminate connection to the Jabber server. Note: the roster is only | 2588 <pre><tt>$HOME/.mcabber/mcabberrc Default configuration file |
632 available when the connection to the server is active, so the | |
633 buddylist is empty when disconnected. | |
634 </dd> | |
635 <dt><b> | |
636 /event #n|* accept|ignore|reject | |
637 </b></dt> | |
638 <dt><b> | |
639 /event list | |
640 </b></dt> | |
641 <dd> | |
642 Tell mcabber what to do about a pending event.<br /> | |
643 If the first parameter is "*", the command will apply to all | |
644 queued events. | |
645 <table class="hlist"> | |
646 <tr valign="top"> | |
647 <td> | |
648 <b>accept</b> | |
649 </td> | |
650 <td> | |
651 accept the event #n | |
652 </td> | |
653 </tr> | |
654 <tr valign="top"> | |
655 <td> | |
656 <b>ignore</b> | |
657 </td> | |
658 <td> | |
659 remove the event #n from the list | |
660 </td> | |
661 </tr> | |
662 <tr valign="top"> | |
663 <td> | |
664 <b>reject</b> | |
665 </td> | |
666 <td> | |
667 reject the event #n | |
668 </td> | |
669 </tr> | |
670 <tr valign="top"> | |
671 <td> | |
672 <b>list</b> | |
673 </td> | |
674 <td> | |
675 list all pending events | |
676 </td> | |
677 </tr> | |
678 </table> | |
679 </dd> | |
680 <dt><b> | |
681 /rawxml send string | |
682 </b></dt> | |
683 <dd> | |
684 <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. | |
685 </dd> | |
686 </dl> | |
687 <h2>COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES</h2> | |
688 <dl> | |
689 <dt><b> | |
690 /add [jid [nickname]] | |
691 </b></dt> | |
692 <dd> | |
693 Add the "jid" Jabber user to our roster (default group), and send a | |
694 notification request to this buddy. If no nickname is specified, the | |
695 jid is used. If no jid (or an empty string "") is provided or if jid | |
696 is ".", the current buddy is used. | |
697 </dd> | |
698 <dt><b> | |
699 /authorization allow|cancel|request|request_unsubscribe [jid] | |
700 </b></dt> | |
701 <dd> | |
702 Manage the presence subscriptions.<br /> | |
703 If no jid is provided, the current buddy is used. | |
704 <table class="hlist"> | |
705 <tr valign="top"> | |
706 <td> | |
707 <b>allow</b> | |
708 </td> | |
709 <td> | |
710 allow the buddy to receive your presence updates | |
711 </td> | |
712 </tr> | |
713 <tr valign="top"> | |
714 <td> | |
715 <b>cancel</b> | |
716 </td> | |
717 <td> | |
718 cancel the buddy' subscription to your presence updates | |
719 </td> | |
720 </tr> | |
721 <tr valign="top"> | |
722 <td> | |
723 <b>request</b> | |
724 </td> | |
725 <td> | |
726 request a subscription to the buddy's presence updates | |
727 </td> | |
728 </tr> | |
729 <tr valign="top"> | |
730 <td> | |
731 <b>request_unsubscribe</b> | |
732 </td> | |
733 <td> | |
734 request unsubscription from the buddy's presence updates | |
735 </td> | |
736 </tr> | |
737 </table> | |
738 </dd> | |
739 <dt><b> | |
740 /del | |
741 </b></dt> | |
742 <dd> | |
743 Delete the current buddy from our roster, unsubscribe from its presence | |
744 notification and unsubscribe it from ours. | |
745 </dd> | |
746 <dt><b> | |
747 /group fold|unfold|toggle | |
748 </b></dt> | |
749 <dd> | |
750 The <b>group</b> command changes the current group display. | |
751 <table class="hlist"> | |
752 <tr valign="top"> | |
753 <td> | |
754 <b>fold</b> | |
755 </td> | |
756 <td> | |
757 fold (shrink) the current group tree in the roster | |
758 </td> | |
759 </tr> | |
760 <tr valign="top"> | |
761 <td> | |
762 <b>unfold</b> | |
763 </td> | |
764 <td> | |
765 unfold (expand) the current group tree in the roster | |
766 </td> | |
767 </tr> | |
768 <tr valign="top"> | |
769 <td> | |
770 <b>toggle</b> | |
771 </td> | |
772 <td> | |
773 toggle the state (fold/unfold) of the current tree | |
774 </td> | |
775 </tr> | |
776 </table> | |
777 </dd> | |
778 <dt><b> | |
779 /info | |
780 </b></dt> | |
781 <dd> | |
782 Display info on the selected entry (user, agent, group…).<br /> | |
783 For users, resources are displayed with the status, priority and | |
784 status message (if available) of each resource. | |
785 </dd> | |
786 <dt><b> | |
787 /move [groupname] | |
788 </b></dt> | |
789 <dd> | |
790 Move the current buddy to the requested group. If no group is | |
791 specified, then the buddy is moved to the default group. | |
792 If the group groupname doesn't exist, it is created.<br /> | |
793 Tip: if the chatmode is enabled, you can use "/roster alternate" | |
794 to jump to the moved buddy. | |
795 </dd> | |
796 <dt><b> | |
797 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort | |
798 </b></dt> | |
799 <dd> | |
800 Send a multi-line message. To write a single message with several | |
801 lines, the <b>multi-line mode</b> should be used. <tt> | |
802 In multi-line mode, each line (except command lines) typed in the input | |
803 line will be added to the multi-line message. Once the message is | |
804 finished, it can be sent to the current selected buddy with the "/msay | |
805 send" command (or Ctrl-d). </tt> | |
806 The <b>begin</b> subcommand enables multi-line mode. Note that it allows | |
807 a message subject to be specified. <tt> | |
808 The <b>verbatim</b> multi-line mode disables commands, so that it is | |
809 possible to enter lines starting with a slash. Only the "/msay" | |
810 command (with send or abort parameters) can be used to exit verbatim | |
811 mode. </tt> | |
812 The <b>toggle</b> and <b>toggle_verbatim</b> subcommands can be bound to a key to | |
813 use the multi-line mode quickly (for example, "bind M109 = msay toggle" | |
814 to switch using the Meta-m combination). | |
815 <table class="hlist"> | |
816 <tr valign="top"> | |
817 <td> | |
818 <b>begin</b> [subject] | |
819 </td> | |
820 <td> | |
821 enter multi-line mode | |
822 </td> | |
823 </tr> | |
824 <tr valign="top"> | |
825 <td> | |
826 <b>verbatim</b> | |
827 </td> | |
828 <td> | |
829 enter verbatim multi-line mode | |
830 </td> | |
831 </tr> | |
832 <tr valign="top"> | |
833 <td> | |
834 <b>send</b> | |
835 </td> | |
836 <td> | |
837 send the current multi-line message to the currently selected buddy | |
838 </td> | |
839 </tr> | |
840 <tr valign="top"> | |
841 <td> | |
842 <b>send_to</b> jid | |
843 </td> | |
844 <td> | |
845 send the current multi-line message to "jid" | |
846 </td> | |
847 </tr> | |
848 <tr valign="top"> | |
849 <td> | |
850 <b>toggle</b> | |
851 </td> | |
852 <td> | |
853 switch to/from multi-line mode (begin/send) | |
854 </td> | |
855 </tr> | |
856 <tr valign="top"> | |
857 <td> | |
858 <b>toggle_verbatim</b> | |
859 </td> | |
860 <td> | |
861 same with verbatim multi-line mode | |
862 </td> | |
863 </tr> | |
864 <tr valign="top"> | |
865 <td> | |
866 <b>abort</b> | |
867 </td> | |
868 <td> | |
869 leave multi-line mode without sending the message | |
870 </td> | |
871 </tr> | |
872 </table> | |
873 </dd> | |
874 <dt><b> | |
875 /pgp disable|enable|force|info [jid] | |
876 </b></dt> | |
877 <dt><b> | |
878 /pgp setkey [jid [key]] | |
879 </b></dt> | |
880 <dd> | |
881 Manipulate PGP settings for the specified jid (by default the currently selected contact). Please note that PGP encryption won't be used if no remote PGP support is detected, even if PGP is enabled with this command. | |
882 <table class="hlist"> | |
883 <tr valign="top"> | |
884 <td> | |
885 <b>disable</b> [jid] | |
886 </td> | |
887 <td> | |
888 disable PGP encryption for jid (or the currently selected contact) | |
889 </td> | |
890 </tr> | |
891 <tr valign="top"> | |
892 <td> | |
893 <b>enable</b> [jid] | |
894 </td> | |
895 <td> | |
896 enable PGP encryption for jid (or the currently selected contact) | |
897 </td> | |
898 </tr> | |
899 <tr valign="top"> | |
900 <td> | |
901 <b>force</b> [jid] | |
902 </td> | |
903 <td> | |
904 enforce PGP encryption, even for offline messages, and always assume the recipient has PGP support | |
905 </td> | |
906 </tr> | |
907 <tr valign="top"> | |
908 <td> | |
909 <b>info</b> [jid] | |
910 </td> | |
911 <td> | |
912 show current PGP settings for the contact | |
913 </td> | |
914 </tr> | |
915 <tr valign="top"> | |
916 <td> | |
917 <b>setkey</b> [jid [key]] | |
918 </td> | |
919 <td> | |
920 set the PGP key to be used to encrypt message for this contact. If no key is provided, the current key is erased. You can use the shortcut-jid "." for the currently selected contact. | |
921 </td> | |
922 </tr> | |
923 </table> | |
924 </dd> | |
925 <dt><b> | |
926 /rename name | |
927 </b></dt> | |
928 <dd> | |
929 Rename current buddy or group to the given name. | |
930 Please note that a group name change is only done when the server's | |
931 acknowledgment is received, so a slight delay can be noticed. | |
932 </dd> | |
933 <dt><b> | |
934 /request last|time|vcard|version [jid] | |
935 </b></dt> | |
936 <dd> | |
937 Send a "IQ" query to the current buddy, or to the specified Jabber | |
938 user. If the resource is not provided with the jid, mcabber will | |
939 send the query to all known resources for this user. | |
940 </dd> | |
941 <dt><b> | |
942 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy | |
943 </b></dt> | |
944 <dt><b> | |
945 /room invite|kick|ban|role|affil | |
946 </b></dt> | |
947 <dt><b> | |
948 /room bookmark [add|del] [-autojoin|+autojoin] | |
949 </b></dt> | |
950 <dd> | |
951 The <b>room</b> command handles Multi-User Chat room actions. | |
952 <table class="hlist"> | |
953 <tr valign="top"> | |
954 <td> | |
955 <b>join</b> [room [nick [pass]]] | |
956 </td> | |
957 <td> | |
958 join "room", using "nick" as nickname. If no nickname is provided (or if it is an empty string), the "nickname" option value is used (see sample configuration file). If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "." can be used instead of the full room id. A password can be provided to enter protected rooms. If your nickname contains space characters, use quotes. | |
959 </td> | |
960 </tr> | |
961 <tr valign="top"> | |
962 <td> | |
963 <b>leave</b> [message] | |
964 </td> | |
965 <td> | |
966 leave the current room | |
967 </td> | |
968 </tr> | |
969 <tr valign="top"> | |
970 <td> | |
971 <b>names</b> [--detail|--short|--quiet] | |
972 </td> | |
973 <td> | |
974 display the members of the current room | |
975 </td> | |
976 </tr> | |
977 <tr valign="top"> | |
978 <td> | |
979 <b>nick</b> nick | |
980 </td> | |
981 <td> | |
982 change your nickname in the current room | |
983 </td> | |
984 </tr> | |
985 <tr valign="top"> | |
986 <td> | |
987 <b>privmsg</b> nick msg | |
988 </td> | |
989 <td> | |
990 send private message "msg" to "nick" | |
991 </td> | |
992 </tr> | |
993 <tr valign="top"> | |
994 <td> | |
995 <b>remove</b> | |
996 </td> | |
997 <td> | |
998 remove the current room from the roster (you must have left this room before) | |
999 </td> | |
1000 </tr> | |
1001 <tr valign="top"> | |
1002 <td> | |
1003 <b>topic</b> | |
1004 </td> | |
1005 <td> | |
1006 set topic for current room | |
1007 </td> | |
1008 </tr> | |
1009 <tr valign="top"> | |
1010 <td> | |
1011 <b>unlock</b> | |
1012 </td> | |
1013 <td> | |
1014 unlock current room (if you are the owner) | |
1015 </td> | |
1016 </tr> | |
1017 <tr valign="top"> | |
1018 <td> | |
1019 <b>destroy</b> [reason] | |
1020 </td> | |
1021 <td> | |
1022 destroy the current room (use with care!) | |
1023 </td> | |
1024 </tr> | |
1025 <tr valign="top"> | |
1026 <td> | |
1027 <b>whois</b> nick | |
1028 </td> | |
1029 <td> | |
1030 display MUC information about "nick" | |
1031 </td> | |
1032 </tr> | |
1033 <tr valign="top"> | |
1034 <td> | |
1035 <b>ban</b> jid [reason] | |
1036 </td> | |
1037 <td> | |
1038 ban jid from the current room | |
1039 </td> | |
1040 </tr> | |
1041 <tr valign="top"> | |
1042 <td> | |
1043 <b>invite</b> jid [reason] | |
1044 </td> | |
1045 <td> | |
1046 invite jid to the current room | |
1047 </td> | |
1048 </tr> | |
1049 <tr valign="top"> | |
1050 <td> | |
1051 <b>kick</b> nick [reason] | |
1052 </td> | |
1053 <td> | |
1054 kick "nick" from the current room | |
1055 </td> | |
1056 </tr> | |
1057 <tr valign="top"> | |
1058 <td> | |
1059 <b>role</b> jid role [reason] | |
1060 </td> | |
1061 <td> | |
1062 change jid's role (role can be "none", "visitor", "participant", "moderator") | |
1063 </td> | |
1064 </tr> | |
1065 <tr valign="top"> | |
1066 <td> | |
1067 <b>affil</b> jid affil [reason] | |
1068 </td> | |
1069 <td> | |
1070 change jid's affiliation (affil can be "none", "member", "admin", "owner") | |
1071 <b>bookmark</b> add/update/remove a room bookmark, set/unset autojoin | |
1072 </td> | |
1073 </tr> | |
1074 </table> | |
1075 </dd> | |
1076 <dt><b> | |
1077 /roster bottom|top|up|down|group_prev|group_next | |
1078 </b></dt> | |
1079 <dt><b> | |
1080 /roster alternate|unread_first|unread_next | |
1081 </b></dt> | |
1082 <dt><b> | |
1083 /roster search bud | |
1084 </b></dt> | |
1085 <dt><b> | |
1086 /roster hide_offline|show_offline|toggle_offline | |
1087 </b></dt> | |
1088 <dt><b> | |
1089 /roster item_lock|item_unlock | |
1090 </b></dt> | |
1091 <dt><b> | |
1092 /roster hide|show|toggle | |
1093 </b></dt> | |
1094 <dt><b> | |
1095 /roster note [-|text] | |
1096 </b></dt> | |
1097 <dd> | |
1098 The <b>roster</b> command manipulates the roster/buddylist. Here are the available parameters: | |
1099 <table class="hlist"> | |
1100 <tr valign="top"> | |
1101 <td> | |
1102 <b>bottom</b> | |
1103 </td> | |
1104 <td> | |
1105 jump to the bottom of the roster | |
1106 </td> | |
1107 </tr> | |
1108 <tr valign="top"> | |
1109 <td> | |
1110 <b>top</b> | |
1111 </td> | |
1112 <td> | |
1113 jump to the top of the roster | |
1114 </td> | |
1115 </tr> | |
1116 <tr valign="top"> | |
1117 <td> | |
1118 <b>up</b> | |
1119 </td> | |
1120 <td> | |
1121 move up in the roster | |
1122 </td> | |
1123 </tr> | |
1124 <tr valign="top"> | |
1125 <td> | |
1126 <b>down</b> | |
1127 </td> | |
1128 <td> | |
1129 move down in the roster | |
1130 </td> | |
1131 </tr> | |
1132 <tr valign="top"> | |
1133 <td> | |
1134 <b>group_prev</b> | |
1135 </td> | |
1136 <td> | |
1137 jump to the previous group in the roster | |
1138 </td> | |
1139 </tr> | |
1140 <tr valign="top"> | |
1141 <td> | |
1142 <b>group_next</b> | |
1143 </td> | |
1144 <td> | |
1145 jump to the next group in the roster | |
1146 </td> | |
1147 </tr> | |
1148 <tr valign="top"> | |
1149 <td> | |
1150 <b>alternate</b> | |
1151 </td> | |
1152 <td> | |
1153 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") | |
1154 </td> | |
1155 </tr> | |
1156 <tr valign="top"> | |
1157 <td> | |
1158 <b>unread_first</b> | |
1159 </td> | |
1160 <td> | |
1161 jump to the first unread message | |
1162 </td> | |
1163 </tr> | |
1164 <tr valign="top"> | |
1165 <td> | |
1166 <b>unread_next</b> | |
1167 </td> | |
1168 <td> | |
1169 jump to the next unread message | |
1170 </td> | |
1171 </tr> | |
1172 <tr valign="top"> | |
1173 <td> | |
1174 <b>search</b> bud | |
1175 </td> | |
1176 <td> | |
1177 search for a buddy with a name or jid containing "bud" (only in the displayed buddylist) | |
1178 </td> | |
1179 </tr> | |
1180 <tr valign="top"> | |
1181 <td> | |
1182 <b>hide_offline</b> | |
1183 </td> | |
1184 <td> | |
1185 hide offline buddies | |
1186 </td> | |
1187 </tr> | |
1188 <tr valign="top"> | |
1189 <td> | |
1190 <b>show_offline</b> | |
1191 </td> | |
1192 <td> | |
1193 show offline buddies | |
1194 </td> | |
1195 </tr> | |
1196 <tr valign="top"> | |
1197 <td> | |
1198 <b>toggle_offline</b> | |
1199 </td> | |
1200 <td> | |
1201 toggle display of offline buddies | |
1202 </td> | |
1203 </tr> | |
1204 <tr valign="top"> | |
1205 <td> | |
1206 <b>item_lock</b> jid | |
1207 </td> | |
1208 <td> | |
1209 lock the roster item so it remains visible regardless of its status | |
1210 </td> | |
1211 </tr> | |
1212 <tr valign="top"> | |
1213 <td> | |
1214 <b>item_unlock</b> jid | |
1215 </td> | |
1216 <td> | |
1217 undo the effects of item_lock | |
1218 </td> | |
1219 </tr> | |
1220 <tr valign="top"> | |
1221 <td> | |
1222 <b>hide</b> | |
1223 </td> | |
1224 <td> | |
1225 hide roster (full-width chat window) | |
1226 </td> | |
1227 </tr> | |
1228 <tr valign="top"> | |
1229 <td> | |
1230 <b>show</b> | |
1231 </td> | |
1232 <td> | |
1233 show roster | |
1234 </td> | |
1235 </tr> | |
1236 <tr valign="top"> | |
1237 <td> | |
1238 <b>toggle</b> | |
1239 </td> | |
1240 <td> | |
1241 toggle roster visibility | |
1242 </td> | |
1243 </tr> | |
1244 <tr valign="top"> | |
1245 <td> | |
1246 <b>note</b> [text] | |
1247 </td> | |
1248 <td> | |
1249 display or set an annotation (if text is "-", the annotation is deleted). In the "status" buffer, it will display all annotations. | |
1250 </td> | |
1251 </tr> | |
1252 </table> | |
1253 </dd> | |
1254 <dt><b> | |
1255 /say text | |
1256 </b></dt> | |
1257 <dd> | |
1258 Send the "text" message to the currently selected buddy. Can be useful | |
1259 if you want to send a message beginning with a slash, for example. | |
1260 </dd> | |
1261 <dt><b> | |
1262 /say_to jid text | |
1263 </b></dt> | |
1264 <dd> | |
1265 Send the "text" message to the specified jid. | |
1266 Please note that this command doesn't set the default resource for | |
1267 a contact, so if you want to send several messages to a specific | |
1268 resource you will have to use "/say_to" for each message. | |
1269 </dd> | |
1270 <dt><b> | |
1271 /status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]] | |
1272 </b></dt> | |
1273 <dd> | |
1274 Show or set the current status. <tt> | |
1275 If no status is specified, display the current status. </tt> | |
1276 If a status message is specified, it will overrride the message* | |
1277 variables (these variables can be set in the configuration file). | |
1278 If no relevant message* variable is set and no status message provided, | |
1279 the current status message is kept. If StatusMessage is "-", the | |
1280 current status message is cleared. | |
1281 </dd> | |
1282 <dt><b> | |
1283 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] | |
1284 </b></dt> | |
1285 <dd> | |
1286 Send the requested status to the specified Jabber user. <tt> | |
1287 If the specified jid is ".", the current buddy is used. </tt> | |
1288 Note: this status will be overridden by subsequent "/status" commands. | |
1289 If you are using the auto-away feature, the status will overridden | |
1290 too.<br /> | |
1291 Note: The jid can include a resource (i.e. user@server/resource). | |
1292 </dd> | |
1293 </dl> | |
1294 <h2>CONFIGURATION FILE</h2> | |
1295 <p>See the provided sample configuration file, which should be self-documenting.</p> | |
1296 <h2>FILES</h2> | |
1297 <p>The following files can be used by <tt>mcabber(1)</tt>:</p> | |
1298 <div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc Default configuration file | |
1299 $HOME/.mcabberrc Configuration file used if no other has been found | 2589 $HOME/.mcabberrc Configuration file used if no other has been found |
1300 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled</pre></div> | 2590 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled |
1301 <h2>BUGS</h2> | 2591 /usr/share/mcabber/help/ Default directory for online help files |
1302 <p>Certainly. Please tell me if you find one! :-)</p> | 2592 /usr/lib/mcabber/ Default directory for modules</tt></pre> |
1303 <h2>AUTHOR</h2> | 2593 </div></div> |
1304 <p>Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br /> | 2594 </div> |
1305 Originally based on <a href="http://cabber.sourceforge.net">Cabber</a>, please | 2595 <h2 id="_bugs">BUGS</h2> |
1306 consult the AUTHORS file for details.</p> | 2596 <div class="sectionbody"> |
1307 <h2>RESOURCES</h2> | 2597 <div class="paragraph"><p>Certainly. Please tell me if you find one! :-)<br /> |
1308 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p> | 2598 Please visit our website to find out about the MUC room and the bug tracker.</p></div> |
1309 <h2>COPYING</h2> | 2599 </div> |
1310 <p>Copyright (C) 2005, 2006, 2007, 2008 Mikael Berthe.<br /> | 2600 <h2 id="_author">AUTHOR</h2> |
1311 Some portions are Copyright (C) 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.</p> | 2601 <div class="sectionbody"> |
1312 <p>Free use of this software is granted under the terms of the GNU General Public | 2602 <div class="paragraph"><p>Written by <a href="mailto:mikael@lilotux.net">Mikael BERTHE</a> and others |
1313 License (GPL).</p> | 2603 (see AUTHORS file).<br /></p></div> |
2604 </div> | |
2605 <h2 id="_resources">RESOURCES</h2> | |
2606 <div class="sectionbody"> | |
2607 <div class="paragraph"><p><a href="http://mcabber.com/">Main web site</a></p></div> | |
2608 </div> | |
2609 <h2 id="_copying">COPYING</h2> | |
2610 <div class="sectionbody"> | |
2611 <div class="paragraph"><p>Copyright (C) 2005-2010 Mikael Berthe and others.<br /></p></div> | |
2612 <div class="paragraph"><p>Free use of this software is granted under the terms of the GNU General Public | |
2613 License (GPL).</p></div> | |
2614 </div> | |
2615 </div> | |
2616 <div id="footnotes"><hr /></div> | |
1314 <div id="footer"> | 2617 <div id="footer"> |
1315 <p> | 2618 <div id="footer-text"> |
1316 Version 0.10.0-dev<br /> | 2619 Version 0.10.0-dev<br /> |
1317 Last updated 27-Jun-2007 22:11:34 CEST | 2620 Last updated 2010-03-13 17:43:30 CEST |
1318 </p> | |
1319 </div> | 2621 </div> |
1320 </div> | 2622 </div> |
1321 </body> | 2623 </body> |
1322 </html> | 2624 </html> |