awbot-greeter - Arch Linux Women IRC welcome bot
awgreeter [config_options]
awbot-greeter is a simple IRC robot which welcomes new people to an IRC channel. It is a fork of awbot-logr which is a fork of awbot.
OpenSSL and socat are required to connect to an IRC server.
The configuration file is /etc/awbot.conf. Configuration can be overridden on the command line by listing options.
- server=
-
The address of the IRC server to connect to.
- port=
-
The port to connect to. This must be the port used for SSL connections.
- nicks=( )
-
An array of IRC nicks to use. If a nick is in use, the next one in the array will be tried.
- nick=
-
Override nicks with a single nick. Used only for testing stuff.
- pass=
-
The corresponding password for the IRC nick. This is optional and can be left blank if there is no password.
Be sure to give the correct password. The bot will ignore NickServ.
WARNING When overriden from the command line, the shell may store the password in a history file.
- ircname=
-
A name like a real name.
- ircuser=
-
A user name like one used for UNIX accounts. It is optional and if not specified the first item in nicks is used.
- welcome=
-
The welcome message to greet new people with. This is an array where each item is a separate line.
The string %nick% is replaced by the nick of the person being greeted.
- notify=( )
-
An array of nicks to send a PM to notify of new people in the channel. This is optional.
- seenlist=
-
The path to the file where a list of seen nicks is kept. This is how the bot knows if a nick is new to the channel or not.
When setting up, populate this file with a list of nicks you kinow are not new.
- channel=
-
The channel to join and post messages to.
awbot is copyrighted work. Use `git shortlog -s` to get a list of current authors and contributors and their contact information.
awbot is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.