A simple IRC notifier
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

59 lines
1.8 KiB

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_]
# DESCRIPTION
Bell is a simple IRC "bot" meant to be combined with a bouncer such as
pounce(1) or soju(1).
It makes use of the Pushover notification service to send notifications to a
mobile device when a specified search pattern is found in a message.
A valid Pushover account is required to use this program.
# 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 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