1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5<head>
6<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7<meta name="generator" content="AsciiDoc 10.2.0" />
8<title>XMPPC(1)</title>
9<style type="text/css">
10/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
25}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
31a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
38
39em {
40 font-style: italic;
41 color: navy;
42}
43
44strong {
45 font-weight: bold;
46 color: #083194;
47}
48
49h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
56h1, h2, h3 {
57 border-bottom: 2px solid silver;
58}
59h2 {
60 padding-top: 0.5em;
61}
62h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
68h5 {
69 font-size: 1.0em;
70}
71
72div.sectionbody {
73 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
85ul, ol, li > p {
86 margin-top: 0;
87}
88ul > li { color: #aaa; }
89ul > li > * { color: black; }
90
91.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
97}
98pre {
99 white-space: pre-wrap;
100}
101
102#author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
106}
107#email {
108}
109#revnumber, #revdate, #revremark {
110}
111
112#footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
118#footer-text {
119 float: left;
120 padding-bottom: 0.5em;
121}
122#footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
125}
126
127#preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
131div.imageblock, div.exampleblock, div.verseblock,
132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
182}
183
184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
190}
191
192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
195}
196
197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206div.verseblock + div.attribution {
207 text-align: left;
208}
209
210div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
217}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
221}
222
223div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
226}
227
228div.imageblock div.content { padding-left: 0; }
229span.image img { border-style: none; vertical-align: text-bottom; }
230a.image:visited { color: white; }
231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
241}
242dd > *:first-child {
243 margin-top: 0.1em;
244}
245
246ul, ol {
247 list-style-position: outside;
248}
249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
253 list-style-type: lower-alpha;
254}
255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
271
272tfoot {
273 font-weight: bold;
274}
275td > div.verse {
276 white-space: pre;
277}
278
279div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
283div.hdlist tr {
284 padding-bottom: 15px;
285}
286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
294}
295td.hdlist2 {
296 vertical-align: top;
297}
298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
306
307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.footnote, span.footnoteref {
312 vertical-align: super;
313}
314
315#footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318}
319
320#footnotes div.footnote {
321 margin: 0 0 5px 0;
322}
323
324#footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
332}
333
334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
341}
342
343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
348 margin-bottom: 2.5em;
349}
350
351#toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
417div.unbreakable { page-break-inside: avoid; }
418
419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
439/* Because the table frame attribute is overridden by CSS in most browsers. */
440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
527body.manpage h2 {
528 border-style: none;
529}
530body.manpage div.sectionbody {
531 margin-left: 3em;
532}
533
534@media print {
535 body.manpage div#toc { display: none; }
536}
537
538
539</style>
540<script type="text/javascript">
541/*<+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
605 }
606
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637},
638
639
640/////////////////////////////////////////////////////////////////////
641// Footnotes generator
642/////////////////////////////////////////////////////////////////////
643
644/* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
654 }
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
682 }
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
689 }
690 }
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
703 }
704 }
705 }
706},
707
708install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
728}
729
730}
731asciidoc.install();
732/*]]>*/
733</script>
734</head>
735<body class="article">
736<div id="header">
737<h1>XMPPC(1)</h1>
738</div>
739<div id="content">
740<div class="sect1">
741<h2 id="_name">NAME</h2>
742<div class="sectionbody">
743<div class="paragraph"><p>xmppc - XMPP Command line Tool</p></div>
744</div>
745</div>
746<div class="sect1">
747<h2 id="_synopsis">SYNOPSIS</h2>
748<div class="sectionbody">
749<div class="paragraph"><p><em>xmppc</em> [<em>OPTIONS</em>] -m <em>MODE</em> <em>COMMAND</em> [<args>…]</p></div>
750<div class="paragraph"><p><em>xmppc</em> [-a <em>ACCOUNT</em>] [-j <em>JID</em>] [-p <em>PASSWORD</em>] -m <em>MODE</em> <em>COMMAND</em> [<args>…]</p></div>
751<div class="paragraph"><p><em>xmppc</em> <em>agent-skill</em> [<em>install</em>]</p></div>
752</div>
753</div>
754<div class="sect1">
755<h2 id="_description">DESCRIPTION</h2>
756<div class="sectionbody">
757<div class="paragraph"><p>xmppc is a XMPP command line tool. You need an XMPP Account to use this tool.
758The account information can be defined via command line argument -j <em>JID</em>. If no
759password is provided via -p <em>PASSWORD</em> xmppc will ask the user to enter the
760password. Another option is to define 1 or more accounts within a configuration
761file. The option -a <em>ACCOUNT</em> can be used to select the account.</p></div>
762<div class="paragraph"><p>The argument -m <em>MODE</em> defines the xmppc <em>MODE</em> which should be used (roster,
763message, pgp, omemo, openpgp, monitor, bookmark, mam, discovery). The <em>COMMAND</em>
764and the args required by the <em>COMMAND</em> depends on the chosen <em>MODE</em>.</p></div>
765<div class="paragraph"><p>The <em>agent-skill</em> command prints or installs instructions for agent use. It does
766not connect to XMPP.</p></div>
767</div>
768</div>
769<div class="sect1">
770<h2 id="_options">OPTIONS</h2>
771<div class="sectionbody">
772<div class="dlist"><dl>
773<dt class="hdlist1">
774<strong>-a, --attribute</strong> <em>ACCOUNT</em>
775</dt>
776<dd>
777<p>
778 <em>ACCOUNT</em> is a name of a xmpp account defined within the configuration file.
779</p>
780</dd>
781<dt class="hdlist1">
782<strong>-j, --jid</strong> <em>JID</em>
783</dt>
784<dd>
785<p>
786 <em>JID</em> of the XMPP Account.
787</p>
788</dd>
789<dt class="hdlist1">
790<strong>-p, --pwd</strong> <em>PWD</em>
791</dt>
792<dd>
793<p>
794 Password of the XMPP Account. Use <em>-</em> to read the password from stdin.
795</p>
796</dd>
797<dt class="hdlist1">
798<strong>-v</strong> <em>VERBOSE</em>
799</dt>
800<dt class="hdlist1">
801Verbose flags. -v[v[v[v]]]
802</dt>
803<dd>
804<p>
805 -v is WARN -vv is INFO --vvv is DEBUG -vvvv is TRACE
806</p>
807</dd>
808<dt class="hdlist1">
809<strong>--help</strong>
810</dt>
811<dd>
812<p>
813 Print program version number and help
814</p>
815</dd>
816<dt class="hdlist1">
817<strong>agent-skill</strong> [<em>install</em>]
818</dt>
819<dd>
820<p>
821 Print the agent-facing xmppc instructions. With <em>install</em>, write a small
822 agent skill that tells agents to run <em>xmppc agent-skill</em>.
823</p>
824</dd>
825</dl></div>
826</div>
827</div>
828<div class="sect1">
829<h2 id="_modes_and_commands">MODES AND COMMANDS</h2>
830<div class="sectionbody">
831<div class="paragraph"><p>xmppc modes.</p></div>
832<div class="dlist"><dl>
833<dt class="hdlist1">
834<strong>-m roster</strong>
835</dt>
836<dd>
837<p>
838The Roster mode can be used to provided information of the xmpp account’s
839roster. The roster is the XMPP list of contacts.
840</p>
841<div class="ulist"><ul>
842<li>
843<p>
844<strong>list</strong> - List all contacts
845</p>
846</li>
847<li>
848<p>
849<strong>export</strong> - Exports all contacts
850</p>
851</li>
852</ul></div>
853</dd>
854<dt class="hdlist1">
855<strong>-m message</strong>
856</dt>
857<dd>
858<p>
859The message mode can be used to send unencrypted messages to another xmpp
860account.
861</p>
862<div class="ulist"><ul>
863<li>
864<p>
865<strong>chat <jid> <message></strong> - Sending unencrypted message to jid. On success,
866 prints one compact XML record after the sent stanza appears in MAM:
867</p>
868<div class="listingblock">
869<div class="content">
870<pre><code><sent archive-id="mam-id" message-id="stanza-id" to="jid"/></code></pre>
871</div></div>
872<div class="paragraph"><p>The <em>archive-id</em> is the MAM archive cursor. Use it as <em>mam receive after-id</em> when
873waiting for a reply. The <em>message-id</em> is the client stanza id and is not a MAM
874cursor.</p></div>
875</li>
876</ul></div>
877</dd>
878<dt class="hdlist1">
879<strong>-m pgp</strong>
880</dt>
881<dd>
882<p>
883PGP Mode (XEP-0027)
884</p>
885<div class="ulist"><ul>
886<li>
887<p>
888<strong>chat <jid> <message></strong> - Sending pgp encrypted message to jid
889</p>
890</li>
891</ul></div>
892</dd>
893<dt class="hdlist1">
894<strong>-m omemo</strong>
895</dt>
896<dd>
897<p>
898OMEMO Mode (XEP-0384)
899</p>
900<div class="ulist"><ul>
901<li>
902<p>
903<strong>list</strong> - List the device IDs and fingerprints
904</p>
905</li>
906<li>
907<p>
908<strong>delete-device-list</strong> - Deletes the OMEMO device list
909</p>
910</li>
911</ul></div>
912</dd>
913<dt class="hdlist1">
914<strong>-m openpgp</strong>
915</dt>
916<dd>
917<p>
918openpgp mode (XEP-0373)
919</p>
920<div class="ulist"><ul>
921<li>
922<p>
923<strong>signcrypt <jid> <message></strong> - Sending pgp signed and encrypted message to jid
924</p>
925</li>
926</ul></div>
927</dd>
928<dt class="hdlist1">
929<strong>-m monitor</strong>
930</dt>
931<dd>
932<p>
933Monitot mode
934</p>
935<div class="ulist"><ul>
936<li>
937<p>
938<strong>stanza</strong> - Stanza Monitor
939</p>
940</li>
941<li>
942<p>
943<strong>monitor</strong> - microblog Monitor microblog (XEP-0277)
944</p>
945</li>
946</ul></div>
947</dd>
948<dt class="hdlist1">
949<strong>-m bookmark</strong>
950</dt>
951<dd>
952<p>
953Bookmark mode (XEP-0048)
954</p>
955<div class="ulist"><ul>
956<li>
957<p>
958<strong>list</strong> - List bookmarks
959</p>
960</li>
961</ul></div>
962</dd>
963<dt class="hdlist1">
964<strong>-m mam</strong>
965</dt>
966<dd>
967<p>
968Message Archive Management (XEP-0313)
969</p>
970<div class="ulist"><ul>
971<li>
972<p>
973<strong>list <jid> [field=value …]</strong> - List archived messages. A bare <em>jid</em> is
974 shorthand for <em>with=jid</em>. Supported fields are <em>with</em>, <em>start</em>, <em>end</em>,
975 <em>after-id</em>, <em>before-id</em>, <em>ids</em>, and <em>max</em>. Field arguments are unordered.
976 If no range or id field is supplied, <em>start=-5m</em> is used. <em>max</em> defaults to 5
977 and is capped at 50.
978</p>
979</li>
980<li>
981<p>
982<strong>receive <jid> after-id=<mam-id> [timeout=300s] [max=5]</strong> - Poll MAM with RSM
983 <em>after</em> until at least one newer archived message is available or the timeout
984 is reached. Prints at most <em>max</em> messages. If no message arrives before the
985 timeout, prints nothing.
986</p>
987<div class="paragraph"><p><em>list</em> and <em>receive</em> print one compact XML record per archived message:</p></div>
988<div class="listingblock">
989<div class="content">
990<pre><code><message id="mam-id" message-id="stanza-id" stamp="..." from="..." to="..."><body>escaped body</body></message></code></pre>
991</div></div>
992<div class="paragraph"><p>The <em>id</em> attribute is the MAM archive cursor. The <em>message-id</em> attribute is the
993client stanza id.</p></div>
994</li>
995</ul></div>
996</dd>
997<dt class="hdlist1">
998<strong>-m discovery</strong>
999</dt>
1000<dd>
1001<p>
1002Service Discovery (XEP-0030)
1003</p>
1004<div class="ulist"><ul>
1005<li>
1006<p>
1007<strong>info <jid></strong> - info request for <jid>
1008</p>
1009</li>
1010<li>
1011<p>
1012<strong>item <jid></strong> - item request for <jid>
1013</p>
1014</li>
1015</ul></div>
1016</dd>
1017</dl></div>
1018</div>
1019</div>
1020<div class="sect1">
1021<h2 id="_send_then_wait_workflow">SEND-THEN-WAIT WORKFLOW</h2>
1022<div class="sectionbody">
1023<div class="paragraph"><p>To send a message and then wait for a reply, capture the <em><sent …/></em> line from
1024<em>message chat</em>, extract its <em>archive-id</em>, and pass that value to <em>mam receive</em>
1025as <em>after-id</em>. This skips the sender’s outgoing archived message and waits for
1026newer archived messages in the conversation.</p></div>
1027<div class="paragraph"><p>If <em>archive-id</em> is empty, the message was sent but the archive cursor was not
1028resolved before timeout. Fall back to <em>mam list</em> over a recent time window, find
1029the line whose <em>message-id</em> matches the <em><sent …/></em> <em>message-id</em>, then use that
1030line’s <em>id</em> as the receive cursor.</p></div>
1031</div>
1032</div>
1033<div class="sect1">
1034<h2 id="_agent_skill">AGENT SKILL</h2>
1035<div class="sectionbody">
1036<div class="paragraph"><p><em>xmppc agent-skill</em> prints the agent-facing contract for using xmppc safely.
1037Agents should read <code>$HOME/.config/xmppc/AGENTS.md</code> when it exists for local policy,
1038allowed accounts, and preferred contacts. Agents must not print secrets,
1039password commands, or <code>$HOME/.config/xmppc.conf</code>.</p></div>
1040<div class="paragraph"><p><em>xmppc agent-skill install</em> writes the small skill
1041<code>$HOME/.config/agents/skills/communicating-through-xmppc/SKILL.md</code>. The installed
1042skill points agents back to <em>xmppc agent-skill</em> for the current command contract.</p></div>
1043</div>
1044</div>
1045<div class="sect1">
1046<h2 id="_environment_variables">ENVIRONMENT VARIABLES</h2>
1047<div class="sectionbody">
1048<div class="ulist"><ul>
1049<li>
1050<p>
1051HOME
1052</p>
1053</li>
1054</ul></div>
1055</div>
1056</div>
1057<div class="sect1">
1058<h2 id="_examples">EXAMPLES</h2>
1059<div class="sectionbody">
1060<div class="literalblock">
1061<div class="content">
1062<pre><code>xmppc --jid user@domain.tld --pwd "secret" --mode roster list
1063xmppc --jid user@domain.tld --mode pgp chat friend@domain.tld "Hello"
1064xmppc -a account1 --mode discovery item conference@domain.tld
1065xmppc --mode bookmark list</code></pre>
1066</div></div>
1067</div>
1068</div>
1069<div class="sect1">
1070<h2 id="_files">FILES</h2>
1071<div class="sectionbody">
1072<div class="paragraph"><p>Configuration file to setup accounts.</p></div>
1073<div class="dlist"><dl>
1074<dt class="hdlist1">
1075<strong>~/.config/xmppc.conf</strong>
1076</dt>
1077<dd>
1078<p>
1079Example:
1080</p>
1081<div class="literalblock">
1082<div class="content">
1083<pre><code>[default]
1084jid=account1@domain.tld
1085pwd=password1</code></pre>
1086</div></div>
1087<div class="literalblock">
1088<div class="content">
1089<pre><code>[account2]
1090jid=account2@domain.tld</code></pre>
1091</div></div>
1092<div class="literalblock">
1093<div class="content">
1094<pre><code>[account3]
1095jid=account3@domain.tld
1096pwd=password3</code></pre>
1097</div></div>
1098</dd>
1099</dl></div>
1100<div class="paragraph"><p>Instead of <em>pwd</em>, an account may use <em>pwd-cmd</em> to read the password from a local
1101command:</p></div>
1102<div class="literalblock">
1103<div class="content">
1104<pre><code>[account4]
1105jid=account4@domain.tld
1106pwd-cmd=pass show xmpp/account4</code></pre>
1107</div></div>
1108<div class="dlist"><dl>
1109<dt class="hdlist1">
1110<strong>$HOME/.config/xmppc/AGENTS.md</strong>
1111</dt>
1112<dd>
1113<p>
1114Optional user-written policy for agents using xmppc. This file can describe
1115allowed accounts, contacts, and usage rules without exposing secrets.
1116</p>
1117</dd>
1118</dl></div>
1119</div>
1120</div>
1121<div class="sect1">
1122<h2 id="_exit_status">EXIT STATUS</h2>
1123<div class="sectionbody">
1124<div class="dlist"><dl>
1125<dt class="hdlist1">
1126<strong>0</strong>
1127</dt>
1128<dd>
1129<p>
1130 Success
1131</p>
1132</dd>
1133<dt class="hdlist1">
1134<strong>1</strong>
1135</dt>
1136<dd>
1137<p>
1138 Failure
1139</p>
1140</dd>
1141</dl></div>
1142</div>
1143</div>
1144<div class="sect1">
1145<h2 id="_bugs">BUGS</h2>
1146<div class="sectionbody">
1147<div class="paragraph"><p>See <a href="https://codeberg.org/Anoxinon_e.V./xmppc/issues">https://codeberg.org/Anoxinon_e.V./xmppc/issues</a></p></div>
1148</div>
1149</div>
1150<div class="sect1">
1151<h2 id="_author">AUTHOR</h2>
1152<div class="sectionbody">
1153<div class="ulist"><ul>
1154<li>
1155<p>
1156DebXWoody
1157</p>
1158</li>
1159</ul></div>
1160</div>
1161</div>
1162<div class="sect1">
1163<h2 id="_resources">RESOURCES</h2>
1164<div class="sectionbody">
1165<div class="paragraph"><p>Source: <a href="https://codeberg.org/Anoxinon_e.V./xmppc">https://codeberg.org/Anoxinon_e.V./xmppc</a></p></div>
1166<div class="paragraph"><p>Documentation: <a href="https://codeberg.org/Anoxinon_e.V./xmppc/wiki">https://codeberg.org/Anoxinon_e.V./xmppc/wiki</a></p></div>
1167</div>
1168</div>
1169<div class="sect1">
1170<h2 id="_copying">COPYING</h2>
1171<div class="sectionbody">
1172<div class="paragraph"><p>Copyright (C) 2020 Anoxinon e.V. Free use of this software is
1173granted under the terms of the GNU General Public License (GPL).</p></div>
1174</div>
1175</div>
1176</div>
1177<div id="footnotes"><hr /></div>
1178<div id="footer">
1179<div id="footer-text">
1180Last updated
1181 2026-07-05 02:27:50 UTC
1182</div>
1183</div>
1184</body>
1185</html>