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">
19 <nohelp line1="There is no help for the topic"
20 line2="You searched for. Please try again.">
23 <nohelpo line1="There is no help for the topic"
24 line2="You searched for. Please try again."
26 line4="Your Query has been forwarded to an IRCop">
28 <commands line1="User Commands"
30 line3="USER NICK QUIT VERSION PING"
31 line4="PONG ADMIN PRIVMSG INFO TIME"
32 line5="WHOIS NOTICE JOIN NAMES PART"
33 line6="KICK MODE TOPIC WHO MOTD"
34 line7="RULES OPER LIST LUSERS STATS"
35 line8="USERHOST AWAY ISON SUMMON USERS"
36 line9="INVITE PASS WHOWAS LINKS MAP">
38 <user line1="/USER [ident] [local host] [remote host] :[GECOS]"
39 line2="This command is used by your client to register your irc session."
40 line3="You should not use it during an established connection.">
42 <nick line1="/NICK [new nick]"
43 line2="Change your nickname to [new nick]">
45 <quit line1="/QUIT [reason]"
46 line2="Quit from IRC and end your current session">
48 <version line1="/VERSION"
49 line2="Returns the server's version number">
51 <ping line1="/PING [server]"
52 line2="Ping a server. Target server will answer with a PONG">
54 <pong line2="/PONG [server]"
55 line2="Your client should send this to answer server PINGs. You"
56 line3="should not issue this command manually.">
58 <admin line1="/ADMIN [server]"
59 line2="Fetches the administrative information on the given"
62 <privmsg line1="/MSG [target] [text]"
63 line2="Sends a message to a user or channel specified in [target]">
65 <notice line1="/NOTICE [target] [text]"
66 line2="Sends a notice to a user or channel specified in [target]">
68 <join line1="/JOIN [channel]{,[channel]} [key]{,[key]}"
69 line2="Joins one or more channels you provide the names for">
71 <names line1="/NAMES [channel]{,[channel]}"
72 line2="Return a list of users on the channels you provide">
74 <part line1="/PART [channel]{,[channel]}"
75 line2="Leaves one or more channels you specify">
77 <kick line1="/KICK [channel] [nick]"
78 line2="Kicks a user from a channel you specify. You must be"
79 line3-"At least a channel halfoperator to kick a user">
81 <mode line1="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}"
82 line2="Sets the mode for a channel or a nickname specified in [target]"
83 line3="A user may only set modes upon themselves, and may not set the"
84 line4="+o usermode, and a user may only change channel modes of"
85 line5="channels where they are at least a halfoperator.">
87 <topic line1="/TOPIC [channel] {topic}"
88 line2="Sets or retrieves the channel topic. If a channel topic is"
89 line3="given in teh command and the channel is either not +t, or"
90 line4="You are at least a halfoperator, the channel topic will be"
91 line5="changed to the new one you provide">
93 <who line1="/WHO [channel|nick|servermask|o 0]"
94 line2="Looks up the information of users matching the range you"
95 line3="provide. You may only /WHO nicknames in channels or on servers"
96 line4="where you share a common channel with them."
97 line5="The syntax '/WHO o 0' shows a list of online IRC operators.">
99 <motd line1="/MOTD [server]"
100 line2="Show the message of the day for [server]. Messages of the"
101 line3="day contain important server rules and notice and should be"
102 line4="read before using a server in any way!">
104 <rules line1="/RULES"
105 line2="Show the rules file for the local server. This is similar in"
106 line3="effect to /MOTD except that rules are optional. All users are"
107 line4="sent the MOTD when they connect without having to request it.">
109 <oper line1="/OPER [login] [password]"
110 line2="Attempts to authenticate a user as an IRC operator."
111 line3="Please be aware that both successful and unsucessful oper attempts"
112 line4="Are logged, and sent to online IRC operators">
115 <list line1="/LIST [pattern]"
116 line2="Creates a list of all existing channels matching the glob pattern"
117 line3="[pattern], e.g. *chat* or bot*">
119 <lusers line1="/LUSERS"
120 line2="Shows a count of local and remote users, servers and channels.">
122 <stats line1="/STATS [symbol]"
123 line2="Shows various server statistics. Depending on configuration this"
124 line3="command may be reserved for oper-only use."
126 line5="Valid symbols are:"
128 line7="m Show command statistics, number of times commands have been used"
129 line8="z Show memory usage statistics"
130 line9="o Show a list of all valid oper usernames and hostmasks"
131 line10="l Show all inbound and outbound server and client connections"
132 line11="u Show server uptime"
134 line13="Note that all /STATS use is broadcast to online IRC operators.">
136 <userhost line1="/USERHOST [nickname]"
137 line2="Returns the hostname and nickname of a user, and some other"
138 line3="miscellanious information.">
140 <away line1="/AWAY {message}"
141 line2="If a message is given, marks you as being away, otherwise"
142 line3="removes your away status and previous message">
144 <ison line1="/ISON [nick] {[nick]...}"
145 line2="Returns a subset of the nicks you give, showing only those"
146 line3="that are currently online.">
148 <summon line1="/SUMMON [user]"
149 line2="Summons a user from the shell where the ircd is running onto irc"
150 line3="This command is deprecated in the current protocol.">
152 <users line1="/USERS"
153 line2="Shows users logged into the shell where the ircd is running."
154 line3="This command is deprecated in the current protocol.">
156 <invite line1="/INVITE [nick] [channel]"
157 line2="Invites a user to a channel. If the channel is NOT +i, any"
158 line3="user, channel op or not, may invite any other user to the"
159 line4="channel, so long as they are a member of that channel."
160 line5="Otherwise, if +i is set only channel halfoperators"
161 line6="and above may invite users into the channel">
163 <pass line1="/PASS [password]"
164 line2="This command is used by your irc client when setting up"
165 line3="your irc session, and should not be issued by a fully"
166 line4="connected client.">
168 <whowas line1="/WHOWAS [nick]"
169 line2="Returns a list of times the user was last seen on irc"
170 line3="along with the time they were last seen and their server.">
172 <links line1="/LINKS"
173 line2="Shows all servers linked to this one. Note that in this"
174 line3="server implementation all links will be flattened as"
175 line4="a tree based layout is not in use.">
178 line2="Shows a graphical representation of all users and servers"
179 line3="on the network. The tree diagram is inaccurate in this"
180 line4="implementation as a tree based network is not in place.">
183 <coper line1="Oper Commands"
184 line2="-------------"
185 line3="DIE RESTART KILL REHASH TRACE"
186 line4="CONNECT SQUIT MODULES">
188 <die line1="/DIE [password]"
189 line2="If the correct password is provided, and you are an operator,"
190 line3="This command will shut down the local server.">
192 <restart line1="/RESTART [password]"
193 line2="If the correct password is provided, and you are an operator,"
194 line3="This command will restart the local server.">
196 <kill line1="/KILL [user] [reason]"
197 line2="This command will disconnect a user from IRC with the given"
200 <rehash line1="/REHASH"
201 line2="This command will cause the server configuration file to be"
202 line3="re-read and values re-initialised.">
204 <trace line1="/TRACE [nick|user@host|servermask]"
205 line2="This command will provide a list of all users and servers which"
206 line3="must be passed through or over to reach a given object (server"
209 <connect line1="/CONNECT [servermask]"
210 line2="Create a mesh connection to the given servermask. You must have"
211 line3="configured the server for linking in your configuration file,"
212 line4="and provided a password.">
214 <squit line1="/SQUIT"
215 line2="Disconnects the local server from the mesh network, causing every"
216 line3="other server in the mesh to drop it.">
218 <modules line1="/MODULES"
219 line2="Lists currently loaded modules, their memory offsets and version"
222 <umodes line1="User Modes"
224 line3="o Is an IRC operator"
225 line4="i Is invisible to /WHO"
226 line5="w Can receive wallops messages"
227 line6="s Can receive server notices"
228 line7="x Cloaked hostname (requires cloaking module)"
229 line8="g Can receive globops (requires globops module)"
230 line9="h Will receive helpops notification (requires helpop module)">
232 <chmodes line1="Channel Modes"
233 line2="-------------"
234 line3="v [nickname] Gives voice to [nickname] (can talk on +m channel)"
235 line4="h [nickname] Gives halfops to [nickname] (requires halfop module)"
236 line5="o [nickname] Gives ops to [nickname]"
237 line6="b [hostmask] Bans [hostmask] on the channel"
238 line7="i Make the channel invite only, must /INVITE users"
239 line8="k [key] Set the channel key (password) to [key]"
240 line9="l [limit] Set the maximum possible users to [limit]"
241 line10="m Enable moderation. Only +vo can speak"
242 line11="n Only users who are members of the channel may message it"
243 line12="p Make channel private (hide from /LIST)"
244 line13="s Make channel secret (can't be used at the same time as +p)"
245 line14="t Only halfops and above can change the topic">