2019-03-25 18:16:44 +00:00
<!DOCTYPE html>
< html >
< head >
< meta http-equiv = 'content-type' content = 'text/html;charset=utf8' >
2020-05-23 16:21:42 +00:00
< meta name = 'generator' content = 'Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)' >
2022-09-04 12:37:11 +00:00
< title > go-sendxmpp(1) - A tool to send messages to an XMPP contact or MUC.< / title >
2019-03-25 18:16:44 +00:00
< style type = 'text/css' media = 'all' >
/* style: man */
body#manpage {margin:0}
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
.mp h2 {margin:10px 0 0 0}
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
.mp h3 {margin:0 0 0 4ex}
.mp dt {margin:0;clear:left}
.mp dt.flush {float:left;width:8ex}
.mp dd {margin:0 0 0 9ex}
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
.mp pre {margin-bottom:20px}
.mp pre+h2,.mp pre+h3 {margin-top:22px}
.mp h2+pre,.mp h3+pre {margin-top:5px}
.mp img {display:block;margin:auto}
.mp h1.man-title {display:none}
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
.mp h2 {font-size:16px;line-height:1.25}
.mp h1 {font-size:20px;line-height:2}
.mp {text-align:justify;background:#fff}
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
.mp u {text-decoration:underline}
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
.mp b.man-ref {font-weight:normal;color:#434241}
.mp pre {padding:0 4ex}
.mp pre code {font-weight:normal;color:#434241}
.mp h2+pre,h3+pre {padding-left:0}
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
ol.man-decor {width:100%}
ol.man-decor li.tl {text-align:left}
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
< / style >
< / head >
<!--
The following styles are deprecated and will be removed at some point:
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
.man-navigation should be used instead.
-->
< body id = 'manpage' >
< div class = 'mp' id = 'man' >
< div class = 'man-navigation' style = 'display:none' >
< a href = "#NAME" > NAME< / a >
< a href = "#SYNOPSIS" > SYNOPSIS< / a >
< a href = "#DESCRIPTION" > DESCRIPTION< / a >
< a href = "#OPTIONS" > OPTIONS< / a >
2023-03-17 20:16:11 +00:00
< a href = "#SHELL-COMPLETIONS" > SHELL COMPLETIONS< / a >
2021-01-29 17:09:58 +00:00
< a href = "#CHAT" > CHAT< / a >
2019-03-25 18:16:44 +00:00
< a href = "#AUTHOR" > AUTHOR< / a >
< a href = "#REPORTING-BUGS" > REPORTING BUGS< / a >
< a href = "#COPYRIGHT" > COPYRIGHT< / a >
< a href = "#SEE-ALSO" > SEE ALSO< / a >
< / div >
< ol class = 'man-decor man-head man head' >
< li class = 'tl' > go-sendxmpp(1)< / li >
2020-04-04 08:53:47 +00:00
< li class = 'tc' > < / li >
2019-03-25 18:16:44 +00:00
< li class = 'tr' > go-sendxmpp(1)< / li >
< / ol >
< h2 id = "NAME" > NAME< / h2 >
< p class = "man-name" >
2022-09-04 12:37:11 +00:00
< code > go-sendxmpp< / code > - < span class = "man-whatis" > A tool to send messages to an XMPP contact or MUC.< / span >
2019-03-25 18:16:44 +00:00
< / p >
< h2 id = "SYNOPSIS" > SYNOPSIS< / h2 >
2023-10-19 21:13:48 +00:00
< p > < code > go-sendxmpp< / code > [-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] [--timeout value] [--tls-version value] [-u value] [--version] [parameters ...]< / p >
2019-03-25 18:16:44 +00:00
< h2 id = "DESCRIPTION" > DESCRIPTION< / h2 >
2022-09-04 12:40:58 +00:00
< p > A tool to send messages to an XMPP contact or MUC inspired by (but not as powerful as) < code > sendxmpp< / code > . < br >
2020-05-23 16:21:42 +00:00
You can either pipe a programs output to < code > go-sendxmpp< / code > , write in your terminal (put < code > ^D< / code > in a new line to
finish) or send the input from a file (< code > -m< / code > or < code > --message< / code > ).
2022-02-25 13:04:04 +00:00
The account data is expected at < code > ~/.config/go-sendxmpp/config< / code > (preferred), < code > ~/.config/go-sendxmpp/sendxmpprc< / code >
(deprecated) < code > ~/.sendxmpprc< / code > (for compatibility with the original perl sendxmpp) if no other configuration
file location is specified with < code > -f< / code > or < code > --file< / code > .< / p >
2019-03-25 18:16:44 +00:00
< h2 id = "OPTIONS" > OPTIONS< / h2 >
2022-11-03 16:24:52 +00:00
< dl >
< dt >
2022-11-27 08:13:58 +00:00
< code > -a< / code > , < code > --alias< / code > =[< var > value< / var > ]< / dt >
< dd > Set alias/nickname for chatrooms.< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > -c< / code > , < code > --chatroom< / code > =[< var > value< / var > ]< / dt >
< dd > Send message to a chatroom.< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > -d< / code > , < code > --debug< / code >
< / dt >
< dd > Show debugging info.< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > -f< / code > , < code > --file< / code > =[< var > value< / var > ]< / dt >
< dd > Set configuration file. (Default: ~/.config/go-sendxmpp/config)< / dd >
2023-06-18 20:21:18 +00:00
< dt > < code > --headline< / code > < / dt >
< dd > Send message as type headline.< / dd >
2022-11-27 08:13:58 +00:00
< dt > < code > --help< / code > < / dt >
< dd > Show help.< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > -h< / code > , < code > --http-upload=< / code > [< var > value< / var > ]< / dt >
< dd > Send a file via http-upload.< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > -i< / code > , < code > --interactive< / code >
< / dt >
< dd > Interactive mode (for use with e.g. < code > tail -f< / code > ).< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > -j< / code > , < code > --jserver< / code > =[< var > value< / var > ]< / dt >
< dd > XMPP server address.< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > -l< / code > , < code > --listen< / code >
< / dt >
< dd > 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.< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > -m< / code > , < code > --message< / code > =[< var > value< / var > ]< / dt >
< dd > Set file including the message.< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > --muc-password< / code > =[< var > value< / var > ]< / dt >
< dd > Password for password protected MUCs.< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > -n< / code > , < code > --no-tls-verify< / code >
< / dt >
< dd > Skip verification of TLS certificates (not recommended).< / dd >
2023-02-18 14:42:04 +00:00
< dt >
< code > --oob-file< / code > =[< var > value< / var > ]< / dt >
< dd > URL to send a file as out of band data.< / dd >
2022-11-27 08:13:58 +00:00
< dt > < code > --ox< / code > < / dt >
< dd > Use "OpenPGP for XMPP" encryption (experimental). < br >
2022-11-03 16:24:52 +00:00
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
2022-11-27 08:13:58 +00:00
due to changed keys.< / dd >
< dt > < code > --ox-delete-nodes< / code > < / dt >
< dd > Delete existing OpenPGP nodes on the server.< / dd >
< dt > < code > --ox-genprivkey-rsa< / code > < / dt >
< dd > Generate a private OpenPGP key (RSA 4096 bit) for the configured account (via config file or < code > -u< / code > and < code > -p< / code > )
2022-11-03 16:24:52 +00:00
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 a passphrase might be set
using < code > --ox-passphrase< / code > while generating the key. < br >
If there is an existing private key for "OpenPGP for XMPP" created by another client (e.g. profanity)
2022-11-27 08:13:58 +00:00
it might be imported using < code > --ox-import-privkey< / code > .< / dd >
< dt > < code > --ox-genprivkey-x25519< / code > < / dt >
< dd > Generate a private OpenPGP key (X25519) for the configured account (via config file or < code > -u< / code > and < code > -p< / code > )
2022-11-03 16:24:52 +00:00
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 a passphrase might be set
using < code > --ox-passphrase< / code > while generating the key. < br >
If there is an existing private key for "OpenPGP for XMPP" created by another client (e.g. profanity)
2022-11-27 08:13:58 +00:00
it might be imported using < code > --ox-import-privkey< / code > .< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > --ox-import-privkey< / code > =[< var > value< / var > ]< / dt >
< dd > Import an existing private OpenPGP key.< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > --ox-passphrase< / code > =[< var > value< / var > ]< / dt >
< dd > Passphrase for locking and unlocking the private OpenPGP key.< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > --tls-version< / code > =[< var > value< / var > ]< / dt >
< dd > Minimal TLS version. 10 (TLSv1.0), 11 (TLSv1.1), 12 (TLSv1.2), 13 (TLSv1.3) (Default: 12)< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > -p< / code > , < code > --password< / code > =[< var > value< / var > ]< / dt >
< dd > Password for XMPP account.< / dd >
< dt > < code > --raw< / code > < / dt >
< dd > 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 < code > -c< / code > and go-sendxmpp will join the MUC.< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > --timeout=< / code > [< var > value< / var > ]< / dt >
< dd > Connection timeout in seconds. (Default: 10)< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > -t< / code > , < code > --tls< / code >
< / dt >
< dd > Use direct TLS.< / dd >
2022-11-03 16:24:52 +00:00
< dt >
2022-11-27 08:13:58 +00:00
< code > -u< / code > , < code > --username< / code > =[< var > value< / var > ]< / dt >
< dd > Username for XMPP account (JID).< / dd >
< dt > < code > --version< / code > < / dt >
< dd > Show version information.< / dd >
2022-11-03 16:24:52 +00:00
< / dl >
2023-03-17 20:16:11 +00:00
< h2 id = "SHELL-COMPLETIONS" > SHELL COMPLETIONS< / h2 >
< h3 id = "ZSH" > ZSH< / h3 >
2023-03-17 20:23:52 +00:00
< p > There are no shell completions yet (contributions welcome) but for zsh it is
possible to automatically create completions from < code > --help< / code > which might work
good enough.< / p >
2023-03-17 20:16:11 +00:00
< p > Just place the following in your < code > ~/.zshrc< / code > or < code > ~/.zshrc.local< / code > :< / p >
< p > < code >
compdef _gnu_generic go-sendxmpp
< / code > < / p >
2021-01-29 17:09:58 +00:00
< h2 id = "CHAT" > CHAT< / h2 >
2022-01-30 12:29:02 +00:00
< p > Feel free to join < a href = "https://join.jabber.network/#go-sendxmpp@chat.mdosch.de?join" data-bare-link = "true" > https://join.jabber.network/#go-sendxmpp@chat.mdosch.de?join< / a > .< / p >
2021-01-29 17:09:58 +00:00
2019-03-25 18:16:44 +00:00
< h2 id = "AUTHOR" > AUTHOR< / h2 >
< p > Written by Martin Dosch.< / p >
< h2 id = "REPORTING-BUGS" > REPORTING BUGS< / h2 >
2022-01-30 12:29:02 +00:00
< p > Report bugs at < a href = "https://salsa.debian.org/mdosch/go-sendxmpp/issues" data-bare-link = "true" > https://salsa.debian.org/mdosch/go-sendxmpp/issues< / a > .< / p >
2019-03-25 18:16:44 +00:00
< h2 id = "COPYRIGHT" > COPYRIGHT< / h2 >
2023-05-11 18:06:50 +00:00
< p > Copyright (c) Martin Dosch
2020-04-04 07:44:48 +00:00
License: BSD 2-clause License< / p >
2019-03-25 18:16:44 +00:00
< h2 id = "SEE-ALSO" > SEE ALSO< / h2 >
2023-06-18 20:21:18 +00:00
< p > < span class = "man-ref" > go-sendxmpp< span class = "s" > (5)< / span > < / span > , < span class = "man-ref" > sendxmpp< span class = "s" > (1)< / span > < / span > < / p >
2019-03-25 18:16:44 +00:00
< ol class = 'man-decor man-foot man foot' >
< li class = 'tl' > < / li >
2023-10-19 21:10:23 +00:00
< li class = 'tc' > October 2023< / li >
2019-03-25 18:16:44 +00:00
< li class = 'tr' > go-sendxmpp(1)< / li >
< / ol >
< / div >
< / body >
< / html >
