]> git.netwichtig.de Git - user/henk/code/inspircd.git/commitdiff
Reorganise configuration files:
authorPeter Powell <petpow@saberuk.com>
Fri, 1 Mar 2013 03:06:06 +0000 (03:06 +0000)
committerPeter Powell <petpow@saberuk.com>
Sat, 2 Mar 2013 15:50:09 +0000 (15:50 +0000)
- Example config files now end with .conf.example.
- Example text files now end with .txt.example.
- Removed 'inspircd' from the name of multiple example files.
- Added missing oper motd example file.

23 files changed:
docs/conf/censor.conf.example [new file with mode: 0644]
docs/conf/filter.conf.example [new file with mode: 0644]
docs/conf/helpop-full.conf.example [new file with mode: 0644]
docs/conf/helpop.conf.example [new file with mode: 0644]
docs/conf/inspircd.censor.example [deleted file]
docs/conf/inspircd.conf.example
docs/conf/inspircd.filter.example [deleted file]
docs/conf/inspircd.helpop-full.example [deleted file]
docs/conf/inspircd.helpop.example [deleted file]
docs/conf/inspircd.motd.example [deleted file]
docs/conf/inspircd.quotes.example [deleted file]
docs/conf/inspircd.rules.example [deleted file]
docs/conf/modules.conf.example
docs/conf/modules/charybdis.conf.example [new file with mode: 0644]
docs/conf/modules/modules.conf.charybdis [deleted file]
docs/conf/modules/modules.conf.unreal [deleted file]
docs/conf/modules/unrealircd.conf.example [new file with mode: 0644]
docs/conf/motd.txt.example [new file with mode: 0644]
docs/conf/opermotd.txt.example [new file with mode: 0644]
docs/conf/quotes.txt.example [new file with mode: 0644]
docs/conf/rules.txt.example [new file with mode: 0644]
make/template/main.mk
win/inspircd.nsi

diff --git a/docs/conf/censor.conf.example b/docs/conf/censor.conf.example
new file mode 100644 (file)
index 0000000..342ccd8
--- /dev/null
@@ -0,0 +1,14 @@
+# Configuration file for m_censor.so (1.0.0.0)
+# C.J.Edwards May 2004.
+#
+
+# The tags for this module are formatted as follows:
+#
+# <badword     text="simple word"
+#              replace="text to replace with">
+#
+# You can specify <badword text="simple word" replace="">
+# to block lines containing the word
+
+<badword text="shit" replace="poo">
+<badword text="fuck" replace="(censored)">
diff --git a/docs/conf/filter.conf.example b/docs/conf/filter.conf.example
new file mode 100644 (file)
index 0000000..922f55f
--- /dev/null
@@ -0,0 +1,60 @@
+# Configuration file for m_filter.so and m_filter_pcre.so
+
+# The tags for this module are formatted as follows:
+#
+# <keyword      pattern="any glob pattern here"
+#               reason="reason for filtering"
+#               action="action to take"
+#               flags="filter flags"
+#              duration="optional length of gline">
+#
+# Valid actions for 'action' are:
+#
+# block         This blocks the line, sends out a notice to all opers with
+#               +s and informs the user that their message was blocked.
+#
+# silent        This blocks the line only, and informs the user their message
+#               was blocked, but does not notify opers.
+#
+# none          This action causes nothing to be done except logging. This
+#               is the default action if none is specified.
+#
+# kill          This disconnects the user, with the 'reason' parameter as
+#               the kill reason.
+#
+# gline         G-LINE the user for 'duration' length of time. Durations may
+#               be specified using the notation 1y2d3h4m6s in a similar way to
+#               other glines, omitting the duration or setting it to 0 makes
+#               any glines set by this filter be permanent.
+#
+# You can add filters from IRC using the /FILTER command. If you do this, they
+# will be set globally to your entire network.
+#
+# Valid characters for 'flags' are one or more of:
+#
+# p: Block private and channel messages
+# n: Block private and channel notices
+# P: Block part messages
+# q: Block quit messages
+# o: Don't match against opers
+# c: Strip color codes from text before trying to match
+# *: Represents all of the above flags
+# -: Does nothing, a non-op for when you do not want to specify any flags 
+#
+# IMPORTANT NOTE: Because the InspIRCd config reader places special meaning on the
+# '\' character, you must use '\\' if you wish to specify a '\' character in a regular
+# expression. For example, to indicate numbers, use \\d and not \d. This does not
+# apply when adding a regular expression over irc with the /FILTER command.
+
+# Example filters for m_filter:
+#
+# <keyword pattern="*qwerty*" reason="You qwertied!" action="block" flags="pn">
+# <keyword pattern="*killmenow*" reason="As you request." action="kill" flags="*">
+# <keyword pattern="*blah*" reason="Dont blah!" action="gline" duration="1d6h" flags="-">
+
+# An example regexp filter for m_filter_pcre:
+#
+# <keyword pattern="^blah.*?$" reason="Dont blah!" action="gline" duration="1d6h" flags="pnPq">
+
+# An example of excluding a channel from filtering:
+# <exemptfromfilter channel="#help">
diff --git a/docs/conf/helpop-full.conf.example b/docs/conf/helpop-full.conf.example
new file mode 100644 (file)
index 0000000..bc9326e
--- /dev/null
@@ -0,0 +1,1058 @@
+#####################
+#  Helpop Standard  #
+#####################
+
+<alias text="HELP" replace="HELPOP $2-">
+
+<helpop key="start" value="InspIRCd Help System
+
+This system provides help for commands and modes.
+Specify your question or a command name as the
+parameter for this command.
+
+/HELPOP CUSER    -      To see a list of user commands
+/HELPOP COPER    -      To see a list of oper commands
+/HELPOP UMODES   -      To see a list of user modes
+/HELPOP CHMODES  -      To see a list of channel modes
+/HELPOP SNOMASKS -      To see a list of oper snotice masks
+/HELPOP EXTBANS  -      To see a list of extended bans">
+
+<helpop key="nohelp" value="There is no help for the topic
+you searched for. Please try again.">
+
+#####################
+#   User Commands   #
+#####################
+
+<helpop key="cuser" value="User Commands
+-------------
+
+PRIVMSG   NOTICE   NICK      JOIN      PART
+CYCLE     KNOCK    MODE      DEVOICE   TOPIC
+KICK      FPART    REMOVE    TBAN      INVITE
+UNINVITE  AWAY     DCCALLOW  SILENCE   ACCEPT
+MKPASSWD  VHOST    TITLE     SETNAME
+
+WHOIS     WHOWAS   ISON      USERHOST  WATCH
+LIST      NAMES    WHO       MOTD      RULES
+ADMIN     MAP      LINKS     LUSERS    TIME
+STATS     VERSION  INFO      MODULES   COMMANDS
+SSLINFO
+
+USER      PASS     PING     PONG       QUIT
+
+OPER">
+
+<helpop key="sslinfo" value="/SSLINFO [nick]
+
+Displays information on the SSL connection and certificate of the
+target user.">
+
+<helpop key="uninvite" value="/UNINVITE [nick] [channel]
+
+Uninvite a user from a channel, same syntax as INVITE.">
+
+<helpop key="tban" value="/TBAN [channel] [duration] [banmask]
+
+Sets a timed ban. The duration of the ban can be specified in the
+following format: 1w2d3h4m6s which indicates a ban of one week, two
+days, three hours, four minutes and six seconds. Alternatively the
+ban may just be specified as a number of seconds. All timed bans
+appear in the banlist as normal bans and may be safely removed
+before their time is up.">
+
+<helpop key="dccallow" value="/DCCALLOW [+|-] [nick] [duration]
+
+Adds a nickname to or deletes a nickname from your DCCALLOW list.">
+
+<helpop key="accept" value="/ACCEPT [+-*] [nick]{ [, [+-]<nick> ] }
+
+Manages your accept list. This list is used to determine who can
+private message you when you have usermode +g set. ACCEPT +nick adds
+a nick to your accept list, ACCEPT -nick removes a nick from your
+accept list, and ACCEPT * displays your accept list.">
+
+<helpop key="cycle" value="/CYCLE [channel]
+
+Cycles a channel (leaving and rejoining), overrides restrictions that
+would stop a new user joining, such as user limits and channel keys.">
+
+<helpop key="title" value="/TITLE [name] [password]
+
+Authenticate for a WHOIS title line and optionally a vhost using the
+specified username and password.">
+
+<helpop key="watch" value="/WATCH [C|S|+/-[NICK]]
+
+Adds or deletes a user from the watch list. C clears the list
+and S queries the status.">
+
+<helpop key="vhost" value="/VHOST [username] [password]
+
+Authenticate for a vhost using the specified username and password.">
+
+<helpop key="remove" value="/REMOVE [nick] [channel] {[reason]}
+
+Removes a user from a channel you specify. You must be at least a
+channel halfoperator to remove a user. A removed user will part with
+a message stating they were removed from the channel and by whom.">
+
+<helpop key="fpart" value="/FPART [channel] [nick] {[reason]}
+
+This behaves identically to /REMOVE, the only difference is that that
+[channel] and [nick] parameters are switched around to match /KICK's
+syntax. Also, /REMOVE is a builtin mIRC command which caused trouble
+for some users. This feature was added in the 1.1 branch.">
+
+<helpop key="devoice" value="/DEVOICE [channel]
+
+Devoices yourself from the specified channel.">
+
+<helpop key="silence" value="/SILENCE [+/-][hostmask] [p|c|i|n|t|a|x]
+
+A serverside ignore of the given n!u@h mask. The letter(s) at the end
+specify what is to be ignored from this hostmask.
+
+Valid SILENCE Flags
+-------------------
+
+ p        Block private messages
+ c        Block channel messages
+ i        Block invites
+ n        Block private notices
+ t        Block channel notices
+ a        Block all of the above
+ x        Exception
+
+Multiple letters may be specified. For an exception, you msut pair x
+with what you want excepted. For example, if you wanted to except
+everything from people with a host matching *.foo.net, you would do
+/SILENCE +*!*@*.foo.net xa
+
+/SILENCE without a parameter will list the hostmasks that you have silenced.">
+
+<helpop key="knock" value="/KNOCK [channel]
+
+Sends a notice to a channel indicating you wish to join.">
+
+<helpop key="user" value="/USER [ident] [local host] [remote host] :[GECOS]
+
+This command is used by your client to register your
+IRC session, providing your ident and GECOS to the
+server.
+
+You should not use it during an established connection.">
+
+<helpop key="nick" value="/NICK [new nick]
+
+Change your nickname to [new nick].">
+
+<helpop key="quit" value="/QUIT {[reason]}
+
+Quit from IRC and end your current session.">
+
+<helpop key="version" value="/VERSION
+
+Returns the server's version information.">
+
+<helpop key="ping" value="/PING [server]
+
+Ping a server. Target server will answer with a PONG.">
+
+<helpop key="pong" value="/PONG [server]
+
+Your client should send this to answer server PINGs. You
+should not issue this command manually.">
+
+<helpop key="admin" value="/ADMIN [server]
+
+Shows the administrative information for the given server.">
+
+<helpop key="privmsg" value="/PRIVMSG [target] [text]
+
+Sends a message to a user or channel specified in [target].">
+
+<helpop key="notice" value="/NOTICE [target] [text]
+
+Sends a notice to a user or channel specified in [target].">
+
+<helpop key="join" value="/JOIN [channel]{,[channel]} [key]{,[key]}
+
+Joins one or more channels you provide the names for.">
+
+<helpop key="names" value="/NAMES [channel]{,[channel]}
+
+Return a list of users on the channels you provide.">
+
+<helpop key="part" value="/PART [channel]{,[channel] [reason]}
+
+Leaves one or more channels you specify.">
+
+<helpop key="kick" value="/KICK [channel] [nick] {[reason]}
+
+Kicks a user from a channel you specify. You must be
+At least a channel halfoperator to kick a user.">
+
+<helpop key="mode" value="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}
+
+Sets the mode for a channel or a nickname specified in [target]
+A user may only set modes upon themselves, and may not set the
++o usermode, and a user may only change channel modes of
+channels where they are at least a halfoperator.
+
+For a list of all user and channel modes, enter /HELPOP UMODES or
+/HELPOP CHMODES.">
+
+<helpop key="topic" value="/TOPIC [channel] {topic}
+
+Sets or retrieves the channel topic. If a channel topic is
+given in the command and either the channel is not +t, or
+you are at least a halfoperator, the channel topic will be
+changed to the new one you provide.">
+
+<helpop key="who" value="/WHO [ [search-pattern] [ohurmaiMplf] ]
+
+Looks up the information of users matching the range you provide.
+You may only /WHO nicknames in channels or on servers where you
+share a common channel with them, or ones which are not +i (unless
+you are an IRC operator). The search-pattern may be a special
+sequence of characters determined by the flags given below, or
+it may be one of a nickname, a channel, a hostmask, an ip address
+mask or a server mask.
+
+Valid WHO Flags
+---------------
+
+The following flags after the mask have the following effects:
+
+ o      Show online IRC operators matching the mask
+
+ a      Show all users who have an away message matching the given mask
+ i      Show all users who have an ident (username) matching the given mask
+ p      Show all users who are connected on the given port number
+ r      Show all users whose realnames match the mask. When this
+        flag is set it overrides the meaning of the search-pattern,
+        which must contain a glob pattern intended to match GECOS
+        (realname) fields.
+ m      Search for all users with a given set of user modes. When
+        this flag is set it overrides the meaning of the
+        search-pattern, which must contain the mode sequence to
+        search for, for example to find all users with +i and
+        without +s, issue the command WHO +i-s m.
+ t      Show users connected within this number of seconds
+ M      Show all users who have metadata attached to them with
+        the given key name
+
+ f      Show only remote (far) users
+ l      Show only local users
+
+ h      Show real hostnames rather than masked hostnames (IRC
+        operators only)
+ u      Unlimit the results past the maximum /who results value
+        (IRC operators only)
+
+You may combine multiple flags in one WHO command except where stated in the table above.">
+
+<helpop key="motd" value="/MOTD [server]
+
+Show the message of the day for [server]. Messages of the day often
+contain important server rules and notices and should be read prior
+to using a server.">
+
+<helpop key="rules" value="/RULES
+
+Show the rules file for the local server. This is similar in effect to
+except that these are not sent automatically on connect.">
+
+<helpop key="oper" value="/OPER [login] [password]
+
+Attempts to authenticate a user as an IRC operator.
+
+Both successful and unsuccessful oper attempts are
+logged, and sent to online IRC operators.">
+
+<helpop key="list" value="/LIST [pattern]
+
+Creates a list of all existing channels matching the glob pattern
+[pattern], e.g. *chat* or bot*.">
+
+<helpop key="lusers" value="/LUSERS
+
+Shows a count of local and remote users, servers and channels.">
+
+<helpop key="userhost" value="/USERHOST [nickname]
+
+Returns the hostname and nickname of a user, and some other
+miscellaneous information.">
+
+<helpop key="away" value="/AWAY {message}
+
+If a message is given, marks you as being away, otherwise
+removes your away status and previous message.">
+
+<helpop key="ison" value="/ISON [nick] {[nick]...}
+
+Returns a subset of the nicks you give, showing only those
+that are currently online.">
+
+<helpop key="invite" value="/INVITE [nick] [channel] {[time]}
+
+Invites a user to a channel. If the channel is NOT +A, only
+channel halfoperators or above can invite people. If +A is set,
+anyone can invite people to the channel, as long as the person
+doing the invite is a member of the channel they wish to invite
+the user to.
+
+Invited users may override bans, +k, and similar in addition to
++i, depending on configuration.
+
+If a time is provided, the invite expires after that time and the user
+can no longer use it to enter the channel.">
+
+<helpop key="pass" value="/PASS [password]
+
+This command is used by your client when setting up
+your IRC session to submit a server password to the
+server.
+
+You should not use it during an established connection.">
+
+<helpop key="whowas" value="/WHOWAS [nick]
+
+Returns a list of times the user was seen recently on IRC along with
+the time they were last seen and their server.">
+
+<helpop key="links" value="/LINKS
+
+Shows all servers linked to this one.">
+
+<helpop key="map" value="/MAP
+
+Shows a graphical representation of all users and servers on the
+network, and the links between them, as a tree from the perspective
+of your server.">
+
+<helpop key="whois" value="/WHOIS [nick] {server}
+
+Returns the WHOIS information of a user, their channels, hostname,
+etc. If a second nickname or server is provided, then a whois is
+performed from the server where the user is actually located rather
+than locally, showing idle and signon times.">
+
+<helpop key="time" value="/TIME [servermask]
+
+Returns the local time of the server, or remote time of another
+server.">
+
+<helpop key="info" value="/INFO
+
+Returns information on the developers and supporters who made this
+IRC server possible.">
+
+<helpop key="setname" value="/SETNAME [name]
+
+Sets your name to the specified name.">
+
+
+#####################
+#   Oper Commands   #
+#####################
+
+<helpop key="coper" value="Oper Commands
+-------------
+
+OPERMOTD  CHECK     CLONES      USERIP   LINE
+ALLTIME   MODULES   WALLOPS     GLOBOPS
+
+SETHOST   SETIDENT  CHGHOST     CHGIDENT CHGNAME
+SETIDLE   SWHOIS
+
+SANICK    NICKLOCK  NICKUNLOCK
+
+SAJOIN    SAPART    SAMODE      SATOPIC  SAKICK
+
+KILL      SAQUIT    GLINE       ZLINE    QLINE
+KLINE     RLINE     ELINE       CBAN     SHUN
+FILTER    OJOIN
+
+CONNECT   SQUIT     RCONNECT    RSQUIT
+
+DIE            RESTART      REHASH
+CLEARCACHE     LOADMODULE   UNLOADMODULE
+RELOADMODULE   GLOADMODULE  GUNLOADMODULE
+GRELOADMODULE  RELOAD       CLOSE
+LOCKSERV       UNLOCKSERV   JUMPSERVER">
+
+<helpop key="userip" value="/USERIP [nickname]
+
+Returns the ip and nickname of a user.">
+
+<helpop key="tline" value="/TLINE [host or ip mask]
+
+This command returns the number of local and global clients matched,
+and the percentage of clients matched, plus how they were matched
+(by IP address or by hostname).">
+
+<helpop key="lockserv" value="/LOCKSERV
+
+Locks out all new connections notifying connecting users that the
+service is temporarily closed and to try again later.">
+
+<helpop key="unlockserv" value="/UNLOCKSERV
+
+Opens the server up again for new connections.">
+
+<helpop key="jumpserver" value="/JUMPSERVER {[newserver] [newport] [+/-flags] {:[reason]}}
+
+Sets or cancels jumpserver mode. If no parameters are given,
+jumpserver mode is cancelled, if it is currently set. If parameters
+are given, a server address must be given for [newserver] and a
+server port must be given for [newport]. Zero or more status flags
+should be given for 'flags', from the list below (if you do not
+wish to specify any flags just place a '+' in this field):
+
+1. +a: Redirect all users immediately (except for opers) and cause
+them to quit with the given reason
+
+2. +n: Redirect any new users who connect and cause them to quit
+during registration
+
+You may use + and - to set or unset these flags in the command, the
+default flags are -a+n, which will just redirect new users. The
+reason parameter is optional, and if not provided defaults to
+'Please use this server/port instead' (the default given in various
+numeric lists)">
+
+<helpop key="filter" value="/FILTER [filter-definition] {[action] [flags] {[gline-duration]} :[reason]}
+
+This command will add a filter when more than one parameter is given,
+for messages of the types specified by the flags, with the given
+filter definition, action, gline duration (when the action is 'gline')
+and reason.
+
+The filter will take effect when a message of any type specified by
+the flags and matching the definition is sent to the server, and
+perform the specified action.
+
+Valid FILTER Actions
+--------------------
+
+None    Does nothing
+Block   Blocks message and informs +s IRCops of the blocked message
+        and all relevant info
+Silent  Blocks message, but does not notify IRCops
+Kill    Kills the user
+Gline   Glines the user for the specified duration
+
+Valid FILTER Flags
+------------------
+
+p    Block private and channel messages
+n    Block private and channel notices
+P    Block part messages
+q    Block quit messages
+o    Don't match against opers
+*    Represents all of the above flags
+-    Does nothing, a non-op for when you do not want to specify any
+     flags
+
+The reason for the filter will be used as the reason for the action,
+unless the ation is 'none', and is sent to the user when their text is
+blocked by 'block' and 'silent' actions.
+
+A gline duration may be specified in seconds, or in the format
+1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
+minutes and 6 seconds. All fields in this format are optional.
+
+When only one parameter is provided (the filter pattern) the provided
+filter will be removed. Note that if you remove a
+configuration-defined filter, it will reappear at next rehash unless
+it is also removed from the config file.">
+
+<helpop key="ojoin" value="/OJOIN [#chan]
+
+Force joins you to the specified channel, and gives you +Y and any other
+configuration-defined modes on it, preventing you from being kicked.
+Depending on configuration, may announce that you have joined the
+channel on official network business.">
+
+<helpop key="clones" value="/CLONES [limit]
+
+Retrieves a list of users with more clones than the specified
+limit.">
+
+<helpop key="check" value="/CHECK [nick|ip|hostmask|channel] {[server]}
+
+Allows opers to look up advanced information on channels, hostmasks
+or IP addresses, in a similar way to WHO but in more detail, displaying
+most information the IRCD has stored on the target, including all
+metadata.
+
+With the second parameter given, runs the command remotely on the
+specified server.">
+
+<helpop key="alltime" value="/ALLTIME
+
+Shows the time on all servers on the network.">
+
+<helpop key="rconnect" value="/RCONNECT [source mask] [target mask]
+
+The server matching [source mask] will try to connect to the first
+server in the config file matching [target mask].">
+
+<helpop key="rsquit" value="/RSQUIT {[source mask]} [target mask]
+
+Causes a remote server matching [target mask] to be disconnected from
+the network, only if connected via a server matching [source mask] if
+it is specified.">
+
+<helpop key="globops" value="/GLOBOPS [message]
+
+Sends a message to all users with the +g snomask.">
+
+<helpop key="cban" value="/CBAN [channel] {[duration] :[reason]}
+
+Sets or removes a channel ban. You must specify all three parameters
+to add a ban, and one parameter to remove a ban (just the channel).
+
+The duration may be specified in seconds, or in the format
+1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
+5 minutes and 6 seconds. All fields in this format are optional.">
+
+<helpop key="sajoin" value="/SAJOIN [nick] [channel]
+
+Forces the user to join the channel.">
+
+<helpop key="sapart" value="/SAPART [nick] [channel]
+
+Forces the user to part the channel.">
+
+<helpop key="samode" value="/SAMODE [target] +/-[modes] {[parameters for modes]}
+
+Applies the given mode change to the channel or nick specified.">
+
+<helpop key="sanick" value="/SANICK [nick] [new nick]
+
+Changes the user's nick to the new nick.">
+
+<helpop key="saquit" value="/SAQUIT [nick] [reason]
+
+Forces user to quit with the specified reason.">
+
+<helpop key="setidle" value="/SETIDLE [idle time]
+
+Sets your idle time (in seconds) to the specified value.">
+
+<helpop key="sethost" value="/SETHOST [host]
+
+Sets your host to the specified host.">
+
+<helpop key="setident" value="/SETIDENT [ident]
+
+Sets your ident to the specified ident.">
+
+<helpop key="swhois" line="/SWHOIS [nick] [swhois]
+
+Sets the user's swhois field to the given swhois.">
+
+<helpop key="mkpasswd" value="/MKPASSWD [hashtype] [plaintext]
+
+Encodes the plaintext to a hash of the given type and displays
+the result.">
+
+<helpop key="opermotd" value="/OPERMOTD
+
+Redisplays the Oper MOTD.">
+
+<helpop key="nicklock" value="/NICKLOCK [nick] [new nick]
+
+Changes the user's nick to the new nick, and forces
+it to remain as such for the remainder of the session.">
+
+<helpop key="nickunlock" value="/NICKUNLOCK [nick]
+
+Allows a previously locked user to change nicks again.">
+
+<helpop key="chghost" value="/CHGHOST [nickname] [new hostname]
+
+Changes the hostname of the user to the new hostname.">
+
+<helpop key="chgname" value="/CHGNAME [nickname] [new name]
+
+Changes the name of the user to the new name.">
+
+<helpop key="chgident" value="/CHGIDENT [nickname] [new ident]
+
+Changes the ident of the user to the new ident.">
+
+<helpop key="shun" value="/SHUN [nick!user@host] {[duration] :[reason]}
+
+Sets or removes a shun (serverside ignore) on a host and ident mask.
+You must specify all three parameters to add a shun, and one parameter
+to remove a shun (just the nick!user@host section).
+
+The duration may be specified in seconds, or in the format
+1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
+5 minutes and 6 seconds. All fields in this format are optional.">
+
+<helpop key="die" value="/DIE [password]
+
+This command shuts down the local server. A single parameter is
+required, which must match the password in the configuration for the
+command to function.">
+
+<helpop key="restart" value="/RESTART [password]
+
+This command restarts down the local server. A single parameter is
+required, which must match the password in the configuration for the
+command to function.">
+
+<helpop key="commands" value="/COMMANDS
+
+Shows all currently available commands.">
+
+<helpop key="kill" value="/KILL [user] [reason]
+
+This command will disconnect a user from IRC with the given reason.">
+
+<helpop key="rehash" value="/REHASH
+
+This command will cause the server configuration file to be reread and
+values reinitialized for all servers matchin the server mask, or the
+local server if one is not specified.">
+
+<helpop key="connect" value="/CONNECT [servermask]
+
+Add a connection to the server matching the given servermask. You must
+have configured the server for linking in your configuration file
+before trying to link them.">
+
+<helpop key="squit" value="/SQUIT [servermask]
+
+Disconnects the server matching the given servermask from this server.">
+
+<helpop key="modules" value="/MODULES
+
+Lists currently loaded modules, their memory offsets, version numbers,
+and flags. If you are not an operator, you will see reduced detail.">
+
+<helpop key="loadmodule" value="/LOADMODULE [filename.so]
+
+Loads the specified module into the local server.">
+
+<helpop key="unloadmodule" value="/UNLOADMODULE [filename.so]
+
+Unloads a module from the local server. The module cannot have the
+static flag set (see the output of /MODULES).">
+
+<helpop key="reloadmodule" value="/RELOADMODULE [filename.so]
+
+Unloads and reloads a module on the local server. This module cannot
+have the static flag set (see the output of /MODULES).">
+
+<helpop key="loadmodule" value="/GLOADMODULE [filename.so]
+
+Loads the specified module on all linked servers.">
+
+<helpop key="unloadmodule" value="/GUNLOADMODULE [filename.so]
+
+Unloads a module from all linked servers. The module cannot have the
+static flag set (see the output of /MODULES).">
+
+<helpop key="reloadmodule" value="/GRELOADMODULE [filename.so]
+
+Unloads and reloads a module on all linked servers. This module cannot
+have the static flag set (see the output of /MODULES).">
+
+<helpop key="kline" value="/KLINE [user@host] {[duration] :[reason]}
+
+Sets or removes a k-line (local host based ban) on a host and ident mask.
+You must specify all three parameters to add a ban, and one parameter
+to remove a ban (just the user@host section).
+
+The duration may be specified in seconds, or in the format
+1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
+5 minutes and 6 seconds. All fields in this format are optional.">
+
+<helpop key="zline" value="/ZLINE [ipmask] {[duration] :[reason]}
+
+Sets or removes a z-line (ip based ban) on an ip range mask.
+You must specify all three parameters to add a ban, and one parameter
+to remove a ban (just the ipmask).
+
+The duration may be specified in seconds, or in the format
+1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
+5 minutes and 6 seconds. All fields in this format are optional.">
+
+<helpop key="qline" value="/QLINE [nickmask] {[duration] :[reason]}
+
+Sets or removes a q-line (nick based ban) on a nick mask.
+You must specify all three parameters to add a ban, and one parameter
+to remove a ban (just the nickmask).
+
+The duration may be specified in seconds, or in the format
+1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
+5 minutes and 6 seconds. All fields in this format are optional.">
+
+<helpop key="gline" value="/GLINE [user@host] {[duration] :[reason]}
+
+Sets or removes a g-line (host based ban) on host mask.
+You must specify all three parameters to add a ban, and one
+parameter to remove a ban (just the user@host section).
+
+The duration may be specified in seconds, or in the format
+1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
+5 minutes and 6 seconds. All fields in this format are optional.">
+
+<helpop key="eline" value="/ELINE [user@host] {[duration] :[reason]}
+
+Sets or removes a e-line (local ban exception) on host mask.
+You must specify at least 3 parameters to add an exception, and one
+parameter to remove an exception (just the user@host section).
+
+The duration may be specified in seconds, or in the format
+1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
+5 minutes and 6 seconds. All fields in this format are optional.
+
+This command has a few important limitations. Bans on *@<ip> can only
+be negated by an eline on *@<ip>, bans on *@<host> can be negated by
+elines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
+can be negated by any eline that matches.">
+
+<helpop key="wallops" value="/WALLOPS [message]
+
+Sends a message to all +w users.">
+
+<helpop key="sakick" value="/SAKICK [#chan] [nick] [reason]
+
+Kicks the given user from the specified channel.">
+
+<helpop key="satopic" value="/SATOPIC [#chan] [new topic]
+
+Applies the given topic to the specified channel.">
+
+<helpop key="rline" value="/RLINE [regex] {[duration] :[reason]}
+
+Sets or removes an r-line (regex line) on a n!u@h\\sgecos mask. You
+must specify all three parameters to add an rline, and one parameter
+to remove an rline (just the regex).
+
+The duration may be specified in seconds, or in the format
+1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
+5 minutes and 6 seconds. All fields in this format are optional.">
+
+<helpop key="clearcache" value="/CLEARCACHE {servername}
+
+This command clears the DNS cache of the specified server. If no
+server is specified, the local server's DNS cache will be cleared.">
+
+<helpop key="reload" value="/RELOAD [core command]
+
+Reloads the specified core command.">
+
+<helpop key="close" value="/CLOSE
+
+Closes all unregistered connections to the local server.">
+
+######################
+# User/Channel Modes #
+######################
+
+<helpop key="umodes" value="User Modes
+----------
+
+ c            Blocks private messages and notices from users who do
+              not share a common channel with you (requires
+              commonchans module).
+ d            Deaf mode. User will not recieve any messages or notices
+              from channels they are in (requires deaf module).
+ g            In combination with /allow, provides for server side
+              ignore (requires callerid module).
+ h            Marks as 'available for help' in WHOIS (IRCop only,
+              requires helpop module).
+ i            Makes invisible to /WHO if the user using /WHO is not in
+              a common channel.
+ k            Prevents the user from being kicked from channels, or
+              having op modes removed from them (services only,
+              requires servprotect module).
+ o            Marks as a IRC operator.
+ s [mask]     Receives server notices specified by [mask]
+              (IRCop only).
+ r            Marks as a having a registered nickname
+              (requires services account module).
+ w            Receives wallops messages.
+ x            Gives a cloaked hostname (requires cloaking module).
+ B            Marks as a bot (requires botmode module).
+ G            Censors messages sent to the user based on filters
+              configured for the network (requires censor module).
+ H            Hides an oper's oper status from WHOIS (requires
+              hideoper module).
+ I            Hides a user's entire channel list in WHOIS from
+              non-IRCops (requires hidechans module).
+ Q            Makes an operator invisible, preventing users from
+              seeing their presence, including in channel user lists
+              (IRCop only, requires invisible module).
+ R            Blocks private messages from unregistered users
+              (requires services account module).
+ S            Strips mIRC color/bold/underline codes out of private
+              messages to the user (requires stripcolor module).
+ W            Receives notification when a user uses WHOIS on them
+              (IRCop only, requires showwhois module).">
+
+<helpop key="chmodes" value="Channel Modes
+-------------
+
+ v [nickname]       Gives voice to [nickname], allowing them to speak
+                    while the channel is +m.
+ h [nickname]       Gives halfop status to [nickname] (this mode can
+                    be disabled).
+ o [nickname]       Gives op status to [nickname].
+ a [nickname]       Gives protected status to [nickname], preventing
+                    them from them from being kicked (+q only,
+                    requires chanprotect module).
+ q [nickname]       Gives owner status to [nickname], preventing them
+                    from being kicked (Services or only, requires
+                    chanprotect module).
+
+ b [hostmask]       Bans [hostmask] from the channel.
+ e [hostmask]       Excepts [hostmask] from bans (requires
+                    banexception module).
+ I [hostmask]       Excepts [hostmask] from +i, allowing matching
+                    users to join while the channel is invite-only
+                    (requires inviteexception module).
+
+ c                  Blocks messages containing mIRC color codes
+                    (requires blockcolor module).
+ d [time]           Blocks messages to a channel from new users
+                    until they have been in the channel for [time]
+                    seconds (requires delaymsg module).
+ f [*][lines]:[sec] Kicks on text flood equal to or above the
+                    specified rate. With *, the user is banned
+                    (requires messageflood module).
+ i                  Makes the channel invite-only.
+                    Users can only join if an operator
+                    uses /INVITE to invite them.
+ j [joins]:[sec]    Limits joins to the specified rate (requires
+                    joinflood module).
+ k [key]            Set the channel key (password) to [key].
+ l [limit]          Set the maximum allowed users to [limit].
+ m                  Enable moderation. Only users with +v, +h, or +o
+                    can speak.
+ n                  Blocks users who are not members of the channel
+                    from messaging it.
+ p                  Make channel private, hiding it in users' whoises
+                    and replacing it with * in /LIST.
+ r                  Marks the channel as registered with Services
+                    (requires services account module).
+ s                  Make channel secret, hiding it in users' whoises
+                    and /LIST.
+ t                  Prevents users without +h or +o from changing the
+                    topic.
+ u                  Makes the channel an auditorium; normal users only
+                    see themselves or themselves and the operators,
+                    while operators see all the users (requires
+                    auditorium module).
+ w [flag]:[banmask] Adds basic channel access controls of [flag] to
+                    [banmask], via the +w listmode.
+                    For example, +w o:R:Brain will op anyone identified
+                    to the account 'Brain' on join.
+                    (requires autoop module)
+ z                  Blocks non-SSL clients from joining the channel.
+
+ A                  Allows anyone to invite users to the channel
+                    (normally only chanops can invite, requires
+                    allowinvite module).
+ B                  Blocks messages with too many capital letters,
+                    as determined by the network configuration
+                    (requires blockcaps module).
+ C                  Blocks any CTCPs to the channel (requires noctcp
+                    module).
+ D                  Delays join messages from users until they
+                    message the channel (requires delayjoin module).
+ F [changes]:[sec]  Blocks nick changes when they equal or exceed the
+                    specified rate (requires nickflood module).
+ G                  Censors messages to the channel based on the
+                    network configuration (requires censor module).
+ J [seconds]        Prevents rejoin after kick for the specified
+                    number of seconds. This prevents auto-rejoin
+                    (requires kicknorejoin module).
+ K                  Blocks /KNOCK on the channel.
+ L [channel]        If the channel reaches its limit set by +l,
+                    redirect users to [channel] (requires redirect
+                    module).
+ M                  Blocks unregistered users from speaking (requires
+                    services account module).
+ N                  Prevents users on the channel from chainging nick
+                    (requires nonicks module).
+ O                  Channel is IRCops only (can only be set by IRCops,
+                    requires operchans module).
+ P                  Makes the channel permanent; Bans, invites, the
+                    topic, modes, and such will not be lost when it
+                    empties (can only be set by IRCops, requires
+                    permchannels module).
+ Q                  Only ulined servers and their users can kick
+                    (requires nokicks module)
+ R                  Blocks unregistered users from joining (requires
+                    services account module).
+ S                  Strips mIRC color codes from messages to the
+                    channel (requirs stripcolor module).
+ T                  Blocks /NOTICEs to the channel from users who are
+                    not at least halfop (requires nonotice module).
+ g [mask]           Blocks messages matching the given blob mask
+                    (requires chanfilter module).
+ X [mode]           Makes channel operators immune to the specified
+                    restrictive mode (requires exemptchanops module).
+
+-------------
+NOTE: A large number of these modes are dependent upon server-side modules
+being loaded by a server/network administrator. The actual modes available
+on your network may be very different to this list. Please consult your
+help channel if you have any questions.">
+
+######################
+#   Stats Symbols    #
+######################
+
+<helpop key="stats" value="/STATS [symbol]
+
+Shows various server statistics. Depending on configuration, some
+symbols may be only available to opers.
+
+Valid symbols are:
+
+e  Show e-lines (local ban exemptions)
+g  Show g-lines (host bans)
+k  Show k-lines (local host bans)
+q  Show q-lines (nick mask bans)
+Z  Show z-lines (IP mask bans)
+R  Show R-lines (regular expression bans)
+
+H  Show shuns
+s  Show filters
+C  Show channel bans
+
+c  Show link blocks
+d  Show configured DNSBLs and related statistics
+m  Show command statistics, number of times commands have been used
+o  Show a list of all valid oper usernames and hostmasks
+p  Show open client ports, and the port type (ssl, plaintext, etc)
+u  Show server uptime
+z  Show memory usage statistics
+i  Show connect class permissions
+l  Show all client connections with information (sendq, commands, bytes, time connected)
+L  Show all client connections with information and IP address
+P  Show online opers and their idle times
+T  Show bandwidth/socket statistics
+U  Show U-lined servers
+Y  Show connection classes
+O  Show opertypes and the allowed user and channel modes it can set
+E  Show socket engine events
+S  Show currently held registered nicknames
+G  Show how many local users are connected from each country according to GeoIP
+
+Note that all /STATS use is broadcast to online IRC operators.">
+
+######################
+#      SNOMASKS      #
+######################
+
+<helpop key="snomasks" value="Server Notice Masks
+
+ a      Allows receipt of local announcement messages.
+ A      Allows receipt of remote announcement messages.
+ c      Allows receipt of local connect messages.
+ C      Allows receipt of remote connect messages.
+ d      Allows receipt of general (and sometimes random) debug
+        messages.
+ f      Allows receipt of flooding notices.
+ g      Allows receipt of globops (requires globops module).
+ G      Allows receipt of notices of use of oper-override (requires
+        override module)
+ j      Allows receipt of channel creation notices (requires
+        chancreate module).
+ J      Allows receipt of remote channel creation notices (requires
+        chancreate module).
+ k      Allows receipt of local kill messages.
+ K      Allows receipt of remote kill messages.
+ l      Allows receipt of local linking related
+        messages.
+ L      Allows receipt of remote linking related
+        messages.
+ n      See local nickname changes (requires seenicks module).
+ N      See remote nickname changes (requires seenicks modules).
+ o      Allows receipt of oper-up, oper-down, and oper-failure
+        messages.
+ O      Allows receipt of remote oper-up, oper-down, and oper-failure
+        messages.
+ q      Allows receipt of local quit messages.
+ Q      Allows receipt of remote quit messages.
+ t      Allows receipt of attempts to use /STATS (local and remote).
+ v      Allows receipt of oper-override notices (requires override module).
+ x      Allows receipt of Xline notices (g/z/q/k/e/R/shuns).">
+
+######################
+#      EXTBANS       #
+######################
+
+<helpop key="extbans" value="Extended Bans
+----------
+
+Extbans are split into two types; matching extbans, which match on
+users in additional ways, and acting extbans, which restrict users
+in different ways to a standard ban.
+
+To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
+instead of a normal nick!user@host mask, to ban or exempt matching
+users. Ban exceptions on acting extbans exempt that user from matching
+an extban of that type, and from any channel mode corresponding to the
+restriction. Matching extbans may also be used for invite exceptions by
+setting +I <extban>.
+
+Matching extbans:
+
+ j:#channel    Matches anyone in #channel. Does not support wildcards
+               for #channel (requires channelban module).
+ r:realname    Matches users with a matching realname (requires gecosban
+               module).
+ s:server      Matches users on a matching server (requires serverban
+               module).
+ z:fingerprint Matches users with a matching ssl fingerprint (requires
+               sslmodes module)
+ O:opertype    Matches IRCops of a matching type, mostly useful as an
+               an invite exception (requires operchans module).
+ R:account     Matches users logged into a matching account (requires
+               services account module).
+
+Acting extbans:
+
+ c:<ban>       Blocks any messages that contain color codes from
+               matching users (requires blockcolor module).
+ m:<ban>       Blocks messages from matching users (requires muteban
+               module). Users with +v or above are not affected.
+ p:<ban>       Blocks part messages from matching users (requires
+               nopartmsg module).
+ A:<ban>       Blocks invites by matching users even when +A is set
+               (requires allowinvite module).
+ B:<ban>       Blocks all capital or nearly all capital messages from
+               matching users (requires blockcaps module).
+ C:<ban>       Blocks CTCPs from matching users (requires noctcp
+               module).
+ N:<ban>       Blocks nick changes from matching users (requires
+               nonicks module).
+ Q:<ban>       Blocks kicks by matching users (requires nokicks
+               module).
+ S:<ban>       Strips color/bold/underline from messages from matching
+               users (requires stripcolor module).
+ T:<ban>       Blocks notices from matching users (requires nonotice
+               module).
+ U:<ban>       Blocks unregistered users matching the given ban.
+               (requires m_services_account)
+
+A ban given to an acting extban may either be a nick!user@host mask,
+matched against users as for a normal ban, or a matching extban.
+
+There is an additional special type of extended ban, a redirect ban:
+
+ Redirect      n!u@h#channel will redirect the banned user to #channel
+               when they try to join (requires banredirect module).">
diff --git a/docs/conf/helpop.conf.example b/docs/conf/helpop.conf.example
new file mode 100644 (file)
index 0000000..02ddff8
--- /dev/null
@@ -0,0 +1,301 @@
+# Sample configuration file for m_helpop.so
+# You can either copy this into your conf folder and set up the module to use it,
+# or you can customize the responses for your network and/or add more.
+#
+# The way the new helpop system works is simple. You use one or more helpop tags.
+#   <helpop key="moo" value="something here">.
+# key is what the user is looking for (i.e. /helpop moo), and value is what they get back
+# (note that it can span multiple lines!).
+#   -- w00t 16/dec/2006
+#
+
+<alias text="HELP" replace="HELPOP $2-">
+
+<helpop key="start" value="InspIRCd Help System
+
+This system provides help for commands and modes.
+Specify your question or a command name as the
+parameter for this command.
+
+/HELPOP CUSER    -      To see a list of user commands
+/HELPOP COPER    -      To see a list of oper commands
+/HELPOP UMODES   -      To see a list of user modes
+/HELPOP CHMODES  -      To see a list of channel modes
+/HELPOP SNOMASKS -      To see a list of oper snotice masks
+/HELPOP EXTBANS  -      To see a list of extended bans">
+
+<helpop key="nohelp" value="There is no help for the topic
+you searched for. Please try again.">
+
+<helpop key="cuser" value="User Commands
+-------------
+
+PRIVMSG   NOTICE   NICK      JOIN      PART
+CYCLE     KNOCK    MODE      DEVOICE   TOPIC
+KICK      FPART    REMOVE    TBAN      INVITE
+UNINVITE  AWAY     DCCALLOW  SILENCE   ACCEPT
+MKPASSWD  VHOST    TITLE
+
+WHOIS     WHOWAS   ISON      USERHOST  WATCH
+LIST      NAMES    WHO       MOTD      RULES
+ADMIN     MAP      LINKS     LUSERS    TIME
+STATS     VERSION  INFO      MODULES   COMMANDS
+SSLINFO
+
+USER      PASS     PING     PONG       QUIT
+
+OPER">
+
+<helpop key="coper" value="Oper Commands
+-------------
+
+OPERMOTD  CHECK     TAXONOMY    CLONES   USERIP
+TLINE     ALLTIME   MODULES     WALLOPS  GLOBOPS
+
+SETHOST   SETIDENT  SETNAME     CHGHOST  CHGIDENT
+CHGNAME   SETIDLE   SWHOIS
+
+SANICK    NICKLOCK  NICKUNLOCK
+
+SAJOIN    SAPART    SAMODE      SATOPIC  SAKICK
+
+KILL      SAQUIT    GLINE       ZLINE    QLINE
+KLINE     RLINE     ELINE       CBAN     SHUN
+FILTER
+
+CONNECT   SQUIT     RCONNECT    RSQUIT
+
+DIE            RESTART      REHASH
+CLEARCACHE     LOADMODULE   UNLOADMODULE
+RELOADMODULE   GLOADMODULE  GUNLOADMODULE
+GRELOADMODULE  RELOAD       CLOSE
+LOCKSERV       UNLOCKSERV   JUMPSERVER">
+
+<helpop key="umodes" value="User Modes
+----------
+
+ c            Blocks private messages and notices from users who do
+              not share a common channel with you (requires
+              commonchans module).
+ d            Deaf mode. User will not recieve any messages or notices
+              from channels they are in (requires deaf module).
+ g            In combination with /allow, provides for server side
+              ignore (requires callerid module).
+ h            Marks as 'available for help' in WHOIS (IRCop only,
+              requires helpop module).
+ i            Makes invisible to /WHO if the user using /WHO is not in
+              a common channel.
+ k            Prevents the user from being kicked from channels, or
+              having op modes removed from them (services only,
+              requires servprotect module).
+ o            Marks as a IRC operator.
+ s [mask]     Receives server notices specified by [mask]
+              (IRCop only).
+ r            Marks as a having a registered nickname
+              (requires services account module).
+ w            Receives wallops messages.
+ x            Gives a cloaked hostname (requires cloaking module).
+ B            Marks as a bot (requires botmode module).
+ G            Censors messages sent to the user based on filters
+              configured for the network (requires censor module).
+ H            Hides an oper's oper status from WHOIS (requires
+              hideoper module).
+ I            Hides a user's entire channel list in WHOIS from
+              non-IRCops (requires hidechans module).
+ Q            Makes an operator invisible, preventing users from
+              seeing their presence, including in channel user lists
+              (IRCop only, requires invisible module).
+ R            Blocks private messages from unregistered users
+              (requires services account module).
+ S            Strips mIRC color/bold/underline codes out of private
+              messages to the user (requires stripcolor module).
+ W            Receives notification when a user uses WHOIS on them
+              (IRCop only, requires showwhois module).">
+
+<helpop key="chmodes" value="Channel Modes
+-------------
+
+ v [nickname]       Gives voice to [nickname], allowing them to speak
+                    while the channel is +m.
+ h [nickname]       Gives halfop status to [nickname] (this mode can
+                    be disabled).
+ o [nickname]       Gives op status to [nickname].
+ a [nickname]       Gives protected status to [nickname], preventing
+                    them from them from being kicked (+q only,
+                    requires chanprotect module).
+ q [nickname]       Gives owner status to [nickname], preventing them
+                    from being kicked (Services or only, requires
+                    chanprotect module).
+
+ b [hostmask]       Bans [hostmask] from the channel.
+ e [hostmask]       Excepts [hostmask] from bans (requires
+                    banexception module).
+ I [hostmask]       Excepts [hostmask] from +i, allowing matching
+                    users to join while the channel is invite-only
+                    (requires inviteexception module).
+
+ c                  Blocks messages containing mIRC color codes
+                    (requires blockcolor module).
+ f [*][lines]:[sec] Kicks on text flood equal to or above the
+                    specified rate. With *, the user is banned
+                    (requires messageflood module).
+ g [mask]           Blocks messages matching the given blob mask
+                    (requires chanfilter module).
+ i                  Makes the channel invite-only.
+                    Users can only join if an operator
+                    uses /INVITE to invite them.
+ j [joins]:[sec]    Limits joins to the specified rate (requires
+                    joinflood module).
+ k [key]            Set the channel key (password) to [key].
+ l [limit]          Set the maximum allowed users to [limit].
+ m                  Enable moderation. Only users with +v, +h, or +o
+                    can speak.
+ n                  Blocks users who are not members of the channel
+                    from messaging it.
+ p                  Make channel private, hiding it in user's whoises
+                    and replacing it with * in /LIST.
+ r                  Marks the channel as registered with Services
+                    (requires services account module).
+ s                  Make channel secret, hiding it in user's whoises
+                    and /LIST.
+ t                  Prevents users without +h or +o from changing the
+                    topic.
+ u                  Makes the channel an auditorium; normal users only
+                    see themselves or themselves and the operators,
+                    while operators see all the users (requires
+                    auditorium module).
+ w [flag]:[banmask] Adds basic channel access controls of [flag] to
+                    [banmask], via the +w listmode.
+                    For example, +w o:R:Brain will op anyone identified
+                    to the account 'Brain' on join.
+                    (requires autoop module)
+ z                  Blocks non-SSL clients from joining the channel.
+
+ A                  Allows anyone to invite users to the channel
+                    (normally only chanops can invite, requires
+                    allowinvite module).
+ B                  Blocks messages with too many capital letters,
+                    as determined by the network configuration
+                    (requires blockcaps module).
+ C                  Blocks any CTCPs to the channel (requires noctcp
+                    module).
+ D                  Delays join messages from users until they
+                    message the channel (requires delayjoin module).
+ F [changes]:[sec]  Blocks nick changes when they equal or exceed the
+                    specified rate (requires nickflood module).
+ G                  Censors messages to the channel based on the
+                    network configuration (requires censor module).
+ J [seconds]        Prevents rejoin after kick for the specified
+                    number of seconds. This prevents auto-rejoin
+                    (requires kicknorejoin module).
+ K                  Blocks /KNOCK on the channel.
+ L [channel]        If the channel reaches its limit set by +l,
+                    redirect users to [channel] (requires redirect
+                    module).
+ M                  Blocks unregistered users from speaking (requires
+                    services account module).
+ N                  Prevents users on the channel from chainging nick
+                    (requires nonicks module).
+ O                  Channel is IRCops only (can only be set by IRCops,
+                    requires operchans module).
+ P                  Makes the channel permanent; Bans, invites, the
+                    topic, modes, and such will not be lost when it
+                    empties (can only be set by IRCops, requires
+                    permchannels module).
+ Q                  Only ulined servers and their users can kick
+                    (requires nokicks module)
+ R                  Blocks unregistered users from joining (requires
+                    services account module).
+ S                  Strips mIRC color codes from messages to the
+                    channel (requirs stripcolor module).
+ T                  Blocks /NOTICEs to the channel from users who are
+                    not at least halfop (requires nonotice module).
+
+-------------
+NOTE: A large number of these modes are dependent upon server-side modules
+being loaded by a server/network administrator. The actual modes available
+on your network may be very different to this list. Please consult your
+help channel if you have any questions.">
+
+<helpop key="snomasks" value="Server Notice Masks
+
+ a      Allows receipt of local announcement messages.
+ A      Allows receipt of remote announcement messages.
+ c      Allows receipt of local connect messages.
+ C      Allows receipt of remote connect messages.
+ d      Allows receipt of general (and sometimes random) debug
+        messages.
+ f      Allows receipt of flooding notices.
+ g      Allows receipt of globops (requires globops module).
+ G      Allows receipt of notices of use of oper-override (requires
+        override module)
+ j      Allows receipt of channel creation notices (requires
+        chancreate module).
+ J      Allows receipt of remote channel creation notices (requires
+        chancreate module).
+ k      Allows receipt of local kill messages.
+ K      Allows receipt of remote kill messages.
+ l      Allows receipt of local linking related
+        messages.
+ L      Allows receipt of remote linking related
+        messages.
+ n      See local nickname changes (requires seenicks module).
+ N      See remote nickname changes (requires seenicks modules).
+ o      Allows receipt of oper-up, oper-down, and oper-failure
+        messages.
+ O      Allows receipt of remote oper-up, oper-down, and oper-failure
+        messages.
+ q      Allows receipt of local quit messages.
+ Q      Allows receipt of remote quit messages.
+ t      Allows receipt of attempts to use /STATS (local and remote).
+ v      Allows receipt of oper-override notices (requires override module).
+ x      Allows receipt of Xline notices (g/z/q/k/e/R/shuns).">
+
+<helpop key="extbans" value="Extended Bans
+----------
+
+ c:n!u@h      Blocks any messages that contain color codes from
+              matching users (requires blockcolor module).
+ j:#channel   Prevents anyone in #channel from joining the channel
+              (requires channelban module).
+ m:n!u@h      Blocks messages from matching users (requires muteban
+              module).
+ p:n!u@h      Blocks part messages from matching users (requires
+              nopartmsg module).
+ r:realname   Prevents users with a matching realname from joining
+              the channel (requires gecosban module).
+ s:server     Prevents users on a matching server from joining the
+              channel (requires services account).
+
+ A:n!u@h      Blocks invites by matching users even when +A is set
+              (requires allowinvite module).
+ B:n!u@h      Blocks all capital or nearly all capital messages from
+              matching users (requires blockcaps module).
+ C:n!u@h      Blocks CTCPs from matching users (requires noctcp
+              module).
+ M:account    Blocks messages from users logged into a matching
+              account (requires services account module).
+ N:n!u@h      Blocks nick changes from matching users (requires
+              nonicks module).
+ O:opertype   Prevents IRCops of the specified opertype from joining
+              the channel, mostly useful as an invite exception (IRCop
+              only, requires operchans module).
+ Q:n!u@h      Blocks kicks by matching users (requires nokicks
+              module).
+ R:account    Prevents users logged into a matching account from
+              joining the channel (requires services account module).
+ S:n!u@h      Strips color/bold/underline from messages from matching
+              users (requires stripcolor module).
+ T:n!u@h      Blocks notices from matching users (requires nonotice
+              module).
+ U:n!u@h      Blocks unregistered users matching the given ban.
+              (requires m_services_account)
+
+ Redirect     n!u@h#channel will redirect the banned user to #channel
+              when they try to join (requires banredirect module).
+
+All extbans that prevent users from joining may by used for ban
+exceptions and invite exceptions (invex), and extbans blocking
+specific actions may be used for ban exceptions to exempt people from
+either wider extbans or the restrictive mode matching the extban,
+where one exists.">
diff --git a/docs/conf/inspircd.censor.example b/docs/conf/inspircd.censor.example
deleted file mode 100644 (file)
index 342ccd8..0000000
+++ /dev/null
@@ -1,14 +0,0 @@
-# Configuration file for m_censor.so (1.0.0.0)
-# C.J.Edwards May 2004.
-#
-
-# The tags for this module are formatted as follows:
-#
-# <badword     text="simple word"
-#              replace="text to replace with">
-#
-# You can specify <badword text="simple word" replace="">
-# to block lines containing the word
-
-<badword text="shit" replace="poo">
-<badword text="fuck" replace="(censored)">
index fea9d5d5c57d299b566ea80900c351e0ca800c5c..83ac59acbceebc0408b2619ed8b175f392b75c11 100644 (file)
 
 # This file has all the information about oper classes, types and o:lines.
 # You *MUST* edit it.
