1'\" t
  2.\"     Title: xmppc
  3.\"    Author: [see the "AUTHOR" section]
  4.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
  5.\"      Date: 07/29/2023
  6.\"    Manual: \ \&
  7.\"    Source: \ \&
  8.\"  Language: English
  9.\"
 10.TH "XMPPC" "1" "07/29/2023" "\ \&" "\ \&"
 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.sp
153.RS 4
154.ie n \{\
155\h'-04'\(bu\h'+03'\c
156.\}
157.el \{\
158.sp -1
159.IP \(bu 2.3
160.\}
161\fBdelete\-device\-list\fR
162\- Deletes the OMEMO device list
163.RE
164.RE
165.PP
166\fB\-m openpgp\fR
167.RS 4
168openpgp mode (XEP\-0373)
169.sp
170.RS 4
171.ie n \{\
172\h'-04'\(bu\h'+03'\c
173.\}
174.el \{\
175.sp -1
176.IP \(bu 2.3
177.\}
178\fBsigncrypt <jid> <message>\fR
179\- Sending pgp signed and encrypted message to jid
180.RE
181.RE
182.PP
183\fB\-m monitor\fR
184.RS 4
185Monitot mode
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\fBstanza\fR
196\- Stanza Monitor
197.RE
198.sp
199.RS 4
200.ie n \{\
201\h'-04'\(bu\h'+03'\c
202.\}
203.el \{\
204.sp -1
205.IP \(bu 2.3
206.\}
207\fBmonitor\fR
208\- microblog Monitor microblog (XEP\-0277)
209.RE
210.RE
211.PP
212\fB\-m bookmark\fR
213.RS 4
214Bookmark mode (XEP\-0048)
215.sp
216.RS 4
217.ie n \{\
218\h'-04'\(bu\h'+03'\c
219.\}
220.el \{\
221.sp -1
222.IP \(bu 2.3
223.\}
224\fBlist\fR
225\- List bookmarks
226.RE
227.RE
228.PP
229\fB\-m mam\fR
230.RS 4
231Message Archive Management (XEP\-0313)
232.sp
233.RS 4
234.ie n \{\
235\h'-04'\(bu\h'+03'\c
236.\}
237.el \{\
238.sp -1
239.IP \(bu 2.3
240.\}
241\fBlist <jid>\fR
242\- List messages from <jid>
243.RE
244.RE
245.PP
246\fB\-m discovery\fR
247.RS 4
248Service Discovery (XEP\-0030)
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\fBinfo <jid>\fR
259\- info request for <jid>
260.RE
261.sp
262.RS 4
263.ie n \{\
264\h'-04'\(bu\h'+03'\c
265.\}
266.el \{\
267.sp -1
268.IP \(bu 2.3
269.\}
270\fBitem <jid>\fR
271\- item request for <jid>
272.RE
273.RE
274.SH "ENVIRONMENT VARIABLES"
275.sp
276.RS 4
277.ie n \{\
278\h'-04'\(bu\h'+03'\c
279.\}
280.el \{\
281.sp -1
282.IP \(bu 2.3
283.\}
284HOME
285.RE
286.SH "EXAMPLES"
287.sp
288.if n \{\
289.RS 4
290.\}
291.nf
292xmppc \-\-jid user@domain\&.tld \-\-pwd "secret" \-\-mode roster list
293xmppc \-\-jid user@domain\&.tld \-\-mode pgp chat friend@domain\&.tld "Hello"
294xmppc \-a account1 \-\-mode discovery item conference@domain\&.tld
295xmppc \-\-mode bookmark list
296.fi
297.if n \{\
298.RE
299.\}
300.SH "FILES"
301.sp
302Configuration file to setup accounts\&.
303.PP
304\fB~/\&.config/xmppc\&.conf\fR
305.RS 4
306Example:
307.sp
308.if n \{\
309.RS 4
310.\}
311.nf
312[default]
313jid=account1@domain\&.tld
314pwd=password1
315.fi
316.if n \{\
317.RE
318.\}
319.sp
320.if n \{\
321.RS 4
322.\}
323.nf
324[account2]
325jid=account2@domain\&.tld
326.fi
327.if n \{\
328.RE
329.\}
330.sp
331.if n \{\
332.RS 4
333.\}
334.nf
335[account3]
336jid=account3@domain\&.tld
337pwd=password3
338.fi
339.if n \{\
340.RE
341.\}
342.RE
343.SH "EXIT STATUS"
344.PP
345\fB0\fR
346.RS 4
347Success
348.RE
349.PP
350\fB1\fR
351.RS 4
352Failure
353.RE
354.SH "BUGS"
355.sp
356See https://codeberg\&.org/Anoxinon_e\&.V\&./xmppc/issues
357.SH "AUTHOR"
358.sp
359.RS 4
360.ie n \{\
361\h'-04'\(bu\h'+03'\c
362.\}
363.el \{\
364.sp -1
365.IP \(bu 2.3
366.\}
367DebXWoody
368.RE
369.SH "RESOURCES"
370.sp
371Source: https://codeberg\&.org/Anoxinon_e\&.V\&./xmppc
372.sp
373Documentation: https://codeberg\&.org/Anoxinon_e\&.V\&./xmppc/wiki
374.SH "COPYING"
375.sp
376Copyright (C) 2020 Anoxinon e\&.V\&. Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.