OpenChanfix - commands

Docs: installation - commands - database - opping logic - the config file

Commands

Interaction with OpenChanfix happens via messages to the OpenChanfix client. It will only respond to opered clients. Some commands are available to all opers, but most require an OpenChanfix account, and a flag.

Flags - Each OpenChanfix account can have certain flags. These allow you to execute certain commands, and are:

a - server admin (limited access to +u commands)
b - can block/unblock channels
c - can add/del notes/alerts to channels
f - can manual chanfix
o - owner
u - user management rights

Umodes - When logged in to the OpenChanfix client, it can message you whenever certain events happen. Setting certain umodes, just like on hybrid-compatible ircds, will make OpenChanfix send you a message when the corresponding event happens. The possible usermodes are:

a - auto fixing opless channel
b - block/unblock
c - manual chanfix
l - login/logout
m - main events
n - notes
u - user management

These are the available commands. [a] indicates that a serveradmin (user with +a flag) has access to this command, but only to affect users with the same main server as the admin.

Oper commands (require IRC Operator status).
SCORE <channel>	Shows the scores of the top-X in #channel.
SCORE <channel> <nick>	Shows the score of currently online client <nick> in #channel.
SCORE <channel> <user@host>	Shows the score of user@host in #channel.
CSCORE [arguments]	The same as SCORE, but with a compact output.
HISTORY <channel>	Shows the times that this channel has been manually fixed.
INFO <channel>	Shows information about the channel: all notes and whether is has been blocked.
STATUS	Shows a detailed status report.
LOGIN <user> <password>	Logs you in as <user>, if both your u@h and the password match. Note: for security reasons, you MUST message the login command to <username>@<server>, where <username> is OCF's username and <server> is OCF's server. Yes, the username and not the nickname. Additional note: for OpenChanfix 3.0.0 for ratbox 2.0.x, this does not work yet, unfortunately. So you'll have to /msg OCF itself. Our apologies for this inconsistency.
Logged in commands (require you to be logged in).
LOGOUT	Logs you out.
PASSWD <currentpass> <newpass>	Changes your password into <newpass>.
WHO	Shows a list of logged in users.
UMODE	This shows your current umode. For each flag, chanfix sends the user notices when other chanfix users perform certain actions.
UMODE <+\|-><flags>	With +flags, these flags are added to your current umode. With -flags, these flags are removed to your current umode.
CHECK <channel>	Shows how many opped clients OpenChanfix sees in this channel. Should only be used in case of desyncs. Sends a notice to all logged in users that this command has been used.
Channel commands (require c flag).
ADDNOTE <channel> <note>	Adds a note to a channel. This note is displayed whenever INFO <channel> is executed.
DELNOTE <channel> <num>	Removes note <num> from <channel>.
ALERT <channel>	Sets the ALERT flag of a channel. If CHANFIX <channel> is requested on a channel with the ALERT flag set, OpenChanfix will not fix it, but send a message back that this channel has some notes. A manual fix can still be forced by appending the OVERRIDE flag.
UNALERT <channel>	Removes the ALERT flag of a channel.
Chanfix commands (require f flag).
CHANFIX <channel> [optional comment]	Performs a manual fix on #channel. Adds a note to the channel that it has been chanfixed by you. If the optional comment is given, a note is added to the channel with that comment.
CHANFIX <channel> [OVERRIDE \| NOW \| !]	Performs a manual fix on #channel. Adds a note to the channel that it has been chanfixed by you. The override forces a manual fix if the channel is being automatically fixed or has an ALERT flag.
OPLIST <channel>	Gives a list of the top X user@hosts of #channel. Sends a notice to all logged in users that this command has been used.
OPNICKS <channel>	Shows a list of all opped clients OpenChanfix sees in this channel. Should only be used in case of desyncs. Sends a notice to all logged in users that this command has been used.
User management commands (require u flag or a flag [see top of page]).
WHOIS <user>	Shows all u@h and flags of <user>.
CHPASS <user> <password> [a]	Changes the password of <user>. Does not work on accounts with the o flag. Only people with the o flag can change the password of users with the u flag.
CHPASSHASH <user> <password hash> [a]	Changes the password hash of <user> directly. This is a DES password hash. Does not work on accounts with the o flag. Only people with the o flag can change the password of users with the u flag.
ADDUSER <user> <u@h> [a]	Adds a new user <user> with this user@host.
DELUSER <user> [a]	Removes a user. Does not work on accounts with the o flag. Only people with the o flag can remove users with the u flag.
ADDHOST <user> <u@h> [a]	Adds a host to a user. Does not work on accounts with the o flag. Only people with the o flag can add u@h of users with the u flag. Always works on yourself.
DELHOST <user> <u@h> [a]	Removes a host from a user. Does not work on accounts with the o flag. Only people with the o flag can remove u@h of users with the u flag. Always works on yourself.
ADDSERVER <user> <server>	Adds a server to a user. Does not work on accounts with the o flag. Only people with the o flag can add u@h of users with the u flag. Always works on yourself.
DELSERVER <user> <server>	Removes a server from a user. Does not work on accounts with the o flag. Only people with the o flag can remove u@h of users with the u flag. Always works on yourself.
ADDFLAG <user> <flag> [a]	Adds <flag> to <user>. Cannot be used to add the o flag. Only people with the o flag can grant the u flag.
DELFLAG <user> <flag> [a]	Removes <flag> from <user>. Cannot be used to remove the o flag. Only people with the o flag can remove the u flag.
WHOSERVER <server> [a]	Shows all accounts on this server.
Block commands (require b flag).
BLOCK <channel> <reason>	Stops #channel from being chanfixed. A note with <reason> is added to the channel.
UNBLOCK <channel>	Reallows #channel being chanfixed.
Owner commands (require o flag).
REHASH	Reloads the config file and the users file.
SET <setting> <value>	Sets <setting> to <value>. Possible settings: - ENABLE_AUTOFIX <on\|off> - ENABLE_CHANFIX <on\|off> - ENABLE_CHANNELBLOCK <on\|off> - NUM_SERVERS <number of servers on the network>