1 # Sample configuration file for m_helpop.so
2 # You can either copy this into your conf folder and set up the module to use it,
3 # or you can customise the responses for your network and/or add more.
5 <start line1=" InspIRCd help system"
6 line2=" --------------------"
8 line4="This system provides help for commands and modes."
9 line5="Specify your question or a command name as the"
10 line6="parameter for this command. If you are an oper"
11 line7="you must prefix your query with a ? symbol."
13 line9="/HELPOP COMMANDS - To see a list of user commands"
14 line10="/HELPOP COPER - To see a list of oper commands"
15 line11="/HELPOP UMODES - To see a list of user modes"
16 line12="/HELPOP CHMODES - To see a list of channel modes">
18 <nohelp line1="There is no help for the topic"
19 line2="You searched for. Please try again.">
21 <nohelpo line1="There is no help for the topic"
22 line2="You searched for. Please try again."
24 line4="Your Query has been forwarded to the IRCops">
26 <commands line1="User Commands"
28 line3="USER NICK QUIT VERSION PING"
29 line4="PONG ADMIN PRIVMSG INFO TIME"
30 line5="WHOIS NOTICE JOIN NAMES PART"
31 line6="KICK MODE TOPIC WHO MOTD"
32 line7="RULES OPER LIST LUSERS STATS"
33 line8="USERHOST AWAY ISON SUMMON USERS"
34 line9="INVITE PASS WHOWAS LINKS MAP">
36 <user line1="/USER [ident] [local host] [remote host] :[GECOS]"
37 line2="This command is used by your client to register your irc session."
38 line3="You should not use it during an established connection.">
40 <nick line1="/NICK [new nick]"
41 line2="Change your nickname to [new nick]">
43 <quit line1="/QUIT [reason]"
44 line2="Quit from IRC and end your current session">
46 <version line1="/VERSION"
47 line2="Returns the server's version number">
49 <ping line1="/PING [server]"
50 line2="Ping a server. Target server will answer with a PONG">
52 <pong line2="/PONG [server]"
53 line2="Your client should send this to answer server PINGs. You"
54 line3="should not issue this command manually.">
56 <admin line1="/ADMIN [server]"
57 line2="Fetches the administrative information on the given"
60 <privmsg line1="/MSG [target] [text]"
61 line2="Sends a message to a user or channel specified in [target]">
63 <notice line1="/NOTICE [target] [text]"
64 line2="Sends a notice to a user or channel specified in [target]">
66 <join line1="/JOIN [channel]{,[channel]} [key]{,[key]}"
67 line2="Joins one or more channels you provide the names for">
69 <names line1="/NAMES [channel]{,[channel]}"
70 line2="Return a list of users on the channels you provide">
72 <part line1="/PART [channel]{,[channel]}"
73 line2="Leaves one or more channels you specify">
75 <kick line1="/KICK [channel] [nick]"
76 line2="Kicks a user from a channel you specify. You must be"
77 line3-"At least a channel halfoperator to kick a user">
79 <mode line1="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}"
80 line2="Sets the mode for a channel or a nickname specified in [target]"
81 line3="A user may only set modes upon themselves, and may not set the"
82 line4="+o usermode, and a user may only change channel modes of"
83 line5="channels where they are at least a halfoperator.">
85 <topic line1="/TOPIC [channel] {topic}"
86 line2="Sets or retrieves the channel topic. If a channel topic is"
87 line3="given in teh command and the channel is either not +t, or"
88 line4="You are at least a halfoperator, the channel topic will be"
89 line5="changed to the new one you provide">
91 <who line1="/WHO [channel|nick|servermask|o 0]"
92 line2="Looks up the information of users matching the range you"
93 line3="provide. You may only /WHO nicknames in channels or on servers"
94 line4="where you share a common channel with them."
95 line5="The syntax '/WHO o 0' shows a list of online IRC operators.">
97 <motd line1="/MOTD [server]"
98 line2="Show the message of the day for [server]. Messages of the"
99 line3="day contain important server rules and notice and should be"
100 line4="read before using a server in any way!">
102 <rules line1="/RULES"
103 line2="Show the rules file for the local server. This is similar in"
104 line3="effect to /MOTD except that rules are optional. All users are"
105 line4="sent the MOTD when they connect without having to request it.">
107 <oper line1="/OPER [login] [password]"
108 line2="Attempts to authenticate a user as an IRC operator."
109 line3="Please be aware that both successful and unsucessful oper attempts"
110 line4="Are logged, and sent to online IRC operators">
113 <list line1="/LIST [pattern]"
114 line2="Creates a list of all existing channels matching the glob pattern"
115 line3="[pattern], e.g. *chat* or bot*">
117 <lusers line1="/LUSERS"
118 line2="Shows a count of local and remote users, servers and channels.">
120 <stats line1="/STATS [symbol]"
121 line2="Shows various server statistics. Depending on configuration this"
122 line3="command may be reserved for oper-only use."
124 line5="Valid symbols are:"
126 line7="m Show command statistics, number of times commands have been used"
127 line8="z Show memory usage statistics"
128 line9="o Show a list of all valid oper usernames and hostmasks"
129 line10="l Show all inbound and outbound server and client connections"
130 line11="u Show server uptime"
132 line13="Note that all /STATS use is broadcast to online IRC operators.">
134 <userhost line1="/USERHOST [nickname]"
135 line2="Returns the hostname and nickname of a user, and some other"
136 line3="miscellanious information.">
138 <away line1="/AWAY {message}"
139 line2="If a message is given, marks you as being away, otherwise"
140 line3="removes your away status and previous message">
142 <ison line1="/ISON [nick] {[nick]...}"
143 line2="Returns a subset of the nicks you give, showing only those"
144 line3="that are currently online.">
146 <summon line1="/SUMMON [user]"
147 line2="Summons a user from the shell where the ircd is running onto irc"
148 line3="This command is deprecated in the current protocol.">
150 <users line1="/USERS"
151 line2="Shows users logged into the shell where the ircd is running."
152 line3="This command is deprecated in the current protocol.">
154 <invite line1="/INVITE [nick] [channel]"
155 line2="Invites a user to a channel. If the channel is NOT +i, any"
156 line3="user, channel op or not, may invite any other user to the"
157 line4="channel, so long as they are a member of that channel."
158 line5="Otherwise, if +i is set only channel halfoperators"
159 line6="and above may invite users into the channel">
161 <pass line1="/PASS [password]"
162 line2="This command is used by your irc client when setting up"
163 line3="your irc session, and should not be issued by a fully"
164 line4="connected client.">
166 <whowas line1="/WHOWAS [nick]"
167 line2="Returns a list of times the user was last seen on irc"
168 line3="along with the time they were last seen and their server.">
170 <links line1="/LINKS"
171 line2="Shows all servers linked to this one. Note that in this"
172 line3="server implementation all links will be flattened as"
173 line4="a tree based layout is not in use.">
176 line2="Shows a graphical representation of all users and servers"
177 line3="on the network. The tree diagram is inaccurate in this"
178 line4="implementation as a tree based network is not in place.">
181 <coper line1="Oper Commands"
182 line2="-------------"
183 line3="DIE RESTART KILL REHASH TRACE"
184 line4="CONNECT SQUIT MODULES">
186 <die line1="/DIE [password]"
187 line2="If the correct password is provided, and you are an operator,"
188 line3="This command will shut down the local server.">
190 <restart line1="/RESTART [password]"
191 line2="If the correct password is provided, and you are an operator,"
192 line3="This command will restart the local server.">
194 <kill line1="/KILL [user] [reason]"
195 line2="This command will disconnect a user from IRC with the given"
198 <rehash line1="/REHASH"
199 line2="This command will cause the server configuration file to be"
200 line3="re-read and values re-initialised.">
202 <trace line1="/TRACE [nick|user@host|servermask]"
203 line2="This command will provide a list of all users and servers which"
204 line3="must be passed through or over to reach a given object (server"
207 <connect line1="/CONNECT [servermask]"
208 line2="Create a mesh connection to the given servermask. You must have"
209 line3="configured the server for linking in your configuration file,"
210 line4="and provided a password.">
212 <squit line1="/SQUIT"
213 line2="Disconnects the local server from the mesh network, causing every"
214 line3="other server in the mesh to drop it.">
216 <modules line1="/MODULES"
217 line2="Lists currently loaded modules, their memory offsets and version"
220 <umodes line1="User Modes"
222 line3="o Is an IRC operator"
223 line4="i Is invisible to /WHO"
224 line5="w Can receive wallops messages"
225 line6="s Can receive server notices"
226 line7="x Cloaked hostname (requires cloaking module)"
227 line8="g Can receive globops (requires globops module)"
228 line9="h Will receive helpops notification (requires helpop module)">
230 <chmodes line1="Channel Modes"
231 line2="-------------"
232 line3="v [nickname] Gives voice to [nickname] (can talk on +m channel)"
233 line4="h [nickname] Gives halfops to [nickname] (requires halfop module)"
234 line5="o [nickname] Gives ops to [nickname]"
235 line6="b [hostmask] Bans [hostmask] on the channel"
236 line7="i Make the channel invite only, must /INVITE users"
237 line8="k [key] Set the channel key (password) to [key]"
238 line9="l [limit] Set the maximum possible users to [limit]"
239 line10="m Enable moderation. Only +vo can speak"
240 line11="n Only users who are members of the channel may message it"
241 line12="p Make channel private (hide from /LIST)"
242 line13="s Make channel secret (can't be used at the same time as +p)"
243 line14="t Only halfops and above can change the topic">