From b9dc268036a515b397904968877e8bbe4cd2cc10 Mon Sep 17 00:00:00 2001 From: DebXWoody Date: Wed, 29 Apr 2020 19:18:24 +0200 Subject: [PATCH] manpage for xmppc 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: #6 --- doc/Makefile | 6 +- doc/xmppc.1 | 392 ++++++++++++++--- doc/xmppc.1.html | 1065 ++++++++++++++++++++++++++++++++++++++++++++++ doc/xmppc.1.txt | 139 ++++++ 4 files changed, 1538 insertions(+), 64 deletions(-) create mode 100644 doc/xmppc.1.html create mode 100644 doc/xmppc.1.txt diff --git a/doc/Makefile b/doc/Makefile index 6cce1f8..aa5d32f 100644 --- a/doc/Makefile +++ b/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) diff --git a/doc/xmppc.1 b/doc/xmppc.1 index e2ede57..5d01c3c 100644 --- a/doc/xmppc.1 +++ b/doc/xmppc.1 @@ -1,68 +1,334 @@ '\" t +.\" Title: xmppc +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" 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 " " -.BR \-p " " -.BR \-m " " -.BR command -.OP args -. -.SY xmppc -.BR \-h -. -.SY xmppc -.BR \-v -.YS -. -.\" --------------------------------------------------------------------------- -.SH DESCRIPTION +.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 [\&...] +.SH "DESCRIPTION" +.sp +xmppc is a command line tool +.SH "OPTIONS" .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 -Send a message to jid -. -.SS OMEMO -.TP -.B list -Device IDs and Fingerprints -. -.\" --------------------------------------------------------------------------- -.SH ENVIRONMENT -.\" --------------------------------------------------------------------------- -.SH FILES -.\" --------------------------------------------------------------------------- -.SH BUGS +\fB\-a, \-\-attribute\fR \fIACCOUNT\fR +.RS 4 +\fIACCOUNT\fR +is an xmpp account\&... +.RE .PP -Issue tracker: -.\" --------------------------------------------------------------------------- -.SH SEE ALSO +\fB\-j, \-\-jid\fR \fIJID\fR +.RS 4 +JID of the XMPP Account\&. [ +.RE .PP -.BR gnupg (1) - +\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 \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 \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 \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 \fR +\- List messages from +.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 \fR +\- info request for +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBitem \fR +\- item request for +.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)\&. diff --git a/doc/xmppc.1.html b/doc/xmppc.1.html new file mode 100644 index 0000000..d2354e7 --- /dev/null +++ b/doc/xmppc.1.html @@ -0,0 +1,1065 @@ + + + + + + +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).

+
+
+
+
+ + + diff --git a/doc/xmppc.1.txt b/doc/xmppc.1.txt new file mode 100644 index 0000000..2f472bb --- /dev/null +++ b/doc/xmppc.1.txt @@ -0,0 +1,139 @@ +XMPPC(1) +======== + +NAME +---- +xmppc - XMPP Command line Tool + + +SYNOPSIS +-------- +'xmppc' ['OPTIONS'] -m 'MODE' 'COMMAND' [...] + + +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 * - Sending unencrypted message to jid + +*-m pgp*:: PGP Mode (XEP-0027) + +* *chat * - 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 * - 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 * - List messages from + +*-m discovery*:: Service Discovery (XEP-0030) + +* *info * - info request for +* *item * - item request for + + +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 + + +AUTHOR +------ +See + +RESOURCES +--------- +Codeberg: + + +COPYING +------- +Copyright \(C) 2020 Anoxinon e.V. Free use of this software is +granted under the terms of the GNU General Public License (GPL).