1 #####################
\r# Helpop Standard #
\r#####################
\r\r<helpop key="start" value="InspIRCd help system
\r-
\rThis system provides help for commands and modes.
\rSpecify your question or a command name as the
\rparameter for this command. If you are an oper
\ryou must prefix your query with a ? symbol.
\r-
\r/HELPOP COMMANDS - To see a list of user commands
\r/HELPOP COPER - To see a list of oper commands
\r/HELPOP UMODES - To see a list of user modes
\r/HELPOP CHMODES - To see a list of channel modes">
\r\r<helpop key="nohelp" value="There is no help for the topic
\ryou searched for. Please try again.">
\r\r#####################
\r# User Commands #
\r#####################
\r\r<helpop key="commands" value="User Commands
\r-------------
\rUSER NICK QUIT VERSION PING
\rPONG ADMIN PRIVMSG INFO TIME
\rWHOIS NOTICE JOIN NAMES PART
\rKICK MODE TOPIC WHO MOTD
\rRULES OPER LIST LUSERS STATS
\rUSERHOST AWAY ISON SUMMON USERS
\rINVITE PASS WHOWAS LINKS MAP
\rCOMMANDS MODULES KNOCK SILENCE DEVOICE
\rREMOVE UNINVITE VHOST WATCH USERIP">
\r\r<helpop key="watch" value="/WATCH [C|S|+/-[NICK]]
\rAdds or deletes a user from the watch list. C clears the list
\rand S queries the status.">
\r\r<helpop key="vhost" value="/VHOST [username] [password]
\rAuthenticate for a vhost.">
\r\r<helpop key="kick" value="/REMOVE [channel] [nick] {[reason]}
\rRemoves a user from a channel you specify. You must be
\rAt least a channel halfoperator to remove a user.
\rA removed user will part with a message stating they
\rwere removed from the channel and by whom.">
\r\r<helpop key="devoice" value="/DEVOICE [channel]
\rDevoices yourself from the specified channel.">
\r\r<helpop key="silence" value="/SILENCE [+/-]<hostmask> [p|c|i|n|t|a|x]
\r p Block private messages
\r c Block channel messages
\r i Block invites
\r n Block private notices
\r t Block channel notices
\r a Block all of the above
\r x Exception
\rA serverside /ignore of the given hostmask.
\r/SILENCE without a parameter will list the hostmasks that you have silenced.">
\r\r<helpop key="knock" value="/KNOCK [channel]
\rSends a notice to a channel indicating you wish to join.">
\r\r<helpop key="user" value="/USER [ident] [local host] [remote host] :[GECOS]
\rThis command is used by your client to register your irc session.
\rYou should not use it during an established connection.">
\r\r<helpop key="nick" value="/NICK [new nick]
\rChange your nickname to [new nick].">
\r\r<helpop key="quit" value="/QUIT [reason]
\rQuit from IRC and end your current session.">
\r\r<helpop key="version" value="/VERSION
\rReturns the server's version number.">
\r\r<helpop key="ping" value="/PING [server]
\rPing a server. Target server will answer with a PONG.">
\r\r<helpop key="pong" value="/PONG [server]
\rYour client should send this to answer server PINGs. You
\rshould not issue this command manually.">
\r\r<helpop key="admin" value="/ADMIN [server]
\rFetches the administrative information on the given server.">
\r\r<helpop key="privmsg" value="/MSG [target] [text]
\rSends a message to a user or channel specified in [target].">
\r\r<helpop key="notice" value="/NOTICE [target] [text]
\rSends a notice to a user or channel specified in [target].">
\r\r<helpop key="join" value="/JOIN [channel]{,[channel]} [key]{,[key]}
\rJoins one or more channels you provide the names for.">
\r\r<helpop key="names" value="/NAMES [channel]{,[channel]}
\rReturn a list of users on the channels you provide.">
\r\r<helpop key="part" value="/PART [channel]{,[channel] [reason]}
\rLeaves one or more channels you specify.">
\r\r<helpop key="kick" value="/KICK [channel] [nick] {[reason]}
\rKicks a user from a channel you specify. You must be
\rAt least a channel halfoperator to kick a user.">
\r\r<helpop key="mode" value="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}
\rSets the mode for a channel or a nickname specified in [target]
\rA user may only set modes upon themselves, and may not set the
\r+o usermode, and a user may only change channel modes of
\rchannels where they are at least a halfoperator.">
\r\r<helpop key="topic" value="/TOPIC [channel] {topic}
\rSets or retrieves the channel topic. If a channel topic is
\rgiven in the command and the channel is either not +t, or
\rYou are at least a halfoperator, the channel topic will be
\rchanged to the new one you provide.">
\r\r<helpop key="who" value="/WHO [ [search-pattern] [ohurmaiMplf] ]
\rLooks up the information of users matching the range you provide.
\rYou may only /WHO nicknames in channels or on servers where you
\rshare a common channel with them, or ones which are not +i (unless
\ryou are an IRC operator). The search-pattern may be a special
\rsequence of characters determined by the flags given below, or
\rit may be one of a nickname, a channel, a hostmask, an ip address
\rmask or a server mask.
\r-
\rValid WHO flags
\r---------------
\rThe following flags after the mask have the following affects:
\r-
\r o Show online IRC operators matching the mask
\r u Unlimit the results past the maximum /who results value
\r (IRC operators only)
\r r Show all users whose realnames match the mask. When this
\r flag is set it overrides the meaning of the search-pattern,
\r which must contain a glob pattern intended to match GECOS
\r (realname) fields.
\r h Show real hostnames rather than masked hostnames (IRC
\r operators only)
\r m Search for all users with a given set of user modes. When
\r this flag is set it overrides the meaning of the
\r search-pattern, which must contain the mode sequence to
\r search for, for example to find all users with +i and
\r without +s, issue the command WHO +i-s m.
\r a Show all users who have an away message matching the given mask
\r p Show all users who are connected on the given port number
\r i Show all users who have an ident (username) matching the given mask
\r M Show all users who have metadata attached to them with
\r the given key name
\r l Show only local users
\r f Show only remote (far) users
\r-
\rYou may combine multiple flags in one WHO command except where stated in the table above.">
\r\r<helpop key="motd" value="/MOTD [server]
\rShow the message of the day for [server]. Messages of the
\rday contain important server rules and notice and should be
\rread before using a server in any way!">
\r\r<helpop key="rules" value="/RULES
\rShow the rules file for the local server. This is similar in
\reffect to /MOTD except that rules are optional. All users are
\rsent the MOTD when they connect without having to request it.">
\r\r<helpop key="oper" value="/OPER [login] [password]
\rAttempts to authenticate a user as an IRC operator.
\rPlease be aware that both successful and unsuccessful oper attempts
\rAre logged, and sent to online IRC operators.">
\r\r<helpop key="list" value="/LIST [pattern]
\rCreates a list of all existing channels matching the glob pattern
\r[pattern], e.g. *chat* or bot*.">
\r\r<helpop key="lusers" value="/LUSERS
\rShows a count of local and remote users, servers and channels.">
\r\r<helpop key="userhost" value="/USERHOST [nickname]
\rReturns the hostname and nickname of a user, and some other
\rmiscellaneous information.">
\r\r<helpop key="userip" value="/USERIP [nickname]
\rReturns the ip and nickname of a user.">
\r\r<helpop key="away" value="/AWAY {message}
\rIf a message is given, marks you as being away, otherwise
\rremoves your away status and previous message.">
\r\r<helpop key="ison" value="/ISON [nick] {[nick]...}
\rReturns a subset of the nicks you give, showing only those
\rthat are currently online.">
\r\r<helpop key="summon" value="/SUMMON [user]
\rSummons a user from the shell where the ircd is running onto irc
\rThis command is deprecated in the current protocol.">
\r\r<helpop key="users" value="/USERS
\rShows users logged into the shell where the ircd is running.
\rThis command is deprecated in the current protocol.">
\r\r<helpop key="invite" value="/INVITE [nick] [channel]
\rInvites a user to a channel. If the channel is NOT +i, any
\ruser, channel op or not, may invite any other user to the
\rchannel, so long as they are a member of that channel.
\rOtherwise, if +i is set only channel halfoperators
\rand above may invite users into the channel.">
\r\r<helpop key="pass" value="/PASS [password]
\rThis command is used by your irc client when setting up
\ryour irc session, and should not be issued by a fully
\rconnected client.">
\r\r<helpop key="whowas" value="/WHOWAS [nick]
\rReturns a list of times the user was last seen on irc
\ralong with the time they were last seen and their server.">
\r\r<helpop key="links" value="/LINKS
\rShows all servers linked to this one. Note that in this
\rserver implementation all links will be flattened as
\ra tree based layout is not in use.">
\r\r<helpop key="map" value="/MAP
\rShows a graphical representation of all users and servers
\ron the network. The tree diagram is inaccurate in this
\rimplementation as a tree based network is not in place.">
\r\r#####################
\r# Oper Commands #
\r#####################
\r\r<helpop key="coper" value="Oper Commands
\r-------------
\rDIE RESTART KILL REHASH TRACE
\rCONNECT SQUIT MODULES MKPASSWD SHUN
\rKLINE QLINE GLINE ELINE ZLINE
\rSAJOIN SAPART SAMODE SAQUIT SANICK
\rSETIDLE SETHOST SETNAME SETIDENT SWHOIS
\rOPERMOTD CHGHOST CHGNAME CHGIDENT CBAN
\rNICKLOCK NICKUNLOCK LOADMODULE UNLOADMODULE GLOBOPS
\rSPYLIST SPYNAMES GLOADMODULE GUNLOADMODULE MKSHA256
\rFREEZE UNFREEZE OPERPERMS RCONNECT">
\r\r<helpop key="rconnect" value="/RCONNECT [source mask] [target mask]
\rAll servers matching [source mask] will try to connect to
\rthe first server in the config file matching [target mask].">
\r\r<helpop key="operperms" value="/OPERPERMS [nick]
\rList all commands an oper has access to use.">
\r\r<helpop key="freeze" value="/FREEZE [nick]
\rPrevents the user from sending commands until they reconnect.
\rUser is also notified they have been frozen.">
\r\r<helpop key="unfreeze" value="/UNFREEZE [nick]
\rUnfreezes a user frozen by the /FREEZE command.">
\r\r<helpop key="spylist" value="/SPYLIST
\rOperates the same as /LIST but includes +s and +p channels.">
\r\r<helpop key="spynames" value="/SPYNAMES [channel]
\rOperates the same as /name but works on +s and +p channels.">
\r\r<helpop key="globops" value="/GLOBOPS [message]
\rSends a message to all +g users.">
\r\r<helpop key="cban " value="/CBAN [channel] {[duration] :[reason]}
\rSets or removes a channel ban. You must specify at least
\r3 parameters to add a ban, and one parameter to remove a ban.
\rThe duration may be specified in seconds, or in the following format
\r1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
\r5 minutes and 6 seconds. All fields in this format are optional.">
\r\r<helpop key="sajoin" value="/SAJOIN [nick] [channel]
\rForces the user to join the channel.">
\r\r<helpop key="sapart" value="/SAPART [nick] [channel]
\rForces the user to part the channel.">
\r\r<helpop key="samode" value="/SAMODE [#chan/nick] +/-[modes] {[parameters for modes]}
\rGives the channel or nick the modes specified.">
\r\r<helpop key="sanick" value="/SANICK [nick] [new nick]
\rChanges the users nick to the new nick.">
\r\r<helpop key="saquit" value="/SAQUIT [nick] [reason]
\rForces user to quit with the specified reason.">
\r\r<helpop key="setidle" value="/SETIDLE [idle time]
\rSets your idle time (in seconds).">
\r\r<helpop key="sethost" value="/SETHOST [host]
\rSets your host to the specified host.">
\r\r<helpop key="setident" value="/SETIDENT [ident]
\rSets your ident to the specified ident.">
\r\r<helpop key="setname" value="/SETNAME [name]
\rSets your name to the specified name.">
\r\r<helpop key="swhois" line="/SWHOIS [nick] [swhois]
\rSets the users swhois field to the given swhois.">
\r\r<helpop key="mkpasswd" value="/MKPASSWD [hashtype] [plaintext]
\rEncodes the plaintext to an MD5 hash and displays the result.">
\r\r<helpop key="opermotd" value="/OPERMOTD
\rRe-displays the Oper MOTD.">
\r\r<helpop key="nicklock" value="/NICKLOCK [nick] [new nick]
\rChanges user's nick to the new nick, and forces
\rit to remain as such for the remainder of the session.">
\r\r<helpop key="nickunlock" value="/NICKUNLOCK [nick]
\rAllows the user to change nicks.">
\r\r<helpop key="chghost" value="/CHGHOST [nickname] [new hostname]
\rChanges the hostname of the user to the new hostname.">
\r\r<helpop key="chgname" value="/CHGNAME [nickname] [new name]
\rChanges the name of the user to the new name.">
\r\r<helpop key="chgident" value="/CHGIDENT [nickname] [new ident]
\rChanges the ident of the user to the new ident.">
\r\r<helpop key="shun" value="/SHUN [user@host] {[duration] :[reason]}
\rSets or removes a shun (serverside ignore) on a host and ident mask.
\rYou must specify at least 3 parameters to add a shun, and one
\rparameter to remove a shun (just the user@host section).
\rThe duration may be specified in seconds, or in the following format
\r1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
\r5 minutes and 6 seconds. All fields in this format are optional.">
\r\r<helpop key="die" value="/DIE [password]
\rIf the correct password is provided, and you are an operator,
\rThis command will shut down the local server.">
\r\r<helpop key="restart" value="/RESTART [password]
\rIf the correct password is provided, and you are an operator,
\rThis command will restart the local server.">
\r\r<helpop key="commands" value="/COMMANDS
\rShows all currently available commands.">
\r\r<helpop key="kill" value="/KILL [user] [reason]
\rThis command will disconnect a user from IRC with the given reason.">
\r\r<helpop key="rehash" value="/REHASH
\rThis command will cause the server configuration file to be
\rre-read and values re-initialized.">
\r\r<helpop key="trace" value="/TRACE [nick|user@host|servermask]
\rThis command will provide a list of all users and servers which
\rmust be passed through or over to reach a given object (server or user).">
\r\r<helpop key="connect" value="/CONNECT [servermask]
\rCreate a mesh connection to the given servermask. You must have
\rconfigured the server for linking in your configuration file,
\rand provided a password.">
\r\r<helpop key="squit" value="/SQUIT
\rDisconnects the local server from the mesh network, causing every
\rother server in the network to drop it.">
\r\r<helpop key="modules" value="/MODULES
\rLists currently loaded modules, their memory offsets and version
\rnumbers and flags. If you are not an operator, you will see reduced
\rdetail.">
\r\r<helpop key="loadmodule" value="/LOADMODULE [filename.so]
\rLoads a module into the IRCd.">
\r\r<helpop key="unloadmodule" value="/UNLOADMODULE [filename.so]
\rUnloads a module from the IRCd. The module cannot have the static
\rflag set (see the output of /MODULES).">
\r\r<helpop key="gloadmodule" value="/GLOADMODULE [filename.so]
\rGlobally loads a module into the network.">
\r\r<helpop key="gunloadmodule" value="/GUNLOADMODULE [filename.so]
\rGlobally unloads a module from the network. The module cannot
\rhave the static flag set (see the output of /MODULES).">
\r\r<helpop key="kline" value="/KLINE [user@host] {[duration] :[reason]}
\rSets or removes a k-line (host based ban) on a host and ident mask.
\rYou must specify at least 3 parameters to add a ban, and one
\rparameter to remove a ban (just the user@host section).
\rThe duration may be specified in seconds, or in the following format
\r1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
\r5 minutes and 6 seconds. All fields in this format are optional.">
\r\r<helpop key="zline" value="/ZLINE [ipmask] {[duration] :[reason]}
\rSets or removes a z-line (ip based ban) on an ip range mask.
\rYou must specify at least 3 parameters to add a ban, and one
\rparameter to remove a ban (just the user@host section).
\rThe duration may be specified in seconds, or in the following format
\r1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
\r5 minutes and 6 seconds. All fields in this format are optional.">
\r\r<helpop key="qline" value="/QLINE [nickmask] {[duration] :[reason]}
\rSets or removes a q-line (nick based ban) on a nick mask.
\rYou must specify at least 3 parameters to add a ban, and one
\rparameter to remove a ban (just the user@host section).
\rThe duration may be specified in seconds, or in the following format
\r1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
\r5 minutes and 6 seconds. All fields in this format are optional.">
\r\r<helpop key="gline" value="/GLINE [user@host] {[duration] :[reason]}
\rSets or removes a g-line (global host based ban) on host mask.
\rYou must specify at least 3 parameters to add a ban, and one
\rparameter to remove a ban (just the user@host section).
\rThe duration may be specified in seconds, or in the following format
\r1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
\r5 minutes and 6 seconds. All fields in this format are optional.">
\r\r<helpop key="eline" value="/ELINE [user@host] {[duration] :[reason]}
\rSets or removes a e-line (local ban exception) on host mask.
\rYou must specify at least 3 parameters to add an exception, and one
\rparameter to remove an exception (just the user@host section).
\rThe duration may be specified in seconds, or in the following format
\r1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
\r5 minutes and 6 seconds. All fields in this format are optional.">
\r\r######################
\r# User/Channel Modes #
\r######################
\r\r<helpop key="umodes" value="User Modes
\r----------
\ro Is an IRC operator
\ri Is invisible to /WHO
\rw Can receive wallops messages
\rs Can receive server notices
\rn [mask] Can receive server notices specified by [mask]
\rx Cloaked hostname (requires cloaking module)
\rg Can receive globops (requires globops module)
\rh Will receive helpops notification (requires helpop module)
\rr Nickname is registered
\rR Only registered users can PRIVMSG this nickname
\rB Is a bot
\rG Messages are censored to user
\rW Can see when a user uses WHOIS on them
\rS mIRC colour codes are stripped to the user
\rD User can not receive PRIVMSGs">
\r\r<helpop key="chmodes" value="Channel Modes
\r-------------
\rv [nickname] Gives voice to [nickname] (can talk on +m channel)
\rh [nickname] Gives halfops to [nickname]
\ro [nickname] Gives ops to [nickname]
\rb [hostmask] Bans [hostmask] on the channel
\ra [nickname] Give protected status to [nickname] (+q only)
\rq [nickname] Give founder status to [nickname] (ulines only)
\ri Make the channel invite only, must /INVITE users
\rk [key] Set the channel key (password) to [key]
\rl [limit] Set the maximum possible users to [limit]
\rm Enable moderation. Only +vo(h) can speak
\rn Only users who are members of the channel may message it
\rp Make channel private (hide from /LIST)
\rs Make channel secret (can't be used at the same time as +p)
\rO Channel is IRCops only (can only be set by IRCops)
\rt Only halfops and above can change the topic
\rQ Only U-Lined servers/nicks can kick
\rT Only halfops/ops can send NOTICEs to the channel
\rC No CTCPs allowed to the channel
\rc mIRC colour codes blocked on the channel
\rS mIRC colour codes are stripped from the channel
\re [hostmask] Ban exception on [hostmask]
\rK No /KNOCK allowed to channel
\rL [channel] If the channel is full, redirect users to [channel]
\rN No nick changes while on the channel
\rG Censors channel based on network censor config
\rg [word] All messages containing the word are blocked
\rI [hostmask] Invite exception allows user to join a channel with +i
\rj [joins]:[sec] Prevents join flooding
\rJ [seconds] Prevents auto-rejoin on kick
\rf [*][lines]:[sec] Kick on text flood. With * user is banned
\rV No invites allowed
\rr Channel is registered
\rR Only registered users can join
\rM Non-registered users can't chat
\rz SSL clients only
\rx Join exception mask. Avoids +ibkO
\r-------------
\rNOTE: A large number of these modes are dependent upon server-side modules
\rbeing loaded by a server/network administrator. The actual modes available
\ron your network may be very different to this list. Please consult your
\rhelp channel if you have any questions.">
\r\r######################
\r# Stats Symbols #
\r######################
\r\r<helpop key="stats" value="/STATS [symbol]
\rShows various server statistics. Depending on configuration this
\rcommand may be reserved for oper-only use.
\r-
\rValid symbols are:
\r-
\rm Show command statistics, number of times commands have been used
\rz Show memory usage statistics
\ro Show a list of all valid oper usernames and hostmasks
\rl Show all inbound and outbound server and client connections
\ru Show server uptime
\rk Show k-lines (local bans)
\rg Show g-lines (global bans)
\rq Show q-lines (nick mask bans)
\rZ Show z-lines (ip mask bans)
\rY Show connection classes
\rC Show link blocks
\rU Show u-lined servers
\rP Show online opers and their idle times
\rI Show connect class permissions
\re Show e-lines (local ban exemptions)
\rC Show channel bans
\rs Show filters
\r-
\rNote that all /STATS use is broadcast to online IRC operators.">
\r\r
projects / user / henk / code / inspircd.git / blob