Browse Source

Adds man page document

master
Noah Pederson 10 months ago
parent
commit
222591b5a6
3 changed files with 67 additions and 1 deletions
  1. +3
    -0
      .gitignore
  2. +15
    -1
      README.md
  3. +49
    -0
      bell.1.scd

+ 3
- 0
.gitignore View File

@ -17,3 +17,6 @@
bell
config
config.packet
config.tilde
bell.1

+ 15
- 1
README.md View File

@ -1,4 +1,18 @@
# bell
Bell is a simple notification client intended for use with
[pounce(1)](https://git.causal.agency/pounce/) and maybe other IRC bouncers
[pounce(1)](https://git.causal.agency/pounce/) and maybe other IRC bouncers.
## Requirements
- Go 1.13+
- scdoc (for making docs)
## Usage
For usage details, please make the documentation and reference
```shell
scdoc < bell.1.scdoc > bell.1
man ./bell.1
```

+ 49
- 0
bell.1.scd View File

@ -0,0 +1,49 @@
bell(1)
# NAME
bell - a simple IRC notifier
# SYNOPSIS
_bell_ [*-h* _host_ ] [*-u* _user_] [*-p* _pass_] [*-m* _matches_] [*-n* _nick_]++
[*-a* _app-token_] [*-t* _user-token_] [*-e* _exclude-channels_]++
[*-x* _exclude-users_] [_config_]
# OPTIONS
*-h* _host_, *host =* _host_
Set's host to connect to. This should probably be an IRC bouncer.
*-u* _user_, *user =* _host_
Username for bell to connect to <host> as. Defaults to -bell
*-p* _pass_, *pass =* _pass_
Password to authenticate to _<host>_ to.
Currently only supports plaintext.
*-m* _matches_, *match =* _matches_
A comman delimited list of words to search for in IRC messages that trigger
notifications.
Currently, only plaintext exact matches are supported.
If none are specified, _<nick>_ is used.
*-n* _nick_, *nick =* _nick_
Nickname of IRC user. This is mostly relevant when *-m* or **
*-a* _app-token_, *app-token =* _app-token_
App token from Pushover to authenticate this app.
*-t* _user-token_, *user-token =* _user-token_
User token from Pushover user to determine which user to send notifications to.
*-e* _exclude-channels_, *exclude-channels =* _exclude-channels_
A comma delimited list of channels to exclude from checking for _matches_
*-x* _exclude-users_, *exclude-users =* _exclude-users_
A comma delimited list of users to exclude from checking for _matches_
# AUTHORS
Maintained by Noah Pederson <noah@packetlost.dev>. For more information about bell development, see https://git.packetlostandfound.us/chiefnoah/bell

Loading…
Cancel
Save