docs/inspircd.helpop.example

   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.
   4 #
   5 # WARNING!!! Do not <include> this file into your main conf, use <helpop file> tag
   6 # instead! There are tags in this file which will conflict with the main config,
   7 # like <admin> and <server>, and if you include it directly, inspircd will complain!
   8 #
   9
  10 <start line1="     InspIRCd help system"
  11         line2="     --------------------"
  12         line3="-"
  13         line4="This system provides help for commands and modes."
  14         line5="Specify your question or a command name as the"
  15         line6="parameter for this command. If you are an oper"
  16         line7="you must prefix your query with a ? symbol."
  17         line8="-"
  18         line9="/HELPOP COMMANDS      -      To see a list of user commands"
  19         line10="/HELPOP COPER         -      To see a list of oper commands"
  20         line11="/HELPOP UMODES        -      To see a list of user modes"
  21         line12="/HELPOP CHMODES       -      To see a list of channel modes">
  22
  23 <nohelp line1="There is no help for the topic"
  24         line2="You searched for. Please try again.">
  25
  26 <nohelpo line1="There is no help for the topic"
  27         line2="You searched for. Please try again."
  28         line3="-"
  29         line4="Your Query has been forwarded to the IRCops">
  30
  31 <commands line1="User Commands"
  32         line2="-------------"
  33         line3="USER     NICK    QUIT    VERSION     PING"
  34         line4="PONG     ADMIN   PRIVMSG INFO        TIME"
  35         line5="WHOIS    NOTICE  JOIN    NAMES       PART"
  36         line6="KICK     MODE    TOPIC   WHO         MOTD"
  37         line7="RULES    OPER    LIST    LUSERS      STATS"
  38         line8="USERHOST AWAY    ISON    SUMMON      USERS"
  39         line9="INVITE   PASS    WHOWAS  LINKS       MAP"
  40         line10="COMMANDS MODULES">
  41
  42 <user line1="/USER [ident] [local host] [remote host] :[GECOS]"
  43         line2="This command is used by your client to register your irc session."
  44         line3="You should not use it during an established connection.">
  45
  46 <nick line1="/NICK [new nick]"
  47         line2="Change your nickname to [new nick]">
  48
  49 <quit line1="/QUIT [reason]"
  50         line2="Quit from IRC and end your current session">
  51
  52 <version line1="/VERSION"
  53         line2="Returns the server's version number">
  54
  55 <ping line1="/PING [server]"
  56         line2="Ping a server. Target server will answer with a PONG">
  57
  58 <pong line2="/PONG [server]"
  59         line2="Your client should send this to answer server PINGs. You"
  60         line3="should not issue this command manually.">
  61
  62 <admin line1="/ADMIN [server]"
  63         line2="Fetches the administrative information on the given"
  64         line3="server.">
  65
  66 <privmsg line1="/MSG [target] [text]"
  67         line2="Sends a message to a user or channel specified in [target]">
  68
  69 <notice line1="/NOTICE [target] [text]"
  70         line2="Sends a notice to a user or channel specified in [target]">
  71
  72 <join line1="/JOIN [channel]{,[channel]} [key]{,[key]}"
  73         line2="Joins one or more channels you provide the names for">
  74
  75 <names line1="/NAMES [channel]{,[channel]}"
  76         line2="Return a list of users on the channels you provide">
  77
  78 <part line1="/PART [channel]{,[channel]}"
  79         line2="Leaves one or more channels you specify">
  80
  81 <kick line1="/KICK [channel] [nick]"
  82         line2="Kicks a user from a channel you specify. You must be"
  83         line3-"At least a channel halfoperator to kick a user">
  84
  85 <mode line1="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}"
  86         line2="Sets the mode for a channel or a nickname specified in [target]"
  87         line3="A user may only set modes upon themselves, and may not set the"
  88         line4="+o usermode, and a user may only change channel modes of"
  89         line5="channels where they are at least a halfoperator.">
  90
  91 <topic line1="/TOPIC [channel] {topic}"
  92         line2="Sets or retrieves the channel topic. If a channel topic is"
  93         line3="given in teh command and the channel is either not +t, or"
  94         line4="You are at least a halfoperator, the channel topic will be"
  95         line5="changed to the new one you provide">
  96
  97 <who line1="/WHO [channel|nick|servermask|o 0]"
  98         line2="Looks up the information of users matching the range you"
  99         line3="provide. You may only /WHO nicknames in channels or on servers"
 100         line4="where you share a common channel with them."
 101         line5="The syntax '/WHO o 0' shows a list of online IRC operators.">
 102
 103 <motd line1="/MOTD [server]"
 104         line2="Show the message of the day for [server]. Messages of the"
 105         line3="day contain important server rules and notice and should be"
 106         line4="read before using a server in any way!">
 107
 108 <rules line1="/RULES"
 109         line2="Show the rules file for the local server. This is similar in"
 110         line3="effect to /MOTD except that rules are optional. All users are"
 111         line4="sent the MOTD when they connect without having to request it.">
 112
 113 <oper line1="/OPER [login] [password]"
 114         line2="Attempts to authenticate a user as an IRC operator."
 115         line3="Please be aware that both successful and unsucessful oper attempts"
 116         line4="Are logged, and sent to online IRC operators">
 117
 118
 119 <list line1="/LIST [pattern]"
 120         line2="Creates a list of all existing channels matching the glob pattern"
 121         line3="[pattern], e.g. *chat* or bot*">
 122
 123 <lusers line1="/LUSERS"
 124         line2="Shows a count of local and remote users, servers and channels.">
 125
 126 <stats line1="/STATS [symbol]"
 127         line2="Shows various server statistics. Depending on configuration this"
 128         line3="command may be reserved for oper-only use."
 129         line4="-"
 130         line5="Valid symbols are:"
 131         line6="-"
 132         line7="m  Show command statistics, number of times commands have been used"
 133         line8="z  Show memory usage statistics"
 134         line9="o  Show a list of all valid oper usernames and hostmasks"
 135         line10="l  Show all inbound and outbound server and client connections"
 136         line11="u  Show server uptime"
 137         line12="k  Show k-lines (local bans)"
 138         line13="g  Show g-lines (global bans)"
 139         line14="q  Show q-lines (nick mask bans)"
 140         line15="Z  Show z-lines (ip mask bans)"
 141         line16="Y  Show connection classes"
 142         line17="C  Show link blocks"
 143         line18="U  Show u-lined servers"
 144         line19="P  Show online opers and their idle times"
 145         line20="I  Show connect class permissions"
 146         line21="e  Show e-lines (local ban exemptions)"
 147         line22="-"
 148         line23="Note that all /STATS use is broadcast to online IRC operators.">
 149
 150 <kline line1="/KLINE [user@host] {[duration] :[reason]}"
 151         line2="Sets or removes a k-line (host based ban) on a host and ident mask."
 152         line3="You must specify at least 3 parameters to add a ban, and one"
 153         line4="parameter to remove a ban (just the user@host section)."
 154         line5="The duration may be specified in seconds, or in the following format"
 155         line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
 156         line7="5 minutes and 6 seconds. All fields in this format are optional.">
 157
 158 <zline line1="/ZLINE [ipmask] {[duration] :[reason]}"
 159         line2="Sets or removes a z-line (ip based ban) on an ip range mask."
 160         line3="You must specify at least 3 parameters to add a ban, and one"
 161         line4="parameter to remove a ban (just the user@host section)."
 162         line5="The duration may be specified in seconds, or in the following format"
 163         line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
 164         line7="5 minutes and 6 seconds. All fields in this format are optional.">
 165
 166 <qline line1="/QLINE [nickmask] {[duration] :[reason]}"
 167         line2="Sets or removes a q-line (nick based ban) on a nick mask."
 168         line3="You must specify at least 3 parameters to add a ban, and one"
 169         line4="parameter to remove a ban (just the user@host section)."
 170         line5="The duration may be specified in seconds, or in the following format"
 171         line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
 172         line7="5 minutes and 6 seconds. All fields in this format are optional.">
 173
 174 <gline line1="/GLINE [user@host] {[duration] :[reason]}"
 175         line2="Sets or removes a g-line (global host based ban) on host mask."
 176         line3="You must specify at least 3 parameters to add a ban, and one"
 177         line4="parameter to remove a ban (just the user@host section)."
 178         line5="The duration may be specified in seconds, or in the following format"
 179         line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
 180         line7="5 minutes and 6 seconds. All fields in this format are optional.">
 181
 182 <eline line1="/ELINE [user@host] {[duration] :[reason]}"
 183         line2="Sets or removes a e-line (local ban exception) on host mask."
 184         line3="You must specify at least 3 parameters to add an exception, and one"
 185         line4="parameter to remove an exception (just the user@host section)."
 186         line5="The duration may be specified in seconds, or in the following format"
 187         line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
 188         line7="5 minutes and 6 seconds. All fields in this format are optional.">
 189
 190 <userhost line1="/USERHOST [nickname]"
 191         line2="Returns the hostname and nickname of a user, and some other"
 192         line3="miscellanious information.">
 193
 194 <away line1="/AWAY {message}"
 195         line2="If a message is given, marks you as being away, otherwise"
 196         line3="removes your away status and previous message">
 197
 198 <ison line1="/ISON [nick] {[nick]...}"
 199         line2="Returns a subset of the nicks you give, showing only those"
 200         line3="that are currently online.">
 201
 202 <summon line1="/SUMMON [user]"
 203         line2="Summons a user from the shell where the ircd is running onto irc"
 204         line3="This command is deprecated in the current protocol.">
 205
 206 <users line1="/USERS"
 207         line2="Shows users logged into the shell where the ircd is running."
 208         line3="This command is deprecated in the current protocol.">
 209
 210 <invite line1="/INVITE [nick] [channel]"
 211         line2="Invites a user to a channel. If the channel is NOT +i, any"
 212         line3="user, channel op or not, may invite any other user to the"
 213         line4="channel, so long as they are a member of that channel."
 214         line5="Otherwise, if +i is set only channel halfoperators"
 215         line6="and above may invite users into the channel">
 216
 217 <pass line1="/PASS [password]"
 218         line2="This command is used by your irc client when setting up"
 219         line3="your irc session, and should not be issued by a fully"
 220         line4="connected client.">
 221
 222 <whowas line1="/WHOWAS [nick]"
 223         line2="Returns a list of times the user was last seen on irc"
 224         line3="along with the time they were last seen and their server.">
 225
 226 <links line1="/LINKS"
 227         line2="Shows all servers linked to this one. Note that in this"
 228         line3="server implementation all links will be flattened as"
 229         line4="a tree based layout is not in use.">
 230
 231 <map line1="/MAP"
 232         line2="Shows a graphical representation of all users and servers"
 233         line3="on the network. The tree diagram is inaccurate in this"
 234         line4="implementation as a tree based network is not in place.">
 235
 236
 237 <coper line1="Oper Commands"
 238         line2="-------------"
 239         line3="DIE      RESTART KILL    REHASH      TRACE"
 240         line4="CONNECT  SQUIT   MODULES KLINE       ZLINE"
 241         line5="QLINE    GLINE   ELINE">
 242
 243 <die line1="/DIE [password]"
 244         line2="If the correct password is provided, and you are an operator,"
 245         line3="This command will shut down the local server.">
 246
 247 <restart line1="/RESTART [password]"
 248         line2="If the correct password is provided, and you are an operator,"
 249         line3="This command will restart the local server.">
 250
 251 <commands line1="/COMMANDS"
 252         line2="Shows all currently available commands.">
 253
 254 <kill line1="/KILL [user] [reason]"
 255         line2="This command will disconnect a user from IRC with the given"
 256         line3="reason.">
 257
 258 <rehash line1="/REHASH"
 259         line2="This command will cause the server configuration file to be"
 260         line3="re-read and values re-initialised.">
 261
 262 <trace line1="/TRACE [nick|user@host|servermask]"
 263         line2="This command will provide a list of all users and servers which"
 264         line3="must be passed through or over to reach a given object (server"
 265         line4="or user)">
 266
 267 <connect line1="/CONNECT [servermask]"
 268         line2="Create a mesh connection to the given servermask. You must have"
 269         line3="configured the server for linking in your configuration file,"
 270         line4="and provided a password.">
 271
 272 <squit line1="/SQUIT"
 273         line2="Disconnects the local server from the mesh network, causing every"
 274         line3="other server in the mesh to drop it.">
 275
 276 <modules line1="/MODULES"
 277         line2="Lists currently loaded modules, their memory offsets and version"
 278         line3="numbers and flags. If you are not an operator, you will see reduced"
 279         line4="detail.">
 280
 281 <loadmodule line1="/LOADMODULE [filename.so]"
 282         line2="Loads a module into the IRCd.">
 283
 284 <unloadmodule line1="/UNLOADMODULE [filename.so]"
 285         line3="Unloads a module from the IRCd. The module cannot have the static"
 286         line4="flag set (see the output of /MODULES)">
 287
 288 <umodes line1="User Modes"
 289         line2="----------"
 290         line3="o                Is an IRC operator"
 291         line4="i                Is invisible to /WHO"
 292         line5="w                Can receive wallops messages"
 293         line6="s                Can receive server notices"
 294         line7="x                Cloaked hostname (requires cloaking module)"
 295         line8="g                Can receive globops (requires globops module)"
 296         line9="h                Will receive helpops notification (requires helpop module)">
 297
 298 <chmodes line1="Channel Modes"
 299         line2="-------------"
 300         line3="v [nickname]     Gives voice to [nickname] (can talk on +m channel)"
 301         line4="h [nickname]     Gives halfops to [nickname] (requires halfop module)"
 302         line5="o [nickname]     Gives ops to [nickname]"
 303         line6="b [hostmask]     Bans [hostmask] on the channel"
 304         line7="a [nickname]     Give protected status to [nickname] (+q only)"
 305         line8="q [nickname]     Give founder status to [nickname] (ulines only)"
 306         line9="i                Make the channel invite only, must /INVITE users"
 307         line10="k [key]          Set the channel key (password) to [key]"
 308         line11="l [limit]        Set the maximum possible users to [limit]"
 309         line12="m                Enable moderation. Only +vo(h) can speak"
 310         line13="n                Only users who are members of the channel may message it"
 311         line14="p                Make channel private (hide from /LIST)"
 312         line15="s                Make channel secret (can't be used at the same time as +p)"
 313         line16="O                Channel is IRCops only (can only be set by IRCops)"
 314         line17="t                Only halfops and above can change the topic"
 315         line18="Q                Only U-Lined servers/nicks can kick"
 316         line19="T                Only halfops/ops can send NOTICEs to the channel"
 317         line20="C                No CTCPs allowed to the channel"
 318         line21="c                mIRC colour codes blocked on the channel"
 319         line22="K                No /KNOCK allowed to channel (if knock module is loaded)"
 320         line23="L [channel]      If the channel is full, redirect users to [channel]"
 321         line24="N                No nickchanges while on the channel"
 322         line25="-------------"
 323         line26="NOTE: A large number of these modes are dependent upon server-side modules"
 324         line27="being loaded by a server/network administrator. The actual modes available"
 325         line28="on your network may be very different to this list. Please consult your"
 326         line29="help channel if you have any questions.">
 327
 328