Update README and fix manpage format problems
This commit is contained in:
parent
1b3bd8db45
commit
01cc0c4a35
2 changed files with 48 additions and 35 deletions
59
README.md
59
README.md
|
@ -18,29 +18,33 @@ There aren't any plans for matrix-send to support encryption.
|
|||
|
||||
In order to start using matrix-send, you need a config file. To copy the default configuration to .config, clone this repository and type `make config` as the desired user (not root).
|
||||
|
||||
Now edit the file ~/.config/matrix-send.conf. You will see three (uncommented) lines.
|
||||
Now edit the file ~/.config/matrix-send/config.lua. You will first see the `login` table.
|
||||
|
||||
```
|
||||
Server ...
|
||||
Username ...
|
||||
Password ...
|
||||
```lua
|
||||
-- This is a comment
|
||||
login = {
|
||||
server = "matrix-client.matrix.org" -- matrix.org
|
||||
username = "user"
|
||||
password = "password"
|
||||
}
|
||||
```
|
||||
|
||||
Delete the example values and enter in your credentials.
|
||||
|
||||
If you don't want to put your password in plain text, as matrix-send.conf is a shell script, you could do something like this:
|
||||
|
||||
```shell
|
||||
Password $(gpg -d /path/to/passwd.gpg)
|
||||
```
|
||||
|
||||
/path/to/passwd.gpg is a GPG-encrypted file containing only your password, once decrypted.
|
||||
|
||||
For more configuration options, see [matrix-send.conf(5)](https://jtbx.codeberg.page/man/matrix-send.conf.5).
|
||||
For more configuration options, see [matrix-send-config(5)](https://jtbx.codeberg.page/man/matrix-send-config.5).
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
Before you install, you will need a few dependencies:
|
||||
|
||||
* lua: >= 5.3
|
||||
* [luarocks](https://luarocks.org)
|
||||
* plus some luarocks packages...
|
||||
|
||||
To install matrix-send, run `make install` as root, in the cloned repository's directory.
|
||||
This will install all required packages, and copy matrix-send and its documentation to your system.
|
||||
|
||||
In order to send messages, you will need the Room ID of your choice. Find the room you want to send to, and find its Room ID in the settings or somewhere else. It will likely be under Advanced or something similar.
|
||||
|
||||
|
@ -52,4 +56,31 @@ matrix-send 'Hi!' \!asdfasdfasdfasdf:matrix.org
|
|||
|
||||
That will send the message "Hi!" to the Matrix room !asdfasdfasdfasdf:matrix.org.
|
||||
|
||||
If you don't want to type the long room ID every time, you can add an alias.
|
||||
|
||||
Open your configuration file, and create a `rooms` table like so:
|
||||
|
||||
```lua
|
||||
rooms = {
|
||||
}
|
||||
```
|
||||
|
||||
Now, you can add aliases. Say you wanted to add an alias called `lounge` for a room with room ID `!AbCdEfGhIjKlMn:matrix.org`.
|
||||
You would make it this way:
|
||||
|
||||
```lua
|
||||
rooms = {
|
||||
lounge = "!AbCdEfGhIjKlMn:matrix.org"
|
||||
}
|
||||
```
|
||||
|
||||
Multiple aliases are separated by commas (as with any Lua table):
|
||||
|
||||
```lua
|
||||
rooms = {
|
||||
lounge = "!AbCdEfGhIjKlMn:matrix.org", -- <-- notice the comma
|
||||
bathroom = "!OpQrStUvWxYz:matrix.org"
|
||||
}
|
||||
```
|
||||
|
||||
For more information, see [matrix-send(1)](https://jtbx.codeberg.page/man/matrix-send.1).
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue