Update README and fix manpage format problems

This commit is contained in:
Jeremy Baxter 2023-01-01 12:29:50 +13:00
parent 1b3bd8db45
commit 01cc0c4a35
2 changed files with 48 additions and 35 deletions

View file

@ -71,24 +71,6 @@ Homeserver dialogue in the sign-in screen, then hovering
over it once entered. Your server's Client-Server API URL should appear once
you hover over it. If it doesn't appear, you should already have it.
.Pp
You may have noticed that with this configuration, your password
is visible in plain sight.
If you would like to have to encrypt your password before use,
you could
replace the
.Em login.password
line with something similar to this
.Pp
login.password = sh "gpg -d /path/to/passwd.gpg"
.Pp
where
.Em /path/to/passwd.gpg
is a GPG-encrypted plain text file containing only your password.
This line would mean that you would be asked for the passphrase required to
decrypt your password file before authenticating. This way, your password
is not in plain text.
More information on configuration options can be found in
.Xr matrix-send-config 5 .
.Pp
@ -99,9 +81,9 @@ This will be something like
.Em !zyxwvutsrq:example.org .
Type the Room ID as the argument after the message you wish to send.
You may have to escape the exclamation mark with a backslash. For example:
You may have to write the Room ID in quotes to avoid shell patterns.
.Pp
.Dl matrix-send "Hello world!" \\!zyxwvutsrq:example.org
.Dl matrix-send 'Hello world!' '!zyxwvutsrq:example.org'
.Pp
That would send a message saying
.Em Hello world!
@ -135,7 +117,7 @@ cache directory
.Sh EXAMPLES
Send a message saying "Hello world!" to the Matrix room !TfbDbeqp:example.org:
.Pp
.Dl matrix-send 'Hello world!' \\!TfbDbeqp:example.org
.Dl matrix-send 'Hello world!' '!TfbDbeqp:example.org'
.Pp
.Sh SEE ALSO