.Dd $Mdocdate: July 29 2022 $
.Dt MATRIX-SEND.CONF 5
.Os
.Sh NAME
.Nm matrix-send.conf
.Nd configuration file for matrix-send(1)
.Sh DESCRIPTION
.Pp
.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 directives are available:
.Bl -bullet
.It
Server
.Ar server
        The Client-Server API URL for your Matrix server.
.It
Username
.Ar username
        The username of your Matrix account.
.It
Password
.Ar password
        The password to your Matrix account.
.It
AccessToken
.Ar token
        Instead of using a username and password to obtain an access token, use
.Ar token .
.It
CacheLocation
.Ar location
        Instead of caching access tokens to ~/.cache, cache them to
.Ar location .
.It
DefaultEvent
.Ar type
Use
.Ar type
as the default event type instead of m.text.
.El
.Pp
The following statements are available:
.Bl -bullet
.It
NoCache
        Don't cache access tokens.
.El
.Sh FILES
.Bl -tag -width ~/.config/matrix-send.conf
.It Pa ~/.config/matrix-send.conf
configuration file for
.Nm
.It Pa ~/.cache/matrix-send/access-token
default access token cache file
.El

.Sh EXAMPLES
This configuration would sign into matrix.org under the user
.Em johndoe
using the password
.Em supersecretpassword :
.Bd -literal -offset indent
Server matrix-client.matrix.org
Username johndoe
Password supersecretpassword
.Ed

.Sh SEE ALSO
.Xr matrix-send 1