go-sendxmpp/man/go-sendxmpp.1.ronn
2022-04-17 17:16:29 +02:00

115 lines
3.7 KiB
Markdown

go-sendxmpp(1) -- A little tool to send messages to an XMPP contact or MUC.
====
## SYNOPSIS
`go-sendxmpp` [-cdintx] [-f value] [--help] [-j value] [-m value] [-p value] [-r value] [-u value] [parameters ...]
## DESCRIPTION
A little tool to send messages to an XMPP contact or MUC inspired by (but not as powerful as) `sendxmpp`.
You can either pipe a programs output to `go-sendxmpp`, write in your terminal (put `^D` in a new line to
finish) or send the input from a file (`-m` or `--message`).
The account data is expected at `~/.config/go-sendxmpp/config` (preferred), `~/.config/go-sendxmpp/sendxmpprc`
(deprecated) `~/.sendxmpprc` (for compatibility with the original perl sendxmpp) if no other configuration
file location is specified with `-f` or `--file`.
## OPTIONS
`-c`, `--chatroom`=[<value>]:
Send message to a chatroom.
`-d`, `--debug`:
Show debugging info.
`-f`, `--file`=[<value>]:
Set configuration file. (Default: ~/.config/go-sendxmpp/config)
`--help`:
Show help.
`--http-upload=`[<value>]:
Send a file via http-upload.
`-i`, `--interactive`:
Interactive mode (for use with e.g. `tail -f`).
`-j`, `--jserver`=[<value>]:
XMPP server address.
`-l`, `--listen`:
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.
`-m`, `--message`=[<value>]:
Set file including the message.
`--muc-password`=[<value>]:
Password for password protected MUCs.
`-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.
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)
`-p`, `--password`=[<value>]:
Password for XMPP account.
`--raw`:
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 `-c` and `go-sendxmpp` will join the MUC.
`-r`, `--resource`=[<value>]:
Set resource. When sending to a chatroom this is used as 'alias'.
`--timeout=`[<value>]:
Connection timeout in seconds. (Default: 10)
`-t`, `--tls`:
Use direct TLS.
`-u`, `--username`=[<value>]:
Username for XMPP account (JID).
`--version`: Show version information.
## CHAT
Feel free to join [https://join.jabber.network/#go-sendxmpp@chat.mdosch.de?join](https://join.jabber.network/#go-sendxmpp@chat.mdosch.de?join).
## AUTHOR
Written by Martin Dosch.
## REPORTING BUGS
Report bugs at [https://salsa.debian.org/mdosch/go-sendxmpp/issues](https://salsa.debian.org/mdosch/go-sendxmpp/issues).
## COPYRIGHT
Copyright (c) 2018 - 2021 Martin Dosch
License: BSD 2-clause License
## SEE ALSO
go-sendxmpp(5), sendxmpp(1)