Re-design matrix-send.conf man page
This commit is contained in:
parent
c4e397f77a
commit
4b1ab4b374
1 changed files with 27 additions and 56 deletions
|
@ -1,11 +1,11 @@
|
|||
.Dd $Mdocdate: August 2 2022 $
|
||||
.Dd $Mdocdate: August 3 2022 $
|
||||
.Dt MATRIX-SEND.CONF 5
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm matrix-send.conf
|
||||
.Nd configuration file for matrix-send(1)
|
||||
.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
|
||||
|
@ -13,69 +13,40 @@ 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.
|
||||
.Pp
|
||||
.It
|
||||
Username
|
||||
.Ar username
|
||||
The username of your Matrix account.
|
||||
.Pp
|
||||
.It
|
||||
Password
|
||||
.Ar password
|
||||
The password to your Matrix account.
|
||||
.Pp
|
||||
.It
|
||||
AccessToken
|
||||
.Ar token
|
||||
Instead of using a username and password to obtain an access token, use
|
||||
.Pp
|
||||
.Ar token .
|
||||
.It
|
||||
CacheLocation
|
||||
.Ar location
|
||||
Instead of caching access tokens to ~/.cache, cache them to
|
||||
.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 CacheLocation Ar location
|
||||
Modify the cache location from the default (~/.cache) to
|
||||
.Ar location .
|
||||
.Pp
|
||||
.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.
|
||||
.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
|
||||
.Bl -tag -width ~/.config/matrix-send.conf -compact
|
||||
.It Pa ~/.config/matrix-send.conf
|
||||
configuration file for
|
||||
.Nm
|
||||
.It Pa ~/.cache/matrix-send/access-token
|
||||
default access token cache file
|
||||
.Xr matrix-send 1
|
||||
configuration file.
|
||||
.It Pa ~/.cache
|
||||
Default cache location.
|
||||
.El
|
||||
|
||||
.Sh EXAMPLES
|
||||
This configuration would sign into matrix.org under the user
|
||||
.Em johndoe
|
||||
using the password
|
||||
.Em supersecretpassword :
|
||||
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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue