File: xmppc.1.adoc

package info (click to toggle)
xmppc 0.1.0-1
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 400 kB
  • sloc: ansic: 1,269; makefile: 29; sh: 1
file content (161 lines) | stat: -rw-r--r-- 3,405 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
XMPPC(1)
========

NAME
----
xmppc - XMPP Command line Tool 


SYNOPSIS
--------
'xmppc' ['OPTIONS'] -m 'MODE' 'COMMAND' [<args>...]

'xmppc' [-a 'ACCOUNT'] [-j 'JID'] [-p 'PASSWORD']  -m 'MODE' 'COMMAND' [<args>...]


DESCRIPTION
-----------
xmppc 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 'JID'. If no
password is provided via -p 'PASSWORD' 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 'ACCOUNT' can be used to select the account.

The argument -m 'MODE' defines the xmppc 'MODE' which should be used (roster,
message, pgp, omemo, openpgp, monitor, bookmark, mam, discovery). The 'COMMAND'
and the args required by the 'COMMAND' depends on the chosen 'MODE'.


OPTIONS
-------
*-a, --attribute* 'ACCOUNT'::
  'ACCOUNT' is a name of a xmpp account defined within the configuration file.

*-j, --jid* 'JID'::
  'JID' of the XMPP Account.

*-p, --pwd* 'PWD'::
  Password of the XMPP Account.

*-v* 'VERBOSE'::
  Verbose flags. -v[v[v[v]]]::
  -v is WARN -vv is INFO --vvv is DEBUG -vvvv is TRACE

*--help*::
    Print program version number and help


MODES AND COMMANDS
------------------
xmppc modes.

*-m roster*:: 
The Roster mode can be used to provided information of the xmpp account's
roster. The roster is the XMPP list of contacts. 

* *list* - List all contacts
* *export* - Exports all contacts

*-m message*:: 
The message mode can be used to send unencrypted messages to another xmpp
account.

* *chat <jid> <message>* - Sending unencrypted message to jid

*-m pgp*:: 
PGP Mode (XEP-0027)

* *chat <jid> <message>* - Sending pgp encrypted message to jid

*-m omemo*:: 
OMEMO Mode (XEP-0384)

* *list* - List the device IDs and fingerprints

*-m openpgp*:: 
openpgp mode (XEP-0373)

* *signcrypt <jid> <message>* - Sending pgp signed and encrypted message to jid

*-m monitor*:: 
Monitot mode

* *stanza* - Stanza Monitor
* *monitor* - microblog Monitor microblog (XEP-0277)

*-m bookmark*:: Bookmark mode (XEP-0048)

* *list* - List bookmarks

*-m mam*:: Message Archive Management (XEP-0313)

* *list <jid>* - List messages from <jid>

*-m discovery*:: Service Discovery (XEP-0030)

* *info <jid>* - info request for <jid>
* *item <jid>* - item request for <jid>


ENVIRONMENT VARIABLES
---------------------

* HOME


EXAMPLES
--------
  xmppc --jid user@domain.tld --pwd "secret" --mode roster list
  xmppc --jid user@domain.tld --mode pgp chat friend@domain.tld "Hello"
  xmppc -a account1 --mode discovery item conference@domain.tld
  xmppc --mode bookmark list


FILES
-----
Configuration file to setup accounts.

*~/.config/xmppc.conf*::
Example:


  [default]
  jid=account1@domain.tld
  pwd=password1
  
  [account2]
  jid=account2@domain.tld
  
  [account3]
  jid=account3@domain.tld
  pwd=password3

EXIT STATUS
-----------
*0*::
    Success

*1*::
    Failure 


BUGS
----
See <https://codeberg.org/Anoxinon_e.V./xmppc/issues>


AUTHOR
------
* DebXWoody (OpenPGP: A602F76893F138B4A8EFDDD5C2DC916F35751C24) 

RESOURCES
---------
Source: <https://codeberg.org/Anoxinon_e.V./xmppc>

Documentation: <https://codeberg.org/Anoxinon_e.V./xmppc/wiki>


COPYING
-------
Copyright \(C) 2020 Anoxinon e.V. Free use of this software is
granted under the terms of the GNU General Public License (GPL).