You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
128 lines
6.9 KiB
Groff
128 lines
6.9 KiB
Groff
.\" generated with Ronn-NG/v0.9.1
|
|
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
|
.TH "GO\-SENDXMPP" "1" "March 2024" ""
|
|
.SH "NAME"
|
|
\fBgo\-sendxmpp\fR \- A tool to send messages to an XMPP contact or MUC\.
|
|
.SH "SYNOPSIS"
|
|
\fBgo\-sendxmpp [\-cdilnt] [\-a value] [\-f value] [\-\-headline] [\-\-help] [\-h value] [\-j value] [\-m value] [\-\-muc\-password value] [\-\-oob\-file value] [\-\-ox] [\-\-ox\-delete\-nodes] [\-\-ox\-genprivkey\-rsa] [\-\-ox\-genprivkey\-x25519] [\-\-ox\-import\-privkey value] [\-\-ox\-passphrase value] [\-p value] [\-\-raw] [\-\-scram\-mech\-pinning value] [\-\-ssdp\-off] [\-\-timeout value] [\-\-tls\-version value] [\-u value] [\-\-version] [recipients…]\fR
|
|
.SH "DESCRIPTION"
|
|
A tool to send messages to an XMPP contact or MUC inspired by \fBsendxmpp\fR\.
|
|
.br
|
|
You can either pipe a programs output to \fBgo\-sendxmpp\fR, write in your terminal (put \fB^D\fR in a new line to finish) or send the input from a file (\fB\-m\fR or \fB\-\-message\fR)\. The account data is expected at \fB~/\.config/go\-sendxmpp/config\fR (preferred), \fB~/\.config/go\-sendxmpp/sendxmpprc\fR (deprecated) \fB~/\.sendxmpprc\fR (for compatibility with the original perl sendxmpp) if no other configuration file location is specified with \fB\-f\fR or \fB\-\-file\fR\.
|
|
.SH "OPTIONS"
|
|
.TP
|
|
\fB\-a\fR, \fB\-\-alias\fR=[\fIvalue\fR]
|
|
Set alias/nickname for chatrooms\.
|
|
.TP
|
|
\fB\-c\fR, \fB\-\-chatroom\fR=[\fIvalue\fR]
|
|
Send message to a chatroom\.
|
|
.TP
|
|
\fB\-d\fR, \fB\-\-debug\fR
|
|
Show debugging info\.
|
|
.TP
|
|
\fB\-f\fR, \fB\-\-file\fR=[\fIvalue\fR]
|
|
Set configuration file\. (Default: ~/\.config/go\-sendxmpp/config)
|
|
.TP
|
|
\fB\-\-headline\fR
|
|
Send message as type headline\.
|
|
.TP
|
|
\fB\-\-help\fR
|
|
Show help\.
|
|
.TP
|
|
\fB\-h\fR, \fB\-\-http\-upload=\fR[\fIvalue\fR]
|
|
Send a file via http\-upload\.
|
|
.TP
|
|
\fB\-i\fR, \fB\-\-interactive\fR
|
|
Interactive mode (for use with e\.g\. \fBtail \-f\fR)\.
|
|
.TP
|
|
\fB\-j\fR, \fB\-\-jserver\fR=[\fIvalue\fR]
|
|
XMPP server address\.
|
|
.TP
|
|
\fB\-l\fR, \fB\-\-listen\fR
|
|
Listen for messages and print them to stdout\. If JIDs are specified only messages from those contacts are shown\. If no JIDs are specified all received messages will be shown\.
|
|
.TP
|
|
\fB\-m\fR, \fB\-\-message\fR=[\fIvalue\fR]
|
|
Set file including the message\.
|
|
.TP
|
|
\fB\-\-muc\-password\fR=[\fIvalue\fR]
|
|
Password for password protected MUCs\.
|
|
.TP
|
|
\fB\-n\fR, \fB\-\-no\-tls\-verify\fR
|
|
Skip verification of TLS certificates (not recommended)\.
|
|
.TP
|
|
\fB\-\-oob\-file\fR=[\fIvalue\fR]
|
|
URL to send a file as out of band data\.
|
|
.TP
|
|
\fB\-\-ox\fR
|
|
Use "OpenPGP for XMPP" encryption (experimental)\.
|
|
.br
|
|
Ox in go\-sendxmpp only supports sending encrypted 1\-1 messages\. Sending to groupchats and sending encrypted files is not supported\. There is 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\. As a user facing client a notification would be shown that a new key is available and ask the user whether to use the new key or stick to the old one\. As go\-sendxmpp is usually used in scripts it just accepts the new key to prevent the user from missing a new notification due to changed keys\.
|
|
.TP
|
|
\fB\-\-ox\-delete\-nodes\fR
|
|
Delete existing OpenPGP nodes on the server\.
|
|
.TP
|
|
\fB\-\-ox\-genprivkey\-rsa\fR
|
|
Generate a private OpenPGP key (RSA 4096 bit) for the configured account (via config file or \fB\-u\fR and \fB\-p\fR) 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 a passphrase might be set using \fB\-\-ox\-passphrase\fR while generating the key\.
|
|
.br
|
|
If there is an existing private key for "OpenPGP for XMPP" created by another client (e\.g\. profanity) it might be imported using \fB\-\-ox\-import\-privkey\fR\.
|
|
.TP
|
|
\fB\-\-ox\-genprivkey\-x25519\fR
|
|
Generate a private OpenPGP key (X25519) for the configured account (via config file or \fB\-u\fR and \fB\-p\fR) 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 a passphrase might be set using \fB\-\-ox\-passphrase\fR while generating the key\.
|
|
.br
|
|
If there is an existing private key for "OpenPGP for XMPP" created by another client (e\.g\. profanity) it might be imported using \fB\-\-ox\-import\-privkey\fR\.
|
|
.TP
|
|
\fB\-\-ox\-import\-privkey\fR=[\fIvalue\fR]
|
|
Import an existing private OpenPGP key\.
|
|
.TP
|
|
\fB\-\-ox\-passphrase\fR=[\fIvalue\fR]
|
|
Passphrase for locking and unlocking the private OpenPGP key\.
|
|
.TP
|
|
\fB\-\-tls\-version\fR=[\fIvalue\fR]
|
|
Minimal TLS version\. 10 (TLSv1\.0), 11 (TLSv1\.1), 12 (TLSv1\.2), 13 (TLSv1\.3) (Default: 12)
|
|
.TP
|
|
\fB\-p\fR, \fB\-\-password\fR=[\fIvalue\fR]
|
|
Password for XMPP account\.
|
|
.TP
|
|
\fB\-\-raw\fR
|
|
Send raw XML\. To send raw XML to a contact as normal chat message no contact must be specified\. To send raw XML to a MUC you have to specify the MUC via \fB\-c\fR and go\-sendxmpp will join the MUC\.
|
|
.TP
|
|
\fB\-\-scram\-mech\-pinning=[<value>]\fR
|
|
Enforce the use of a certain SCRAM authentication mechanism\. Currently go\-sendxmpp supports \fBSCRAM\-SHA\-1\fR, \fBSCRAM\-SHA\-1\-PLUS\fR, \fBSCRAM\-SHA\-256\fR, \fBSCRAM\-SHA\-256\-PLUS\fR, \fBSCRAM\-SHA\-512\fR and \fBSCRAM\-SHA\-512\-PLUS\fR\. You should know what you are doing when using this setting and make sure the chosen mechanism is supported by the server\. If not set, go\-sendxmpp will use XEP\-0474 to prevent downgrade attacks (needs server support)\.
|
|
.TP
|
|
\fB\-\-ssdp\-off\fR
|
|
Disable XEP\-0474: SASL SCRAM Downgrade Protection\.
|
|
.TP
|
|
\fB\-\-timeout=\fR[\fIvalue\fR]
|
|
Connection timeout in seconds\. (Default: 10)
|
|
.TP
|
|
\fB\-t\fR, \fB\-\-tls\fR
|
|
Use direct TLS\.
|
|
.TP
|
|
\fB\-u\fR, \fB\-\-username\fR=[\fIvalue\fR]
|
|
Username for XMPP account (JID)\.
|
|
.TP
|
|
\fB\-\-version\fR
|
|
Show version information\.
|
|
.SH "ENVIRONMENT VARIABLES"
|
|
.SS "HTTP_PROXY"
|
|
A SOCKS5 proxy can be used by setting the environment variable \fBHTTP_PROXY\fR\. This feature is considered experimental and there is no guarantee that there won't be any connections not using the proxy although it didn't happen during testing\.
|
|
.P
|
|
\fBHTTP_PROXY="socks5://127\.0\.0\.1:9050" go\-sendxmpp \-\-http\-upload file\.txt user@example\.org\fR
|
|
.SH "SHELL COMPLETIONS"
|
|
.SS "ZSH"
|
|
There are no shell completions yet (contributions welcome) but for zsh it is possible to automatically create completions from \fB\-\-help\fR which might work good enough\.
|
|
.P
|
|
Just place the following in your \fB~/\.zshrc\fR or \fB~/\.zshrc\.local\fR:
|
|
.P
|
|
\fBcompdef _gnu_generic go\-sendxmpp\fR
|
|
.SH "CHAT"
|
|
Feel free to join \fIhttps://join\.jabber\.network/#go\-sendxmpp@chat\.mdosch\.de?join\fR\.
|
|
.SH "AUTHOR"
|
|
Written by Martin Dosch\.
|
|
.SH "REPORTING BUGS"
|
|
Report bugs at \fIhttps://salsa\.debian\.org/mdosch/go\-sendxmpp/issues\fR\.
|
|
.SH "COPYRIGHT"
|
|
Copyright (c) Martin Dosch License: BSD 2\-clause License
|
|
.SH "SEE ALSO"
|
|
go\-sendxmpp(5), sendxmpp(1)
|