Update docs.

ox
Martin Dosch 2 years ago
parent ea80a0172e
commit a97e4911bc

@ -83,7 +83,7 @@ If no configuration file is present or if the values should be overridden it is
the account details via command line options:
```plain
Usage: go-sendxmpp [-cdilnt] [-f value] [--help] [--http-upload value] [-j value] [-m value] [--muc-password value] [--ox] [-p value] [--raw] [-r value] [--timeout value] [--tls-version value] [-u value] [--version] [parameters ...]
Usage: go-sendxmpp [-cdilnt] [-f value] [--help] [--http-upload value] [-j value] [-m value] [--muc-password value] [--ox] [--ox-genprivkey] [--ox-passphrase value] [-p value] [--raw] [-r value] [--timeout value] [--tls-version value] [-u value] [--version] [parameters ...]
-c, --chatroom Send message to a chatroom.
-d, --debug Show debugging info.
-f, --file=value Set configuration file. (Default:
@ -102,6 +102,12 @@ Usage: go-sendxmpp [-cdilnt] [-f value] [--help] [--http-upload value] [-j value
-n, --no-tls-verify
Skip verification of TLS certificates (not recommended).
--ox Use "OpenPGP for XMPP" encryption (experimental).
--ox-genprivkey
Generate a public OpenPGP key for the given JID and publish
the corresponding public key.
--ox-passphrase=value
Passphrase for locking and unlocking the private OpenPGP
key.
-p, --password=value
Password for XMPP account.
--raw Send raw XML.

@ -34,10 +34,14 @@ You can either pipe a programs output to \fBgo\-sendxmpp\fR, write in your termi
.P
\fB\-\-ox\fR: Use "OpenPGP for XMPP" encryption (experimental)\.
.br
\fBOx\fR in go\-sendxmpp only supports sending encrypted 1\-1 messages\. Sending to groupchats, sending encrypted files or receiveing encrypted messages is not supported\. There is also no support for signing\. The recipients public key is also not cached at the moment but requested via pubsub for every single message\.
\fBOx\fR in go\-sendxmpp only supports sending encrypted 1\-1 messages\. Sending to groupchats, sending encrypted files or receiveing encrypted messages is not supported\. The recipients public key is not cached at the moment but requested via pubsub for every single message\.
.br
There is also no check whether the recipients key is trusted as there is no local keyring used\. Go\-sendxmpp just uses the most recent key that is provided via pubsub and checks that it is not expired\.
.P
\fB\-\-ox\-genprivkey\fR: Generate a public OpenPGP key for the given JID and publish the corresponding public key\. Go\-sendxmpp will save the key in \fB$XDG_DATA_HOME/go\-sendxmpp/oxprivkeys\fR or \fB$HOME/\.local/share/go\-sendxmpp/oxprivkeys\fR\. To protect the key you might want to set a passphrase using \fB\-\-ox\-passphrase\fR while generating the key\.
.P
\fB\-\-ox\-passphrase=value\fR: Passphrase for locking and unlocking the private OpenPGP key\.
.P
\fB\-\-tls\-version\fR=[\fIvalue\fR]: Minimal TLS version\. 10 (TLSv1\.0), 11 (TLSv1\.1), 12 (TLSv1\.2), 13 (TLSv1\.3) (Default: 12)
.P
\fB\-p\fR, \fB\-\-password\fR=[\fIvalue\fR]: Password for XMPP account\.

@ -128,13 +128,21 @@ file location is specified with <code>-f</code> or <code>--file</code>.</p>
<p><code>--ox</code>:
Use "OpenPGP for XMPP" encryption (experimental). <br>
<code>Ox</code> in go-sendxmpp only supports sending encrypted 1-1 messages. Sending to groupchats, sending
encrypted files or receiveing encrypted messages is not supported. There is also no support for
signing. The recipients public key is also not cached at the moment but requested via pubsub for
every single message. <br>
encrypted files or receiveing encrypted messages is not supported.
The recipients public key is not cached at the moment but requested via pubsub for every single message. <br>
There is also no check whether the recipients key is trusted as there is no local keyring used.
Go-sendxmpp just uses the most recent key that is provided via pubsub and checks that it is not
expired.</p>
<p><code>--ox-genprivkey</code>:
Generate a public OpenPGP key for the given JID and publish the corresponding public key.
Go-sendxmpp will save the key in <code>$XDG_DATA_HOME/go-sendxmpp/oxprivkeys</code> or
<code>$HOME/.local/share/go-sendxmpp/oxprivkeys</code>. To protect the key you might want to set a
passphrase using <code>--ox-passphrase</code> while generating the key.</p>
<p><code>--ox-passphrase=value</code>:
Passphrase for locking and unlocking the private OpenPGP key.</p>
<p><code>--tls-version</code>=[<var>value</var>]:
Minimal TLS version. 10 (TLSv1.0), 11 (TLSv1.1), 12 (TLSv1.2), 13 (TLSv1.3) (Default: 12)</p>

@ -53,13 +53,21 @@ file location is specified with `-f` or `--file`.
`--ox`:
Use "OpenPGP for XMPP" encryption (experimental).
`Ox` in go-sendxmpp only supports sending encrypted 1-1 messages. Sending to groupchats, sending
encrypted files or receiveing encrypted messages is not supported. There is also no support for
signing. The recipients public key is also not cached at the moment but requested via pubsub for
every single message.
encrypted files or receiveing encrypted messages is not supported.
The recipients public key is not cached at the moment but requested via pubsub for every single message.
There is also no check whether the recipients key is trusted as there is no local keyring used.
Go-sendxmpp just uses the most recent key that is provided via pubsub and checks that it is not
expired.
`--ox-genprivkey`:
Generate a public OpenPGP key for the given JID and publish the corresponding public key.
Go-sendxmpp will save the key in `$XDG_DATA_HOME/go-sendxmpp/oxprivkeys` or
`$HOME/.local/share/go-sendxmpp/oxprivkeys`. To protect the key you might want to set a
passphrase using `--ox-passphrase` while generating the key.
`--ox-passphrase=value`:
Passphrase for locking and unlocking the private OpenPGP key.
`--tls-version`=[<value>]:
Minimal TLS version. 10 (TLSv1.0), 11 (TLSv1.1), 12 (TLSv1.2), 13 (TLSv1.3) (Default: 12)

Loading…
Cancel
Save