xmppc.1

  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: 04/29/2020
  6.\"    Manual: \ \&
  7.\"    Source: \ \&
  8.\"  Language: English
  9.\"
 10.TH "XMPPC" "1" "04/29/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.SH "DESCRIPTION"
 36.sp
 37xmppc is a command line tool
 38.SH "OPTIONS"
 39.PP
 40\fB\-a, \-\-attribute\fR \fIACCOUNT\fR
 41.RS 4
 42\fIACCOUNT\fR
 43is an xmpp account\&...
 44.RE
 45.PP
 46\fB\-j, \-\-jid\fR \fIJID\fR
 47.RS 4
 48JID of the XMPP Account\&. [
 49.RE
 50.PP
 51\fB\-p, \-\-pwd\fR \fIPWD\fR, \fB\-v\fR \fIVERBOSE\fR
 52.RS 4
 53Verbose flags\&. \-v WARN \-vv INFO \-\-vvv DEBUG \-vvvv TRACE
 54.RE
 55.PP
 56\fB\-\-help\fR
 57.RS 4
 58Print program version number and help
 59.RE
 60.SH "MODES AND COMMANDS"
 61.sp
 62xmppc modes\&.
 63.PP
 64\fB\-m roster\fR:: Roster
 65.RS 4
 66.sp
 67.RS 4
 68.ie n \{\
 69\h'-04'\(bu\h'+03'\c
 70.\}
 71.el \{\
 72.sp -1
 73.IP \(bu 2.3
 74.\}
 75\fBlist\fR
 76\- List all contacts
 77.RE
 78.sp
 79.RS 4
 80.ie n \{\
 81\h'-04'\(bu\h'+03'\c
 82.\}
 83.el \{\
 84.sp -1
 85.IP \(bu 2.3
 86.\}
 87\fBexport\fR
 88\- Exports all contacts
 89.RE
 90.RE
 91.PP
 92\fB\-m message\fR
 93.RS 4
 94Message
 95.sp
 96.RS 4
 97.ie n \{\
 98\h'-04'\(bu\h'+03'\c
 99.\}
100.el \{\
101.sp -1
102.IP \(bu 2.3
103.\}
104\fBchat <jid> <message>\fR
105\- Sending unencrypted message to jid
106.RE
107.RE
108.PP
109\fB\-m pgp\fR
110.RS 4
111PGP Mode (XEP\-0027)
112.sp
113.RS 4
114.ie n \{\
115\h'-04'\(bu\h'+03'\c
116.\}
117.el \{\
118.sp -1
119.IP \(bu 2.3
120.\}
121\fBchat <jid> <message>\fR
122\- Sending pgp encrypted message to jid
123.RE
124.RE
125.PP
126\fB\-m omemo\fR
127.RS 4
128OMEMO Mode (XEP\-0384)
129.sp
130.RS 4
131.ie n \{\
132\h'-04'\(bu\h'+03'\c
133.\}
134.el \{\
135.sp -1
136.IP \(bu 2.3
137.\}
138\fBlist\fR
139\- List the device IDs and fingerprints
140.RE
141.RE
142.PP
143\fB\-m openpgp\fR
144.RS 4
145openpgp mode (XEP\-0373)
146.sp
147.RS 4
148.ie n \{\
149\h'-04'\(bu\h'+03'\c
150.\}
151.el \{\
152.sp -1
153.IP \(bu 2.3
154.\}
155\fBsigncrypt <jid> <message>\fR
156\- Sending pgp signed and encrypted message to jid
157.RE
158.RE
159.PP
160\fB\-m monitor\fR
161.RS 4
162Monitot mode
163.sp
164.RS 4
165.ie n \{\
166\h'-04'\(bu\h'+03'\c
167.\}
168.el \{\
169.sp -1
170.IP \(bu 2.3
171.\}
172\fBstanza\fR
173\- Stanza Monitor
174.RE
175.sp
176.RS 4
177.ie n \{\
178\h'-04'\(bu\h'+03'\c
179.\}
180.el \{\
181.sp -1
182.IP \(bu 2.3
183.\}
184\fBmonitor\fR
185\- microblog Monitor microblog (XEP\-0277)
186.RE
187.RE
188.PP
189\fB\-m bookmark\fR
190.RS 4
191Bookmark mode (XEP\-0048)
192.sp
193.RS 4
194.ie n \{\
195\h'-04'\(bu\h'+03'\c
196.\}
197.el \{\
198.sp -1
199.IP \(bu 2.3
200.\}
201\fBlist\fR
202\- List bookmarks
203.RE
204.RE
205.PP
206\fB\-m mam\fR
207.RS 4
208Message Archive Management (XEP\-0313)
209.sp
210.RS 4
211.ie n \{\
212\h'-04'\(bu\h'+03'\c
213.\}
214.el \{\
215.sp -1
216.IP \(bu 2.3
217.\}
218\fBlist <jid>\fR
219\- List messages from <jid>
220.RE
221.RE
222.PP
223\fB\-m discovery\fR
224.RS 4
225Service Discovery (XEP\-0030)
226.sp
227.RS 4
228.ie n \{\
229\h'-04'\(bu\h'+03'\c
230.\}
231.el \{\
232.sp -1
233.IP \(bu 2.3
234.\}
235\fBinfo <jid>\fR
236\- info request for <jid>
237.RE
238.sp
239.RS 4
240.ie n \{\
241\h'-04'\(bu\h'+03'\c
242.\}
243.el \{\
244.sp -1
245.IP \(bu 2.3
246.\}
247\fBitem <jid>\fR
248\- item request for <jid>
249.RE
250.RE
251.SH "ENVIRONMENT VARIABLES"
252.sp
253*none
254.SH "EXAMPLES"
255.sp
256.if n \{\
257.RS 4
258.\}
259.nf
260xmppc \-\-jid user@domain\&.tld \-\-pwd "secret" \-\-mode roster list
261xmppc \-\-jid user@domain\&.tld \-\-pwd "secret" \-\-mode pgp chat friend@domain\&.tld "Hello"
262xmppc \-a account1 \-\-mode discovery item conference@domain\&.tld
263xmppc \-\-mode bookmark list
264.fi
265.if n \{\
266.RE
267.\}
268.SH "FILES"
269.sp
270Configuration file to setup accounts\&.
271.PP
272\fB~/\&.config/xmppc\&.conf\fR
273.RS 4
274Example:
275.sp
276.if n \{\
277.RS 4
278.\}
279.nf
280[default]
281jid=account1@domain\&.tld
282pwd=password1
283.fi
284.if n \{\
285.RE
286.\}
287.sp
288.if n \{\
289.RS 4
290.\}
291.nf
292[account2]
293jid=account2@domain\&.tld
294pwd=password2
295.fi
296.if n \{\
297.RE
298.\}
299.sp
300.if n \{\
301.RS 4
302.\}
303.nf
304[account3]
305jid=account3@domain\&.tld
306pwd=password3
307.fi
308.if n \{\
309.RE
310.\}
311.RE
312.SH "EXIT STATUS"
313.PP
314\fB0\fR
315.RS 4
316Success
317.RE
318.PP
319\fB1\fR
320.RS 4
321Failure
322.RE
323.SH "BUGS"
324.sp
325See https://codeberg\&.org/Anoxinon_e\&.V\&./xmppc/issues
326.SH "AUTHOR"
327.sp
328See
329.SH "RESOURCES"
330.sp
331Codeberg: https://codeberg\&.org/Anoxinon_e\&.V\&./xmppc
332.SH "COPYING"
333.sp
334Copyright (C) 2020 Anoxinon e\&.V\&. Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.