sendxmpp-rs/README.md

35 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2017-08-11 00:37:50 -04:00
# sendxmpp-rs
`sendxmpp` is the XMPP equivalent of sendmail. It is an alternative to the old sendxmpp written in Perl, or the newer [sendxmpp-py](https://github.com/moparisthebest/sendxmpp-py).
2021-01-16 02:06:05 -05:00
Installation:
`cargo install sendxmpp`
2017-08-11 00:37:50 -04:00
Configuration: `cp sendxmpp.toml ~/.config/` and edit `~/.config/sendxmpp.toml` with your XMPP credentials
2021-01-16 02:06:05 -05:00
```
Usage: sendxmpp [OPTIONS] [ARGUMENTS]
Positional arguments:
recipients
Optional arguments:
-h, --help show this help message and exit
-c, --config CONFIG path to config file. default: ~/.config/sendxmpp.toml with fallback to /etc/sendxmpp/sendxmpp.toml
-e, --force-pgp Force OpenPGP encryption for all recipients
-a, --attempt-pgp Attempt OpenPGP encryption for all recipients
2022-11-04 21:52:14 -04:00
-r, --raw Send raw XML stream, cannot be used with recipients or PGP
-p, --presence Send a <presence/> after connecting before sending messages, required for receiving for --raw
-m, --muc Recipients are Multi-User Chats
-n, --nick NICK Nickname to use in Multi-User Chats
2021-01-16 02:06:05 -05:00
```
2017-08-11 00:37:50 -04:00
Usage examples:
- `echo "This is a test" | sendxmpp user@host`
- `sendxmpp user@host <README.md`
License
-------
2021-01-16 02:06:05 -05:00
GNU/AGPLv3 - Check LICENSE.md for details