Added options to matrix-send(1)

This commit is contained in:
Jeremy Baxter 2022-07-29 06:50:07 +12:00
parent 11c736ae99
commit a4f1622aa0

View file

@ -19,6 +19,16 @@ It works by sending a JSON request to your Matrix server. The message
type will always be m.text, but other options may be considered in the
future.
.Pp
The options are as follows:
.Bl -tag -width keyword
.It Fl c
Clear cached access tokens.
.It Fl h
Show a help menu, then exit.
.It Fl V
Print version and program information, then exit
.El
.Pp
To begin, start by making a configuration file. This always has the location of
.Em ~/.config/matrix-send.conf .
@ -78,13 +88,17 @@ matrix-send "Hello world!" \!zyxwvutsrq:example.org
That should send a message saying
.Em Hello world!
to the room with the Room ID !zyxwvutsrq:example.org.
.Pp
By default,
.Nm
caches access tokens in
.Em $HOME/.cache/matrix-send/access-token .
If you would like to disable caching of access tokens, add NoCache to your
.Em matrix-send.conf .
.Pp
Encryption is not supported. All messages will be sent unencrypted.
There are currently no plans to add encryption to
.Nm .
.El
.Sh FILES