Added matrix-send.conf(5) manpage
This commit is contained in:
parent
717645a421
commit
e59bb405d6
1 changed files with 59 additions and 0 deletions
59
matrix-send.conf.5
Normal file
59
matrix-send.conf.5
Normal file
|
@ -0,0 +1,59 @@
|
||||||
|
.Dd $Mdocdate: July 28 2022 $
|
||||||
|
.Dt MATRIX-SEND.CONF 5
|
||||||
|
.Os
|
||||||
|
.Sh NAME
|
||||||
|
.Nm matrix-send.conf
|
||||||
|
.Nd configuration file for
|
||||||
|
.Xr 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
|
||||||
|
Your Matrix username.
|
||||||
|
.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, just use
|
||||||
|
.Ar token .
|
||||||
|
.It
|
||||||
|
CacheLocation
|
||||||
|
.Ar location
|
||||||
|
Instead of caching access tokens to ~/.cache, cache them to
|
||||||
|
.Ar location .
|
||||||
|
.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 SEE ALSO
|
||||||
|
.Xr matrix-send 1
|
Loading…
Add table
Add a link
Reference in a new issue