57 lines
1.7 KiB
Groff
57 lines
1.7 KiB
Groff
.Dd $Mdocdate: August 4 2022 $
|
|
.Dt MATRIX-SEND.CONF 5
|
|
.Os
|
|
.Sh NAME
|
|
.Nm matrix-send.conf
|
|
.Nd configuration file for
|
|
.Xr matrix-send 1
|
|
.Sh DESCRIPTION
|
|
.Xr matrix-send 1
|
|
sends messages to Matrix rooms. In order to send a message however, it needs
|
|
credentials for the account sending the message. These credentials are provided
|
|
in the
|
|
.Nm
|
|
configuration file, as well as other options if you need them.
|
|
.Pp
|
|
The following configuration options are available:
|
|
.Bl -tag -width 11n
|
|
.Bl -tag -width keepenv
|
|
.It Ic Server Ar server
|
|
The Client-Server API address of the Matrix server being used.
|
|
.It Ic Username Ar username
|
|
The username of the account being used.
|
|
.It Ic Password Ar password
|
|
The password for the account being used.
|
|
.It Ic AccessToken Ar token
|
|
Instead of authenticating via username and password to obtain an access token, use
|
|
.Ar token .
|
|
.It Ic CacheLocation Ar location
|
|
Modify the cache location from the default (~/.cache) to
|
|
.Ar location .
|
|
.It Ic NoCache
|
|
Don't cache access tokens.
|
|
.It Ic DefaultEvent Ar type
|
|
Modify the default event type from the default (m.text) to
|
|
.Ar type .
|
|
Supported types are m.text, and m.notice.
|
|
.El
|
|
.Sh FILES
|
|
.Bl -tag -width ~/.config/matrix-send.conf -compact
|
|
.It Pa ~/.config/matrix-send.conf
|
|
.Xr matrix-send 1
|
|
configuration file.
|
|
.It Pa ~/.cache
|
|
Default cache location.
|
|
.El
|
|
.Sh EXAMPLES
|
|
The following example logs into the user johndoe of the server with the
|
|
Client-Server API address of matrix-client.matrix.org with the password
|
|
supersecretpassword, and sets the default event type to m.notice.
|
|
.Bd -literal -offset indent
|
|
Server matrix-client.matrix.org
|
|
Username johndoe
|
|
Password supersecretpassword
|
|
DefaultEvent m.notice
|
|
.Ed
|
|
.Sh SEE ALSO
|
|
.Xr matrix-send 1
|