InspIRCd v4 is still early in development!
If you use this branch you may experience crashes, weird behaviour, and unannounced breaking changes.
You probably want to use InspIRCd v3 instead.
The "help" Module (v4)
Description
This module adds the /HELP
command which allows users to view help on various topics.
Configuration
To load this module use the following <module>
tag:
<module name="help">
<helpmsg>
The <helpmsg>
tag defines responses to the /HELPOP command. This tag can only be defined once.
Name | Type | Default Value | Description |
---|---|---|---|
nohelp | Text | There is no help for the topic you searched for. Please try again. | The message to respond with when a help topic does not exist. |
Example Usage
<helpmsg nohelp="There is no help for the topic you searched for. Please try again.">
<helptopic>
The <helptopic>
tag defines a help topic. This tag can be defined as many times as required.
Name | Type | Default Value | Description |
---|---|---|---|
key | Text | None | The name of this help topic. |
title | Text | None | The header for the help topic. |
value | Text | None | The contents of this help topic. This can be split over multiple lines if needed. |
Example Usage
<helptopic key="test"
title="Testing?"
value="This is a test!">
Commands
Name | Parameter Count | Syntax | Description |
---|---|---|---|
HELPOP | 0-1 | [<topic>] | Looks up help on a particular topic. |
Example Usage
Responds with the help introduction page:
/HELPOP
Responds with a list of all potential help topics:
/HELPOP index
Responds with the contents of the "example" help topic:
/HELPOP example
Special Notes
You may find it useful to use the predefined help file which ships with InspIRCd.
To use this add the following tag to your configuration:
<include file="examples/help.conf.example">