Update documention.

ox
Martin Dosch 2 years ago
parent 44ac374af0
commit 9e864f9fa0

@ -1,6 +1,8 @@
# Changelog
## Unreleased
### Added
- Experimental support for Ox (OpenPGP for XMPP) encryption.
## [v0.3.0] 2022-03-21
### Added

@ -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] [-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] [-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:
@ -101,6 +101,7 @@ Usage: go-sendxmpp [-cdilnt] [-f value] [--help] [--http-upload value] [-j value
Password for password protected MUCs.
-n, --no-tls-verify
Skip verification of TLS certificates (not recommended).
--ox Use "OpenPGP for XMPP" encryption (experimental).
-p, --password=value
Password for XMPP account.
--raw Send raw XML.
@ -111,7 +112,7 @@ Usage: go-sendxmpp [-cdilnt] [-f value] [--help] [--http-upload value] [-j value
Connection timeout in seconds. [10]
-t, --tls Use direct TLS.
--tls-version=value
Minimal TLS version. 10 (TSLv1.0), 11 (TLSv1.1), 12
Minimal TLS version. 10 (TLSv1.0), 11 (TLSv1.1), 12
(TLSv1.2) or 13 (TLSv1.3). [12]
-u, --username=value
Username for XMPP account.

@ -1,6 +1,6 @@
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "GO\-SENDXMPP" "1" "March 2022" ""
.TH "GO\-SENDXMPP" "1" "April 2022" ""
.SH "NAME"
\fBgo\-sendxmpp\fR \- A little tool to send messages to an XMPP contact or MUC\.
.SH "SYNOPSIS"
@ -32,6 +32,12 @@ You can either pipe a programs output to \fBgo\-sendxmpp\fR, write in your termi
.P
\fB\-n\fR, \fB\-\-no\-tls\-verify\fR: Skip verification of TLS certificates (not recommended)\.
.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\.
.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\-\-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\.

@ -125,6 +125,16 @@ file location is specified with <code>-f</code> or <code>--file</code>.</p>
<p><code>-n</code>, <code>--no-tls-verify</code>:
Skip verification of TLS certificates (not recommended).</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>
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>--tls-version</code>=[<var>value</var>]:
Minimal TLS version. 10 (TLSv1.0), 11 (TLSv1.1), 12 (TLSv1.2), 13 (TLSv1.3) (Default: 12)</p>
@ -172,7 +182,7 @@ License: BSD 2-clause License</p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>March 2022</li>
<li class='tc'>April 2022</li>
<li class='tr'>go-sendxmpp(1)</li>
</ol>

@ -50,6 +50,16 @@ file location is specified with `-f` or `--file`.
`-n`, `--no-tls-verify`:
Skip verification of TLS certificates (not recommended).
`--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.
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.
`--tls-version`=[<value>]:
Minimal TLS version. 10 (TLSv1.0), 11 (TLSv1.1), 12 (TLSv1.2), 13 (TLSv1.3) (Default: 12)

Loading…
Cancel
Save