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