-<include file="conf/opers.conf.example">
+<include file="conf/examples/opers.conf.example">
 
 # This file has all the information about server links and ulined servers.
 # You *MUST* edit it if you intend to link servers.
-<include file="conf/links.conf.example">
+<include file="conf/examples/links.conf.example">
 
 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 #   motd - displayed on connect and when a user executes /MOTD
 #   rules - displayed when the user executes /RULES
 # Modules can also define their own files
-<files motd="conf/inspircd.motd.example" rules="conf/inspircd.rules.example">
+<files motd="conf/examples/motd.txt.example" rules="conf/examples/rules.txt.example">
 
 # Example of an executable file include. Note this will be read on rehash,
 # not when the command is run.
 # provide almost all the features of InspIRCd. :)                     #
 #                                                                     #
 # The default does nothing -- we include it for simplicity for you.   #
-<include file="conf/modules.conf.example">
+<include file="conf/examples/modules.conf.example">
 
 # Here are some pre-built modules.conf files that closely match the
 # default configurations of some popular IRCd's. You still may want to
 # recommended that you make your own modules file based on modules.conf.example.
 
 # Settings similar to UnrealIRCd defaults.
-#<include file="conf/modules/modules.conf.unreal">
+#<include file="conf/examples/modules/unrealircd.conf.example">
 
 # Settings similar to Charybdis IRCd defaults.
-#<include file="conf/modules/modules.conf.charybdis">
+#<include file="conf/examples/modules/charybdis.conf.example">
 
 
 #########################################################################
