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
75*-m openpgp*::
76openpgp mode (XEP-0373)
77
78* *signcrypt <jid> <message>* - Sending pgp signed and encrypted message to jid
79
80*-m monitor*::
81Monitot mode
82
83* *stanza* - Stanza Monitor
84* *monitor* - microblog Monitor microblog (XEP-0277)
85
86*-m bookmark*:: Bookmark mode (XEP-0048)
87
88* *list* - List bookmarks
89
90*-m mam*:: Message Archive Management (XEP-0313)
91
92* *list <jid>* - List messages from <jid>
93
94*-m discovery*:: Service Discovery (XEP-0030)
95
96* *info <jid>* - info request for <jid>
97* *item <jid>* - item request for <jid>
98
99
100ENVIRONMENT VARIABLES
101---------------------
102
103* HOME
104
105
106EXAMPLES
107--------
108 xmppc --jid user@domain.tld --pwd "secret" --mode roster list
109 xmppc --jid user@domain.tld --mode pgp chat friend@domain.tld "Hello"
110 xmppc -a account1 --mode discovery item conference@domain.tld
111 xmppc --mode bookmark list
112
113
114FILES
115-----
116Configuration file to setup accounts.
117
118*~/.config/xmppc.conf*::
119Example:
120
121
122 [default]
123 jid=account1@domain.tld
124 pwd=password1
125
126 [account2]
127 jid=account2@domain.tld
128
129 [account3]
130 jid=account3@domain.tld
131 pwd=password3
132
133EXIT STATUS
134-----------
135*0*::
136 Success
137
138*1*::
139 Failure
140
141
142BUGS
143----
144See <https://codeberg.org/Anoxinon_e.V./xmppc/issues>
145
146
147AUTHOR
148------
149* DebXWoody (OpenPGP: A602F76893F138B4A8EFDDD5C2DC916F35751C24)
150
151RESOURCES
152---------
153Source: <https://codeberg.org/Anoxinon_e.V./xmppc>
154
155Documentation: <https://codeberg.org/Anoxinon_e.V./xmppc/wiki>
156
157
158COPYING
159-------
160Copyright \(C) 2020 Anoxinon e.V. Free use of this software is
161granted under the terms of the GNU General Public License (GPL).