jeremy/matrix-send
1
Fork 0
Code Releases Activity

Added -t option

Browse source
This commit is contained in:
Jeremy Baxter 2022-07-29 08:12:43 +12:00
parent b98624bc78
commit 9591bcdaa6
5 changed files with 82 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

24
matrix-send.1
View file

@ -1,4 +1,4 @@
.Dd $Mdocdate: July 28 2022 $
.Dd $Mdocdate: July 29 2022 $
.Dt MATRIX-SEND 1
.Os
.Sh NAME
@ -7,6 +7,7 @@
.Sh SYNOPSIS
.Nm matrix-send
.Bk -words
.Op Fl t Ar type
.Op Fl c
.Op Fl h
.Op Fl v
@ -15,18 +16,27 @@
.Sh DESCRIPTION
.Nm
is a script to send a message to a Matrix room.
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.
It works by sending a JSON message to your Matrix server. The default message
type is m.text, but you can specify a custom type with
.Em -t .
.Pp
The options are as follows:
.Bl -tag -width keyword
.It Fl t Ar type
Change the event type to
.Ar type .
Currently supported types are
.Em m.text
and
.Em m.notice .
Default is
.Em m.text .
.It Fl c
Clear cached access tokens.
.It Fl h
Show a help menu, then exit.
Show the help menu, then exit.
.It Fl V
Print version and program information, then exit
Print version and program information, then exit.
.El
.Pp
To begin, start by making a configuration file. This always has the location of
@ -82,7 +92,7 @@ This will be something like
Type the Room ID as the argument after the message you wish to send.
You may have to escape the exclamation mark with a backslash. For example:
.Bd -literal -offset indent
matrix-send "Hello world!" \!zyxwvutsrq:example.org
matrix-send "Hello world!" \\!zyxwvutsrq:example.org
.Ed
.Pp
That should send a message saying