jeremy/matrix-send
1
Fork 0
Code Releases Activity

Added options to matrix-send(1)

Browse source
This commit is contained in:
Jeremy Baxter 2022-07-29 06:50:07 +12:00
parent 11c736ae99
commit a4f1622aa0
1 changed files with 15 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

16
matrix-send.1
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 type will always be m.text, but other options may be considered in the
future. future.
.Pp .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 To begin, start by making a configuration file. This always has the location of
.Em ~/.config/matrix-send.conf . .Em ~/.config/matrix-send.conf .
@ -78,13 +88,17 @@ matrix-send "Hello world!" \!zyxwvutsrq:example.org
That should send a message saying That should send a message saying
.Em Hello world! .Em Hello world!
to the room with the Room ID !zyxwvutsrq:example.org. to the room with the Room ID !zyxwvutsrq:example.org.
.Pp
By default, By default,
.Nm .Nm
caches access tokens in caches access tokens in
.Em $HOME/.cache/matrix-send/access-token . .Em $HOME/.cache/matrix-send/access-token .
If you would like to disable caching of access tokens, add NoCache to your If you would like to disable caching of access tokens, add NoCache to your
.Em matrix-send.conf . .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 .El
.Sh FILES .Sh FILES