1'\" t
  2.\"     Title: xmppc
  3.\"    Author: [see the "AUTHOR" section]
  4.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5.\"      Date: 05/16/2020
  6.\"    Manual: \ \&
  7.\"    Source: \ \&
  8.\"  Language: English
  9.\"
 10.TH "XMPPC" "1" "05/16/2020" "\ \&" "\ \&"
 11.\" -----------------------------------------------------------------
 12.\" * Define some portability stuff
 13.\" -----------------------------------------------------------------
 14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 15.\" http://bugs.debian.org/507673
 16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
 17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 18.ie \n(.g .ds Aq \(aq
 19.el       .ds Aq '
 20.\" -----------------------------------------------------------------
 21.\" * set default formatting
 22.\" -----------------------------------------------------------------
 23.\" disable hyphenation
 24.nh
 25.\" disable justification (adjust text to left margin only)
 26.ad l
 27.\" -----------------------------------------------------------------
 28.\" * MAIN CONTENT STARTS HERE *
 29.\" -----------------------------------------------------------------
 30.SH "NAME"
 31xmppc \- XMPP Command line Tool
 32.SH "SYNOPSIS"
 33.sp
 34\fIxmppc\fR [\fIOPTIONS\fR] \-m \fIMODE\fR \fICOMMAND\fR [<args>\&...]
 35.sp
 36\fIxmppc\fR [\-a \fIACCOUNT\fR] [\-j \fIJID\fR] [\-p \fIPASSWORD\fR] \-m \fIMODE\fR \fICOMMAND\fR [<args>\&...]
 37.SH "DESCRIPTION"
 38.sp
 39xmppc is a XMPP command line tool\&. You need an XMPP Account to use this tool\&. The account information can be defined via command line argument \-j \fIJID\fR\&. If no password is provided via \-p \fIPASSWORD\fR xmppc will ask the user to enter the password\&. Another option is to define 1 or more accounts within a configuration file\&. The option \-a \fIACCOUNT\fR can be used to select the account\&.
 40.sp
 41The argument \-m \fIMODE\fR defines the xmppc \fIMODE\fR which should be used (roster, message, pgp, omemo, openpgp, monitor, bookmark, mam, discovery)\&. The \fICOMMAND\fR and the args required by the \fICOMMAND\fR depends on the chosen \fIMODE\fR\&.
 42.SH "OPTIONS"
 43.PP
 44\fB\-a, \-\-attribute\fR \fIACCOUNT\fR
 45.RS 4
 46\fIACCOUNT\fR
 47is a name of a xmpp account defined within the configuration file\&.
 48.RE
 49.PP
 50\fB\-j, \-\-jid\fR \fIJID\fR
 51.RS 4
 52\fIJID\fR
 53of the XMPP Account\&.
 54.RE
 55.PP
 56\fB\-p, \-\-pwd\fR \fIPWD\fR
 57.RS 4
 58Password of the XMPP Account\&.
 59.RE
 60.PP
 61\fB\-v\fR \fIVERBOSE\fR, Verbose flags\&. \-v[v[v[v]]]
 62.RS 4
 63\-v is WARN \-vv is INFO \-\-vvv is DEBUG \-vvvv is TRACE
 64.RE
 65.PP
 66\fB\-\-help\fR
 67.RS 4
 68Print program version number and help
 69.RE
 70.SH "MODES AND COMMANDS"
 71.sp
 72xmppc modes\&.
 73.PP
 74\fB\-m roster\fR
 75.RS 4
 76The Roster mode can be used to provided information of the xmpp account\(cqs roster\&. The roster is the XMPP list of contacts\&.
 77.sp
 78.RS 4
 79.ie n \{\
 80\h'-04'\(bu\h'+03'\c
 81.\}
 82.el \{\
 83.sp -1
 84.IP \(bu 2.3
 85.\}
 86\fBlist\fR
 87\- List all contacts
 88.RE
 89.sp
 90.RS 4
 91.ie n \{\
 92\h'-04'\(bu\h'+03'\c
 93.\}
 94.el \{\
 95.sp -1
 96.IP \(bu 2.3
 97.\}
 98\fBexport\fR
 99\- Exports all contacts
100.RE
101.RE
102.PP
103\fB\-m message\fR
104.RS 4
105The message mode can be used to send unencrypted messages to another xmpp account\&.
106.sp
107.RS 4
108.ie n \{\
109\h'-04'\(bu\h'+03'\c
110.\}
111.el \{\
112.sp -1
113.IP \(bu 2.3
114.\}
115\fBchat <jid> <message>\fR
116\- Sending unencrypted message to jid
117.RE
118.RE
119.PP
120\fB\-m pgp\fR
121.RS 4
122PGP Mode (XEP\-0027)
123.sp
124.RS 4
125.ie n \{\
126\h'-04'\(bu\h'+03'\c
127.\}
128.el \{\
129.sp -1
130.IP \(bu 2.3
131.\}
132\fBchat <jid> <message>\fR
133\- Sending pgp encrypted message to jid
134.RE
135.RE
136.PP
137\fB\-m omemo\fR
138.RS 4
139OMEMO Mode (XEP\-0384)
140.sp
141.RS 4
142.ie n \{\
143\h'-04'\(bu\h'+03'\c
144.\}
145.el \{\
146.sp -1
147.IP \(bu 2.3
148.\}
149\fBlist\fR
150\- List the device IDs and fingerprints
151.RE
152.RE
153.PP
154\fB\-m openpgp\fR
155.RS 4
156openpgp mode (XEP\-0373)
157.sp
158.RS 4
159.ie n \{\
160\h'-04'\(bu\h'+03'\c
161.\}
162.el \{\
163.sp -1
164.IP \(bu 2.3
165.\}
166\fBsigncrypt <jid> <message>\fR
167\- Sending pgp signed and encrypted message to jid
168.RE
169.RE
170.PP
171\fB\-m monitor\fR
172.RS 4
173Monitot mode
174.sp
175.RS 4
176.ie n \{\
177\h'-04'\(bu\h'+03'\c
178.\}
179.el \{\
180.sp -1
181.IP \(bu 2.3
182.\}
183\fBstanza\fR
184\- Stanza Monitor
185.RE
186.sp
187.RS 4
188.ie n \{\
189\h'-04'\(bu\h'+03'\c
190.\}
191.el \{\
192.sp -1
193.IP \(bu 2.3
194.\}
195\fBmonitor\fR
196\- microblog Monitor microblog (XEP\-0277)
197.RE
198.RE
199.PP
200\fB\-m bookmark\fR
201.RS 4
202Bookmark mode (XEP\-0048)
203.sp
204.RS 4
205.ie n \{\
206\h'-04'\(bu\h'+03'\c
207.\}
208.el \{\
209.sp -1
210.IP \(bu 2.3
211.\}
212\fBlist\fR
213\- List bookmarks
214.RE
215.RE
216.PP
217\fB\-m mam\fR
218.RS 4
219Message Archive Management (XEP\-0313)
220.sp
221.RS 4
222.ie n \{\
223\h'-04'\(bu\h'+03'\c
224.\}
225.el \{\
226.sp -1
227.IP \(bu 2.3
228.\}
229\fBlist <jid>\fR
230\- List messages from <jid>
231.RE
232.RE
233.PP
234\fB\-m discovery\fR
235.RS 4
236Service Discovery (XEP\-0030)
237.sp
238.RS 4
239.ie n \{\
240\h'-04'\(bu\h'+03'\c
241.\}
242.el \{\
243.sp -1
244.IP \(bu 2.3
245.\}
246\fBinfo <jid>\fR
247\- info request for <jid>
248.RE
249.sp
250.RS 4
251.ie n \{\
252\h'-04'\(bu\h'+03'\c
253.\}
254.el \{\
255.sp -1
256.IP \(bu 2.3
257.\}
258\fBitem <jid>\fR
259\- item request for <jid>
260.RE
261.RE
262.SH "ENVIRONMENT VARIABLES"
263.sp
264.RS 4
265.ie n \{\
266\h'-04'\(bu\h'+03'\c
267.\}
268.el \{\
269.sp -1
270.IP \(bu 2.3
271.\}
272HOME
273.RE
274.SH "EXAMPLES"
275.sp
276.if n \{\
277.RS 4
278.\}
279.nf
280xmppc \-\-jid user@domain\&.tld \-\-pwd "secret" \-\-mode roster list
281xmppc \-\-jid user@domain\&.tld \-\-mode pgp chat friend@domain\&.tld "Hello"
282xmppc \-a account1 \-\-mode discovery item conference@domain\&.tld
283xmppc \-\-mode bookmark list
284.fi
285.if n \{\
286.RE
287.\}
288.SH "FILES"
289.sp
290Configuration file to setup accounts\&.
291.PP
292\fB~/\&.config/xmppc\&.conf\fR
293.RS 4
294Example:
295.sp
296.if n \{\
297.RS 4
298.\}
299.nf
300[default]
301jid=account1@domain\&.tld
302pwd=password1
303.fi
304.if n \{\
305.RE
306.\}
307.sp
308.if n \{\
309.RS 4
310.\}
311.nf
312[account2]
313jid=account2@domain\&.tld
314.fi
315.if n \{\
316.RE
317.\}
318.sp
319.if n \{\
320.RS 4
321.\}
322.nf
323[account3]
324jid=account3@domain\&.tld
325pwd=password3
326.fi
327.if n \{\
328.RE
329.\}
330.RE
331.SH "EXIT STATUS"
332.PP
333\fB0\fR
334.RS 4
335Success
336.RE
337.PP
338\fB1\fR
339.RS 4
340Failure
341.RE
342.SH "BUGS"
343.sp
344See https://codeberg\&.org/Anoxinon_e\&.V\&./xmppc/issues
345.SH "AUTHOR"
346.sp
347.RS 4
348.ie n \{\
349\h'-04'\(bu\h'+03'\c
350.\}
351.el \{\
352.sp -1
353.IP \(bu 2.3
354.\}
355DebXWoody (OpenPGP: A602F76893F138B4A8EFDDD5C2DC916F35751C24)
356.RE
357.SH "RESOURCES"
358.sp
359Source: https://codeberg\&.org/Anoxinon_e\&.V\&./xmppc
360.sp
361Documentation: https://codeberg\&.org/Anoxinon_e\&.V\&./xmppc/wiki
362.SH "COPYING"
363.sp
364Copyright (C) 2020 Anoxinon e\&.V\&. Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.