go-sendxmpp(5) -- A tool to send messages to an XMPP contact or MUC.
====

## LOCATION

The account data is expected at `~/.config/go-sendxmpp/config` (preferred), `~/.config/go-sendxmpp/sendxmpprc`
(deprecated) or `~/.sendxmpprc` (for compatibility with the original perl sendxmpp) if no other configuration file
location is specified with -f or --file. The configuration file is expected to be in the following format:

## FORMAT

username: [<your_jid>]    
jserver: [<jabber_server>]    
port: [<jabber_port>]    
password: [<your_jabber_password>]    
eval_password: [<command_to_unlock_your_password>]    
alias: [<your_alias>]    
allow_plain: [<bool>]

## REQUIRED SETTINGS

If all necessary settings are supplied as command line arguments no config file is needed at all.
Setting `jserver` and `port` might not be necessary depending on the used server.    
You should either use a password manager and the setting `eval_password` or add
your password in plaintext to the config file with the setting `password`.
Please be careful with `eval_password` as any command put there will be executed.

## OPTIONS

* `username`:
Your JID, e.g. **user@example.com**.

* `jserver`:
Your server, e.g. **xmpp.example.com**.
Should not be necessary if the server is set up properly.

* `port`:
The client-to-server port of the XMPP server, e.g. **5222**.
Should not be necessary if the server is set up properly.

* `password`:
Your accounts password, e.g. **hunter2** (please, do not use **hunter2**).
Use `"` if your password contains spaces, e.g. **"hunter 2"** (please, also do nut use **hunter 2**).

* `eval_password`:
A command to retrieve the password from a password manager, e.g. **pass xmpp/user@example.com**.

* `alias`:
The alias/nickname for chatrooms, e.g. **Martin** or **"My nick contains spaces"**.

* `allow_plain`:
Boolean to allow  PLAIN  authentication. Note that this setting has no effect if there was a successful
connection using a SCRAM authentication mechanism before. In that case PLAIN is not allowed to prevent 
downgrades by a man-in-the-middle attack.    
Allowed values: **true**/**false** (Default: false)

## AUTHOR

Written by Martin Dosch.

## REPORTING BUGS


Report bugs at [https://salsa.debian.org/mdosch/go-sendxmpp/-/work_items](https://salsa.debian.org/mdosch/go-sendxmpp/-/work_items).

## COPYRIGHT

Copyright (c) Martin Dosch
License: BSD 2-clause License

## SEE ALSO

go-sendxmpp(1), sendxmpp(1)