diff --git a/docs/conf/inspircd.filter.example b/docs/conf/inspircd.filter.example
deleted file mode 100644 (file)
index 922f55f..0000000
+++ /dev/null
@@ -1,60 +0,0 @@
-# Configuration file for m_filter.so and m_filter_pcre.so
-
-# The tags for this module are formatted as follows:
-#
-# <keyword      pattern="any glob pattern here"
-#               reason="reason for filtering"
-#               action="action to take"
-#               flags="filter flags"
-#              duration="optional length of gline">
-#
-# Valid actions for 'action' are:
-#
-# block         This blocks the line, sends out a notice to all opers with
-#               +s and informs the user that their message was blocked.
-#
-# silent        This blocks the line only, and informs the user their message
-#               was blocked, but does not notify opers.
-#
-# none          This action causes nothing to be done except logging. This
-#               is the default action if none is specified.
-#
-# kill          This disconnects the user, with the 'reason' parameter as
-#               the kill reason.
-#
-# gline         G-LINE the user for 'duration' length of time. Durations may
-#               be specified using the notation 1y2d3h4m6s in a similar way to
-#               other glines, omitting the duration or setting it to 0 makes
-#               any glines set by this filter be permanent.
-#
-# You can add filters from IRC using the /FILTER command. If you do this, they
-# will be set globally to your entire network.
-#
-# Valid characters for 'flags' are one or more of:
-#
-# p: Block private and channel messages
-# n: Block private and channel notices
-# P: Block part messages
-# q: Block quit messages
-# o: Don't match against opers
-# c: Strip color codes from text before trying to match
-# *: Represents all of the above flags
-# -: Does nothing, a non-op for when you do not want to specify any flags 
-#
-# IMPORTANT NOTE: Because the InspIRCd config reader places special meaning on the
-# '\' character, you must use '\\' if you wish to specify a '\' character in a regular
-# expression. For example, to indicate numbers, use \\d and not \d. This does not
-# apply when adding a regular expression over irc with the /FILTER command.
-
-# Example filters for m_filter:
-#
-# <keyword pattern="*qwerty*" reason="You qwertied!" action="block" flags="pn">
-# <keyword pattern="*killmenow*" reason="As you request." action="kill" flags="*">
-# <keyword pattern="*blah*" reason="Dont blah!" action="gline" duration="1d6h" flags="-">
-
-# An example regexp filter for m_filter_pcre:
-#
-# <keyword pattern="^blah.*?$" reason="Dont blah!" action="gline" duration="1d6h" flags="pnPq">
-
-# An example of excluding a channel from filtering:
-# <exemptfromfilter channel="#help">
diff --git a/docs/conf/inspircd.helpop-full.example b/docs/conf/inspircd.helpop-full.example
deleted file mode 100644 (file)
index bc9326e..0000000
+++ /dev/null
@@ -1,1058 +0,0 @@
-#####################
-#  Helpop Standard  #
-#####################
-
-<alias text="HELP" replace="HELPOP $2-">
-
-<helpop key="start" value="InspIRCd Help System
-
-This system provides help for commands and modes.
-Specify your question or a command name as the
-parameter for this command.
-
-/HELPOP CUSER    -      To see a list of user commands
-/HELPOP COPER    -      To see a list of oper commands
-/HELPOP UMODES   -      To see a list of user modes
-/HELPOP CHMODES  -      To see a list of channel modes
-/HELPOP SNOMASKS -      To see a list of oper snotice masks
-/HELPOP EXTBANS  -      To see a list of extended bans">
-
-<helpop key="nohelp" value="There is no help for the topic
-you searched for. Please try again.">
-
-#####################
-#   User Commands   #
-#####################
-
-<helpop key="cuser" value="User Commands
--------------
-
-PRIVMSG   NOTICE   NICK      JOIN      PART
-CYCLE     KNOCK    MODE      DEVOICE   TOPIC
-KICK      FPART    REMOVE    TBAN      INVITE
-UNINVITE  AWAY     DCCALLOW  SILENCE   ACCEPT
-MKPASSWD  VHOST    TITLE     SETNAME
-
-WHOIS     WHOWAS   ISON      USERHOST  WATCH
-LIST      NAMES    WHO       MOTD      RULES
-ADMIN     MAP      LINKS     LUSERS    TIME
-STATS     VERSION  INFO      MODULES   COMMANDS
-SSLINFO
-
-USER      PASS     PING     PONG       QUIT
-
-OPER">
-
-<helpop key="sslinfo" value="/SSLINFO [nick]
-
-Displays information on the SSL connection and certificate of the
-target user.">
-
-<helpop key="uninvite" value="/UNINVITE [nick] [channel]
-
-Uninvite a user from a channel, same syntax as INVITE.">
-
-<helpop key="tban" value="/TBAN [channel] [duration] [banmask]
-
-Sets a timed ban. The duration of the ban can be specified in the
-following format: 1w2d3h4m6s which indicates a ban of one week, two
-days, three hours, four minutes and six seconds. Alternatively the
-ban may just be specified as a number of seconds. All timed bans
-appear in the banlist as normal bans and may be safely removed
-before their time is up.">
-
-<helpop key="dccallow" value="/DCCALLOW [+|-] [nick] [duration]
-
-Adds a nickname to or deletes a nickname from your DCCALLOW list.">
-
-<helpop key="accept" value="/ACCEPT [+-*] [nick]{ [, [+-]<nick> ] }
-
-Manages your accept list. This list is used to determine who can
-private message you when you have usermode +g set. ACCEPT +nick adds
-a nick to your accept list, ACCEPT -nick removes a nick from your
-accept list, and ACCEPT * displays your accept list.">
-
-<helpop key="cycle" value="/CYCLE [channel]
-
-Cycles a channel (leaving and rejoining), overrides restrictions that
-would stop a new user joining, such as user limits and channel keys.">
-
-<helpop key="title" value="/TITLE [name] [password]
-
-Authenticate for a WHOIS title line and optionally a vhost using the
-specified username and password.">
-
-<helpop key="watch" value="/WATCH [C|S|+/-[NICK]]
-
-Adds or deletes a user from the watch list. C clears the list
-and S queries the status.">
-
-<helpop key="vhost" value="/VHOST [username] [password]
-
-Authenticate for a vhost using the specified username and password.">
-
-<helpop key="remove" value="/REMOVE [nick] [channel] {[reason]}
-
-Removes a user from a channel you specify. You must be at least a
-channel halfoperator to remove a user. A removed user will part with
-a message stating they were removed from the channel and by whom.">
-
-<helpop key="fpart" value="/FPART [channel] [nick] {[reason]}
-
-This behaves identically to /REMOVE, the only difference is that that
-[channel] and [nick] parameters are switched around to match /KICK's
-syntax. Also, /REMOVE is a builtin mIRC command which caused trouble
-for some users. This feature was added in the 1.1 branch.">
-
-<helpop key="devoice" value="/DEVOICE [channel]
-
-Devoices yourself from the specified channel.">
-
-<helpop key="silence" value="/SILENCE [+/-][hostmask] [p|c|i|n|t|a|x]
-
-A serverside ignore of the given n!u@h mask. The letter(s) at the end
-specify what is to be ignored from this hostmask.
-
-Valid SILENCE Flags
--------------------
-
- p        Block private messages
- c        Block channel messages
- i        Block invites
- n        Block private notices
- t        Block channel notices
- a        Block all of the above
- x        Exception
-
-Multiple letters may be specified. For an exception, you msut pair x
-with what you want excepted. For example, if you wanted to except
-everything from people with a host matching *.foo.net, you would do
-/SILENCE +*!*@*.foo.net xa
-
-/SILENCE without a parameter will list the hostmasks that you have silenced.">
-
-<helpop key="knock" value="/KNOCK [channel]
-
-Sends a notice to a channel indicating you wish to join.">
-
-<helpop key="user" value="/USER [ident] [local host] [remote host] :[GECOS]
-
-This command is used by your client to register your
-IRC session, providing your ident and GECOS to the
-server.
-
-You should not use it during an established connection.">
-
-<helpop key="nick" value="/NICK [new nick]
-
-Change your nickname to [new nick].">
-
-<helpop key="quit" value="/QUIT {[reason]}
-
-Quit from IRC and end your current session.">
-
-<helpop key="version" value="/VERSION
-
-Returns the server's version information.">
-
-<helpop key="ping" value="/PING [server]
-
-Ping a server. Target server will answer with a PONG.">
-
-<helpop key="pong" value="/PONG [server]
-
-Your client should send this to answer server PINGs. You
-should not issue this command manually.">
-
-<helpop key="admin" value="/ADMIN [server]
-
-Shows the administrative information for the given server.">
-
-<helpop key="privmsg" value="/PRIVMSG [target] [text]
-
-Sends a message to a user or channel specified in [target].">
-
-<helpop key="notice" value="/NOTICE [target] [text]
-
-Sends a notice to a user or channel specified in [target].">
-
-<helpop key="join" value="/JOIN [channel]{,[channel]} [key]{,[key]}
-
-Joins one or more channels you provide the names for.">
-
-<helpop key="names" value="/NAMES [channel]{,[channel]}
-
-Return a list of users on the channels you provide.">
-
-<helpop key="part" value="/PART [channel]{,[channel] [reason]}
-
-Leaves one or more channels you specify.">
-
-<helpop key="kick" value="/KICK [channel] [nick] {[reason]}
-
-Kicks a user from a channel you specify. You must be
-At least a channel halfoperator to kick a user.">
-
-<helpop key="mode" value="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}
-
-Sets the mode for a channel or a nickname specified in [target]
-A user may only set modes upon themselves, and may not set the
-+o usermode, and a user may only change channel modes of
-channels where they are at least a halfoperator.
-
-For a list of all user and channel modes, enter /HELPOP UMODES or
-/HELPOP CHMODES.">
-
-<helpop key="topic" value="/TOPIC [channel] {topic}
-
-Sets or retrieves the channel topic. If a channel topic is
-given in the command and either the channel is not +t, or
-you are at least a halfoperator, the channel topic will be
-changed to the new one you provide.">
-
-<helpop key="who" value="/WHO [ [search-pattern] [ohurmaiMplf] ]
-
-Looks up the information of users matching the range you provide.
-You may only /WHO nicknames in channels or on servers where you
-share a common channel with them, or ones which are not +i (unless
-you are an IRC operator). The search-pattern may be a special
-sequence of characters determined by the flags given below, or
-it may be one of a nickname, a channel, a hostmask, an ip address
-mask or a server mask.
-
-Valid WHO Flags
----------------
-
-The following flags after the mask have the following effects:
-
- o      Show online IRC operators matching the mask
-
- a      Show all users who have an away message matching the given mask
- i      Show all users who have an ident (username) matching the given mask
- p      Show all users who are connected on the given port number
- r      Show all users whose realnames match the mask. When this
-        flag is set it overrides the meaning of the search-pattern,
-        which must contain a glob pattern intended to match GECOS
-        (realname) fields.
- m      Search for all users with a given set of user modes. When
-        this flag is set it overrides the meaning of the
-        search-pattern, which must contain the mode sequence to
-        search for, for example to find all users with +i and
-        without +s, issue the command WHO +i-s m.
- t      Show users connected within this number of seconds
- M      Show all users who have metadata attached to them with
-        the given key name
-
- f      Show only remote (far) users
- l      Show only local users
-
- h      Show real hostnames rather than masked hostnames (IRC
-        operators only)
- u      Unlimit the results past the maximum /who results value
-        (IRC operators only)
-
-You may combine multiple flags in one WHO command except where stated in the table above.">
-
-<helpop key="motd" value="/MOTD [server]
-
-Show the message of the day for [server]. Messages of the day often
-contain important server rules and notices and should be read prior
-to using a server.">
-
-<helpop key="rules" value="/RULES
-
-Show the rules file for the local server. This is similar in effect to
-except that these are not sent automatically on connect.">
-
-<helpop key="oper" value="/OPER [login] [password]
-
-Attempts to authenticate a user as an IRC operator.
-
-Both successful and unsuccessful oper attempts are
-logged, and sent to online IRC operators.">
-
-<helpop key="list" value="/LIST [pattern]
-
-Creates a list of all existing channels matching the glob pattern
-[pattern], e.g. *chat* or bot*.">
-
-<helpop key="lusers" value="/LUSERS
-
-Shows a count of local and remote users, servers and channels.">
-
-<helpop key="userhost" value="/USERHOST [nickname]
-
-Returns the hostname and nickname of a user, and some other
-miscellaneous information.">
-
-<helpop key="away" value="/AWAY {message}
-
-If a message is given, marks you as being away, otherwise
-removes your away status and previous message.">
-
-<helpop key="ison" value="/ISON [nick] {[nick]...}
-
-Returns a subset of the nicks you give, showing only those
-that are currently online.">
-
-<helpop key="invite" value="/INVITE [nick] [channel] {[time]}
-
-Invites a user to a channel. If the channel is NOT +A, only
-channel halfoperators or above can invite people. If +A is set,
-anyone can invite people to the channel, as long as the person
-doing the invite is a member of the channel they wish to invite
-the user to.
-
-Invited users may override bans, +k, and similar in addition to
-+i, depending on configuration.
-
-If a time is provided, the invite expires after that time and the user
-can no longer use it to enter the channel.">
-
-<helpop key="pass" value="/PASS [password]
-
-This command is used by your client when setting up
-your IRC session to submit a server password to the
-server.
-
-You should not use it during an established connection.">
-
-<helpop key="whowas" value="/WHOWAS [nick]
-
-Returns a list of times the user was seen recently on IRC along with
-the time they were last seen and their server.">
-
-<helpop key="links" value="/LINKS
-
-Shows all servers linked to this one.">
-
-<helpop key="map" value="/MAP
-
-Shows a graphical representation of all users and servers on the
-network, and the links between them, as a tree from the perspective
-of your server.">
-
-<helpop key="whois" value="/WHOIS [nick] {server}
-
-Returns the WHOIS information of a user, their channels, hostname,
-etc. If a second nickname or server is provided, then a whois is
-performed from the server where the user is actually located rather
-than locally, showing idle and signon times.">
-
-<helpop key="time" value="/TIME [servermask]
-
-Returns the local time of the server, or remote time of another
-server.">
-
-<helpop key="info" value="/INFO
-
-Returns information on the developers and supporters who made this
-IRC server possible.">
-
-<helpop key="setname" value="/SETNAME [name]
-
-Sets your name to the specified name.">
-
-
-#####################
-#   Oper Commands   #
-#####################
-
-<helpop key="coper" value="Oper Commands
--------------
-
-OPERMOTD  CHECK     CLONES      USERIP   LINE
-ALLTIME   MODULES   WALLOPS     GLOBOPS
-
-SETHOST   SETIDENT  CHGHOST     CHGIDENT CHGNAME
-SETIDLE   SWHOIS
-
-SANICK    NICKLOCK  NICKUNLOCK
-
-SAJOIN    SAPART    SAMODE      SATOPIC  SAKICK
-
-KILL      SAQUIT    GLINE       ZLINE    QLINE
-KLINE     RLINE     ELINE       CBAN     SHUN
-FILTER    OJOIN
-
-CONNECT   SQUIT     RCONNECT    RSQUIT
-
-DIE            RESTART      REHASH
-CLEARCACHE     LOADMODULE   UNLOADMODULE
-RELOADMODULE   GLOADMODULE  GUNLOADMODULE
-GRELOADMODULE  RELOAD       CLOSE
-LOCKSERV       UNLOCKSERV   JUMPSERVER">
-
-<helpop key="userip" value="/USERIP [nickname]
-
-Returns the ip and nickname of a user.">
-
-<helpop key="tline" value="/TLINE [host or ip mask]
-
-This command returns the number of local and global clients matched,
-and the percentage of clients matched, plus how they were matched
-(by IP address or by hostname).">
-
-<helpop key="lockserv" value="/LOCKSERV
-
-Locks out all new connections notifying connecting users that the
-service is temporarily closed and to try again later.">
-
-<helpop key="unlockserv" value="/UNLOCKSERV
-
-Opens the server up again for new connections.">
-
-<helpop key="jumpserver" value="/JUMPSERVER {[newserver] [newport] [+/-flags] {:[reason]}}
-
-Sets or cancels jumpserver mode. If no parameters are given,
-jumpserver mode is cancelled, if it is currently set. If parameters
-are given, a server address must be given for [newserver] and a
-server port must be given for [newport]. Zero or more status flags
-should be given for 'flags', from the list below (if you do not
-wish to specify any flags just place a '+' in this field):
-
-1. +a: Redirect all users immediately (except for opers) and cause
-them to quit with the given reason
-
-2. +n: Redirect any new users who connect and cause them to quit
-during registration
-
-You may use + and - to set or unset these flags in the command, the
-default flags are -a+n, which will just redirect new users. The
-reason parameter is optional, and if not provided defaults to
-'Please use this server/port instead' (the default given in various
-numeric lists)">
-
-<helpop key="filter" value="/FILTER [filter-definition] {[action] [flags] {[gline-duration]} :[reason]}
-
-This command will add a filter when more than one parameter is given,
-for messages of the types specified by the flags, with the given
-filter definition, action, gline duration (when the action is 'gline')
-and reason.
-
-The filter will take effect when a message of any type specified by
-the flags and matching the definition is sent to the server, and
-perform the specified action.
-
-Valid FILTER Actions
---------------------
-
-None    Does nothing
-Block   Blocks message and informs +s IRCops of the blocked message
-        and all relevant info
-Silent  Blocks message, but does not notify IRCops
-Kill    Kills the user
-Gline   Glines the user for the specified duration
-
-Valid FILTER Flags
-------------------
-
-p    Block private and channel messages
-n    Block private and channel notices
-P    Block part messages
-q    Block quit messages
-o    Don't match against opers
-*    Represents all of the above flags
--    Does nothing, a non-op for when you do not want to specify any
-     flags
-
-The reason for the filter will be used as the reason for the action,
-unless the ation is 'none', and is sent to the user when their text is
-blocked by 'block' and 'silent' actions.
-
-A gline duration may be specified in seconds, or in the format
-1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
-minutes and 6 seconds. All fields in this format are optional.
-
-When only one parameter is provided (the filter pattern) the provided
-filter will be removed. Note that if you remove a
-configuration-defined filter, it will reappear at next rehash unless
-it is also removed from the config file.">
-
-<helpop key="ojoin" value="/OJOIN [#chan]
-
-Force joins you to the specified channel, and gives you +Y and any other
-configuration-defined modes on it, preventing you from being kicked.
-Depending on configuration, may announce that you have joined the
-channel on official network business.">
-
-<helpop key="clones" value="/CLONES [limit]
-
-Retrieves a list of users with more clones than the specified
-limit.">
-
-<helpop key="check" value="/CHECK [nick|ip|hostmask|channel] {[server]}
-
-Allows opers to look up advanced information on channels, hostmasks
-or IP addresses, in a similar way to WHO but in more detail, displaying
-most information the IRCD has stored on the target, including all
-metadata.
-
-With the second parameter given, runs the command remotely on the
-specified server.">
-
-<helpop key="alltime" value="/ALLTIME
-
-Shows the time on all servers on the network.">
-
-<helpop key="rconnect" value="/RCONNECT [source mask] [target mask]
-
-The server matching [source mask] will try to connect to the first
-server in the config file matching [target mask].">
-
-<helpop key="rsquit" value="/RSQUIT {[source mask]} [target mask]
-
-Causes a remote server matching [target mask] to be disconnected from
-the network, only if connected via a server matching [source mask] if
-it is specified.">
-
-<helpop key="globops" value="/GLOBOPS [message]
-
-Sends a message to all users with the +g snomask.">
-
-<helpop key="cban" value="/CBAN [channel] {[duration] :[reason]}
-
-Sets or removes a channel ban. You must specify all three parameters
-to add a ban, and one parameter to remove a ban (just the channel).
-
-The duration may be specified in seconds, or in the format
-1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
-5 minutes and 6 seconds. All fields in this format are optional.">
-
-<helpop key="sajoin" value="/SAJOIN [nick] [channel]
-
-Forces the user to join the channel.">
-
-<helpop key="sapart" value="/SAPART [nick] [channel]
-
-Forces the user to part the channel.">
-
-<helpop key="samode" value="/SAMODE [target] +/-[modes] {[parameters for modes]}
-
-Applies the given mode change to the channel or nick specified.">
-
-<helpop key="sanick" value="/SANICK [nick] [new nick]
-
-Changes the user's nick to the new nick.">
-
-<helpop key="saquit" value="/SAQUIT [nick] [reason]
-
-Forces user to quit with the specified reason.">
-
-<helpop key="setidle" value="/SETIDLE [idle time]
-
-Sets your idle time (in seconds) to the specified value.">
-
-<helpop key="sethost" value="/SETHOST [host]
-
-Sets your host to the specified host.">
-
-<helpop key="setident" value="/SETIDENT [ident]
-
-Sets your ident to the specified ident.">
-
-<helpop key="swhois" line="/SWHOIS [nick] [swhois]
-
-Sets the user's swhois field to the given swhois.">
-
-<helpop key="mkpasswd" value="/MKPASSWD [hashtype] [plaintext]
-
-Encodes the plaintext to a hash of the given type and displays
-the result.">
-
-<helpop key="opermotd" value="/OPERMOTD
-
-Redisplays the Oper MOTD.">
-
-<helpop key="nicklock" value="/NICKLOCK [nick] [new nick]
-
-Changes the user's nick to the new nick, and forces
-it to remain as such for the remainder of the session.">
-
-<helpop key="nickunlock" value="/NICKUNLOCK [nick]
-
-Allows a previously locked user to change nicks again.">
-
-<helpop key="chghost" value="/CHGHOST [nickname] [new hostname]
-
-Changes the hostname of the user to the new hostname.">
-
-<helpop key="chgname" value="/CHGNAME [nickname] [new name]
-
-Changes the name of the user to the new name.">
-
-<helpop key="chgident" value="/CHGIDENT [nickname] [new ident]
-
-Changes the ident of the user to the new ident.">
-
-<helpop key="shun" value="/SHUN [nick!user@host] {[duration] :[reason]}
-
-Sets or removes a shun (serverside ignore) on a host and ident mask.
-You must specify all three parameters to add a shun, and one parameter
-to remove a shun (just the nick!user@host section).
-
-The duration may be specified in seconds, or in the format
-1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
-5 minutes and 6 seconds. All fields in this format are optional.">
-
-<helpop key="die" value="/DIE [password]
-
-This command shuts down the local server. A single parameter is
-required, which must match the password in the configuration for the
-command to function.">
-
-<helpop key="restart" value="/RESTART [password]
-
-This command restarts down the local server. A single parameter is
-required, which must match the password in the configuration for the
-command to function.">
-
-<helpop key="commands" value="/COMMANDS
-
-Shows all currently available commands.">
-
-<helpop key="kill" value="/KILL [user] [reason]
-
-This command will disconnect a user from IRC with the given reason.">
-
-<helpop key="rehash" value="/REHASH
-
-This command will cause the server configuration file to be reread and
-values reinitialized for all servers matchin the server mask, or the
-local server if one is not specified.">
-
-<helpop key="connect" value="/CONNECT [servermask]
-
-Add a connection to the server matching the given servermask. You must
-have configured the server for linking in your configuration file
-before trying to link them.">
-
-<helpop key="squit" value="/SQUIT [servermask]
-
-Disconnects the server matching the given servermask from this server.">
-
-<helpop key="modules" value="/MODULES
-
-Lists currently loaded modules, their memory offsets, version numbers,
-and flags. If you are not an operator, you will see reduced detail.">
-
-<helpop key="loadmodule" value="/LOADMODULE [filename.so]
-
-Loads the specified module into the local server.">
-
-<helpop key="unloadmodule" value="/UNLOADMODULE [filename.so]
-
-Unloads a module from the local server. The module cannot have the
-static flag set (see the output of /MODULES).">
-
-<helpop key="reloadmodule" value="/RELOADMODULE [filename.so]
-
-Unloads and reloads a module on the local server. This module cannot
-have the static flag set (see the output of /MODULES).">
-
-<helpop key="loadmodule" value="/GLOADMODULE [filename.so]
-
-Loads the specified module on all linked servers.">
-
-<helpop key="unloadmodule" value="/GUNLOADMODULE [filename.so]
-
-Unloads a module from all linked servers. The module cannot have the
-static flag set (see the output of /MODULES).">
-
-<helpop key="reloadmodule" value="/GRELOADMODULE [filename.so]
-
-Unloads and reloads a module on all linked servers. This module cannot
-have the static flag set (see the output of /MODULES).">
-
-<helpop key="kline" value="/KLINE [user@host] {[duration] :[reason]}
-
-Sets or removes a k-line (local host based ban) on a host and ident mask.
-You must specify all three parameters to add a ban, and one parameter
-to remove a ban (just the user@host section).
-
-The duration may be specified in seconds, or in the format
-1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
-5 minutes and 6 seconds. All fields in this format are optional.">
-
-<helpop key="zline" value="/ZLINE [ipmask] {[duration] :[reason]}
-
-Sets or removes a z-line (ip based ban) on an ip range mask.
-You must specify all three parameters to add a ban, and one parameter
-to remove a ban (just the ipmask).
-
-The duration may be specified in seconds, or in the format
-1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
-5 minutes and 6 seconds. All fields in this format are optional.">
-
-<helpop key="qline" value="/QLINE [nickmask] {[duration] :[reason]}
-
-Sets or removes a q-line (nick based ban) on a nick mask.
-You must specify all three parameters to add a ban, and one parameter
-to remove a ban (just the nickmask).
-
-The duration may be specified in seconds, or in the format
-1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
-5 minutes and 6 seconds. All fields in this format are optional.">
-
-<helpop key="gline" value="/GLINE [user@host] {[duration] :[reason]}
-
-Sets or removes a g-line (host based ban) on host mask.
-You must specify all three parameters to add a ban, and one
-parameter to remove a ban (just the user@host section).
-
-The duration may be specified in seconds, or in the format
-1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
-5 minutes and 6 seconds. All fields in this format are optional.">
-
-<helpop key="eline" value="/ELINE [user@host] {[duration] :[reason]}
-
-Sets or removes a e-line (local ban exception) on host mask.
-You must specify at least 3 parameters to add an exception, and one
-parameter to remove an exception (just the user@host section).
-
-The duration may be specified in seconds, or in the format
-1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
-5 minutes and 6 seconds. All fields in this format are optional.
-
-This command has a few important limitations. Bans on *@<ip> can only
-be negated by an eline on *@<ip>, bans on *@<host> can be negated by
-elines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
-can be negated by any eline that matches.">
-
-<helpop key="wallops" value="/WALLOPS [message]
-
-Sends a message to all +w users.">
-
-<helpop key="sakick" value="/SAKICK [#chan] [nick] [reason]
-
-Kicks the given user from the specified channel.">
-
-<helpop key="satopic" value="/SATOPIC [#chan] [new topic]
-
-Applies the given topic to the specified channel.">
-
-<helpop key="rline" value="/RLINE [regex] {[duration] :[reason]}
-
-Sets or removes an r-line (regex line) on a n!u@h\\sgecos mask. You
-must specify all three parameters to add an rline, and one parameter
-to remove an rline (just the regex).
-
-The duration may be specified in seconds, or in the format
-1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
-5 minutes and 6 seconds. All fields in this format are optional.">
-
-<helpop key="clearcache" value="/CLEARCACHE {servername}
-
-This command clears the DNS cache of the specified server. If no
-server is specified, the local server's DNS cache will be cleared.">
-
-<helpop key="reload" value="/RELOAD [core command]
-
-Reloads the specified core command.">
-
-<helpop key="close" value="/CLOSE
-
-Closes all unregistered connections to the local server.">
-
-######################
-# User/Channel Modes #
-######################
-
-<helpop key="umodes" value="User Modes
-----------
-
- c            Blocks private messages and notices from users who do
-              not share a common channel with you (requires
-              commonchans module).
- d            Deaf mode. User will not recieve any messages or notices
-              from channels they are in (requires deaf module).
- g            In combination with /allow, provides for server side
-              ignore (requires callerid module).
- h            Marks as 'available for help' in WHOIS (IRCop only,
-              requires helpop module).
- i            Makes invisible to /WHO if the user using /WHO is not in
-              a common channel.
- k            Prevents the user from being kicked from channels, or
-              having op modes removed from them (services only,
-              requires servprotect module).
- o            Marks as a IRC operator.
- s [mask]     Receives server notices specified by [mask]
-              (IRCop only).
- r            Marks as a having a registered nickname
-              (requires services account module).
- w            Receives wallops messages.
- x            Gives a cloaked hostname (requires cloaking module).
- B            Marks as a bot (requires botmode module).
- G            Censors messages sent to the user based on filters
-              configured for the network (requires censor module).
- H            Hides an oper's oper status from WHOIS (requires
-              hideoper module).
- I            Hides a user's entire channel list in WHOIS from
-              non-IRCops (requires hidechans module).
- Q            Makes an operator invisible, preventing users from
-              seeing their presence, including in channel user lists
-              (IRCop only, requires invisible module).
- R            Blocks private messages from unregistered users
-              (requires services account module).
- S            Strips mIRC color/bold/underline codes out of private
-              messages to the user (requires stripcolor module).
- W            Receives notification when a user uses WHOIS on them
-              (IRCop only, requires showwhois module).">
-
-<helpop key="chmodes" value="Channel Modes
--------------
-
- v [nickname]       Gives voice to [nickname], allowing them to speak
-                    while the channel is +m.
- h [nickname]       Gives halfop status to [nickname] (this mode can
-                    be disabled).
- o [nickname]       Gives op status to [nickname].
- a [nickname]       Gives protected status to [nickname], preventing
-                    them from them from being kicked (+q only,
-                    requires chanprotect module).
- q [nickname]       Gives owner status to [nickname], preventing them
-                    from being kicked (Services or only, requires
-                    chanprotect module).
-
- b [hostmask]       Bans [hostmask] from the channel.
- e [hostmask]       Excepts [hostmask] from bans (requires
-                    banexception module).
- I [hostmask]       Excepts [hostmask] from +i, allowing matching
-                    users to join while the channel is invite-only
-                    (requires inviteexception module).
-
- c                  Blocks messages containing mIRC color codes
-                    (requires blockcolor module).
- d [time]           Blocks messages to a channel from new users
-                    until they have been in the channel for [time]
-                    seconds (requires delaymsg module).
- f [*][lines]:[sec] Kicks on text flood equal to or above the
-                    specified rate. With *, the user is banned
-                    (requires messageflood module).
- i                  Makes the channel invite-only.
-                    Users can only join if an operator
-                    uses /INVITE to invite them.
- j [joins]:[sec]    Limits joins to the specified rate (requires
-                    joinflood module).
- k [key]            Set the channel key (password) to [key].
- l [limit]          Set the maximum allowed users to [limit].
- m                  Enable moderation. Only users with +v, +h, or +o
-                    can speak.
- n                  Blocks users who are not members of the channel
-                    from messaging it.
- p                  Make channel private, hiding it in users' whoises
-                    and replacing it with * in /LIST.
- r                  Marks the channel as registered with Services
-                    (requires services account module).
- s                  Make channel secret, hiding it in users' whoises
-                    and /LIST.
- t                  Prevents users without +h or +o from changing the
-                    topic.
- u                  Makes the channel an auditorium; normal users only
-                    see themselves or themselves and the operators,
-                    while operators see all the users (requires
-                    auditorium module).
- w [flag]:[banmask] Adds basic channel access controls of [flag] to
-                    [banmask], via the +w listmode.
-                    For example, +w o:R:Brain will op anyone identified
-                    to the account 'Brain' on join.
-                    (requires autoop module)
- z                  Blocks non-SSL clients from joining the channel.
-
- A                  Allows anyone to invite users to the channel
-                    (normally only chanops can invite, requires
-                    allowinvite module).
- B                  Blocks messages with too many capital letters,
-                    as determined by the network configuration
-                    (requires blockcaps module).
- C                  Blocks any CTCPs to the channel (requires noctcp
-                    module).
- D                  Delays join messages from users until they
-                    message the channel (requires delayjoin module).
- F [changes]:[sec]  Blocks nick changes when they equal or exceed the
-                    specified rate (requires nickflood module).
- G                  Censors messages to the channel based on the
-                    network configuration (requires censor module).
- J [seconds]        Prevents rejoin after kick for the specified
-                    number of seconds. This prevents auto-rejoin
-                    (requires kicknorejoin module).
- K                  Blocks /KNOCK on the channel.
- L [channel]        If the channel reaches its limit set by +l,
-                    redirect users to [channel] (requires redirect
-                    module).
- M                  Blocks unregistered users from speaking (requires
-                    services account module).
- N                  Prevents users on the channel from chainging nick
-                    (requires nonicks module).
- O                  Channel is IRCops only (can only be set by IRCops,
-                    requires operchans module).
- P                  Makes the channel permanent; Bans, invites, the
-                    topic, modes, and such will not be lost when it
-                    empties (can only be set by IRCops, requires
-                    permchannels module).
- Q                  Only ulined servers and their users can kick
-                    (requires nokicks module)
- R                  Blocks unregistered users from joining (requires
-                    services account module).
- S                  Strips mIRC color codes from messages to the
-                    channel (requirs stripcolor module).
- T                  Blocks /NOTICEs to the channel from users who are
-                    not at least halfop (requires nonotice module).
- g [mask]           Blocks messages matching the given blob mask
-                    (requires chanfilter module).
- X [mode]           Makes channel operators immune to the specified
-                    restrictive mode (requires exemptchanops module).
-
--------------
-NOTE: A large number of these modes are dependent upon server-side modules
-being loaded by a server/network administrator. The actual modes available
-on your network may be very different to this list. Please consult your
-help channel if you have any questions.">
-
-######################
-#   Stats Symbols    #
-######################
-
-<helpop key="stats" value="/STATS [symbol]
-
-Shows various server statistics. Depending on configuration, some
-symbols may be only available to opers.
-
-Valid symbols are:
-
-e  Show e-lines (local ban exemptions)
-g  Show g-lines (host bans)
-k  Show k-lines (local host bans)
-q  Show q-lines (nick mask bans)
-Z  Show z-lines (IP mask bans)
-R  Show R-lines (regular expression bans)
-
-H  Show shuns
-s  Show filters
-C  Show channel bans
-
-c  Show link blocks
-d  Show configured DNSBLs and related statistics
-m  Show command statistics, number of times commands have been used
-o  Show a list of all valid oper usernames and hostmasks
-p  Show open client ports, and the port type (ssl, plaintext, etc)
-u  Show server uptime
-z  Show memory usage statistics
-i  Show connect class permissions
-l  Show all client connections with information (sendq, commands, bytes, time connected)
-L  Show all client connections with information and IP address
-P  Show online opers and their idle times
-T  Show bandwidth/socket statistics
-U  Show U-lined servers
-Y  Show connection classes
-O  Show opertypes and the allowed user and channel modes it can set
-E  Show socket engine events
-S  Show currently held registered nicknames
-G  Show how many local users are connected from each country according to GeoIP
-
-Note that all /STATS use is broadcast to online IRC operators.">
-
-######################
-#      SNOMASKS      #
-######################
-
-<helpop key="snomasks" value="Server Notice Masks
-
- a      Allows receipt of local announcement messages.
- A      Allows receipt of remote announcement messages.
- c      Allows receipt of local connect messages.
- C      Allows receipt of remote connect messages.
- d      Allows receipt of general (and sometimes random) debug
-        messages.
- f      Allows receipt of flooding notices.
- g      Allows receipt of globops (requires globops module).
- G      Allows receipt of notices of use of oper-override (requires
-        override module)
- j      Allows receipt of channel creation notices (requires
-        chancreate module).
- J      Allows receipt of remote channel creation notices (requires
-        chancreate module).
- k      Allows receipt of local kill messages.
- K      Allows receipt of remote kill messages.
- l      Allows receipt of local linking related
-        messages.
- L      Allows receipt of remote linking related
-        messages.
- n      See local nickname changes (requires seenicks module).
- N      See remote nickname changes (requires seenicks modules).
- o      Allows receipt of oper-up, oper-down, and oper-failure
-        messages.
- O      Allows receipt of remote oper-up, oper-down, and oper-failure
-        messages.
- q      Allows receipt of local quit messages.
- Q      Allows receipt of remote quit messages.
- t      Allows receipt of attempts to use /STATS (local and remote).
- v      Allows receipt of oper-override notices (requires override module).
- x      Allows receipt of Xline notices (g/z/q/k/e/R/shuns).">
-
-######################
-#      EXTBANS       #
-######################
-
-<helpop key="extbans" value="Extended Bans
-----------
-
-Extbans are split into two types; matching extbans, which match on
-users in additional ways, and acting extbans, which restrict users
-in different ways to a standard ban.
-
-To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
-instead of a normal nick!user@host mask, to ban or exempt matching
-users. Ban exceptions on acting extbans exempt that user from matching
-an extban of that type, and from any channel mode corresponding to the
-restriction. Matching extbans may also be used for invite exceptions by
-setting +I <extban>.
-
-Matching extbans:
-
- j:#channel    Matches anyone in #channel. Does not support wildcards
-               for #channel (requires channelban module).
- r:realname    Matches users with a matching realname (requires gecosban
-               module).
- s:server      Matches users on a matching server (requires serverban
-               module).
- z:fingerprint Matches users with a matching ssl fingerprint (requires
-               sslmodes module)
- O:opertype    Matches IRCops of a matching type, mostly useful as an
-               an invite exception (requires operchans module).
- R:account     Matches users logged into a matching account (requires
-               services account module).
-
-Acting extbans:
-
- c:<ban>       Blocks any messages that contain color codes from
-               matching users (requires blockcolor module).
- m:<ban>       Blocks messages from matching users (requires muteban
-               module). Users with +v or above are not affected.
- p:<ban>       Blocks part messages from matching users (requires
-               nopartmsg module).
- A:<ban>       Blocks invites by matching users even when +A is set
-               (requires allowinvite module).
- B:<ban>       Blocks all capital or nearly all capital messages from
-               matching users (requires blockcaps module).
- C:<ban>       Blocks CTCPs from matching users (requires noctcp
-               module).
- N:<ban>       Blocks nick changes from matching users (requires
-               nonicks module).
- Q:<ban>       Blocks kicks by matching users (requires nokicks
-               module).
- S:<ban>       Strips color/bold/underline from messages from matching
-               users (requires stripcolor module).
- T:<ban>       Blocks notices from matching users (requires nonotice
-               module).
- U:<ban>       Blocks unregistered users matching the given ban.
-               (requires m_services_account)
-
-A ban given to an acting extban may either be a nick!user@host mask,
-matched against users as for a normal ban, or a matching extban.
-
-There is an additional special type of extended ban, a redirect ban:
-
- Redirect      n!u@h#channel will redirect the banned user to #channel
-               when they try to join (requires banredirect module).">
diff --git a/docs/conf/inspircd.helpop.example b/docs/conf/inspircd.helpop.example
deleted file mode 100644 (file)
index 02ddff8..0000000
+++ /dev/null
@@ -1,301 +0,0 @@
-# Sample configuration file for m_helpop.so
-# You can either copy this into your conf folder and set up the module to use it,
-# or you can customize the responses for your network and/or add more.
-#
-# The way the new helpop system works is simple. You use one or more helpop tags.
-#   <helpop key="moo" value="something here">.
-# key is what the user is looking for (i.e. /helpop moo), and value is what they get back
-# (note that it can span multiple lines!).
-#   -- w00t 16/dec/2006
-#
-
-<alias text="HELP" replace="HELPOP $2-">
-
-<helpop key="start" value="InspIRCd Help System
-
-This system provides help for commands and modes.
-Specify your question or a command name as the
-parameter for this command.
-
-/HELPOP CUSER    -      To see a list of user commands
-/HELPOP COPER    -      To see a list of oper commands
-/HELPOP UMODES   -      To see a list of user modes
-/HELPOP CHMODES  -      To see a list of channel modes
-/HELPOP SNOMASKS -      To see a list of oper snotice masks
-/HELPOP EXTBANS  -      To see a list of extended bans">
-
-<helpop key="nohelp" value="There is no help for the topic
-you searched for. Please try again.">
-
-<helpop key="cuser" value="User Commands
--------------
-
-PRIVMSG   NOTICE   NICK      JOIN      PART
-CYCLE     KNOCK    MODE      DEVOICE   TOPIC
-KICK      FPART    REMOVE    TBAN      INVITE
-UNINVITE  AWAY     DCCALLOW  SILENCE   ACCEPT
-MKPASSWD  VHOST    TITLE
-
-WHOIS     WHOWAS   ISON      USERHOST  WATCH
-LIST      NAMES    WHO       MOTD      RULES
-ADMIN     MAP      LINKS     LUSERS    TIME
-STATS     VERSION  INFO      MODULES   COMMANDS
-SSLINFO
-
-USER      PASS     PING     PONG       QUIT
-
-OPER">
-
-<helpop key="coper" value="Oper Commands
--------------
-
-OPERMOTD  CHECK     TAXONOMY    CLONES   USERIP
-TLINE     ALLTIME   MODULES     WALLOPS  GLOBOPS
-
-SETHOST   SETIDENT  SETNAME     CHGHOST  CHGIDENT
-CHGNAME   SETIDLE   SWHOIS
-
-SANICK    NICKLOCK  NICKUNLOCK
-
-SAJOIN    SAPART    SAMODE      SATOPIC  SAKICK
-
-KILL      SAQUIT    GLINE       ZLINE    QLINE
-KLINE     RLINE     ELINE       CBAN     SHUN
-FILTER
-
-CONNECT   SQUIT     RCONNECT    RSQUIT
-
-DIE            RESTART      REHASH
-CLEARCACHE     LOADMODULE   UNLOADMODULE
-RELOADMODULE   GLOADMODULE  GUNLOADMODULE
-GRELOADMODULE  RELOAD       CLOSE
-LOCKSERV       UNLOCKSERV   JUMPSERVER">
-
-<helpop key="umodes" value="User Modes
-----------
-
- c            Blocks private messages and notices from users who do
-              not share a common channel with you (requires
-              commonchans module).
- d            Deaf mode. User will not recieve any messages or notices
-              from channels they are in (requires deaf module).
- g            In combination with /allow, provides for server side
-              ignore (requires callerid module).
- h            Marks as 'available for help' in WHOIS (IRCop only,
-              requires helpop module).
- i            Makes invisible to /WHO if the user using /WHO is not in
-              a common channel.
- k            Prevents the user from being kicked from channels, or
-              having op modes removed from them (services only,
-              requires servprotect module).
- o            Marks as a IRC operator.
- s [mask]     Receives server notices specified by [mask]
-              (IRCop only).
- r            Marks as a having a registered nickname
-              (requires services account module).
- w            Receives wallops messages.
- x            Gives a cloaked hostname (requires cloaking module).
- B            Marks as a bot (requires botmode module).
- G            Censors messages sent to the user based on filters
-              configured for the network (requires censor module).
- H            Hides an oper's oper status from WHOIS (requires
-              hideoper module).
- I            Hides a user's entire channel list in WHOIS from
-              non-IRCops (requires hidechans module).
- Q            Makes an operator invisible, preventing users from
-              seeing their presence, including in channel user lists
-              (IRCop only, requires invisible module).
- R            Blocks private messages from unregistered users
-              (requires services account module).
- S            Strips mIRC color/bold/underline codes out of private
-              messages to the user (requires stripcolor module).
- W            Receives notification when a user uses WHOIS on them
-              (IRCop only, requires showwhois module).">
-
-<helpop key="chmodes" value="Channel Modes
--------------
-
- v [nickname]       Gives voice to [nickname], allowing them to speak
-                    while the channel is +m.
- h [nickname]       Gives halfop status to [nickname] (this mode can
-                    be disabled).
- o [nickname]       Gives op status to [nickname].
- a [nickname]       Gives protected status to [nickname], preventing
-                    them from them from being kicked (+q only,
-                    requires chanprotect module).
- q [nickname]       Gives owner status to [nickname], preventing them
-                    from being kicked (Services or only, requires
-                    chanprotect module).
-
- b [hostmask]       Bans [hostmask] from the channel.
- e [hostmask]       Excepts [hostmask] from bans (requires
-                    banexception module).
- I [hostmask]       Excepts [hostmask] from +i, allowing matching
-                    users to join while the channel is invite-only
-                    (requires inviteexception module).
-
- c                  Blocks messages containing mIRC color codes
-                    (requires blockcolor module).
- f [*][lines]:[sec] Kicks on text flood equal to or above the
-                    specified rate. With *, the user is banned
-                    (requires messageflood module).
- g [mask]           Blocks messages matching the given blob mask
-                    (requires chanfilter module).
- i                  Makes the channel invite-only.
-                    Users can only join if an operator
-                    uses /INVITE to invite them.
- j [joins]:[sec]    Limits joins to the specified rate (requires
-                    joinflood module).
- k [key]            Set the channel key (password) to [key].
- l [limit]          Set the maximum allowed users to [limit].
- m                  Enable moderation. Only users with +v, +h, or +o
-                    can speak.
- n                  Blocks users who are not members of the channel
-                    from messaging it.
- p                  Make channel private, hiding it in user's whoises
-                    and replacing it with * in /LIST.
- r                  Marks the channel as registered with Services
-                    (requires services account module).
- s                  Make channel secret, hiding it in user's whoises
-                    and /LIST.
- t                  Prevents users without +h or +o from changing the
-                    topic.
- u                  Makes the channel an auditorium; normal users only
-                    see themselves or themselves and the operators,
-                    while operators see all the users (requires
-                    auditorium module).
- w [flag]:[banmask] Adds basic channel access controls of [flag] to
-                    [banmask], via the +w listmode.
-                    For example, +w o:R:Brain will op anyone identified
-                    to the account 'Brain' on join.
-                    (requires autoop module)
- z                  Blocks non-SSL clients from joining the channel.
-
- A                  Allows anyone to invite users to the channel
-                    (normally only chanops can invite, requires
-                    allowinvite module).
- B                  Blocks messages with too many capital letters,
-                    as determined by the network configuration
-                    (requires blockcaps module).
- C                  Blocks any CTCPs to the channel (requires noctcp
-                    module).
- D                  Delays join messages from users until they
-                    message the channel (requires delayjoin module).
- F [changes]:[sec]  Blocks nick changes when they equal or exceed the
-                    specified rate (requires nickflood module).
- G                  Censors messages to the channel based on the
-                    network configuration (requires censor module).
- J [seconds]        Prevents rejoin after kick for the specified
-                    number of seconds. This prevents auto-rejoin
-                    (requires kicknorejoin module).
- K                  Blocks /KNOCK on the channel.
- L [channel]        If the channel reaches its limit set by +l,
-                    redirect users to [channel] (requires redirect
-                    module).
- M                  Blocks unregistered users from speaking (requires
-                    services account module).
- N                  Prevents users on the channel from chainging nick
-                    (requires nonicks module).
- O                  Channel is IRCops only (can only be set by IRCops,
-                    requires operchans module).
- P                  Makes the channel permanent; Bans, invites, the
-                    topic, modes, and such will not be lost when it
-                    empties (can only be set by IRCops, requires
-                    permchannels module).
- Q                  Only ulined servers and their users can kick
-                    (requires nokicks module)
- R                  Blocks unregistered users from joining (requires
-                    services account module).
- S                  Strips mIRC color codes from messages to the
-                    channel (requirs stripcolor module).
- T                  Blocks /NOTICEs to the channel from users who are
-                    not at least halfop (requires nonotice module).
-
--------------
-NOTE: A large number of these modes are dependent upon server-side modules
-being loaded by a server/network administrator. The actual modes available
-on your network may be very different to this list. Please consult your
-help channel if you have any questions.">
-
-<helpop key="snomasks" value="Server Notice Masks
-
- a      Allows receipt of local announcement messages.
- A      Allows receipt of remote announcement messages.
- c      Allows receipt of local connect messages.
- C      Allows receipt of remote connect messages.
- d      Allows receipt of general (and sometimes random) debug
-        messages.
- f      Allows receipt of flooding notices.
- g      Allows receipt of globops (requires globops module).
- G      Allows receipt of notices of use of oper-override (requires
-        override module)
- j      Allows receipt of channel creation notices (requires
-        chancreate module).
- J      Allows receipt of remote channel creation notices (requires
-        chancreate module).
- k      Allows receipt of local kill messages.
- K      Allows receipt of remote kill messages.
- l      Allows receipt of local linking related
-        messages.
- L      Allows receipt of remote linking related
-        messages.
- n      See local nickname changes (requires seenicks module).
- N      See remote nickname changes (requires seenicks modules).
- o      Allows receipt of oper-up, oper-down, and oper-failure
-        messages.
- O      Allows receipt of remote oper-up, oper-down, and oper-failure
-        messages.
- q      Allows receipt of local quit messages.
- Q      Allows receipt of remote quit messages.
- t      Allows receipt of attempts to use /STATS (local and remote).
- v      Allows receipt of oper-override notices (requires override module).
- x      Allows receipt of Xline notices (g/z/q/k/e/R/shuns).">
-
-<helpop key="extbans" value="Extended Bans
-----------
-
- c:n!u@h      Blocks any messages that contain color codes from
-              matching users (requires blockcolor module).
- j:#channel   Prevents anyone in #channel from joining the channel
-              (requires channelban module).
- m:n!u@h      Blocks messages from matching users (requires muteban
-              module).
- p:n!u@h      Blocks part messages from matching users (requires
-              nopartmsg module).
- r:realname   Prevents users with a matching realname from joining
-              the channel (requires gecosban module).
- s:server     Prevents users on a matching server from joining the
-              channel (requires services account).
-
- A:n!u@h      Blocks invites by matching users even when +A is set
-              (requires allowinvite module).
- B:n!u@h      Blocks all capital or nearly all capital messages from
-              matching users (requires blockcaps module).
- C:n!u@h      Blocks CTCPs from matching users (requires noctcp
-              module).
- M:account    Blocks messages from users logged into a matching
-              account (requires services account module).
- N:n!u@h      Blocks nick changes from matching users (requires
-              nonicks module).
- O:opertype   Prevents IRCops of the specified opertype from joining
-              the channel, mostly useful as an invite exception (IRCop
-              only, requires operchans module).
- Q:n!u@h      Blocks kicks by matching users (requires nokicks
-              module).
- R:account    Prevents users logged into a matching account from
-              joining the channel (requires services account module).
- S:n!u@h      Strips color/bold/underline from messages from matching
-              users (requires stripcolor module).
- T:n!u@h      Blocks notices from matching users (requires nonotice
-              module).
- U:n!u@h      Blocks unregistered users matching the given ban.
-              (requires m_services_account)
-
- Redirect     n!u@h#channel will redirect the banned user to #channel
-              when they try to join (requires banredirect module).
-
-All extbans that prevent users from joining may by used for ban
-exceptions and invite exceptions (invex), and extbans blocking
-specific actions may be used for ban exceptions to exempt people from
-either wider extbans or the restrictive mode matching the extban,
-where one exists.">
diff --git a/docs/conf/inspircd.motd.example b/docs/conf/inspircd.motd.example
deleted file mode 100644 (file)
index 0a1260c..0000000
+++ /dev/null
@@ -1,41 +0,0 @@
-
- _____                        _____   _____    _____      _
-|_   _|                      |_   _| |  __ \  / ____|    | |
-  | |    _ __    ___   _ __    | |   | |__) || |       __| |
-  | |   | '_ \  / __| | '_ \   | |   |  _  / | |      / _` |
- _| |_  | | | | \__ \ | |_) | _| |_  | | \ \ | |____ | (_| |
-|_____| |_| |_| |___/ | .__/ |_____| |_|  \_\ \_____| \__,_|
-    __________________| |_______________________________
-   |__________________|_|_______________________________|
-
-                        Putting the ricer in IRCer since 2007
-
-       //\ 
-       V  \    WELCOME TO AN INSPIRCD NETWORK
-        \  \_    If you see this, I am probably new.
-         \,'.`-.   If I'm not new, my owner is lazy.
-          |\ `. `. 
-          ( \  `. `-.                        _,.-:\
-           \ \   `.  `-._             __..--' ,-';/
-            \ `.   `-.   `-..___..---'   _.--' ,'/
-             `. `.    `-._        __..--'    ,' /
-               `. `-_     ``--..''       _.-' ,'
-                 `-_ `-.___        __,--'   ,'
-                    `-.__  `----"""    __.-'
-                         `--..____..--'
-  
-        -- To change, see inspircd.motd.example --
-       /                                          \
-      /     * Web: http://www.inspircd.org         \
-      |     * IRC: irc.inspircd.org #inspircd      |
-      |     * Docs: http://wiki.inspircd.org       |
-      |     * Bugs: http://inspircd.org/bugtrack/  |
-      |                                            |
-      | We hope you like this software. Please do  |
-      | make  sure  you  put  some  effort  into   |
-      | your configuration, though, so you love it.|
-      | Enjoy.                                     |
-      |                                            |
-      \                   -- The InspIRCd Team    /
-       -------------------------------------------
-
diff --git a/docs/conf/inspircd.quotes.example b/docs/conf/inspircd.quotes.example
deleted file mode 100644 (file)
index 56a580e..0000000
+++ /dev/null
@@ -1,203 +0,0 @@
-Men are from Mars. Women are from Venus. Computers are from hell
-Computer /nm./: a device designed to speed and automate errors
-Hardware /nm./: the part of the computer that you can kick.
-Maniac /n./ An early computer built by nuts.
-RAM /abr./: Rarely Adequate Memory.
-Programmer /n./ A red-eyed, mumbling mammal capable of conversing with inanimate objects
-Multitasking /adj./ 3 PCs and a chair with wheels
-Plonk /excl./: The sound a newbie makes as he falls to the bottom of a kill file
-hURL /n./: a link to a web site that makes you want to puke
-SUPERCOMPUTER: what it sounded like before you bought it.
-If it's really a supercomputer, how come the bullets don't bounce off when I shoot it?  . The Covert Comic. 
-A computer is like an Old Testament god, with a lot of rules and no mercy.  . Joseph Campbell
-I dropped my computer on my foot! That Megahurtz!!
-A computer's attention span is as long as it's power cord
-586: The average IQ needed to understand a PC
-Memory is like an orgasm. It's a lot better if you don't have to fake it
-If it jams, force it. If it breaks, it needed replacing anyway.
-A bus station is where a bus stops. A train station is where a train stops. On my desk I have a workstation..
-Want to come see my HARD DRIVE ? I promise it isn't 3.5 inches and it ain't floppy.  . Geek pick-up line.
-If you torture the data enough, it will confess.  . Ronald Coase
-If you give someone a program, you will frustrate them for a day; if you teach them how to program, you will frustrate them for a lifetime
-ASCII stupid question, get a stupid ANSI!
-Use the source, Luke...
-Programming is an art form that fights back
-MacOS, Windows, BeOS: they're all just Xerox copies
-Whenever you think you have a clever programming trick... forget it!
-Managing senior programmers is like herding cats.  . Dave Platt
-Your program is sick ! Shoot it and put it out of its memory
-/* You are not expected to understand this */
-To define recursion, we must first define recursion
-ERROR: Computer possessed; Load EXOR.SYS ? [Y/N]
-Linux is only free if your time is worthless
-Linux: find out what you've been missing while you've been rebooting Windows NT
-unzip; strip; touch; finger; mount; fsck; more; yes; unmount; sleep
-Profanity is the one language all programmers know best
-It's 5.50 a.m.... Do you know where your stack pointer is?
-#define QUESTION ((bb) || !(bb))  . Shakespeare
-The more I C, the less I see.
-Confucius say: He who play in root, eventually kill tree.
-Unix is the answer, but only if you phrase the question very carefully
-C++: Hard to learn and built to stay that way
-Java is, in many ways, C++--  . Michael Feldman.
-They don't make bugs like Bunny anymore  . Olav Mjelde
-If debugging is the process of removing software bugs, then programming must be the process of putting them in
-When the only tool you own is a hammer, every problem you encounter resembles a nail
-System Error: press F13 to continue...
-To err is human, but for a real disaster you need a computer
-Computers make very fast, very accurate mistakes
-Life would be so much easier if we only had the source code
-Who is this 'General Failure' and why is he reading my disk?
-hAS aNYONE sEEN MY cAPSLOCK kEY?
-InspIRCd, now with excessive ammounts of Cheeze
-I'm in the computer business, I make Out-Of-Order signs
-Kevorkian Virus: helps your computer shut down whenever it wants to.
-          [OUT OF QUOTES, PLEASE ORDER MORE]
-Insert Something Funkeh.. err.. There! -->
-Cannot delete tmp150---3.tmp: There is not enough free disk space. Delete one or more files to free disk space, and then try again
-File not found. Should I fake it ? (Y/N)
-The definition of an upgrade: Take old bugs out, put new ones in
-If it's not on fire, it's a software problem
-It's a little-known fact that the Y1K problem caused the Dark Ages
-Artificial Intelligence usually beats natural stupidity
-Making fun of AOL users is like making fun of the kid in the wheel chair
-Daddy, why doesn't this magnet pick up this floppy disk?
-Daddy, what does FORMATTING DRIVE C mean?
-See daddy ? All the keys are in alphabetical order now.
-Enter any 11-digit prime number to continue...
-ASCII and ye shall receive.
-The web is a dominatrix. Every where I turn, I see little buttons ordering me to Submit.
-<FrostyCoolSlug> NO, You cannot dial 999, I'm downloading my mail ;/
-640K ought to be enough for anybody.  . Bill Gates, 1981
-Windows not found, [P]arty, [C]elebrate, [D]rink?
-English, the Microsoft of languages...
-It's been said that Bill Gates named his company after his dick...
-Ever notice how fast Windows runs ?  -- Neither did I
-If at first you don't succeed, work for Microsoft
-We are Microsoft. Resistance Is Futile. You Will Be Assimilated
-"Microsoft Works."  . Oxymoron
-Windows isn't a virus, viruses do something
-PANIC! buffer = :NickServ WRITE_DB(3). <-- JUST KIDDING!
-It just keeps going and going and going and going and goi <BANG>
-All that I know is that nukes are comming from 127.0.0.1
-I know all about the irc and the mirc cops.
-M re ink n ed d, ple s  r fil
-Please refrain from feeding the IRC Operators. Thank you.
-I know all about mirc stuff, hmm.. I think this channel is experiencing packet loss..
-MacDonalds claims Macintosh stole their next idea of the iMac
-I can't hold her any longer, captain, she's gonna bl.. sorry, got caught up in the moment
-I recommend purchasing a Cyrix CPU for testing nuclear meltdowns
-Is it an international rule to have the worst picture possible on your driver license?
-Have you hugged your services coder, today?
-Ever wonder why they make the colon flash on alarm clocks?
-Whats this?.. blue screen with a VXD error?!.. I'VE BEEN NUKED!
-do-do-bop-doo-doo-do-do-doo.. For those of you who know that song, you have problems..
-be wery wery quiet... hunting wabbit...
-I've been IRC Nuked"Great warrior?  War does not make one great." - Yoda
-"I find your lack of faith.....disturbing." - Darth Vader
-"I have a bad feeling about this.."--All of the Star Wars characters.
-Can I upgrade my Hard Drive to a WARP drive?
-Canadian DOS prompt: EH?\>
-Canadian DOS: "Yer sure, eh?" [y/n]
-CONGRESS.SYS Corrupted: Re-boot Washington D.C (Y/n)?
-I don't have a solution but I admire the problem.
-Famous Last Words: Trust me. I know what I'm doing.
-Hey Captain, I just created a black ho-÷p!%$û NO CARRIER
-Access denied--nah nah na nah nah!
-Bad command. Bad, bad command! Sit! Stay! Staaay..
-Error: Keyboard not attached. Press F1 to continue.
-*grumble* "You're just supposed to sit here?"
-"Hey, what's this button d..<BOOM>" -W. Crusher
-"He has become One with Himself!" "He's passed out!" "That too."-B5
-For a funny quote, call back later.
-Famous last words: 'You saw a WHAT around the corner?!'
-I like work ... I can sit and watch it for hours.
-Copywight 1994 Elmer Fudd. All wights wesewved.
-Cannot find REALITY.SYS. Universe halted.
-BUFFERS=20 FILES=15 2nd down, 4th quarter, 5 yards to go!
-My software never has bugs. It just develops random features.
-Why doesn't DOS ever say 'EXCELLENT command or filename!?
-Shell to DOS... Come in DOS, do you copy? Shell to DOS...
-Computing Definition - Network-Admin: Primary person who just got set up for the blame of the system crash.
-An expert is a person who has made all the mistakes which can be made in a very narrow field.
-Famous last words: This is the safe way to do it.......
-Famous Last Words: Trust me. I know what I'm doing.
-Clinton, "I didn't say that - er, well - yes, but I didn't mean..."
-CLINTON LEGACY??...even Pharaoh had only ten plagues...
-IBM             I Bought McIntosh
-IBM             I Bring Manuals
-IBM             I've Been Moved
-IBM             Idolized By Management
-IBM             Impenetrable Brain Matter
-IBM             Imperialism By Marketing
-IBM             Incorrigible Boisterous Mammoth
-IBM             Inertia Breeds Mediocrity
-IBM             Ingenuity Becomes Mysterious
-IBM             Ingrained Batch Mentality
-IBM             Innovation By Management
-IBM             Insipid Belligerent Mossbacks
-IBM             Insipidly Bankrolling Millions
-IBM             Inspect Before Multiusing
-IBM             Install Bigger Memory
-IBM             Institution By Machiavelli
-IBM             Insultingly Boring Merchandisers
-IBM             Intellectuals Being Moronized
-IBM             Intelligence Belittling Meaning
-IBM             Intimidated, Buffaloed Management
-IBM             Into Building Money
-IBM             Intolerant of Beards & Moustaches
-IBM             Invest Before Multi-tasking
-IBM             Investigate Baffling Malodor
-IBM             Irresponsible Behave Multinational
-IBM             It Beats Mattel
-IBM             It's a Big Mess
-IBM             It's Better Manually
-IBM             Itty Bitty Machine
-IBM             Institute for Black Magic
-100,000 lemmings can't be wrong.
-Murphy's Eighth Law: If everything seems to be going well, you have obviously overlooked something.
-Rules of the game: Do not believe in miracles - rely on them.
-Rules of the game: Any given program, once running, is obsolete.
-Computing Definition - Error: What someone else has made when they disagree with your computer output.
-Backup not found: (A)bort (R)etry (P)anic
-WinErr 653: Multitasking attempted - system confused.
-Cannot join #real_life (invite only)
-"Unfortunatly, no one can be told what the Matrix is. You have to see it for yourself." - Matrix
-"Reality is a thing of the past" - Matrix
-"The future will not be user friendly" - Matrix
-"The general idea in chat is to make yourself understandable... ..." - Peer
-"heh i am talkin to someone...she's not dead...yet anyways" - Stinky
-"He who must die, must die in the dark, even though he sells candles"
-"If at first you don't succeed, skydiving is not for you."
-"Friendship is like peeing on yourself: everyone can see it, but only you get the warm feeling that it brings."
-"France sucks, but Paris swallows"
-"A computer once beat me at chess, but it was no match for me at kick boxing.
-"Ever wonder why the SAME PEOPLE make up ALL the conspiracy theories?
-"Don't think of it as being outnumbered. Think of it as having a wide target selection."
-"Sysadmins can't be sued for malpractice, but surgeons don't have to deal with patients who install new versions of their own innards."
-"FACE!"
-"Dirka Dirka Mohammed JIHAD!"
-We can learn much from wise words, little from wisecracks, and less from wise guys.
-"Blessed are the young, for they shall inherit the national debt." - Herbert Hoover
-If you have five dollars and Chuck Norris has five dollars, Chuck Norris has more money than you.
-Apple pays Chuck Norris 99 cents every time he listens to a song.
-If Chuck Norris and InspIRCd met in a dark alley, Chuck Norris would get his first black eye. Ever.
-Chuck Norris can sneeze with his eyes open.
-Chuck Norris can kill two stones with one bird.
-There is no theory of evolution. Just a list of animals Chuck Norris allows to live. 
-The Great Wall of China was originally created to keep Chuck Norris out. It failed miserably.
-Chuck Norris can win a game of Connect Four in only three moves.
-Chuck Norris is not hung like a horse... horses are hung like Chuck Norris.
-Chuck Norris is currently suing NBC, claiming Law and Order are trademarked names for his left and right legs.
-Chuck Norris CAN believe it's not butter.
-Chuck Norris is so fast, he can run around the world and punch himself in the back of the head.
-When the Boogeyman goes to sleep every night, he checks his closet for Chuck Norris.
-Outer space exists because it's afraid to be on the same planet with Chuck Norris.
-Chuck Norris counted to infinity - twice.
-Chuck Norris only fears one thing in this world, and that is InspIRCd.
-InspIRCd's core is ran by donated Chuck Norris DNA.
-Chuck Norris exists because InspIRCd allows him to.
-Chuck Norris CAN punch you in the face over the internet.
-When Chuck Norris uses InspIRCd, he doesn't use the /kill command, he uses the /ROUND-HOUSE-TO-THE-FACE command.
-A developer only classifies oneself as such if they consider themselves as such.
-"While hunting in Africa, I shot an elephant in my pajamas. How an elephant got into my pajamas I'll never know." -- Groucho Marx
diff --git a/docs/conf/inspircd.rules.example b/docs/conf/inspircd.rules.example
deleted file mode 100644 (file)
index e51f0af..0000000
+++ /dev/null
@@ -1,3 +0,0 @@
-This is the InspIRCd rules file. 
-Place any network or server rules here :) 
index 5ddb21baaaca3d5f528d6bf1281d622ef99db1a3..bc76dfac3221c1c26d65de14896f4159a6a7f7c1 100644 (file)
 # specify some censor tags. See also:                                 #
 # http://wiki.inspircd.org/Modules/censor                             #
 #
-#<include file="conf/censor.conf">
+#<include file="conf/examples/censor.conf.example">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
 # specfiy below the path to the filter.conf file, or define some      #
 # <filter> tags.                                                      #
 #                                                                     #
-#<include file="conf/filter.conf">
+#<include file="conf/examples/filter.conf.example">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Gecosban: Implements extended ban r:, which stops anyone matching
 # specify below the path to the helpop.conf file, or if you like to   #
 # make a mess, define your helpop tags in this conf.                  #
 #                                                                     #
-#<include file="conf/inspircd.helpop-full.example">
+#<include file="conf/examples/inspircd.helpop-full.example">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # HIDECHANS module: Allows opers to hide their channels list from non-
 #                 Read the comment above <connect:allowmotdcolors> in #
 #                 inspircd.conf.example for details.                  #
 #                                                                     #
-#<opermotd file="conf/oper.motd" onoper="yes" processcolors="false">
+#<opermotd file="conf/examples/opermotd.txt.example" onoper="yes" processcolors="false">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Override module: Adds support for oper override
diff --git a/docs/conf/modules/charybdis.conf.example b/docs/conf/modules/charybdis.conf.example
new file mode 100644 (file)
index 0000000..4490d54
--- /dev/null
@@ -0,0 +1,315 @@
+<module name="m_md5.so">
+<module name="m_sha256.so">
+<module name="m_alias.so">
+<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
+<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
+<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
+<alias text="BOTSERV" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
+<alias text="HOSTSERV" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
+<alias text="MEMOSERV" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
+<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
+<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
+<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
+<alias text="BS" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
+<alias text="HS" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
+<alias text="MS" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
+<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2" requires="NickServ" uline="yes">
+
+<module name="m_banexception.so">
+<module name="m_banredirect.so">
+<module name="m_blockcolor.so">
+<module name="m_callerid.so">
+<callerid maxaccepts="16"
+          operoverride="no"
+          tracknick="no"
+          cooldown="60">
+
+<module name="m_cap.so">
+<module name="m_cban.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# CGI:IRC module: Adds support for automatic host changing in CGI:IRC
+# (http://cgiirc.sourceforge.net).
+#<module name="m_cgiirc.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-# CGIIRC  CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
+#
+# Optional - If you specify to use m_cgiirc, then you must specify one
+# or more cgihost tags which indicate authorised CGI:IRC servers which
+# will be connecting to your network, and an optional cgiirc tag.
+# For more information see: http://wiki.inspircd.org/Modules/cgiirc
+#
+# Set to yes if you want to notice opers when CGI clients connect
+# <cgiirc opernotice="no">
+#
+# The type field indicates where the module should get the real
+# client's IP address from, for further information, please see the
+# CGI:IRC documentation.
+#
+# Old style:
+# <cgihost type="pass" mask="www.mysite.com">       # Get IP from PASS
+# <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
+# <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
+# New style:
+# <cgihost type="webirc" password="foobar"
+#   mask="somebox.mysite.com">                      # Get IP from WEBIRC
+#
+# IMPORTANT NOTE:
+# ---------------
+#
+# When you connect CGI:IRC clients, there are two connect classes which
+# apply to these clients. When the client initially connects, the connect
+# class which matches the cgi:irc site's host is checked. Therefore you
+# must raise the maximum local/global clients for this ip as high as you
+# want to allow cgi clients. After the client has connected and is
+# determined to be a cgi:irc client, the class which matches the client's
+# real IP is then checked. You may set this class to a lower value, so that
+# the real IP of the client can still be restricted to, for example, 3
+# sessions maximum.
+#
+
+<module name="m_chancreate.so">
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Channel Names module: Allows disabling channels which have certain
+# characters in the channel name such as bold, colorcodes, etc which
+# can be quite annoying and allow users to on occasion have a channel
+# that looks like the name of another channel on the network.
+<module name="m_channames.so">
+
+<channames
+       # denyrange: characters or range of characters to deny in channel
+       # names.
+       denyrange="2"
+
+       # allowrange: characters or range of characters to specifically allow
+       # in channel names.
+       allowrange="">
+
+<module name="m_channelban.so">
+<module name="m_chghost.so">
+<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
+<module name="m_chgident.so">
+<module name="m_chgname.so">
+<module name="m_cloaking.so">
+#
+#-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# If you specify the m_cloaking.so module as above, you must define   #
+# cloak keys, and optionally a cloak prefix as shown below. The cloak #
+# keys must be shared across the network for correct cloaking.        #
+#                                                                     #
+# There are four methods of cloaking:                                 #
+#                                                                     #
+#   half           Cloak only the "unique" portion of a host; show    #
+#                  the last 2 parts of the domain, /16 subnet of IPv4 #
+#                  or /48 subnet of the IPv6 address.                 #
+#                                                                     #
+#   full           Cloak the users completely, using three slices for #
+#                  common CIDR bans (IPv4: /16, /24; IPv6: /48, /64)  #
+#                                                                     #
+# These methods use a single key that can be any length of text.      #
+# An optional prefix may be specified to mark cloaked hosts.          #
+#                                                                     #
+# The following methods are maintained for backwards compatibility;   #
+# they are slightly less secure, and always hide unresolved IPs       #
+#                                                                     #
+#   compat-host    InspIRCd 1.2-compatible host-based cloaking        #
+#   compat-ip      InspIRCd 1.2-compatible ip-always cloaking         #
+#                                                                     #
+# You must specify key1, key2, key3, key4 for the compat cloaking     #
+# modes; the values must be less than 0x80000000 and should be picked #
+# at random. Prefix is mandatory, will default to network name if not #
+# specified, and will always have a "-" appended.                     #
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+#
+<cloak mode="half"
+       key="secret"
+       prefix="net-">
+
+<module name="m_close.so">
+<module name="m_conn_umodes.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Connectban: Provides IP connection throttling. Any IP range that connects
+# too many times (configurable) in an hour is zlined for a (configurable)
+# duration, and their count resets to 0.
+#
+# ipv4cidr and ipv6cidr allow you to turn the comparison from individual
+# IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
+# over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
+#
+#<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
+# This allows for 10 connections in an hour with a 10 minute ban if that is exceeded.
+#
+#<module name="m_connectban.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Connection throttle module. Configuration:
+#<module name="m_connflood.so">
+#
+#-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
+#  seconds, maxconns -  Amount of connections per <seconds>.
+#
+#  timeout           -  Time to wait after the throttle was activated
+#                       before deactivating it. Be aware that the time
+#                       is seconds + timeout.
+#
+#  quitmsg           -  The message that users get if they attempt to
+#                       connect while the throttle is active.
+#
+#  bootwait          -  Amount of time to wait before enforcing the
+#                       throttling when the server just booted.
+#
+#<connflood seconds="30" maxconns="3" timeout="30"
+#   quitmsg="Throttled" bootwait="10">
+
+<module name="m_deaf.so">
+<module name="m_dnsbl.so">                                           
+<module name="m_gecosban.so">
+<module name="m_globalload.so">
+<module name="m_ident.so">
+<ident timeout="1">
+<module name="m_inviteexception.so">
+<module name="m_joinflood.so">
+<module name="m_knock.so">
+<module name="m_namesx.so">
+<module name="m_operchans.so">
+<module name="m_operlog.so">
+<module name="m_opermodes.so">
+<module name="m_password_hash.so">
+<module name="m_permchannels.so">
+<module name="m_muteban.so">
+<module name="m_redirect.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Regular Expression Provider for Glob or wildcard (?/*) matching.
+# You must have at least 1 provider loaded to use m_filter or m_rline
+# modules. This module has no additional requirements, as it uses the
+# matching already present in InspIRCd core.
+#<module name="m_regex_glob.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Regular Expression Provider for PCRE (Perl-Compatible Regular
+# Expressions). You need libpcre installed to compile and load this
+# module. You must have at least 1 provider loaded to use m_filter or
+# m_rline.
+#<module name="m_regex_pcre.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Regular Expression Provider for POSIX Regular Expressions.
+# You shouldn't need any additional libraries on a POSIX-compatible
+# system (ie: any Linux, BSD, but not Windows). You must have at least
+# 1 provider loaded to use m_filter or m_rline.
+# On POSIX-compliant systems, regex syntax can be found by using the
+# command: 'man 7 regex'.
+#<module name="m_regex_posix.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Registered users only channel creation
+# Allows only registered users and opers to create new channels.
+#
+# You probably *DO NOT* want to load this module on a public network.
+#
+#<module name="m_regonlycreate.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Ban users through regular expression patterns
+#<module name="m_rline.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
+#
+# If you wish to re-check a user when they change nickname (can be
+# useful under some situations, but *can* also use CPU with more users
+# on a server) then set the following configuration value:
+# Also, this is where you set what Regular Expression engine is to be
+# used. If you ever change it while running, all of your R-Lines will be
+# wiped. This is the regex engine used by all R-Lines set, and
+# m_regex_<engine>.so must be loaded, or rline will be nonfunctional
+# until you load it or change the engine to one that is loaded.
+#
+#<rline matchonnickchange="yes" engine="pcre">
+#
+# Generally, you will NOT want to use 'glob' here, as this turns
+# rline into just another gline. The exceptions are that rline will
+# always use the full nick!user@host realname string, rather than only
+# user@host, but beware that only the ? and * wildcards are available,
+# and are the only way to specify where the space can occur if you do
+# use glob. For this reason, is recommended to use a real regex engine
+# so that at least \s or [[:space:]] is available.
+
+<module name="m_sasl.so">
+<module name="m_servprotect.so">
+<module name="m_services_account.so">
+<module name="m_sethost.so">
+<module name="m_serverban.so">
+<module name="m_showwhois.so">
+<showwhois opersonly="yes" showfromopers="yes">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Spy module: Provides the ability to see the complete names list of 
+# channels an oper is not a member of
+# This module is oper-only.
+#<module name="m_spy.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# SSL channel mode module: Adds support for SSL-only channels (+z).
+# does not do anything useful without a working SSL module (see below)
+#<module name="m_sslmodes.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
+# if enabled. You must copy the source for this module from the directory
+# src/modules/extra, or answer 'yes' in ./configure when asked if you
+# want to enable this, or it will not load.
+#<module name="m_ssl_gnutls.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
+# http://wiki.inspircd.org/Modules/ssl_gnutls                         #
+#                                                                     #
+# NOTE: If you want to use this module to encrypt and sign your       #
+# server to server traffic, you MUST load it before m_spanningtree in #
+# your configuration file!                                            #
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# SSL Info module: Allows users to retrieve information about other
+# user's peer SSL certificates and keys. This can be used by client
+# scripts to validate users. For this to work, one of m_ssl_gnutls.so
+# or m_ssl_openssl.so must be loaded. This module also adds the 
+# "* <user> is using a secure connection" whois line, the ability for
+# opers to use SSL fingerprints to verify their identity and the ability
+# to force opers to use SSL connections in order to oper up.
+# It is highly recommended to load this module especially if
+# you use SSL on your network.
+# For how to use the oper features, please see the first example <oper> tag
+# in opers.conf.example.
+#
+#<module name="m_sslinfo.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
+# if enabled. You must copy the source for this module from the directory
+# src/modules/extra, or answer 'yes' in ./configure when asked if you
+# want to enable this, or it will not load.
+#<module name="m_ssl_openssl.so">
+#
+#-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# m_ssl_openssl.so is too complex it describe here, see the wiki:     #
+# http://wiki.inspircd.org/Modules/ssl_openssl                        #
+#                                                                     #
+# NOTE: If you want to use this module to encrypt and sign your       #
+# server to server traffic, you MUST load it before m_spanningtree in #
+# your configuration file!                                            #
+
+<module name="m_stripcolor.so">
+<module name="m_svshold.so">
+<module name="m_tline.so">
+<module name="m_uhnames.so">
+<module name="m_watch.so">
+<watch maxentries="32">
+<module name="m_xline_db.so">
+
+<module name="m_spanningtree.so">
+
diff --git a/docs/conf/modules/modules.conf.charybdis b/docs/conf/modules/modules.conf.charybdis
deleted file mode 100644 (file)
index 4490d54..0000000
+++ /dev/null
@@ -1,315 +0,0 @@
-<module name="m_md5.so">
-<module name="m_sha256.so">
-<module name="m_alias.so">
-<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
-<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
-<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
-<alias text="BOTSERV" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
-<alias text="HOSTSERV" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
-<alias text="MEMOSERV" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
-<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
-<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
-<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
-<alias text="BS" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
-<alias text="HS" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
-<alias text="MS" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
-<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2" requires="NickServ" uline="yes">
-
-<module name="m_banexception.so">
-<module name="m_banredirect.so">
-<module name="m_blockcolor.so">
-<module name="m_callerid.so">
-<callerid maxaccepts="16"
-          operoverride="no"
-          tracknick="no"
-          cooldown="60">
-
-<module name="m_cap.so">
-<module name="m_cban.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# CGI:IRC module: Adds support for automatic host changing in CGI:IRC
-# (http://cgiirc.sourceforge.net).
-#<module name="m_cgiirc.so">
-#
-#-#-#-#-#-#-#-#-#-#-#-# CGIIRC  CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
-#
-# Optional - If you specify to use m_cgiirc, then you must specify one
-# or more cgihost tags which indicate authorised CGI:IRC servers which
-# will be connecting to your network, and an optional cgiirc tag.
-# For more information see: http://wiki.inspircd.org/Modules/cgiirc
-#
-# Set to yes if you want to notice opers when CGI clients connect
-# <cgiirc opernotice="no">
-#
-# The type field indicates where the module should get the real
-# client's IP address from, for further information, please see the
-# CGI:IRC documentation.
-#
-# Old style:
-# <cgihost type="pass" mask="www.mysite.com">       # Get IP from PASS
-# <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
-# <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
-# New style:
-# <cgihost type="webirc" password="foobar"
-#   mask="somebox.mysite.com">                      # Get IP from WEBIRC
-#
-# IMPORTANT NOTE:
-# ---------------
-#
-# When you connect CGI:IRC clients, there are two connect classes which
-# apply to these clients. When the client initially connects, the connect
-# class which matches the cgi:irc site's host is checked. Therefore you
-# must raise the maximum local/global clients for this ip as high as you
-# want to allow cgi clients. After the client has connected and is
-# determined to be a cgi:irc client, the class which matches the client's
-# real IP is then checked. You may set this class to a lower value, so that
-# the real IP of the client can still be restricted to, for example, 3
-# sessions maximum.
-#
-
-<module name="m_chancreate.so">
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Channel Names module: Allows disabling channels which have certain
-# characters in the channel name such as bold, colorcodes, etc which
-# can be quite annoying and allow users to on occasion have a channel
-# that looks like the name of another channel on the network.
-<module name="m_channames.so">
-
-<channames
-       # denyrange: characters or range of characters to deny in channel
-       # names.
-       denyrange="2"
-
-       # allowrange: characters or range of characters to specifically allow
-       # in channel names.
-       allowrange="">
-
-<module name="m_channelban.so">
-<module name="m_chghost.so">
-<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
-<module name="m_chgident.so">
-<module name="m_chgname.so">
-<module name="m_cloaking.so">
-#
-#-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# If you specify the m_cloaking.so module as above, you must define   #
-# cloak keys, and optionally a cloak prefix as shown below. The cloak #
-# keys must be shared across the network for correct cloaking.        #
-#                                                                     #
-# There are four methods of cloaking:                                 #
-#                                                                     #
-#   half           Cloak only the "unique" portion of a host; show    #
-#                  the last 2 parts of the domain, /16 subnet of IPv4 #
-#                  or /48 subnet of the IPv6 address.                 #
-#                                                                     #
-#   full           Cloak the users completely, using three slices for #
-#                  common CIDR bans (IPv4: /16, /24; IPv6: /48, /64)  #
-#                                                                     #
-# These methods use a single key that can be any length of text.      #
-# An optional prefix may be specified to mark cloaked hosts.          #
-#                                                                     #
-# The following methods are maintained for backwards compatibility;   #
-# they are slightly less secure, and always hide unresolved IPs       #
-#                                                                     #
-#   compat-host    InspIRCd 1.2-compatible host-based cloaking        #
-#   compat-ip      InspIRCd 1.2-compatible ip-always cloaking         #
-#                                                                     #
-# You must specify key1, key2, key3, key4 for the compat cloaking     #
-# modes; the values must be less than 0x80000000 and should be picked #
-# at random. Prefix is mandatory, will default to network name if not #
-# specified, and will always have a "-" appended.                     #
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-#
-<cloak mode="half"
-       key="secret"
-       prefix="net-">
-
-<module name="m_close.so">
-<module name="m_conn_umodes.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Connectban: Provides IP connection throttling. Any IP range that connects
-# too many times (configurable) in an hour is zlined for a (configurable)
-# duration, and their count resets to 0.
-#
-# ipv4cidr and ipv6cidr allow you to turn the comparison from individual
-# IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
-# over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
-#
-#<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
-# This allows for 10 connections in an hour with a 10 minute ban if that is exceeded.
-#
-#<module name="m_connectban.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Connection throttle module. Configuration:
-#<module name="m_connflood.so">
-#
-#-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
-#  seconds, maxconns -  Amount of connections per <seconds>.
-#
-#  timeout           -  Time to wait after the throttle was activated
-#                       before deactivating it. Be aware that the time
-#                       is seconds + timeout.
-#
-#  quitmsg           -  The message that users get if they attempt to
-#                       connect while the throttle is active.
-#
-#  bootwait          -  Amount of time to wait before enforcing the
-#                       throttling when the server just booted.
-#
-#<connflood seconds="30" maxconns="3" timeout="30"
-#   quitmsg="Throttled" bootwait="10">
-
-<module name="m_deaf.so">
-<module name="m_dnsbl.so">                                           
-<module name="m_gecosban.so">
-<module name="m_globalload.so">
-<module name="m_ident.so">
-<ident timeout="1">
-<module name="m_inviteexception.so">
-<module name="m_joinflood.so">
-<module name="m_knock.so">
-<module name="m_namesx.so">
-<module name="m_operchans.so">
-<module name="m_operlog.so">
-<module name="m_opermodes.so">
-<module name="m_password_hash.so">
-<module name="m_permchannels.so">
-<module name="m_muteban.so">
-<module name="m_redirect.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Regular Expression Provider for Glob or wildcard (?/*) matching.
-# You must have at least 1 provider loaded to use m_filter or m_rline
-# modules. This module has no additional requirements, as it uses the
-# matching already present in InspIRCd core.
-#<module name="m_regex_glob.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Regular Expression Provider for PCRE (Perl-Compatible Regular
-# Expressions). You need libpcre installed to compile and load this
-# module. You must have at least 1 provider loaded to use m_filter or
-# m_rline.
-#<module name="m_regex_pcre.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Regular Expression Provider for POSIX Regular Expressions.
-# You shouldn't need any additional libraries on a POSIX-compatible
-# system (ie: any Linux, BSD, but not Windows). You must have at least
-# 1 provider loaded to use m_filter or m_rline.
-# On POSIX-compliant systems, regex syntax can be found by using the
-# command: 'man 7 regex'.
-#<module name="m_regex_posix.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Registered users only channel creation
-# Allows only registered users and opers to create new channels.
-#
-# You probably *DO NOT* want to load this module on a public network.
-#
-#<module name="m_regonlycreate.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Ban users through regular expression patterns
-#<module name="m_rline.so">
-#
-#-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
-#
-# If you wish to re-check a user when they change nickname (can be
-# useful under some situations, but *can* also use CPU with more users
-# on a server) then set the following configuration value:
-# Also, this is where you set what Regular Expression engine is to be
-# used. If you ever change it while running, all of your R-Lines will be
-# wiped. This is the regex engine used by all R-Lines set, and
-# m_regex_<engine>.so must be loaded, or rline will be nonfunctional
-# until you load it or change the engine to one that is loaded.
-#
-#<rline matchonnickchange="yes" engine="pcre">
-#
-# Generally, you will NOT want to use 'glob' here, as this turns
-# rline into just another gline. The exceptions are that rline will
-# always use the full nick!user@host realname string, rather than only
-# user@host, but beware that only the ? and * wildcards are available,
-# and are the only way to specify where the space can occur if you do
-# use glob. For this reason, is recommended to use a real regex engine
-# so that at least \s or [[:space:]] is available.
-
-<module name="m_sasl.so">
-<module name="m_servprotect.so">
-<module name="m_services_account.so">
-<module name="m_sethost.so">
-<module name="m_serverban.so">
-<module name="m_showwhois.so">
-<showwhois opersonly="yes" showfromopers="yes">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Spy module: Provides the ability to see the complete names list of 
-# channels an oper is not a member of
-# This module is oper-only.
-#<module name="m_spy.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# SSL channel mode module: Adds support for SSL-only channels (+z).
-# does not do anything useful without a working SSL module (see below)
-#<module name="m_sslmodes.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
-# if enabled. You must copy the source for this module from the directory
-# src/modules/extra, or answer 'yes' in ./configure when asked if you
-# want to enable this, or it will not load.
-#<module name="m_ssl_gnutls.so">
-#
-#-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
-# http://wiki.inspircd.org/Modules/ssl_gnutls                         #
-#                                                                     #
-# NOTE: If you want to use this module to encrypt and sign your       #
-# server to server traffic, you MUST load it before m_spanningtree in #
-# your configuration file!                                            #
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# SSL Info module: Allows users to retrieve information about other
-# user's peer SSL certificates and keys. This can be used by client
-# scripts to validate users. For this to work, one of m_ssl_gnutls.so
-# or m_ssl_openssl.so must be loaded. This module also adds the 
-# "* <user> is using a secure connection" whois line, the ability for
-# opers to use SSL fingerprints to verify their identity and the ability
-# to force opers to use SSL connections in order to oper up.
-# It is highly recommended to load this module especially if
-# you use SSL on your network.
-# For how to use the oper features, please see the first example <oper> tag
-# in opers.conf.example.
-#
-#<module name="m_sslinfo.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
-# if enabled. You must copy the source for this module from the directory
-# src/modules/extra, or answer 'yes' in ./configure when asked if you
-# want to enable this, or it will not load.
-#<module name="m_ssl_openssl.so">
-#
-#-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# m_ssl_openssl.so is too complex it describe here, see the wiki:     #
-# http://wiki.inspircd.org/Modules/ssl_openssl                        #
-#                                                                     #
-# NOTE: If you want to use this module to encrypt and sign your       #
-# server to server traffic, you MUST load it before m_spanningtree in #
-# your configuration file!                                            #
-
-<module name="m_stripcolor.so">
-<module name="m_svshold.so">
-<module name="m_tline.so">
-<module name="m_uhnames.so">
-<module name="m_watch.so">
-<watch maxentries="32">
-<module name="m_xline_db.so">
-
-<module name="m_spanningtree.so">
-
diff --git a/docs/conf/modules/modules.conf.unreal b/docs/conf/modules/modules.conf.unreal
deleted file mode 100644 (file)
index fa5d652..0000000
+++ /dev/null
@@ -1,420 +0,0 @@
-<module name="m_md5.so">
-<module name="m_sha256.so">
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Alias module: Allows you to define server-side command aliases
-<module name="m_alias.so">
-<fantasy prefix="!" allowbots="no">
-# Aliases
-<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
-<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
-<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
-<alias text="BOTSERV" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
-<alias text="HOSTSERV" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
-<alias text="MEMOSERV" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
-<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
-<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
-<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
-<alias text="BS" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
-<alias text="HS" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
-<alias text="MS" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
-#
-# An example of using the format value to create an alias with two
-# different behaviours depending on the format of the parameters.
-#
-#<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
-#  requires="ChanServ" uline="yes">
-#
-#<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
-#  requires="NickServ" uline="yes">
-#
-# This alias fixes a glitch in xchat 2.6.x and above and the way it
-# assumes IDENTIFY must be prefixed by a colon (:) character. It should
-# be placed ABOVE the default NICKSERV alias (the first example) listed
-# above.
-#
-#<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
-#  requires="NickServ" uline="yes">
-
-<module name="m_allowinvite.so">
-<module name="m_alltime.so">
-<module name="m_auditorium.so">
-<auditorium showops="yes" operoverride="yes">
-<module name="m_banexception.so">
-<module name="m_blockcaps.so">
-<blockcaps percent="50"
-           minlen="5"
-           capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
-<module name="m_blockcolor.so">
-<module name="m_botmode.so">
-<module name="m_censor.so">
-<include file="inspircd.censor.example">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# CGI:IRC module: Adds support for automatic host changing in CGI:IRC
-# (http://cgiirc.sourceforge.net).
-#<module name="m_cgiirc.so">
-#
-#-#-#-#-#-#-#-#-#-#-#-# CGIIRC  CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
-#
-# Optional - If you specify to use m_cgiirc, then you must specify one
-# or more cgihost tags which indicate authorised CGI:IRC servers which
-# will be connecting to your network, and an optional cgiirc tag.
-# For more information see: http://wiki.inspircd.org/Modules/cgiirc
-#
-# Set to yes if you want to notice opers when CGI clients connect
-# <cgiirc opernotice="no">
-#
-# The type field indicates where the module should get the real
-# client's IP address from, for further information, please see the
-# CGI:IRC documentation.
-#
-# Old style:
-# <cgihost type="pass" mask="www.mysite.com">       # Get IP from PASS
-# <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
-# <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
-# New style:
-# <cgihost type="webirc" password="foobar"
-#   mask="somebox.mysite.com">                      # Get IP from WEBIRC
-#
-# IMPORTANT NOTE:
-# ---------------
-#
-# When you connect CGI:IRC clients, there are two connect classes which
-# apply to these clients. When the client initially connects, the connect
-# class which matches the cgi:irc site's host is checked. Therefore you
-# must raise the maximum local/global clients for this ip as high as you
-# want to allow cgi clients. After the client has connected and is
-# determined to be a cgi:irc client, the class which matches the client's
-# real IP is then checked. You may set this class to a lower value, so that
-# the real IP of the client can still be restricted to, for example, 3
-# sessions maximum.
-#
-
-<module name="m_chanfilter.so">
-<chanfilter hidemask="yes">
-
-<module name="m_chanprotect.so">
-
-<chanprotect
-       noservices="no"
-       qprefix="~"
-       aprefix="&amp;"
-       deprotectself="yes"
-       deprotectothers="yes">
-
-<module name="m_check.so">
-<module name="m_chghost.so">
-<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
-
-<module name="m_chgident.so">
-<module name="m_chgname.so">
-<module name="m_cloaking.so">
-<cloak mode="half"
-       key="secret"
-       prefix="net-">
-
-<module name="m_close.so">
-<module name="m_clones.so">
-<module name="m_commonchans.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Conn-Join: Allows you to force users to join one or more channels
-# automatically upon connecting to the server.
-#<module name="m_conn_join.so">
-#
-#-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
-#
-# If you have m_conn_join.so loaded, you can configure it using the
-# follow values:
-#
-#<autojoin channel="#one,#two,#three">
-
-<module name="m_conn_umodes.so">
-<module name="m_cycle.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Connection throttle module. Configuration:
-#<module name="m_connflood.so">
-#
-#-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
-#  seconds, maxconns -  Amount of connections per <seconds>.
-#
-#  timeout           -  Time to wait after the throttle was activated
-#                       before deactivating it. Be aware that the time
-#                       is seconds + timeout.
-#
-#  quitmsg           -  The message that users get if they attempt to
-#                       connect while the throttle is active.
-#
-#  bootwait          -  Amount of time to wait before enforcing the
-#                       throttling when the server just booted.
-#
-#<connflood seconds="30" maxconns="3" timeout="30"
-#   quitmsg="Throttled" bootwait="10">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# DCCALLOW module: Adds the /DCCALLOW command
-<module name="m_dccallow.so">
-#
-#-#-#-#-#-#-#-#-#-#-#-  DCCALLOW CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
-#  blockchat         - Whether to block DCC CHAT as well as DCC SEND
-#  length            - Default duration of entries in DCCALLOW list
-#  action            - Default action to take if no action is specified
-#                      can be 'block' or 'allow'
-#
-# File configuration:
-#  pattern           - The glob pattern to match against
-#  action            - Action to take if a user attempts to send a file
-#                      that matches this pattern, can be 'block' or 'allow'
-#
-#<dccallow blockchat="yes" length="5m" action="block">
-#<banfile pattern="*.exe" action="block">
-#<banfile pattern="*.txt" action="allow">
-#
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-
-<module name="m_deaf.so">
-<module name="m_denychans.so"> 
-#<badchan name="#gods*" allowopers="yes" reason="Tortoises!">         #
-#<badchan name="#heaven" redirect="#hell" reason="Nice try!">         #
-
-<module name="m_devoice.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Filter module: Provides message filtering, similar to SPAMFILTER.
-<module name="m_filter.so">
-#                                                                     #
-# This module depends upon a regex provider such as m_regex_pcre or   #
-# m_regex_glob to function. You must specify which of these you want  #
-# m_filter to use via the tag below.                                  #
-#                                                                     #
-# Valid engines are:                                                  #
-#                                                                     #
-# glob  - Glob patterns, provided via m_regex_glob.so                 #
-# pcre  - PCRE regexps, provided via m_regex_pcre.so, needs libpcre   #
-# tre   - TRE regexps, provided via m_regex_tre.so, requires libtre   #
-# posix - POSIX regexps, provided via m_regex_posix.so, not availale  #
-#         on windows, no dependencies on other operating systems.     #
-#                                                                     #
-<filteropts engine="glob">                                           
-#                                                                     #
-# Your choice of regex engine must match on all servers network-wide.
-#
-# You may specify specific channels that are exempt from being filtered:
-#<exemptfromfilter channel="#blah">
-#
-#-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# Optional - If you specify to use the m_filter module, then          #
-# specfiy below the path to the filter.conf file, or define some      #
-# <filter> tags.                                                      #
-#                                                                     #
-#<include file="filter.conf">
-
-<module name="m_gecosban.so">
-<module name="m_globops.so">
-<module name="m_globalload.so">
-<module name="m_halfop.so">
-<module name="m_helpop.so">
-<include file="inspircd.helpop-full.example">
-
-<module name="m_hidechans.so">
-<hidechans affectsopers="false">
-
-<module name="m_hideoper.so">
-<module name="m_ident.so">
-<ident timeout="1">
-<module name="m_inviteexception.so">
-<module name="m_joinflood.so">
-<module name="m_jumpserver.so">
-<module name="m_knock.so">
-<module name="m_messageflood.so">
-<module name="m_namesx.so">
-<module name="m_nickflood.so">
-<module name="m_noctcp.so">
-<module name="m_nokicks.so">
-<module name="m_nonicks.so">
-<module name="m_nopartmsg.so">
-<module name="m_nonotice.so">
-<module name="m_operchans.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Oper Join module: Auto-joins opers to a channel upon oper-up
-# This module is oper-only. For the user equivalent, see m_conn_join.
-<module name="m_operjoin.so">
-#
-#-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# If you are using the m_operjoin.so module, specify options here:    #
-#                                                                     #
-# channel     -      The channel name to join, can also be a comma    #
-#                    seperated list eg. "#channel1,#channel2".        #
-#                                                                     #
-# override    -      Lets the oper join walking thru any modes that   #
-#                    might be set, even bans. Use "yes" or "no".      #
-#                                                                     #
-#<operjoin channel="#channel" override="no">
-#
-# Alternatively you can use the autojoin="channellist" in a <type>    #
-# tag to set specific autojoins for a type of oper, for example:      #
-#
-#<type name="Helper" autojoin="#help" classes="...">
-
-<module name="m_operlog.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Oper MOTD module: Provides support for seperate message of the day
-# on oper-up
-# This module is oper-only.
-#<module name="m_opermotd.so">
-#
-#-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# If you are using the m_opermotd.so module, specify the motd here    #
-#                                                                     #
-# onoper      -      Should the message be sent on /OPER or only when #
-#                    /OPERMOTD is used. Use "yes" or "no".            #
-#                                                                     #
-#<opermotd file="oper.motd" onoper="yes">
-
-<module name="m_override.so">
-#-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# m_override.so is too complex it describe here, see the wiki:        #
-# http://wiki.inspircd.org/Modules/override                           #
-
-<module name="m_operlevels.so">
-<module name="m_opermodes.so">
-<module name="m_password_hash.so">
-<module name="m_muteban.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Random Quote module: provides a random quote on connect.
-# NOTE: Some of these may mimic fatal errors and confuse users and 
-# opers alike! - BEWARE!
-#<module name="m_randquote.so">
-#
-#-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# Optional - If you specify to use the m_randquote.so module, then    #
-# specify below the path to the randquotes.conf file.                 #
-#                                                                     #
-#<randquote file="randquotes.conf">
-
-<module name="m_redirect.so">
-<module name="m_regex_glob.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Regular Expression Provider for PCRE (Perl-Compatible Regular
-# Expressions). You need libpcre installed to compile and load this
-# module. You must have at least 1 provider loaded to use m_filter or
-# m_rline.
-#<module name="m_regex_pcre.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Regular Expression Provider for POSIX Regular Expressions.
-# You shouldn't need any additional libraries on a POSIX-compatible
-# system (ie: any Linux, BSD, but not Windows). You must have at least
-# 1 provider loaded to use m_filter or m_rline.
-# On POSIX-compliant systems, regex syntax can be found by using the
-# command: 'man 7 regex'.
-#<module name="m_regex_posix.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Regular Expression Provider for TRE Regular Expressions.
-# This is the same regular expression engine used by UnrealIRCd, so
-# if you are most familiar with the syntax of /spamfilter from there,
-# this is the provider you want. You need libtre installed in order
-# to compile and load this module.
-#<module name="m_regex_tre.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Registered users only channel creation
-# Allows only registered users and opers to create new channels.
-#
-# You probably *DO NOT* want to load this module on a public network.
-#
-#<module name="m_regonlycreate.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Restricted channels module: Allows only opers to create channels.
-#
-# You probably *DO NOT* want to load this module on a public network.
-#
-#<module name="m_restrictchans.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Restrict message module: Allows users to only message opers.
-#
-# You probably *DO NOT* want to load this module on a public network.
-#
-#<module name="m_restrictmsg.so">
-
-<module name="m_sajoin.so">
-<module name="m_sakick.so">
-<module name="m_samode.so">
-<module name="m_sanick.so">
-<module name="m_sapart.so">
-<module name="m_saquit.so">
-<module name="m_satopic.so">
-<module name="m_servprotect.so">
-<module name="m_seenicks.so">
-<module name="m_setidle.so">
-<module name="m_services_account.so">
-<module name="m_sethost.so">
-<module name="m_setident.so">
-<module name="m_setname.so">
-<module name="m_showwhois.so">
-<showwhois opersonly="yes" showfromopers="yes">
-
-<module name="m_shun.so">
-<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="no" affectopers="no">
-
-<module name="m_spy.so">
-<module name="m_sslmodes.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
-# if enabled. You must copy the source for this module from the directory
-# src/modules/extra, or answer 'yes' in ./configure when asked if you
-# want to enable this, or it will not load.
-#<module name="m_ssl_gnutls.so">
-#
-#-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
-# http://wiki.inspircd.org/Modules/ssl_gnutls                         #
-#                                                                     #
-# NOTE: If you want to use this module to encrypt and sign your       #
-# server to server traffic, you MUST load it before m_spanningtree in #
-# your configuration file!                                            #
-
-<module name="m_sslinfo.so">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
-# if enabled. You must copy the source for this module from the directory
-# src/modules/extra, or answer 'yes' in ./configure when asked if you
-# want to enable this, or it will not load.
-#<module name="m_ssl_openssl.so">
-#
-#-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# m_ssl_openssl.so is too complex it describe here, see the wiki:     #
-# http://wiki.inspircd.org/Modules/ssl_openssl                        #
-#                                                                     #
-# NOTE: If you want to use this module to encrypt and sign your       #
-# server to server traffic, you MUST load it before m_spanningtree in #
-# your configuration file!                                            #
-
-<module name="m_stripcolor.so">
-<module name="m_svshold.so">
-<module name="m_swhois.so">
-<module name="m_tline.so">
-<module name="m_uhnames.so">
-<module name="m_userip.so">
-<module name="m_watch.so">
-<watch maxentries="32">
-
-<module name="m_spanningtree.so">
-
diff --git a/docs/conf/modules/unrealircd.conf.example b/docs/conf/modules/unrealircd.conf.example
new file mode 100644 (file)
index 0000000..fa5d652
--- /dev/null
@@ -0,0 +1,420 @@
+<module name="m_md5.so">
+<module name="m_sha256.so">
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Alias module: Allows you to define server-side command aliases
+<module name="m_alias.so">
+<fantasy prefix="!" allowbots="no">
+# Aliases
+<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
+<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
+<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
+<alias text="BOTSERV" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
+<alias text="HOSTSERV" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
+<alias text="MEMOSERV" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
+<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
+<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
+<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
+<alias text="BS" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
+<alias text="HS" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
+<alias text="MS" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
+#
+# An example of using the format value to create an alias with two
+# different behaviours depending on the format of the parameters.
+#
+#<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
+#  requires="ChanServ" uline="yes">
+#
+#<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
+#  requires="NickServ" uline="yes">
+#
+# This alias fixes a glitch in xchat 2.6.x and above and the way it
+# assumes IDENTIFY must be prefixed by a colon (:) character. It should
+# be placed ABOVE the default NICKSERV alias (the first example) listed
+# above.
+#
+#<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
+#  requires="NickServ" uline="yes">
+
+<module name="m_allowinvite.so">
+<module name="m_alltime.so">
+<module name="m_auditorium.so">
+<auditorium showops="yes" operoverride="yes">
+<module name="m_banexception.so">
+<module name="m_blockcaps.so">
+<blockcaps percent="50"
+           minlen="5"
+           capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
+<module name="m_blockcolor.so">
+<module name="m_botmode.so">
+<module name="m_censor.so">
+<include file="inspircd.censor.example">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# CGI:IRC module: Adds support for automatic host changing in CGI:IRC
+# (http://cgiirc.sourceforge.net).
+#<module name="m_cgiirc.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-# CGIIRC  CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
+#
+# Optional - If you specify to use m_cgiirc, then you must specify one
+# or more cgihost tags which indicate authorised CGI:IRC servers which
+# will be connecting to your network, and an optional cgiirc tag.
+# For more information see: http://wiki.inspircd.org/Modules/cgiirc
+#
+# Set to yes if you want to notice opers when CGI clients connect
+# <cgiirc opernotice="no">
+#
+# The type field indicates where the module should get the real
+# client's IP address from, for further information, please see the
+# CGI:IRC documentation.
+#
+# Old style:
+# <cgihost type="pass" mask="www.mysite.com">       # Get IP from PASS
+# <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
+# <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
+# New style:
+# <cgihost type="webirc" password="foobar"
+#   mask="somebox.mysite.com">                      # Get IP from WEBIRC
+#
+# IMPORTANT NOTE:
+# ---------------
+#
+# When you connect CGI:IRC clients, there are two connect classes which
+# apply to these clients. When the client initially connects, the connect
+# class which matches the cgi:irc site's host is checked. Therefore you
+# must raise the maximum local/global clients for this ip as high as you
+# want to allow cgi clients. After the client has connected and is
+# determined to be a cgi:irc client, the class which matches the client's
+# real IP is then checked. You may set this class to a lower value, so that
+# the real IP of the client can still be restricted to, for example, 3
+# sessions maximum.
+#
+
+<module name="m_chanfilter.so">
+<chanfilter hidemask="yes">
+
+<module name="m_chanprotect.so">
+
+<chanprotect
+       noservices="no"
+       qprefix="~"
+       aprefix="&amp;"
+       deprotectself="yes"
+       deprotectothers="yes">
+
+<module name="m_check.so">
+<module name="m_chghost.so">
+<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
+
+<module name="m_chgident.so">
+<module name="m_chgname.so">
+<module name="m_cloaking.so">
+<cloak mode="half"
+       key="secret"
+       prefix="net-">
+
+<module name="m_close.so">
+<module name="m_clones.so">
+<module name="m_commonchans.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Conn-Join: Allows you to force users to join one or more channels
+# automatically upon connecting to the server.
+#<module name="m_conn_join.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
+#
+# If you have m_conn_join.so loaded, you can configure it using the
+# follow values:
+#
+#<autojoin channel="#one,#two,#three">
+
+<module name="m_conn_umodes.so">
+<module name="m_cycle.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Connection throttle module. Configuration:
+#<module name="m_connflood.so">
+#
+#-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
+#  seconds, maxconns -  Amount of connections per <seconds>.
+#
+#  timeout           -  Time to wait after the throttle was activated
+#                       before deactivating it. Be aware that the time
+#                       is seconds + timeout.
+#
+#  quitmsg           -  The message that users get if they attempt to
+#                       connect while the throttle is active.
+#
+#  bootwait          -  Amount of time to wait before enforcing the
+#                       throttling when the server just booted.
+#
+#<connflood seconds="30" maxconns="3" timeout="30"
+#   quitmsg="Throttled" bootwait="10">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# DCCALLOW module: Adds the /DCCALLOW command
+<module name="m_dccallow.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-  DCCALLOW CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
+#  blockchat         - Whether to block DCC CHAT as well as DCC SEND
+#  length            - Default duration of entries in DCCALLOW list
+#  action            - Default action to take if no action is specified
+#                      can be 'block' or 'allow'
+#
+# File configuration:
+#  pattern           - The glob pattern to match against
+#  action            - Action to take if a user attempts to send a file
+#                      that matches this pattern, can be 'block' or 'allow'
+#
+#<dccallow blockchat="yes" length="5m" action="block">
+#<banfile pattern="*.exe" action="block">
+#<banfile pattern="*.txt" action="allow">
+#
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+
+<module name="m_deaf.so">
+<module name="m_denychans.so"> 
+#<badchan name="#gods*" allowopers="yes" reason="Tortoises!">         #
+#<badchan name="#heaven" redirect="#hell" reason="Nice try!">         #
+
+<module name="m_devoice.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Filter module: Provides message filtering, similar to SPAMFILTER.
+<module name="m_filter.so">
+#                                                                     #
+# This module depends upon a regex provider such as m_regex_pcre or   #
+# m_regex_glob to function. You must specify which of these you want  #
+# m_filter to use via the tag below.                                  #
+#                                                                     #
+# Valid engines are:                                                  #
+#                                                                     #
+# glob  - Glob patterns, provided via m_regex_glob.so                 #
+# pcre  - PCRE regexps, provided via m_regex_pcre.so, needs libpcre   #
+# tre   - TRE regexps, provided via m_regex_tre.so, requires libtre   #
+# posix - POSIX regexps, provided via m_regex_posix.so, not availale  #
+#         on windows, no dependencies on other operating systems.     #
+#                                                                     #
+<filteropts engine="glob">                                           
+#                                                                     #
+# Your choice of regex engine must match on all servers network-wide.
+#
+# You may specify specific channels that are exempt from being filtered:
+#<exemptfromfilter channel="#blah">
+#
+#-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# Optional - If you specify to use the m_filter module, then          #
+# specfiy below the path to the filter.conf file, or define some      #
+# <filter> tags.                                                      #
+#                                                                     #
+#<include file="filter.conf">
+
+<module name="m_gecosban.so">
+<module name="m_globops.so">
+<module name="m_globalload.so">
+<module name="m_halfop.so">
+<module name="m_helpop.so">
+<include file="inspircd.helpop-full.example">
+
+<module name="m_hidechans.so">
+<hidechans affectsopers="false">
+
+<module name="m_hideoper.so">
+<module name="m_ident.so">
+<ident timeout="1">
+<module name="m_inviteexception.so">
+<module name="m_joinflood.so">
+<module name="m_jumpserver.so">
+<module name="m_knock.so">
+<module name="m_messageflood.so">
+<module name="m_namesx.so">
+<module name="m_nickflood.so">
+<module name="m_noctcp.so">
+<module name="m_nokicks.so">
+<module name="m_nonicks.so">
+<module name="m_nopartmsg.so">
+<module name="m_nonotice.so">
+<module name="m_operchans.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Oper Join module: Auto-joins opers to a channel upon oper-up
+# This module is oper-only. For the user equivalent, see m_conn_join.
+<module name="m_operjoin.so">
+#
+#-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# If you are using the m_operjoin.so module, specify options here:    #
+#                                                                     #
+# channel     -      The channel name to join, can also be a comma    #
+#                    seperated list eg. "#channel1,#channel2".        #
+#                                                                     #
+# override    -      Lets the oper join walking thru any modes that   #
+#                    might be set, even bans. Use "yes" or "no".      #
+#                                                                     #
+#<operjoin channel="#channel" override="no">
+#
+# Alternatively you can use the autojoin="channellist" in a <type>    #
+# tag to set specific autojoins for a type of oper, for example:      #
+#
+#<type name="Helper" autojoin="#help" classes="...">
+
+<module name="m_operlog.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Oper MOTD module: Provides support for seperate message of the day
+# on oper-up
+# This module is oper-only.
+#<module name="m_opermotd.so">
+#
+#-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# If you are using the m_opermotd.so module, specify the motd here    #
+#                                                                     #
+# onoper      -      Should the message be sent on /OPER or only when #
+#                    /OPERMOTD is used. Use "yes" or "no".            #
+#                                                                     #
+#<opermotd file="oper.motd" onoper="yes">
+
+<module name="m_override.so">
+#-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# m_override.so is too complex it describe here, see the wiki:        #
+# http://wiki.inspircd.org/Modules/override                           #
+
+<module name="m_operlevels.so">
+<module name="m_opermodes.so">
+<module name="m_password_hash.so">
+<module name="m_muteban.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Random Quote module: provides a random quote on connect.
+# NOTE: Some of these may mimic fatal errors and confuse users and 
+# opers alike! - BEWARE!
+#<module name="m_randquote.so">
+#
+#-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# Optional - If you specify to use the m_randquote.so module, then    #
+# specify below the path to the randquotes.conf file.                 #
+#                                                                     #
+#<randquote file="randquotes.conf">
+
+<module name="m_redirect.so">
+<module name="m_regex_glob.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Regular Expression Provider for PCRE (Perl-Compatible Regular
+# Expressions). You need libpcre installed to compile and load this
+# module. You must have at least 1 provider loaded to use m_filter or
+# m_rline.
+#<module name="m_regex_pcre.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Regular Expression Provider for POSIX Regular Expressions.
+# You shouldn't need any additional libraries on a POSIX-compatible
+# system (ie: any Linux, BSD, but not Windows). You must have at least
+# 1 provider loaded to use m_filter or m_rline.
+# On POSIX-compliant systems, regex syntax can be found by using the
+# command: 'man 7 regex'.
+#<module name="m_regex_posix.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Regular Expression Provider for TRE Regular Expressions.
+# This is the same regular expression engine used by UnrealIRCd, so
+# if you are most familiar with the syntax of /spamfilter from there,
+# this is the provider you want. You need libtre installed in order
+# to compile and load this module.
+#<module name="m_regex_tre.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Registered users only channel creation
+# Allows only registered users and opers to create new channels.
+#
+# You probably *DO NOT* want to load this module on a public network.
+#
+#<module name="m_regonlycreate.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Restricted channels module: Allows only opers to create channels.
+#
+# You probably *DO NOT* want to load this module on a public network.
+#
+#<module name="m_restrictchans.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Restrict message module: Allows users to only message opers.
+#
+# You probably *DO NOT* want to load this module on a public network.
+#
+#<module name="m_restrictmsg.so">
+
+<module name="m_sajoin.so">
+<module name="m_sakick.so">
+<module name="m_samode.so">
+<module name="m_sanick.so">
+<module name="m_sapart.so">
+<module name="m_saquit.so">
+<module name="m_satopic.so">
+<module name="m_servprotect.so">
+<module name="m_seenicks.so">
+<module name="m_setidle.so">
+<module name="m_services_account.so">
+<module name="m_sethost.so">
+<module name="m_setident.so">
+<module name="m_setname.so">
+<module name="m_showwhois.so">
+<showwhois opersonly="yes" showfromopers="yes">
+
+<module name="m_shun.so">
+<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="no" affectopers="no">
+
+<module name="m_spy.so">
+<module name="m_sslmodes.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
+# if enabled. You must copy the source for this module from the directory
+# src/modules/extra, or answer 'yes' in ./configure when asked if you
+# want to enable this, or it will not load.
+#<module name="m_ssl_gnutls.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
+# http://wiki.inspircd.org/Modules/ssl_gnutls                         #
+#                                                                     #
+# NOTE: If you want to use this module to encrypt and sign your       #
+# server to server traffic, you MUST load it before m_spanningtree in #
+# your configuration file!                                            #
+
+<module name="m_sslinfo.so">
+
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
+# if enabled. You must copy the source for this module from the directory
+# src/modules/extra, or answer 'yes' in ./configure when asked if you
+# want to enable this, or it will not load.
+#<module name="m_ssl_openssl.so">
+#
+#-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# m_ssl_openssl.so is too complex it describe here, see the wiki:     #
+# http://wiki.inspircd.org/Modules/ssl_openssl                        #
+#                                                                     #
+# NOTE: If you want to use this module to encrypt and sign your       #
+# server to server traffic, you MUST load it before m_spanningtree in #
+# your configuration file!                                            #
+
+<module name="m_stripcolor.so">
+<module name="m_svshold.so">
+<module name="m_swhois.so">
+<module name="m_tline.so">
+<module name="m_uhnames.so">
+<module name="m_userip.so">
+<module name="m_watch.so">
+<watch maxentries="32">
+
+<module name="m_spanningtree.so">
+
diff --git a/docs/conf/motd.txt.example b/docs/conf/motd.txt.example
new file mode 100644 (file)
index 0000000..70830b8
--- /dev/null
@@ -0,0 +1,41 @@
+
+ _____                        _____   _____    _____      _
+|_   _|                      |_   _| |  __ \  / ____|    | |
+  | |    _ __    ___   _ __    | |   | |__) || |       __| |
+  | |   | '_ \  / __| | '_ \   | |   |  _  / | |      / _` |
+ _| |_  | | | | \__ \ | |_) | _| |_  | | \ \ | |____ | (_| |
+|_____| |_| |_| |___/ | .__/ |_____| |_|  \_\ \_____| \__,_|
+    __________________| |_______________________________
+   |__________________|_|_______________________________|
+
+                        Putting the ricer in IRCer since 2007
+
+       //\ 
+       V  \    WELCOME TO AN INSPIRCD NETWORK
+        \  \_    If you see this, I am probably new.
+         \,'.`-.   If I'm not new, my owner is lazy.
+          |\ `. `. 
+          ( \  `. `-.                        _,.-:\
+           \ \   `.  `-._             __..--' ,-';/
+            \ `.   `-.   `-..___..---'   _.--' ,'/
+             `. `.    `-._        __..--'    ,' /
+               `. `-_     ``--..''       _.-' ,'
+                 `-_ `-.___        __,--'   ,'
+                    `-.__  `----"""    __.-'
+                         `--..____..--'
+  
+        ---- To change, see motd.txt.example -----
+       /                                          \
+      /   * Web: http://www.inspircd.org           \
+      |   * IRC: irc.inspircd.org #inspircd        |
+      |   * Docs: http://wiki.inspircd.org         |
+      |   * Bugs: http://inspircd.github.com/bugs  |
+      |                                            |
+      | We hope you like this software. Please do  |
+      | make  sure  you  put  some  effort  into   |
+      | your configuration, though, so you love it.|
+      | Enjoy.                                     |
+      |                                            |
+      \                   -- The InspIRCd Team    /
+       -------------------------------------------
+
diff --git a/docs/conf/opermotd.txt.example b/docs/conf/opermotd.txt.example
new file mode 100644 (file)
index 0000000..c91b36a
--- /dev/null
@@ -0,0 +1,41 @@
+
+ _____                        _____   _____    _____      _
+|_   _|                      |_   _| |  __ \  / ____|    | |
+  | |    _ __    ___   _ __    | |   | |__) || |       __| |
+  | |   | '_ \  / __| | '_ \   | |   |  _  / | |      / _` |
+ _| |_  | | | | \__ \ | |_) | _| |_  | | \ \ | |____ | (_| |
+|_____| |_| |_| |___/ | .__/ |_____| |_|  \_\ \_____| \__,_|
+    __________________| |_______________________________
+   |__________________|_|_______________________________|
+
+                        Putting the ricer in IRCer since 2007
+
+       //\ 
+       V  \    WELCOME TO AN INSPIRCD NETWORK
+        \  \_    If you see this, I am probably new.
+         \,'.`-.   If I'm not new, my owner is lazy.
+          |\ `. `. 
+          ( \  `. `-.                        _,.-:\
+           \ \   `.  `-._             __..--' ,-';/
+            \ `.   `-.   `-..___..---'   _.--' ,'/
+             `. `.    `-._        __..--'    ,' /
+               `. `-_     ``--..''       _.-' ,'
+                 `-_ `-.___        __,--'   ,'
+                    `-.__  `----"""    __.-'
+                         `--..____..--'
+  
+        -- To change, see opermotd.txt.example ---
+       /                                          \
+      /   * Web: http://www.inspircd.org           \
+      |   * IRC: irc.inspircd.org #inspircd        |
+      |   * Docs: http://wiki.inspircd.org         |
+      |   * Bugs: http://inspircd.github.com/bugs  |
+      |                                            |
+      | We hope you like this software. Please do  |
+      | make  sure  you  put  some  effort  into   |
+      | your configuration, though, so you love it.|
+      | Enjoy.                                     |
+      |                                            |
+      \                   -- The InspIRCd Team    /
+       -------------------------------------------
+
diff --git a/docs/conf/quotes.txt.example b/docs/conf/quotes.txt.example
new file mode 100644 (file)
index 0000000..56a580e
--- /dev/null
@@ -0,0 +1,203 @@
+Men are from Mars. Women are from Venus. Computers are from hell
+Computer /nm./: a device designed to speed and automate errors
+Hardware /nm./: the part of the computer that you can kick.
+Maniac /n./ An early computer built by nuts.
+RAM /abr./: Rarely Adequate Memory.
+Programmer /n./ A red-eyed, mumbling mammal capable of conversing with inanimate objects
+Multitasking /adj./ 3 PCs and a chair with wheels
+Plonk /excl./: The sound a newbie makes as he falls to the bottom of a kill file
+hURL /n./: a link to a web site that makes you want to puke
+SUPERCOMPUTER: what it sounded like before you bought it.
+If it's really a supercomputer, how come the bullets don't bounce off when I shoot it?  . The Covert Comic. 
+A computer is like an Old Testament god, with a lot of rules and no mercy.  . Joseph Campbell
+I dropped my computer on my foot! That Megahurtz!!
+A computer's attention span is as long as it's power cord
+586: The average IQ needed to understand a PC
+Memory is like an orgasm. It's a lot better if you don't have to fake it
+If it jams, force it. If it breaks, it needed replacing anyway.
+A bus station is where a bus stops. A train station is where a train stops. On my desk I have a workstation..
+Want to come see my HARD DRIVE ? I promise it isn't 3.5 inches and it ain't floppy.  . Geek pick-up line.
+If you torture the data enough, it will confess.  . Ronald Coase
+If you give someone a program, you will frustrate them for a day; if you teach them how to program, you will frustrate them for a lifetime
+ASCII stupid question, get a stupid ANSI!
+Use the source, Luke...
+Programming is an art form that fights back
+MacOS, Windows, BeOS: they're all just Xerox copies
+Whenever you think you have a clever programming trick... forget it!
+Managing senior programmers is like herding cats.  . Dave Platt
+Your program is sick ! Shoot it and put it out of its memory
+/* You are not expected to understand this */
+To define recursion, we must first define recursion
+ERROR: Computer possessed; Load EXOR.SYS ? [Y/N]
+Linux is only free if your time is worthless
+Linux: find out what you've been missing while you've been rebooting Windows NT
+unzip; strip; touch; finger; mount; fsck; more; yes; unmount; sleep
+Profanity is the one language all programmers know best
+It's 5.50 a.m.... Do you know where your stack pointer is?
+#define QUESTION ((bb) || !(bb))  . Shakespeare
+The more I C, the less I see.
+Confucius say: He who play in root, eventually kill tree.
+Unix is the answer, but only if you phrase the question very carefully
+C++: Hard to learn and built to stay that way
+Java is, in many ways, C++--  . Michael Feldman.
+They don't make bugs like Bunny anymore  . Olav Mjelde
+If debugging is the process of removing software bugs, then programming must be the process of putting them in
+When the only tool you own is a hammer, every problem you encounter resembles a nail
+System Error: press F13 to continue...
+To err is human, but for a real disaster you need a computer
+Computers make very fast, very accurate mistakes
+Life would be so much easier if we only had the source code
+Who is this 'General Failure' and why is he reading my disk?
+hAS aNYONE sEEN MY cAPSLOCK kEY?
+InspIRCd, now with excessive ammounts of Cheeze
+I'm in the computer business, I make Out-Of-Order signs
+Kevorkian Virus: helps your computer shut down whenever it wants to.
+          [OUT OF QUOTES, PLEASE ORDER MORE]
+Insert Something Funkeh.. err.. There! -->
+Cannot delete tmp150---3.tmp: There is not enough free disk space. Delete one or more files to free disk space, and then try again
+File not found. Should I fake it ? (Y/N)
+The definition of an upgrade: Take old bugs out, put new ones in
+If it's not on fire, it's a software problem
+It's a little-known fact that the Y1K problem caused the Dark Ages
+Artificial Intelligence usually beats natural stupidity
+Making fun of AOL users is like making fun of the kid in the wheel chair
+Daddy, why doesn't this magnet pick up this floppy disk?
+Daddy, what does FORMATTING DRIVE C mean?
+See daddy ? All the keys are in alphabetical order now.
+Enter any 11-digit prime number to continue...
+ASCII and ye shall receive.
+The web is a dominatrix. Every where I turn, I see little buttons ordering me to Submit.
+<FrostyCoolSlug> NO, You cannot dial 999, I'm downloading my mail ;/
+640K ought to be enough for anybody.  . Bill Gates, 1981
+Windows not found, [P]arty, [C]elebrate, [D]rink?
+English, the Microsoft of languages...
+It's been said that Bill Gates named his company after his dick...
+Ever notice how fast Windows runs ?  -- Neither did I
+If at first you don't succeed, work for Microsoft
+We are Microsoft. Resistance Is Futile. You Will Be Assimilated
+"Microsoft Works."  . Oxymoron
+Windows isn't a virus, viruses do something
+PANIC! buffer = :NickServ WRITE_DB(3). <-- JUST KIDDING!
+It just keeps going and going and going and going and goi <BANG>
+All that I know is that nukes are comming from 127.0.0.1
+I know all about the irc and the mirc cops.
+M re ink n ed d, ple s  r fil
+Please refrain from feeding the IRC Operators. Thank you.
+I know all about mirc stuff, hmm.. I think this channel is experiencing packet loss..
+MacDonalds claims Macintosh stole their next idea of the iMac
+I can't hold her any longer, captain, she's gonna bl.. sorry, got caught up in the moment
+I recommend purchasing a Cyrix CPU for testing nuclear meltdowns
+Is it an international rule to have the worst picture possible on your driver license?
+Have you hugged your services coder, today?
+Ever wonder why they make the colon flash on alarm clocks?
+Whats this?.. blue screen with a VXD error?!.. I'VE BEEN NUKED!
+do-do-bop-doo-doo-do-do-doo.. For those of you who know that song, you have problems..
+be wery wery quiet... hunting wabbit...
+I've been IRC Nuked"Great warrior?  War does not make one great." - Yoda
+"I find your lack of faith.....disturbing." - Darth Vader
+"I have a bad feeling about this.."--All of the Star Wars characters.
+Can I upgrade my Hard Drive to a WARP drive?
+Canadian DOS prompt: EH?\>
+Canadian DOS: "Yer sure, eh?" [y/n]
+CONGRESS.SYS Corrupted: Re-boot Washington D.C (Y/n)?
+I don't have a solution but I admire the problem.
+Famous Last Words: Trust me. I know what I'm doing.
+Hey Captain, I just created a black ho-÷p!%$û NO CARRIER
+Access denied--nah nah na nah nah!
+Bad command. Bad, bad command! Sit! Stay! Staaay..
+Error: Keyboard not attached. Press F1 to continue.
+*grumble* "You're just supposed to sit here?"
+"Hey, what's this button d..<BOOM>" -W. Crusher
+"He has become One with Himself!" "He's passed out!" "That too."-B5
+For a funny quote, call back later.
+Famous last words: 'You saw a WHAT around the corner?!'
+I like work ... I can sit and watch it for hours.
+Copywight 1994 Elmer Fudd. All wights wesewved.
+Cannot find REALITY.SYS. Universe halted.
+BUFFERS=20 FILES=15 2nd down, 4th quarter, 5 yards to go!
+My software never has bugs. It just develops random features.
+Why doesn't DOS ever say 'EXCELLENT command or filename!?
+Shell to DOS... Come in DOS, do you copy? Shell to DOS...
+Computing Definition - Network-Admin: Primary person who just got set up for the blame of the system crash.
+An expert is a person who has made all the mistakes which can be made in a very narrow field.
+Famous last words: This is the safe way to do it.......
+Famous Last Words: Trust me. I know what I'm doing.
+Clinton, "I didn't say that - er, well - yes, but I didn't mean..."
+CLINTON LEGACY??...even Pharaoh had only ten plagues...
+IBM             I Bought McIntosh
+IBM             I Bring Manuals
+IBM             I've Been Moved
+IBM             Idolized By Management
+IBM             Impenetrable Brain Matter
+IBM             Imperialism By Marketing
+IBM             Incorrigible Boisterous Mammoth
+IBM             Inertia Breeds Mediocrity
+IBM             Ingenuity Becomes Mysterious
+IBM             Ingrained Batch Mentality
+IBM             Innovation By Management
+IBM             Insipid Belligerent Mossbacks
+IBM             Insipidly Bankrolling Millions
+IBM             Inspect Before Multiusing
+IBM             Install Bigger Memory
+IBM             Institution By Machiavelli
+IBM             Insultingly Boring Merchandisers
+IBM             Intellectuals Being Moronized
+IBM             Intelligence Belittling Meaning
+IBM             Intimidated, Buffaloed Management
+IBM             Into Building Money
+IBM             Intolerant of Beards & Moustaches
+IBM             Invest Before Multi-tasking
+IBM             Investigate Baffling Malodor
+IBM             Irresponsible Behave Multinational
+IBM             It Beats Mattel
+IBM             It's a Big Mess
+IBM             It's Better Manually
+IBM             Itty Bitty Machine
+IBM             Institute for Black Magic
+100,000 lemmings can't be wrong.
+Murphy's Eighth Law: If everything seems to be going well, you have obviously overlooked something.
+Rules of the game: Do not believe in miracles - rely on them.
+Rules of the game: Any given program, once running, is obsolete.
+Computing Definition - Error: What someone else has made when they disagree with your computer output.
+Backup not found: (A)bort (R)etry (P)anic
+WinErr 653: Multitasking attempted - system confused.
+Cannot join #real_life (invite only)
+"Unfortunatly, no one can be told what the Matrix is. You have to see it for yourself." - Matrix
+"Reality is a thing of the past" - Matrix
+"The future will not be user friendly" - Matrix
+"The general idea in chat is to make yourself understandable... ..." - Peer
+"heh i am talkin to someone...she's not dead...yet anyways" - Stinky
+"He who must die, must die in the dark, even though he sells candles"
+"If at first you don't succeed, skydiving is not for you."
+"Friendship is like peeing on yourself: everyone can see it, but only you get the warm feeling that it brings."
+"France sucks, but Paris swallows"
+"A computer once beat me at chess, but it was no match for me at kick boxing.
+"Ever wonder why the SAME PEOPLE make up ALL the conspiracy theories?
+"Don't think of it as being outnumbered. Think of it as having a wide target selection."
+"Sysadmins can't be sued for malpractice, but surgeons don't have to deal with patients who install new versions of their own innards."
+"FACE!"
+"Dirka Dirka Mohammed JIHAD!"
+We can learn much from wise words, little from wisecracks, and less from wise guys.
+"Blessed are the young, for they shall inherit the national debt." - Herbert Hoover
+If you have five dollars and Chuck Norris has five dollars, Chuck Norris has more money than you.
+Apple pays Chuck Norris 99 cents every time he listens to a song.
+If Chuck Norris and InspIRCd met in a dark alley, Chuck Norris would get his first black eye. Ever.
+Chuck Norris can sneeze with his eyes open.
+Chuck Norris can kill two stones with one bird.
+There is no theory of evolution. Just a list of animals Chuck Norris allows to live. 
+The Great Wall of China was originally created to keep Chuck Norris out. It failed miserably.
+Chuck Norris can win a game of Connect Four in only three moves.
+Chuck Norris is not hung like a horse... horses are hung like Chuck Norris.
+Chuck Norris is currently suing NBC, claiming Law and Order are trademarked names for his left and right legs.
+Chuck Norris CAN believe it's not butter.
+Chuck Norris is so fast, he can run around the world and punch himself in the back of the head.
+When the Boogeyman goes to sleep every night, he checks his closet for Chuck Norris.
+Outer space exists because it's afraid to be on the same planet with Chuck Norris.
+Chuck Norris counted to infinity - twice.
+Chuck Norris only fears one thing in this world, and that is InspIRCd.
+InspIRCd's core is ran by donated Chuck Norris DNA.
+Chuck Norris exists because InspIRCd allows him to.
+Chuck Norris CAN punch you in the face over the internet.
+When Chuck Norris uses InspIRCd, he doesn't use the /kill command, he uses the /ROUND-HOUSE-TO-THE-FACE command.
+A developer only classifies oneself as such if they consider themselves as such.
+"While hunting in Africa, I shot an elephant in my pajamas. How an elephant got into my pajamas I'll never know." -- Groucho Marx
diff --git a/docs/conf/rules.txt.example b/docs/conf/rules.txt.example
new file mode 100644 (file)
index 0000000..e51f0af
--- /dev/null
@@ -0,0 +1,3 @@
+This is the InspIRCd rules file. 
+Place any network or server rules here :) 
index 114122dd3131be2889614a35becaafdac80733e2..17e15f53af2f46420a4b22d3285c01818e92c005 100644 (file)
@@ -233,7 +233,7 @@ install: target
        -$(INSTALL) -m $(INSTMODE_LIB) tools/gdbargs $(BASE)/.gdbargs 2>/dev/null
        -$(INSTALL) -m $(INSTMODE_LIB) docs/conf/*.example $(CONPATH)/examples
        -$(INSTALL) -m $(INSTMODE_LIB) docs/conf/aliases/*.example $(CONPATH)/examples/aliases
-       -$(INSTALL) -m $(INSTMODE_LIB) docs/conf/modules/*.conf.* $(CONPATH)/examples/modules
+       -$(INSTALL) -m $(INSTMODE_LIB) docs/conf/modules/*.example $(CONPATH)/examples/modules
        @echo ""
        @echo "*************************************"
        @echo "*        INSTALL COMPLETE!          *"
index 4204ec29b0caa6d2e85f95a14d0aa4eda94397d9..e1ce0159f3fd5bd8f6f5e42c2bff69d2d12a204e 100644 (file)
@@ -156,7 +156,7 @@ Section "Config Files" SEC02
   SetOutPath "$INSTDIR\conf\aliases"
   File "..\docs\conf\aliases\*.example"
   SetOutPath "$INSTDIR\conf\modules"
-  File "..\docs\conf\modules\modules.*"
+  File "..\docs\conf\modules\*.example"
 SectionEnd
 
 Section "Command Handlers" SEC03