OOMon: The OO IRC Monitor Bot

The oomon.cf file, demystified

NOTE: The format of the oomon.cf file may change without notice. Documentation reflecting those changes is NOT guaranteed to be shown in the text below.

B: (bot) lines

B:nickname:username:vhost:realname:opernick:operpass:

The B: line sets options regarding the OOMon's identity.

The nickname field tells OOMon what nick to use when it is connected to IRC.

The username field tells OOMon how to identify its username when it connects to IRC. This field can be left blank, as OOMon will try to retrieve its username from the operating system.

The vhost field tells OOMon what hostname it should connect to IRC from. If left blank, OOMon will retrieve the hostname from the operating system.

The realname field tells OOMon what to use as its IRCNAME when connecting to an IRC server.

The opernick field sets the nick OOMon should use when using the OPER command after connecting to the IRC server.

The operpass field sets the password OOMon should use when using the OPER command after connecting to the IRC server. This field must be the plaintext password!

S: (server) lines

S:hostname:port:password:channels:

The S: line tells OOMon how to connect to IRC.

The hostname field tells OOMon the address of the IRC server to connect to.

The port field tells OOMon what port to connect to.

The password field tells OOMon what password to use to gain access to the IRC server. This field must be the plaintext password! Leave this field blank if no password is required to connect.

The channels field tells OOMon what channels to join after connecting to the IRC server.

H: (help file) lines

H:filename:

An H: line tells OOMon where to find the help file.

I: (include) lines

I:filename:

An I: line tells OOMon to read an additional file for configuration data. This gives the user the ability to organize configuration information, such as placing user data in another file.

O: (operator) lines

O:handle:userhostmask:password:flags:

O: lines tell OOMon who is authorized to connect via DCC.

The handle field is "nickname" an oper identifies himself as when he uses the .auth command. If no handle is specified, the user's IRC nick is used for chatline features, etc.

The userhostmask field specifies what user@host mask the oper is allowed to connect from.

The password field sets the password the oper must enter when using the .auth command. If USE_CRYPT is set (see oomon.h) this field should be ciphertext. Otherwise, it is the plaintext password.

The flags field determines which commands the oper may use. Acceptable flags are:

  • C - Channel (.join, .part, .op)
  • D - D-line (.dline)
  • G - G-line (.gline, .gclone, .gflood, etc.)
  • K - K-line (.kline, .kclone, .kflood, etc.)
  • M - Master (.die, .reload, etc.)
  • N - Can see client nick changes
  • O - Oper (.kill, .multi, .list, etc.)
  • R - Remove (.command@otherbot)
  • W - Can see WALLOPS/OPERWALL/LOCOPS messages
  • X - Can see client connects/disconnects

The stock userlist.cf file contains the line:

O::*@*::

Don't be fooled. This is NOT a back door. Because this line does not specify any flags, it simply allows any user to connect and, after entering the .auth command without specifying a handle or password, talk on the chatline. If you don't want J. Random User connecting and using the chatline, remove this O: line.

E: (exception) lines

E:mask:

E: lines tell OOMon not to kill or k-line certain user@host masks.

M: (MOTD) line

M:filename:

The M: line tells OOMon what file to read when displaying the Message of the Day. The default is motd.txt.

G: (log) line

G:filename:

The G: line tells OOMon what file to write its log to. The default is "oomon.log".

H: (help file) line

H:filename:

The H: line tells OOMon what file to read when displaying help text The default is "oomon.help".

T: (OOMon settings file) line

T:filename:

The T: line tells OOMon what file to read or write when loading or saving its settings. The default is "oomon.settings".

U: (User settings file) line

U:filename:

The U: line tells OOMon what file to read/write when loading or saving user-specific settings (watches, etc.). The default is "users.db".

P: (port) lines

P:portnum:

The P: line tells OOMon what port to listen to for incoming OOMon connections. By default, OOMon listens to port 4000.

L: (link) lines

L:Handle:hostmask:password:flags:

This section is under construction

C: (connect) lines

C:Handle:hostname:password:flags:port:

This section is under construction

Y: (class) lines

Y:classnum:description:

The Y: lines set the descriptions associated with particular user classes when using the .class command.

W: (wingate) lines

W:vhost:

The W: line tells OOMon what hostname to use when detecting open-access WinGates and SOCKS proxies. By default, the vhost listed in the B: line is used.

This document is XHTML 1.0 Strict and CSS 3 compliant. Site issues/problems? Contact <avj> [at] <users.sf.net>