1XMPPC(1)
2========
3
4NAME
5----
6xmppc - XMPP Command line Tool
7
8
9SYNOPSIS
10--------
11'xmppc' ['OPTIONS'] -m 'MODE' 'COMMAND' [<args>...]
12
13'xmppc' [-a 'ACCOUNT'] [-j 'JID'] [-p 'PASSWORD'] -m 'MODE' 'COMMAND' [<args>...]
14
15
16DESCRIPTION
17-----------
18xmppc is a XMPP command line tool. You need an XMPP Account to use this tool.
19The account information can be defined via command line argument -j 'JID'. If no
20password is provided via -p 'PASSWORD' xmppc will ask the user to enter the
21password. Another option is to define 1 or more accounts within a configuration
22file. The option -a 'ACCOUNT' can be used to select the account.
23
24The argument -m 'MODE' defines the xmppc 'MODE' which should be used (roster,
25message, pgp, omemo, openpgp, monitor, bookmark, mam, discovery). The 'COMMAND'
26and the args required by the 'COMMAND' depends on the chosen 'MODE'.
27
28
29OPTIONS
30-------
31*-a, --attribute* 'ACCOUNT'::
32 'ACCOUNT' is a name of a xmpp account defined within the configuration file.
33
34*-j, --jid* 'JID'::
35 'JID' of the XMPP Account.
36
37*-p, --pwd* 'PWD'::
38 Password of the XMPP Account.
39
40*-v* 'VERBOSE'::
41 Verbose flags. -v[v[v[v]]]::
42 -v is WARN -vv is INFO --vvv is DEBUG -vvvv is TRACE
43
44*--help*::
45 Print program version number and help
46
47
48MODES AND COMMANDS
49------------------
50xmppc modes.
51
52*-m roster*::
53The Roster mode can be used to provided information of the xmpp account's
54roster. The roster is the XMPP list of contacts.
55
56* *list* - List all contacts
57* *export* - Exports all contacts
58
59*-m message*::
60The message mode can be used to send unencrypted messages to another xmpp
61account.
62
63* *chat <jid> <message>* - Sending unencrypted message to jid
64
65*-m pgp*::
66PGP Mode (XEP-0027)
67
68* *chat <jid> <message>* - Sending pgp encrypted message to jid
69
70*-m omemo*::
71OMEMO Mode (XEP-0384)
72
73* *list* - List the device IDs and fingerprints
74* *delete-device-list* - Deletes the OMEMO device list
75
76*-m openpgp*::
77openpgp mode (XEP-0373)
78
79* *signcrypt <jid> <message>* - Sending pgp signed and encrypted message to jid
80
81*-m monitor*::
82Monitot mode
83
84* *stanza* - Stanza Monitor
85* *monitor* - microblog Monitor microblog (XEP-0277)
86
87*-m bookmark*:: Bookmark mode (XEP-0048)
88
89* *list* - List bookmarks
90
91*-m mam*:: Message Archive Management (XEP-0313)
92
93* *list <jid>* - List messages from <jid>
94
95*-m discovery*:: Service Discovery (XEP-0030)
96
97* *info <jid>* - info request for <jid>
98* *item <jid>* - item request for <jid>
99
100
101ENVIRONMENT VARIABLES
102---------------------
103
104* HOME
105
106
107EXAMPLES
108--------
109 xmppc --jid user@domain.tld --pwd "secret" --mode roster list
110 xmppc --jid user@domain.tld --mode pgp chat friend@domain.tld "Hello"
111 xmppc -a account1 --mode discovery item conference@domain.tld
112 xmppc --mode bookmark list
113
114
115FILES
116-----
117Configuration file to setup accounts.
118
119*~/.config/xmppc.conf*::
120Example:
121
122
123 [default]
124 jid=account1@domain.tld
125 pwd=password1
126
127 [account2]
128 jid=account2@domain.tld
129
130 [account3]
131 jid=account3@domain.tld
132 pwd=password3
133
134EXIT STATUS
135-----------
136*0*::
137 Success
138
139*1*::
140 Failure
141
142
143BUGS
144----
145See <https://codeberg.org/Anoxinon_e.V./xmppc/issues>
146
147
148AUTHOR
149------
150* DebXWoody
151
152RESOURCES
153---------
154Source: <https://codeberg.org/Anoxinon_e.V./xmppc>
155
156Documentation: <https://codeberg.org/Anoxinon_e.V./xmppc/wiki>
157
158
159COPYING
160-------
161Copyright \(C) 2020 Anoxinon e.V. Free use of this software is
162granted under the terms of the GNU General Public License (GPL).