doc/Makefile 🔗
@@ -1,3 +1,7 @@
+TXT_FILE = xmppc.1.txt
+
all:
doxygen Doxyfile
-
+ asciidoc -b docbook $(TXT_FILE)
+ asciidoc -b html $(TXT_FILE)
+ a2x --doctype manpage --format manpage $(TXT_FILE)
manpage for xmppc
DebXWoody created
xmppc.1.txt is the manpage in asciidoc format. It can be converted to docbook /
html with asciidoc and a2x to manpage.
asciidoc -b docbook $(TXT_FILE)
asciidoc -b html $(TXT_FILE)
a2x --doctype manpage --format manpage $(TXT_FILE)
Issue: #6Change summary
doc/Makefile | 6
doc/xmppc.1 | 398 +++++++++++++++---
doc/xmppc.1.html | 1065 ++++++++++++++++++++++++++++++++++++++++++++++++++
doc/xmppc.1.txt | 139 ++++++
4 files changed, 1,541 insertions(+), 67 deletions(-)
Detailed changes
doc/xmppc.1 🔗
@@ -1,68 +1,334 @@
'\" t
+.\" Title: xmppc
+.\" Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\" Date: 04/29/2020
+.\" Manual: \ \&
+.\" Source: \ \&
+.\" Language: English
.\"
-.TH xmppc 1 "2020-04-10" Linux "User Manuals"
-.\" ---------------------------------------------------------------------------
-.SH NAME
-.\" ---------------------------------------------------------------------------
-xmppc \- XMPP Command Line Client
-.
-.\" ---------------------------------------------------------------------------
-.SH SYNTAX
-.SY xmppc
-.OP \-v [vvv]
-.BR \-j " <XMPP-ID>"
-.BR \-p " <password>"
-.BR \-m " <mode>"
-.BR command
-.OP args
-.
-.SY xmppc
-.BR \-h
-.
-.SY xmppc
-.BR \-v
-.YS
-.
-.\" ---------------------------------------------------------------------------
-.SH DESCRIPTION
-.PP
-xmppc is a XMPP command line client.
-.
-.\" ---------------------------------------------------------------------------
-.SH OPTIONS
-.TP
-.B --jid jid
-.TQ
-.B -j jid
-XMPP ID of the XMPP account.
-.
-.TP
-.B --pwd password
-.TQ
-.B -p password
-Password of the XMPP account.
-.\" ---------------------------------------------------------------------------
-.SH COMMANDS
-.SS Message
-.TP
-.B chat <jid> <message>
-Send a message to jid
-.
-.SS OMEMO
-.TP
-.B list
-Device IDs and Fingerprints
-.
-.\" ---------------------------------------------------------------------------
-.SH ENVIRONMENT
-.\" ---------------------------------------------------------------------------
-.SH FILES
-.\" ---------------------------------------------------------------------------
-.SH BUGS
-.PP
-Issue tracker:
-.\" ---------------------------------------------------------------------------
-.SH SEE ALSO
-.PP
-.BR gnupg (1)
-
+.TH "XMPPC" "1" "04/29/2020" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+xmppc \- XMPP Command line Tool
+.SH "SYNOPSIS"
+.sp
+\fIxmppc\fR [\fIOPTIONS\fR] \-m \fIMODE\fR \fICOMMAND\fR [<args>\&...]
+.SH "DESCRIPTION"
+.sp
+xmppc is a command line tool
+.SH "OPTIONS"
+.PP
+\fB\-a, \-\-attribute\fR \fIACCOUNT\fR
+.RS 4
+\fIACCOUNT\fR
+is an xmpp account\&...
+.RE
+.PP
+\fB\-j, \-\-jid\fR \fIJID\fR
+.RS 4
+JID of the XMPP Account\&. [
+.RE
+.PP
+\fB\-p, \-\-pwd\fR \fIPWD\fR, \fB\-v\fR \fIVERBOSE\fR
+.RS 4
+Verbose flags\&. \-v WARN \-vv INFO \-\-vvv DEBUG \-vvvv TRACE
+.RE
+.PP
+\fB\-\-help\fR
+.RS 4
+Print program version number and help
+.RE
+.SH "MODES AND COMMANDS"
+.sp
+xmppc modes\&.
+.PP
+\fB\-m roster\fR:: Roster
+.RS 4
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBlist\fR
+\- List all contacts
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBexport\fR
+\- Exports all contacts
+.RE
+.RE
+.PP
+\fB\-m message\fR
+.RS 4
+Message
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBchat <jid> <message>\fR
+\- Sending unencrypted message to jid
+.RE
+.RE
+.PP
+\fB\-m pgp\fR
+.RS 4
+PGP Mode (XEP\-0027)
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBchat <jid> <message>\fR
+\- Sending pgp encrypted message to jid
+.RE
+.RE
+.PP
+\fB\-m omemo\fR
+.RS 4
+OMEMO Mode (XEP\-0384)
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBlist\fR
+\- List the device IDs and fingerprints
+.RE
+.RE
+.PP
+\fB\-m openpgp\fR
+.RS 4
+openpgp mode (XEP\-0373)
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBsigncrypt <jid> <message>\fR
+\- Sending pgp signed and encrypted message to jid
+.RE
+.RE
+.PP
+\fB\-m monitor\fR
+.RS 4
+Monitot mode
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBstanza\fR
+\- Stanza Monitor
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBmonitor\fR
+\- microblog Monitor microblog (XEP\-0277)
+.RE
+.RE
+.PP
+\fB\-m bookmark\fR
+.RS 4
+Bookmark mode (XEP\-0048)
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBlist\fR
+\- List bookmarks
+.RE
+.RE
+.PP
+\fB\-m mam\fR
+.RS 4
+Message Archive Management (XEP\-0313)
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBlist <jid>\fR
+\- List messages from <jid>
+.RE
+.RE
+.PP
+\fB\-m discovery\fR
+.RS 4
+Service Discovery (XEP\-0030)
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBinfo <jid>\fR
+\- info request for <jid>
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBitem <jid>\fR
+\- item request for <jid>
+.RE
+.RE
+.SH "ENVIRONMENT VARIABLES"
+.sp
+*none
+.SH "EXAMPLES"
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+xmppc \-\-jid user@domain\&.tld \-\-pwd "secret" \-\-mode roster list
+xmppc \-\-jid user@domain\&.tld \-\-pwd "secret" \-\-mode pgp chat friend@domain\&.tld "Hello"
+xmppc \-a account1 \-\-mode discovery item conference@domain\&.tld
+xmppc \-\-mode bookmark list
+.fi
+.if n \{\
+.RE
+.\}
+.SH "FILES"
+.sp
+Configuration file to setup accounts\&.
+.PP
+\fB~/\&.config/xmppc\&.conf\fR
+.RS 4
+Example:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+[default]
+jid=account1@domain\&.tld
+pwd=password1
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+[account2]
+jid=account2@domain\&.tld
+pwd=password2
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+[account3]
+jid=account3@domain\&.tld
+pwd=password3
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "EXIT STATUS"
+.PP
+\fB0\fR
+.RS 4
+Success
+.RE
+.PP
+\fB1\fR
+.RS 4
+Failure
+.RE
+.SH "BUGS"
+.sp
+See https://codeberg\&.org/Anoxinon_e\&.V\&./xmppc/issues
+.SH "AUTHOR"
+.sp
+See
+.SH "RESOURCES"
+.sp
+Codeberg: https://codeberg\&.org/Anoxinon_e\&.V\&./xmppc
+.SH "COPYING"
+.sp
+Copyright (C) 2020 Anoxinon e\&.V\&. Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.
doc/xmppc.1.html 🔗
@@ -0,0 +1,1065 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 8.6.10" />
+<title>XMPPC(1)</title>
+<style type="text/css">
+/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
+
+/* Default font. */
+body {
+ font-family: Georgia,serif;
+}
+
+/* Title font. */
+h1, h2, h3, h4, h5, h6,
+div.title, caption.title,
+thead, p.table.header,
+#toctitle,
+#author, #revnumber, #revdate, #revremark,
+#footer {
+ font-family: Arial,Helvetica,sans-serif;
+}
+
+body {
+ margin: 1em 5% 1em 5%;
+}
+
+a {
+ color: blue;
+ text-decoration: underline;
+}
+a:visited {
+ color: fuchsia;
+}
+
+em {
+ font-style: italic;
+ color: navy;
+}
+
+strong {
+ font-weight: bold;
+ color: #083194;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ color: #527bbd;
+ margin-top: 1.2em;
+ margin-bottom: 0.5em;
+ line-height: 1.3;
+}
+
+h1, h2, h3 {
+ border-bottom: 2px solid silver;
+}
+h2 {
+ padding-top: 0.5em;
+}
+h3 {
+ float: left;
+}
+h3 + * {
+ clear: left;
+}
+h5 {
+ font-size: 1.0em;
+}
+
+div.sectionbody {
+ margin-left: 0;
+}
+
+hr {
+ border: 1px solid silver;
+}
+
+p {
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
+}
+
+ul, ol, li > p {
+ margin-top: 0;
+}
+ul > li { color: #aaa; }
+ul > li > * { color: black; }
+
+.monospaced, code, pre {
+ font-family: "Courier New", Courier, monospace;
+ font-size: inherit;
+ color: navy;
+ padding: 0;
+ margin: 0;
+}
+pre {
+ white-space: pre-wrap;
+}
+
+#author {
+ color: #527bbd;
+ font-weight: bold;
+ font-size: 1.1em;
+}
+#email {
+}
+#revnumber, #revdate, #revremark {
+}
+
+#footer {
+ font-size: small;
+ border-top: 2px solid silver;
+ padding-top: 0.5em;
+ margin-top: 4.0em;
+}
+#footer-text {
+ float: left;
+ padding-bottom: 0.5em;
+}
+#footer-badges {
+ float: right;
+ padding-bottom: 0.5em;
+}
+
+#preamble {
+ margin-top: 1.5em;
+ margin-bottom: 1.5em;
+}
+div.imageblock, div.exampleblock, div.verseblock,
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
+div.admonitionblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
+}
+div.admonitionblock {
+ margin-top: 2.0em;
+ margin-bottom: 2.0em;
+ margin-right: 10%;
+ color: #606060;
+}
+
+div.content { /* Block element content. */
+ padding: 0;
+}
+
+/* Block element titles. */
+div.title, caption.title {
+ color: #527bbd;
+ font-weight: bold;
+ text-align: left;
+ margin-top: 1.0em;
+ margin-bottom: 0.5em;
+}
+div.title + * {
+ margin-top: 0;
+}
+
+td div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content + div.title {
+ margin-top: 0.0em;
+}
+
+div.sidebarblock > div.content {
+ background: #ffffee;
+ border: 1px solid #dddddd;
+ border-left: 4px solid #f0f0f0;
+ padding: 0.5em;
+}
+
+div.listingblock > div.content {
+ border: 1px solid #dddddd;
+ border-left: 5px solid #f0f0f0;
+ background: #f8f8f8;
+ padding: 0.5em;
+}
+
+div.quoteblock, div.verseblock {
+ padding-left: 1.0em;
+ margin-left: 1.0em;
+ margin-right: 10%;
+ border-left: 5px solid #f0f0f0;
+ color: #888;
+}
+
+div.quoteblock > div.attribution {
+ padding-top: 0.5em;
+ text-align: right;
+}
+
+div.verseblock > pre.content {
+ font-family: inherit;
+ font-size: inherit;
+}
+div.verseblock > div.attribution {
+ padding-top: 0.75em;
+ text-align: left;
+}
+/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
+div.verseblock + div.attribution {
+ text-align: left;
+}
+
+div.admonitionblock .icon {
+ vertical-align: top;
+ font-size: 1.1em;
+ font-weight: bold;
+ text-decoration: underline;
+ color: #527bbd;
+ padding-right: 0.5em;
+}
+div.admonitionblock td.content {
+ padding-left: 0.5em;
+ border-left: 3px solid #dddddd;
+}
+
+div.exampleblock > div.content {
+ border-left: 3px solid #dddddd;
+ padding-left: 0.5em;
+}
+
+div.imageblock div.content { padding-left: 0; }
+span.image img { border-style: none; vertical-align: text-bottom; }
+a.image:visited { color: white; }
+
+dl {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+dt {
+ margin-top: 0.5em;
+ margin-bottom: 0;
+ font-style: normal;
+ color: navy;
+}
+dd > *:first-child {
+ margin-top: 0.1em;
+}
+
+ul, ol {
+ list-style-position: outside;
+}
+ol.arabic {
+ list-style-type: decimal;
+}
+ol.loweralpha {
+ list-style-type: lower-alpha;
+}
+ol.upperalpha {
+ list-style-type: upper-alpha;
+}
+ol.lowerroman {
+ list-style-type: lower-roman;
+}
+ol.upperroman {
+ list-style-type: upper-roman;
+}
+
+div.compact ul, div.compact ol,
+div.compact p, div.compact p,
+div.compact div, div.compact div {
+ margin-top: 0.1em;
+ margin-bottom: 0.1em;
+}
+
+tfoot {
+ font-weight: bold;
+}
+td > div.verse {
+ white-space: pre;
+}
+
+div.hdlist {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+div.hdlist tr {
+ padding-bottom: 15px;
+}
+dt.hdlist1.strong, td.hdlist1.strong {
+ font-weight: bold;
+}
+td.hdlist1 {
+ vertical-align: top;
+ font-style: normal;
+ padding-right: 0.8em;
+ color: navy;
+}
+td.hdlist2 {
+ vertical-align: top;
+}
+div.hdlist.compact tr {
+ margin: 0;
+ padding-bottom: 0;
+}
+
+.comment {
+ background: yellow;
+}
+
+.footnote, .footnoteref {
+ font-size: 0.8em;
+}
+
+span.footnote, span.footnoteref {
+ vertical-align: super;
+}
+
+#footnotes {
+ margin: 20px 0 20px 0;
+ padding: 7px 0 0 0;
+}
+
+#footnotes div.footnote {
+ margin: 0 0 5px 0;
+}
+
+#footnotes hr {
+ border: none;
+ border-top: 1px solid silver;
+ height: 1px;
+ text-align: left;
+ margin-left: 0;
+ width: 20%;
+ min-width: 100px;
+}
+
+div.colist td {
+ padding-right: 0.5em;
+ padding-bottom: 0.3em;
+ vertical-align: top;
+}
+div.colist td img {
+ margin-top: 0.3em;
+}
+
+@media print {
+ #footer-badges { display: none; }
+}
+
+#toc {
+ margin-bottom: 2.5em;
+}
+
+#toctitle {
+ color: #527bbd;
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 1.0em;
+ margin-bottom: 0.1em;
+}
+
+div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+div.toclevel2 {
+ margin-left: 2em;
+ font-size: 0.9em;
+}
+div.toclevel3 {
+ margin-left: 4em;
+ font-size: 0.9em;
+}
+div.toclevel4 {
+ margin-left: 6em;
+ font-size: 0.9em;
+}
+
+span.aqua { color: aqua; }
+span.black { color: black; }
+span.blue { color: blue; }
+span.fuchsia { color: fuchsia; }
+span.gray { color: gray; }
+span.green { color: green; }
+span.lime { color: lime; }
+span.maroon { color: maroon; }
+span.navy { color: navy; }
+span.olive { color: olive; }
+span.purple { color: purple; }
+span.red { color: red; }
+span.silver { color: silver; }
+span.teal { color: teal; }
+span.white { color: white; }
+span.yellow { color: yellow; }
+
+span.aqua-background { background: aqua; }
+span.black-background { background: black; }
+span.blue-background { background: blue; }
+span.fuchsia-background { background: fuchsia; }
+span.gray-background { background: gray; }
+span.green-background { background: green; }
+span.lime-background { background: lime; }
+span.maroon-background { background: maroon; }
+span.navy-background { background: navy; }
+span.olive-background { background: olive; }
+span.purple-background { background: purple; }
+span.red-background { background: red; }
+span.silver-background { background: silver; }
+span.teal-background { background: teal; }
+span.white-background { background: white; }
+span.yellow-background { background: yellow; }
+
+span.big { font-size: 2em; }
+span.small { font-size: 0.6em; }
+
+span.underline { text-decoration: underline; }
+span.overline { text-decoration: overline; }
+span.line-through { text-decoration: line-through; }
+
+div.unbreakable { page-break-inside: avoid; }
+
+
+/*
+ * xhtml11 specific
+ *
+ * */
+
+div.tableblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
+}
+div.tableblock > table {
+ border: 3px solid #527bbd;
+}
+thead, p.table.header {
+ font-weight: bold;
+ color: #527bbd;
+}
+p.table {
+ margin-top: 0;
+}
+/* Because the table frame attribute is overriden by CSS in most browsers. */
+div.tableblock > table[frame="void"] {
+ border-style: none;
+}
+div.tableblock > table[frame="hsides"] {
+ border-left-style: none;
+ border-right-style: none;
+}
+div.tableblock > table[frame="vsides"] {
+ border-top-style: none;
+ border-bottom-style: none;
+}
+
+
+/*
+ * html5 specific
+ *
+ * */
+
+table.tableblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
+}
+thead, p.tableblock.header {
+ font-weight: bold;
+ color: #527bbd;
+}
+p.tableblock {
+ margin-top: 0;
+}
+table.tableblock {
+ border-width: 3px;
+ border-spacing: 0px;
+ border-style: solid;
+ border-color: #527bbd;
+ border-collapse: collapse;
+}
+th.tableblock, td.tableblock {
+ border-width: 1px;
+ padding: 4px;
+ border-style: solid;
+ border-color: #527bbd;
+}
+
+table.tableblock.frame-topbot {
+ border-left-style: hidden;
+ border-right-style: hidden;
+}
+table.tableblock.frame-sides {
+ border-top-style: hidden;
+ border-bottom-style: hidden;
+}
+table.tableblock.frame-none {
+ border-style: hidden;
+}
+
+th.tableblock.halign-left, td.tableblock.halign-left {
+ text-align: left;
+}
+th.tableblock.halign-center, td.tableblock.halign-center {
+ text-align: center;
+}
+th.tableblock.halign-right, td.tableblock.halign-right {
+ text-align: right;
+}
+
+th.tableblock.valign-top, td.tableblock.valign-top {
+ vertical-align: top;
+}
+th.tableblock.valign-middle, td.tableblock.valign-middle {
+ vertical-align: middle;
+}
+th.tableblock.valign-bottom, td.tableblock.valign-bottom {
+ vertical-align: bottom;
+}
+
+
+/*
+ * manpage specific
+ *
+ * */
+
+body.manpage h1 {
+ padding-top: 0.5em;
+ padding-bottom: 0.5em;
+ border-top: 2px solid silver;
+ border-bottom: 2px solid silver;
+}
+body.manpage h2 {
+ border-style: none;
+}
+body.manpage div.sectionbody {
+ margin-left: 3em;
+}
+
+@media print {
+ body.manpage div#toc { display: none; }
+}
+
+
+</style>
+<script type="text/javascript">
+/*<+'])');
+ // Function that scans the DOM tree for header elements (the DOM2
+ // nodeIterator API would be a better technique but not supported by all
+ // browsers).
+ var iterate = function (el) {
+ for (var i = el.firstChild; i != null; i = i.nextSibling) {
+ if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
+ var mo = re.exec(i.tagName);
+ if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
+ result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
+ }
+ iterate(i);
+ }
+ }
+ }
+ iterate(el);
+ return result;
+ }
+
+ var toc = document.getElementById("toc");
+ if (!toc) {
+ return;
+ }
+
+ // Delete existing TOC entries in case we're reloading the TOC.
+ var tocEntriesToRemove = [];
+ var i;
+ for (i = 0; i < toc.childNodes.length; i++) {
+ var entry = toc.childNodes[i];
+ if (entry.nodeName.toLowerCase() == 'div'
+ && entry.getAttribute("class")
+ && entry.getAttribute("class").match(/^toclevel/))
+ tocEntriesToRemove.push(entry);
+ }
+ for (i = 0; i < tocEntriesToRemove.length; i++) {
+ toc.removeChild(tocEntriesToRemove[i]);
+ }
+
+ // Rebuild TOC entries.
+ var entries = tocEntries(document.getElementById("content"), toclevels);
+ for (var i = 0; i < entries.length; ++i) {
+ var entry = entries[i];
+ if (entry.element.id == "")
+ entry.element.id = "_toc_" + i;
+ var a = document.createElement("a");
+ a.href = "#" + entry.element.id;
+ a.appendChild(document.createTextNode(entry.text));
+ var div = document.createElement("div");
+ div.appendChild(a);
+ div.className = "toclevel" + entry.toclevel;
+ toc.appendChild(div);
+ }
+ if (entries.length == 0)
+ toc.parentNode.removeChild(toc);
+},
+
+
+/////////////////////////////////////////////////////////////////////
+// Footnotes generator
+/////////////////////////////////////////////////////////////////////
+
+/* Based on footnote generation code from:
+ * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
+ */
+
+footnotes: function () {
+ // Delete existing footnote entries in case we're reloading the footnodes.
+ var i;
+ var noteholder = document.getElementById("footnotes");
+ if (!noteholder) {
+ return;
+ }
+ var entriesToRemove = [];
+ for (i = 0; i < noteholder.childNodes.length; i++) {
+ var entry = noteholder.childNodes[i];
+ if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
+ entriesToRemove.push(entry);
+ }
+ for (i = 0; i < entriesToRemove.length; i++) {
+ noteholder.removeChild(entriesToRemove[i]);
+ }
+
+ // Rebuild footnote entries.
+ var cont = document.getElementById("content");
+ var spans = cont.getElementsByTagName("span");
+ var refs = {};
+ var n = 0;
+ for (i=0; i<spans.length; i++) {
+ if (spans[i].className == "footnote") {
+ n++;
+ var note = spans[i].getAttribute("data-note");
+ if (!note) {
+ // Use [\s\S] in place of . so multi-line matches work.
+ // Because JavaScript has no s (dotall) regex flag.
+ note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
+ spans[i].innerHTML =
+ "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
+ "' title='View footnote' class='footnote'>" + n + "</a>]";
+ spans[i].setAttribute("data-note", note);
+ }
+ noteholder.innerHTML +=
+ "<div class='footnote' id='_footnote_" + n + "'>" +
+ "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
+ n + "</a>. " + note + "</div>";
+ var id =spans[i].getAttribute("id");
+ if (id != null) refs["#"+id] = n;
+ }
+ }
+ if (n == 0)
+ noteholder.parentNode.removeChild(noteholder);
+ else {
+ // Process footnoterefs.
+ for (i=0; i<spans.length; i++) {
+ if (spans[i].className == "footnoteref") {
+ var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
+ href = href.match(/#.*/)[0]; // Because IE return full URL.
+ n = refs[href];
+ spans[i].innerHTML =
+ "[<a href='#_footnote_" + n +
+ "' title='View footnote' class='footnote'>" + n + "</a>]";
+ }
+ }
+ }
+},
+
+install: function(toclevels) {
+ var timerId;
+
+ function reinstall() {
+ asciidoc.footnotes();
+ if (toclevels) {
+ asciidoc.toc(toclevels);
+ }
+ }
+
+ function reinstallAndRemoveTimer() {
+ clearInterval(timerId);
+ reinstall();
+ }
+
+ timerId = setInterval(reinstall, 500);
+ if (document.addEventListener)
+ document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
+ else
+ window.onload = reinstallAndRemoveTimer;
+}
+
+}
+asciidoc.install();
+/*]]>*/
+</script>
+</head>
+<body class="article">
+<div id="header">
+<h1>XMPPC(1)</h1>
+</div>
+<div id="content">
+<div class="sect1">
+<h2 id="_name">NAME</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>xmppc - XMPP Command line Tool</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_synopsis">SYNOPSIS</h2>
+<div class="sectionbody">
+<div class="paragraph"><p><em>xmppc</em> [<em>OPTIONS</em>] -m <em>MODE</em> <em>COMMAND</em> [<args>…]</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_description">DESCRIPTION</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>xmppc is a command line tool</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_options">OPTIONS</h2>
+<div class="sectionbody">
+<div class="dlist"><dl>
+<dt class="hdlist1">
+<strong>-a, --attribute</strong> <em>ACCOUNT</em>
+</dt>
+<dd>
+<p>
+ <em>ACCOUNT</em> is an xmpp account…
+</p>
+</dd>
+<dt class="hdlist1">
+<strong>-j, --jid</strong> <em>JID</em>
+</dt>
+<dd>
+<p>
+ JID of the XMPP Account.
+[
+</p>
+</dd>
+<dt class="hdlist1">
+<strong>-p, --pwd</strong> <em>PWD</em>
+</dt>
+<dt class="hdlist1">
+<strong>-v</strong> <em>VERBOSE</em>
+</dt>
+<dd>
+<p>
+ Verbose flags. -v WARN -vv INFO --vvv DEBUG -vvvv TRACE
+</p>
+</dd>
+<dt class="hdlist1">
+<strong>--help</strong>
+</dt>
+<dd>
+<p>
+ Print program version number and help
+</p>
+</dd>
+</dl></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_modes_and_commands">MODES AND COMMANDS</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>xmppc modes.</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+<strong>-m roster</strong>:: Roster
+</dt>
+<dd>
+<div class="ulist"><ul>
+<li>
+<p>
+<strong>list</strong> - List all contacts
+</p>
+</li>
+<li>
+<p>
+<strong>export</strong> - Exports all contacts
+</p>
+</li>
+</ul></div>
+</dd>
+<dt class="hdlist1">
+<strong>-m message</strong>
+</dt>
+<dd>
+<p>
+Message
+</p>
+<div class="ulist"><ul>
+<li>
+<p>
+<strong>chat <jid> <message></strong> - Sending unencrypted message to jid
+</p>
+</li>
+</ul></div>
+</dd>
+<dt class="hdlist1">
+<strong>-m pgp</strong>
+</dt>
+<dd>
+<p>
+PGP Mode (XEP-0027)
+</p>
+<div class="ulist"><ul>
+<li>
+<p>
+<strong>chat <jid> <message></strong> - Sending pgp encrypted message to jid
+</p>
+</li>
+</ul></div>
+</dd>
+<dt class="hdlist1">
+<strong>-m omemo</strong>
+</dt>
+<dd>
+<p>
+OMEMO Mode (XEP-0384)
+</p>
+<div class="ulist"><ul>
+<li>
+<p>
+<strong>list</strong> - List the device IDs and fingerprints
+</p>
+</li>
+</ul></div>
+</dd>
+<dt class="hdlist1">
+<strong>-m openpgp</strong>
+</dt>
+<dd>
+<p>
+openpgp mode (XEP-0373)
+</p>
+<div class="ulist"><ul>
+<li>
+<p>
+<strong>signcrypt <jid> <message></strong> - Sending pgp signed and encrypted message to jid
+</p>
+</li>
+</ul></div>
+</dd>
+<dt class="hdlist1">
+<strong>-m monitor</strong>
+</dt>
+<dd>
+<p>
+Monitot mode
+</p>
+<div class="ulist"><ul>
+<li>
+<p>
+<strong>stanza</strong> - Stanza Monitor
+</p>
+</li>
+<li>
+<p>
+<strong>monitor</strong> - microblog Monitor microblog (XEP-0277)
+</p>
+</li>
+</ul></div>
+</dd>
+<dt class="hdlist1">
+<strong>-m bookmark</strong>
+</dt>
+<dd>
+<p>
+Bookmark mode (XEP-0048)
+</p>
+<div class="ulist"><ul>
+<li>
+<p>
+<strong>list</strong> - List bookmarks
+</p>
+</li>
+</ul></div>
+</dd>
+<dt class="hdlist1">
+<strong>-m mam</strong>
+</dt>
+<dd>
+<p>
+Message Archive Management (XEP-0313)
+</p>
+<div class="ulist"><ul>
+<li>
+<p>
+<strong>list <jid></strong> - List messages from <jid>
+</p>
+</li>
+</ul></div>
+</dd>
+<dt class="hdlist1">
+<strong>-m discovery</strong>
+</dt>
+<dd>
+<p>
+Service Discovery (XEP-0030)
+</p>
+<div class="ulist"><ul>
+<li>
+<p>
+<strong>info <jid></strong> - info request for <jid>
+</p>
+</li>
+<li>
+<p>
+<strong>item <jid></strong> - item request for <jid>
+</p>
+</li>
+</ul></div>
+</dd>
+</dl></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_environment_variables">ENVIRONMENT VARIABLES</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>*none</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_examples">EXAMPLES</h2>
+<div class="sectionbody">
+<div class="literalblock">
+<div class="content">
+<pre><code>xmppc --jid user@domain.tld --pwd "secret" --mode roster list
+xmppc --jid user@domain.tld --pwd "secret" --mode pgp chat friend@domain.tld "Hello"
+xmppc -a account1 --mode discovery item conference@domain.tld
+xmppc --mode bookmark list</code></pre>
+</div></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_files">FILES</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>Configuration file to setup accounts.</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+<strong>~/.config/xmppc.conf</strong>
+</dt>
+<dd>
+<p>
+Example:
+</p>
+<div class="literalblock">
+<div class="content">
+<pre><code>[default]
+jid=account1@domain.tld
+pwd=password1</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>[account2]
+jid=account2@domain.tld
+pwd=password2</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>[account3]
+jid=account3@domain.tld
+pwd=password3</code></pre>
+</div></div>
+</dd>
+</dl></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_exit_status">EXIT STATUS</h2>
+<div class="sectionbody">
+<div class="dlist"><dl>
+<dt class="hdlist1">
+<strong>0</strong>
+</dt>
+<dd>
+<p>
+ Success
+</p>
+</dd>
+<dt class="hdlist1">
+<strong>1</strong>
+</dt>
+<dd>
+<p>
+ Failure
+</p>
+</dd>
+</dl></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_bugs">BUGS</h2>
+<div class="sectionbody">
+<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>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_author">AUTHOR</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>See</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_resources">RESOURCES</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>Codeberg: <a href="https://codeberg.org/Anoxinon_e.V./xmppc">https://codeberg.org/Anoxinon_e.V./xmppc</a></p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_copying">COPYING</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>Copyright (C) 2020 Anoxinon e.V. Free use of this software is
+granted under the terms of the GNU General Public License (GPL).</p></div>
+</div>
+</div>
+</div>
+<div id="footnotes"><hr /></div>
+<div id="footer">
+<div id="footer-text">
+Last updated
+ 2020-04-29 19:16:17 CEST
+</div>
+</div>
+</body>
+</html>
doc/xmppc.1.txt 🔗
@@ -0,0 +1,139 @@
+XMPPC(1)
+========
+
+NAME
+----
+xmppc - XMPP Command line Tool
+
+
+SYNOPSIS
+--------
+'xmppc' ['OPTIONS'] -m 'MODE' 'COMMAND' [<args>...]
+
+
+DESCRIPTION
+-----------
+xmppc is a command line tool
+
+OPTIONS
+-------
+*-a, --attribute* 'ACCOUNT'::
+ 'ACCOUNT' is an xmpp account...
+
+*-j, --jid* 'JID'::
+ JID of the XMPP Account.
+[
+*-p, --pwd* 'PWD'::
+
+*-v* 'VERBOSE'::
+ Verbose flags. -v WARN -vv INFO --vvv DEBUG -vvvv TRACE
+
+*--help*::
+ Print program version number and help
+
+
+MODES AND COMMANDS
+------------------
+xmppc modes.
+
+*-m roster*:: Roster::
+
+* *list* - List all contacts
+* *export* - Exports all contacts
+
+*-m message*:: Message
+
+* *chat <jid> <message>* - Sending unencrypted message to jid
+
+*-m pgp*:: PGP Mode (XEP-0027)
+
+* *chat <jid> <message>* - Sending pgp encrypted message to jid
+
+*-m omemo*:: OMEMO Mode (XEP-0384)
+
+* *list* - List the device IDs and fingerprints
+
+*-m openpgp*:: openpgp mode (XEP-0373)
+
+* *signcrypt <jid> <message>* - Sending pgp signed and encrypted message to jid
+
+*-m monitor*:: Monitot mode
+
+* *stanza* - Stanza Monitor
+* *monitor* - microblog Monitor microblog (XEP-0277)
+
+*-m bookmark*:: Bookmark mode (XEP-0048)
+
+* *list* - List bookmarks
+
+*-m mam*:: Message Archive Management (XEP-0313)
+
+* *list <jid>* - List messages from <jid>
+
+*-m discovery*:: Service Discovery (XEP-0030)
+
+* *info <jid>* - info request for <jid>
+* *item <jid>* - item request for <jid>
+
+
+ENVIRONMENT VARIABLES
+---------------------
+
+*none
+
+
+EXAMPLES
+--------
+ xmppc --jid user@domain.tld --pwd "secret" --mode roster list
+ xmppc --jid user@domain.tld --pwd "secret" --mode pgp chat friend@domain.tld "Hello"
+ xmppc -a account1 --mode discovery item conference@domain.tld
+ xmppc --mode bookmark list
+
+
+FILES
+-----
+Configuration file to setup accounts.
+
+*~/.config/xmppc.conf*::
+Example:
+
+
+ [default]
+ jid=account1@domain.tld
+ pwd=password1
+
+ [account2]
+ jid=account2@domain.tld
+ pwd=password2
+
+ [account3]
+ jid=account3@domain.tld
+ pwd=password3
+
+EXIT STATUS
+-----------
+*0*::
+ Success
+
+*1*::
+ Failure
+
+
+BUGS
+----
+See <https://codeberg.org/Anoxinon_e.V./xmppc/issues>
+
+
+AUTHOR
+------
+See
+
+RESOURCES
+---------
+Codeberg: <https://codeberg.org/Anoxinon_e.V./xmppc>
+
+
+COPYING
+-------
+Copyright \(C) 2020 Anoxinon e.V. Free use of this software is
+granted under the terms of the GNU General Public License (GPL).