jeremy/matrix-send
1
Fork 0
Code Releases Activity

Re-design matrix-send.conf man page

Browse source
This commit is contained in:
Jeremy Baxter 2022-08-03 11:19:55 +12:00
parent 9c636a88e3
commit e4d1d2cb20
1 changed files with 27 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

83
matrix-send.conf.5
View file

@ -1,11 +1,11 @@
.Dd $Mdocdate: August 2 2022 $ .Dd $Mdocdate: August 3 2022 $
.Dt MATRIX-SEND.CONF 5 .Dt MATRIX-SEND.CONF 5
.Os .Os
.Sh NAME .Sh NAME
.Nm matrix-send.conf .Nm matrix-send.conf
.Nd configuration file for matrix-send(1) .Nd configuration file for
.Xr matrix-send 1
.Sh DESCRIPTION .Sh DESCRIPTION
.Pp
.Xr matrix-send 1 .Xr matrix-send 1
sends messages to Matrix rooms. In order to send a message however, it needs 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 credentials for the account sending the message. These credentials are provided
@ -13,69 +13,40 @@ in the
.Nm .Nm
configuration file, as well as other options if you need them. configuration file, as well as other options if you need them.
.Pp .Pp
The following directives are available: The following configuration options are available:
.Bl -bullet .Bl -tag -width 11n
.It .Bl -tag -width keepenv
Server .It Ic Server Ar server
.Ar server The Client-Server API address of the Matrix server being used.
The Client-Server API URL for your Matrix server. .It Ic Username Ar username
.Pp The username of the account being used.
.It .It Ic Password Ar password
Username The password for the account being used.
.Ar username .It Ic CacheLocation Ar location
The username of your Matrix account. Modify the cache location from the default (~/.cache) to
.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
.Ar location . .Ar location .
.Pp .It Ic DefaultEvent Ar type
.It Modify the default event type from the default (m.text) to
DefaultEvent .Ar type .
.Ar type Supported types are m.text, and m.notice.
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 .El
.Sh FILES .Sh FILES
.Bl -tag -width ~/.config/matrix-send.conf .Bl -tag -width ~/.config/matrix-send.conf -compact
.It Pa ~/.config/matrix-send.conf .It Pa ~/.config/matrix-send.conf
configuration file for .Xr matrix-send 1
.Nm configuration file.
.It Pa ~/.cache/matrix-send/access-token .It Pa ~/.cache
default access token cache file Default cache location.
.El .El
.Sh EXAMPLES .Sh EXAMPLES
This configuration would sign into matrix.org under the user The following example logs into the user johndoe of the server with the
.Em johndoe Client-Server API address of matrix-client.matrix.org with the password
using the password supersecretpassword, and sets the default event type to m.notice.
.Em supersecretpassword :
.Bd -literal -offset indent .Bd -literal -offset indent
Server matrix-client.matrix.org Server matrix-client.matrix.org
Username johndoe Username johndoe
Password supersecretpassword Password supersecretpassword
DefaultEvent m.notice
.Ed .Ed
.Sh SEE ALSO .Sh SEE ALSO
.Xr matrix-send 1 .Xr matrix-send 1