Modules/helpop
From the makers of InspIRCd.
helpop module (InspIRCd-helpop version)
| 1.0 Documentation | 1.1 Documentation | 1.2 Documentation |
| Description
|
| The Helpop module adds support for the /helpop command, which allows users to get help on IRCd commands. |
| Configuration Tags
|
With this module, the following tag is required in the config:
<include file="helpop.conf"> 'file' is a full path to your helpop file (usually called helpop.conf). An example helpop file is in the inspircd docs directory, called 'helpop.conf.example' Every possible help topic is configured in the helpop.conf file, which contains a tag for each topic in the form: <helpop key="moo" value="information about moo cows here"> Newlines are permitted in values, and will be changed to send multiple lines of output to the user. |
| Additional Modes
|
| USERMODE: +h -- Marks a user as available for help. |
| Additional Commands
|
/helpop <text> /helpop index Index lists all available topics for help. /helpop kill This lists help on the kill topic. |
| Special Notes
|
The helpop file behaves like a normal InspIRCd config file, the tag name is the 'Entry', then it is preceded by several 'lines' (lineX in the file), each line is seperated and sent to the user as a single line. There are some reserved tags, these are:
An example of a helpop text file tag: <helpop key="vhost" value="/VHOST [username] [password] Authenticate for a vhost."> |
