5 <helpop key="start" value="InspIRCd help system
7 This system provides help for commands and modes.
8 Specify your question or a command name as the
9 parameter for this command. If you are an oper
10 you must prefix your query with a ? symbol.
12 /HELPOP COMMANDS - To see a list of user commands
13 /HELPOP COPER - To see a list of oper commands
14 /HELPOP UMODES - To see a list of user modes
15 /HELPOP CHMODES - To see a list of channel modes">
17 <helpop key="nohelp" value="There is no help for the topic
18 you searched for. Please try again.">
24 <helpop key="commands" value="User Commands
26 USER NICK QUIT VERSION PING
27 PONG ADMIN PRIVMSG INFO TIME
28 WHOIS NOTICE JOIN NAMES PART
29 KICK MODE TOPIC WHO MOTD
30 RULES OPER LIST LUSERS STATS
31 USERHOST AWAY ISON SUMMON USERS
32 INVITE PASS WHOWAS LINKS MAP
33 COMMANDS MODULES KNOCK SILENCE DEVOICE
34 REMOVE UNINVITE VHOST WATCH USERIP">
36 <helpop key="watch" value="/WATCH [C|S|+/-[NICK]]
37 Adds or deletes a user from the watch list. C clears the list
38 and S queries the status.">
40 <helpop key="vhost" value="/VHOST [username] [password]
41 Authenticate for a vhost.">
43 <helpop key="kick" value="/REMOVE [channel] [nick] {[reason]}
44 Removes a user from a channel you specify. You must be
45 At least a channel halfoperator to remove a user.
46 A removed user will part with a message stating they
47 were removed from the channel and by whom.">
49 <helpop key="devoice" value="/DEVOICE [channel]
50 Devoices yourself from the specified channel.">
52 <helpop key="silence" value="/SILENCE +/-[nick]
53 A serverside /ignore of the given nick. It does not follow
54 the users nick so if they change their nick you will receive
55 their messages. /SILENCE without a parameter will list the nicks
56 that you have silenced.">
58 <helpop key="knock" value="/KNOCK [channel]
59 Sends a notice to a channel indicating you wish to join.">
61 <helpop key="user" value="/USER [ident] [local host] [remote host] :[GECOS]
62 This command is used by your client to register your irc session.
63 You should not use it during an established connection.">
65 <helpop key="nick" value="/NICK [new nick]
66 Change your nickname to [new nick].">
68 <helpop key="quit" value="/QUIT [reason]
69 Quit from IRC and end your current session.">
71 <helpop key="version" value="/VERSION
72 Returns the server's version number.">
74 <helpop key="ping" value="/PING [server]
75 Ping a server. Target server will answer with a PONG.">
77 <helpop key="pong" value="/PONG [server]
78 Your client should send this to answer server PINGs. You
79 should not issue this command manually.">
81 <helpop key="admin" value="/ADMIN [server]
82 Fetches the administrative information on the given server.">
84 <helpop key="privmsg" value="/MSG [target] [text]
85 Sends a message to a user or channel specified in [target].">
87 <helpop key="notice" value="/NOTICE [target] [text]
88 Sends a notice to a user or channel specified in [target].">
90 <helpop key="join" value="/JOIN [channel]{,[channel]} [key]{,[key]}
91 Joins one or more channels you provide the names for.">
93 <helpop key="names" value="/NAMES [channel]{,[channel]}
94 Return a list of users on the channels you provide.">
96 <helpop key="part" value="/PART [channel]{,[channel] [reason]}
97 Leaves one or more channels you specify.">
99 <helpop key="kick" value="/KICK [channel] [nick] {[reason]}
100 Kicks a user from a channel you specify. You must be
101 At least a channel halfoperator to kick a user.">
103 <helpop key="mode" value="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}
104 Sets the mode for a channel or a nickname specified in [target]
105 A user may only set modes upon themselves, and may not set the
106 +o usermode, and a user may only change channel modes of
107 channels where they are at least a halfoperator.">
109 <helpop key="topic" value="/TOPIC [channel] {topic}
110 Sets or retrieves the channel topic. If a channel topic is
111 given in the command and the channel is either not +t, or
112 You are at least a halfoperator, the channel topic will be
113 changed to the new one you provide.">
115 <helpop key="who" value="/WHO [ [search-pattern] [ohurmaiMplf] ]
116 Looks up the information of users matching the range you provide.
117 You may only /WHO nicknames in channels or on servers where you
118 share a common channel with them, or ones which are not +i (unless
119 you are an IRC operator). The search-pattern may be a special
120 sequence of characters determined by the flags given below, or
121 it may be one of a nickname, a channel, a hostmask, an ip address
122 mask or a server mask.
126 The following flags after the mask have the following affects:
128 o Show online IRC operators matching the mask
129 u Unlimit the results past the maximum /who results value
131 r Show all users whose realnames match the mask. When this
132 flag is set it overrides the meaning of the search-pattern,
133 which must contain a glob pattern intended to match GECOS
135 h Show real hostnames rather than masked hostnames (IRC
137 m Search for all users with a given set of user modes. When
138 this flag is set it overrides the meaning of the
139 search-pattern, which must contain the mode sequence to
140 search for, for example to find all users with +i and
141 without +s, issue the command WHO +i-s m.
142 a Show all users who have an away message matching the given mask
143 p Show all users who are connected on the given port number
144 i Show all users who have an ident (username) matching the given mask
145 M Show all users who have metadata attached to them with
147 l Show only local users
148 f Show only remote (far) users
150 You may combine multiple flags in one WHO command except where stated in the table above.">
152 <helpop key="motd" value="/MOTD [server]
153 Show the message of the day for [server]. Messages of the
154 day contain important server rules and notice and should be
155 read before using a server in any way!">
157 <helpop key="rules" value="/RULES
158 Show the rules file for the local server. This is similar in
159 effect to /MOTD except that rules are optional. All users are
160 sent the MOTD when they connect without having to request it.">
162 <helpop key="oper" value="/OPER [login] [password]
163 Attempts to authenticate a user as an IRC operator.
164 Please be aware that both successful and unsuccessful oper attempts
165 Are logged, and sent to online IRC operators.">
167 <helpop key="list" value="/LIST [pattern]
168 Creates a list of all existing channels matching the glob pattern
169 [pattern], e.g. *chat* or bot*.">
171 <helpop key="lusers" value="/LUSERS
172 Shows a count of local and remote users, servers and channels.">
174 <helpop key="userhost" value="/USERHOST [nickname]
175 Returns the hostname and nickname of a user, and some other
176 miscellaneous information.">
178 <helpop key="userip" value="/USERIP [nickname]
179 Returns the ip and nickname of a user.">
181 <helpop key="away" value="/AWAY {message}
182 If a message is given, marks you as being away, otherwise
183 removes your away status and previous message.">
185 <helpop key="ison" value="/ISON [nick] {[nick]...}
186 Returns a subset of the nicks you give, showing only those
187 that are currently online.">
189 <helpop key="summon" value="/SUMMON [user]
190 Summons a user from the shell where the ircd is running onto irc
191 This command is deprecated in the current protocol.">
193 <helpop key="users" value="/USERS
194 Shows users logged into the shell where the ircd is running.
195 This command is deprecated in the current protocol.">
197 <helpop key="invite" value="/INVITE [nick] [channel]
198 Invites a user to a channel. If the channel is NOT +i, any
199 user, channel op or not, may invite any other user to the
200 channel, so long as they are a member of that channel.
201 Otherwise, if +i is set only channel halfoperators
202 and above may invite users into the channel.">
204 <helpop key="pass" value="/PASS [password]
205 This command is used by your irc client when setting up
206 your irc session, and should not be issued by a fully
209 <helpop key="whowas" value="/WHOWAS [nick]
210 Returns a list of times the user was last seen on irc
211 along with the time they were last seen and their server.">
213 <helpop key="links" value="/LINKS
214 Shows all servers linked to this one. Note that in this
215 server implementation all links will be flattened as
216 a tree based layout is not in use.">
218 <helpop key="map" value="/MAP
219 Shows a graphical representation of all users and servers
220 on the network. The tree diagram is inaccurate in this
221 implementation as a tree based network is not in place.">
223 #####################
225 #####################
227 <helpop key="coper" value="Oper Commands
229 DIE RESTART KILL REHASH TRACE
230 CONNECT SQUIT MODULES MKPASSWD SHUN
231 KLINE QLINE GLINE ELINE ZLINE
232 SAJOIN SAPART SAMODE SAQUIT SANICK
233 SETIDLE SETHOST SETNAME SETIDENT SWHOIS
234 OPERMOTD CHGHOST CHGNAME CHGIDENT CBAN
235 NICKLOCK NICKUNLOCK LOADMODULE UNLOADMODULE GLOBOPS
236 SPYLIST SPYNAMES GLOADMODULE GUNLOADMODULE MKSHA256
237 FREEZE UNFREEZE OPERPERMS RCONNECT">
239 <helpop key="rconnect" value="/RCONNECT [source mask] [target mask]
240 All servers matching [source mask] will try to connect to
241 the first server in the config file matching [target mask].">
243 <helpop key="operperms" value="/OPERPERMS [nick]
244 List all commands an oper has access to use.">
246 <helpop key="freeze" value="/FREEZE [nick]
247 Prevents the user from sending commands until they reconnect.
248 User is also notified they have been frozen.">
250 <helpop key="unfreeze" value="/UNFREEZE [nick]
251 Unfreezes a user frozen by the /FREEZE command.">
253 <helpop key="spylist" value="/SPYLIST
254 Operates the same as /LIST but includes +s and +p channels.">
256 <helpop key="spynames" value="/SPYNAMES [channel]
257 Operates the same as /name but works on +s and +p channels.">
259 <helpop key="globops" value="/GLOBOPS [message]
260 Sends a message to all +g users.">
262 <helpop key="cban " value="/CBAN [channel] {[duration] :[reason]}
263 Sets or removes a channel ban. You must specify at least
264 3 parameters to add a ban, and one parameter to remove a ban.
265 The duration may be specified in seconds, or in the following format
266 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
267 5 minutes and 6 seconds. All fields in this format are optional.">
269 <helpop key="sajoin" value="/SAJOIN [nick] [channel]
270 Forces the user to join the channel.">
272 <helpop key="sapart" value="/SAPART [nick] [channel]
273 Forces the user to part the channel.">
275 <helpop key="samode" value="/SAMODE [#chan/nick] +/-[modes] {[parameters for modes]}
276 Gives the channel or nick the modes specified.">
278 <helpop key="sanick" value="/SANICK [nick] [new nick]
279 Changes the users nick to the new nick.">
281 <helpop key="saquit" value="/SAQUIT [nick] [reason]
282 Forces user to quit with the specified reason.">
284 <helpop key="setidle" value="/SETIDLE [idle time]
285 Sets your idle time (in seconds).">
287 <helpop key="sethost" value="/SETHOST [host]
288 Sets your host to the specified host.">
290 <helpop key="setident" value="/SETIDENT [ident]
291 Sets your ident to the specified ident.">
293 <helpop key="setname" value="/SETNAME [name]
294 Sets your name to the specified name.">
296 <helpop key="swhois" line="/SWHOIS [nick] [swhois]
297 Sets the users swhois field to the given swhois.">
299 <helpop key="mkpasswd" value="/MKPASSWD [hashtype] [plaintext]
300 Encodes the plaintext to an MD5 hash and displays the result.">
302 <helpop key="opermotd" value="/OPERMOTD
303 Re-displays the Oper MOTD.">
305 <helpop key="nicklock" value="/NICKLOCK [nick] [new nick]
306 Changes user's nick to the new nick, and forces
307 it to remain as such for the remainder of the session.">
309 <helpop key="nickunlock" value="/NICKUNLOCK [nick]
310 Allows the user to change nicks.">
312 <helpop key="chghost" value="/CHGHOST [nickname] [new hostname]
313 Changes the hostname of the user to the new hostname.">
315 <helpop key="chgname" value="/CHGNAME [nickname] [new name]
316 Changes the name of the user to the new name.">
318 <helpop key="chgident" value="/CHGIDENT [nickname] [new ident]
319 Changes the ident of the user to the new ident.">
321 <helpop key="shun" value="/SHUN [user@host] {[duration] :[reason]}
322 Sets or removes a shun (serverside ignore) on a host and ident mask.
323 You must specify at least 3 parameters to add a shun, and one
324 parameter to remove a shun (just the user@host section).
325 The duration may be specified in seconds, or in the following format
326 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
327 5 minutes and 6 seconds. All fields in this format are optional.">
329 <helpop key="die" value="/DIE [password]
330 If the correct password is provided, and you are an operator,
331 This command will shut down the local server.">
333 <helpop key="restart" value="/RESTART [password]
334 If the correct password is provided, and you are an operator,
335 This command will restart the local server.">
337 <helpop key="commands" value="/COMMANDS
338 Shows all currently available commands.">
340 <helpop key="kill" value="/KILL [user] [reason]
341 This command will disconnect a user from IRC with the given reason.">
343 <helpop key="rehash" value="/REHASH
344 This command will cause the server configuration file to be
345 re-read and values re-initialized.">
347 <helpop key="trace" value="/TRACE [nick|user@host|servermask]
348 This command will provide a list of all users and servers which
349 must be passed through or over to reach a given object (server or user).">
351 <helpop key="connect" value="/CONNECT [servermask]
352 Create a mesh connection to the given servermask. You must have
353 configured the server for linking in your configuration file,
354 and provided a password.">
356 <helpop key="squit" value="/SQUIT
357 Disconnects the local server from the mesh network, causing every
358 other server in the network to drop it.">
360 <helpop key="modules" value="/MODULES
361 Lists currently loaded modules, their memory offsets and version
362 numbers and flags. If you are not an operator, you will see reduced
365 <helpop key="loadmodule" value="/LOADMODULE [filename.so]
366 Loads a module into the IRCd.">
368 <helpop key="unloadmodule" value="/UNLOADMODULE [filename.so]
369 Unloads a module from the IRCd. The module cannot have the static
370 flag set (see the output of /MODULES).">
372 <helpop key="gloadmodule" value="/GLOADMODULE [filename.so]
373 Globally loads a module into the network.">
375 <helpop key="gunloadmodule" value="/GUNLOADMODULE [filename.so]
376 Globally unloads a module from the network. The module cannot
377 have the static flag set (see the output of /MODULES).">
379 <helpop key="kline" value="/KLINE [user@host] {[duration] :[reason]}
380 Sets or removes a k-line (host based ban) on a host and ident mask.
381 You must specify at least 3 parameters to add a ban, and one
382 parameter to remove a ban (just the user@host section).
383 The duration may be specified in seconds, or in the following format
384 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
385 5 minutes and 6 seconds. All fields in this format are optional.">
387 <helpop key="zline" value="/ZLINE [ipmask] {[duration] :[reason]}
388 Sets or removes a z-line (ip based ban) on an ip range mask.
389 You must specify at least 3 parameters to add a ban, and one
390 parameter to remove a ban (just the user@host section).
391 The duration may be specified in seconds, or in the following format
392 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
393 5 minutes and 6 seconds. All fields in this format are optional.">
395 <helpop key="qline" value="/QLINE [nickmask] {[duration] :[reason]}
396 Sets or removes a q-line (nick based ban) on a nick mask.
397 You must specify at least 3 parameters to add a ban, and one
398 parameter to remove a ban (just the user@host section).
399 The duration may be specified in seconds, or in the following format
400 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
401 5 minutes and 6 seconds. All fields in this format are optional.">
403 <helpop key="gline" value="/GLINE [user@host] {[duration] :[reason]}
404 Sets or removes a g-line (global host based ban) on host mask.
405 You must specify at least 3 parameters to add a ban, and one
406 parameter to remove a ban (just the user@host section).
407 The duration may be specified in seconds, or in the following format
408 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
409 5 minutes and 6 seconds. All fields in this format are optional.">
411 <helpop key="eline" value="/ELINE [user@host] {[duration] :[reason]}
412 Sets or removes a e-line (local ban exception) on host mask.
413 You must specify at least 3 parameters to add an exception, and one
414 parameter to remove an exception (just the user@host section).
415 The duration may be specified in seconds, or in the following format
416 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
417 5 minutes and 6 seconds. All fields in this format are optional.">
419 ######################
420 # User/Channel Modes #
421 ######################
423 <helpop key="umodes" value="User Modes
426 i Is invisible to /WHO
427 w Can receive wallops messages
428 s Can receive server notices
429 n [mask] Can receive server notices specified by [mask]
430 x Cloaked hostname (requires cloaking module)
431 g Can receive globops (requires globops module)
432 h Will receive helpops notification (requires helpop module)
433 r Nickname is registered
434 R Only registered users can PRIVMSG this nickname
436 G Messages are censored to user
437 W Can see when a user uses WHOIS on them
438 S mIRC colour codes are stripped to the user
439 D User can not receive PRIVMSGs">
441 <helpop key="chmodes" value="Channel Modes
443 v [nickname] Gives voice to [nickname] (can talk on +m channel)
444 h [nickname] Gives halfops to [nickname]
445 o [nickname] Gives ops to [nickname]
446 b [hostmask] Bans [hostmask] on the channel
447 a [nickname] Give protected status to [nickname] (+q only)
448 q [nickname] Give founder status to [nickname] (ulines only)
449 i Make the channel invite only, must /INVITE users
450 k [key] Set the channel key (password) to [key]
451 l [limit] Set the maximum possible users to [limit]
452 m Enable moderation. Only +vo(h) can speak
453 n Only users who are members of the channel may message it
454 p Make channel private (hide from /LIST)
455 s Make channel secret (can't be used at the same time as +p)
456 O Channel is IRCops only (can only be set by IRCops)
457 t Only halfops and above can change the topic
458 Q Only U-Lined servers/nicks can kick
459 T Only halfops/ops can send NOTICEs to the channel
460 C No CTCPs allowed to the channel
461 c mIRC colour codes blocked on the channel
462 S mIRC colour codes are stripped from the channel
463 e [hostmask] Ban exception on [hostmask]
464 K No /KNOCK allowed to channel
465 L [channel] If the channel is full, redirect users to [channel]
466 N No nick changes while on the channel
467 G Censors channel based on network censor config
468 g [word] All messages containing the word are blocked
469 I [hostmask] Invite exception allows user to join a channel with +i
470 j [joins]:[sec] Prevents join flooding
471 J [seconds] Prevents auto-rejoin on kick
472 f [*][lines]:[sec] Kick on text flood. With * user is banned
474 r Channel is registered
475 R Only registered users can join
476 M Non-registered users can't chat
478 x Join exception mask. Avoids +ibkO
480 NOTE: A large number of these modes are dependent upon server-side modules
481 being loaded by a server/network administrator. The actual modes available
482 on your network may be very different to this list. Please consult your
483 help channel if you have any questions.">
485 ######################
487 ######################
489 <helpop key="stats" value="/STATS [symbol]
490 Shows various server statistics. Depending on configuration this
491 command may be reserved for oper-only use.
495 m Show command statistics, number of times commands have been used
496 z Show memory usage statistics
497 o Show a list of all valid oper usernames and hostmasks
498 l Show all inbound and outbound server and client connections
500 k Show k-lines (local bans)
501 g Show g-lines (global bans)
502 q Show q-lines (nick mask bans)
503 Z Show z-lines (ip mask bans)
504 Y Show connection classes
506 U Show u-lined servers
507 P Show online opers and their idle times
508 I Show connect class permissions
509 e Show e-lines (local ban exemptions)
513 Note that all /STATS use is broadcast to online IRC operators.">