diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/inspircd.censor.example | 12 | ||||
| -rw-r--r-- | docs/inspircd.conf.example | 1183 | ||||
| -rw-r--r-- | docs/inspircd.filter.example | 24 | ||||
| -rw-r--r-- | docs/inspircd.helpop-full.example | 506 | ||||
| -rw-r--r-- | docs/inspircd.helpop.example | 328 |
5 files changed, 0 insertions, 2053 deletions
diff --git a/docs/inspircd.censor.example b/docs/inspircd.censor.example deleted file mode 100644 index 89730669f..000000000 --- a/docs/inspircd.censor.example +++ /dev/null @@ -1,12 +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"> - -<badword text="shit" replace="poo"> -<badword text="fuck" replace="(censored)"> - diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example deleted file mode 100644 index f20f0c255..000000000 --- a/docs/inspircd.conf.example +++ /dev/null @@ -1,1183 +0,0 @@ -######################################################################## -# # -# ___ ___ ____ ____ _ # -# |_ _|_ __ ___ _ __|_ _| _ \ / ___|__| | # -# | || '_ \/ __| '_ \| || |_) | | / _` | # -# | || | | \__ \ |_) | || _ <| |__| (_| | # -# |___|_| |_|___/ .__/___|_| \_\\____\__,_| # -# |_| # -# ____ __ _ _ _ # -# / ___|___ _ __ / _(_) __ _ _ _ _ __ __ _| |_(_) ___ _ __ # -# | | / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \ # -# | |__| (_) | | | | _| | (_| | |_| | | | (_| | |_| | (_) | | | | # -# \____\___/|_| |_|_| |_|\__, |\__,_|_| \__,_|\__|_|\___/|_| |_| # -# |___/ # -# # -##################################||#################################### - #||# -##################################||#################################### -# # -# This is an example of the config file for InspIRCd. # -# Change the options to suit your network # -# # -# Last updated on : 09/01/2006 # -# Written by : CC (cc@backchat.co.za) # -# Updated by : katsklaw (katsklaw@gmail.com) # -# Updated by : brain (brain@inspircd.org) # -# # -# ____ _ _____ _ _ ____ _ _ _ # -# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # -# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # -# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # -# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # -# # -# Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT # -# lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even # -# if you've configured InspIRCd before, these probably indicate # -# something new or different to this version and you SHOULD READ IT. # -# # -######################################################################## -# # -# Unalphabeticalise the modules list at your own risk # -# # -######################################################################## - - -#-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#- -# # -# Here is where you enter the information about your server. # -# # -# Syntax is as follows: # -# # -# <server name="server.name" # -# description="Server Description" # -# network="MyNetwork"> # -# # - -<server name="penguin.omega.org.za" - description="Waddle World" - network="Omega"> - - -#-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-# -# # -# Describes the Server Administrator's real name, nick # -# and email address. # -# # -# Syntax is as follows: # -# <admin name="real name" # -# nick="nick name" # -# email="email@address.com"> # -# # - -<admin name="Johnny English" - nick="MI5" - email="MI5@the.best.secret.agent"> - - -#-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- -# # -# Enter the port and address bindings here. # -# # -# bind address - specifies which the address which ports bind # -# port - opens an unused port # -# type - can be 'clients' or 'servers'. The clients type is # -# a standard tcp based socket, the servers type is a # -# also a TCP based connection but of a different # -# format. # -# ____ _ _____ _ _ ____ _ _ _ # -# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # -# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # -# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # -# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # -# # -# If you want to link servers to InspIRCd you must load the # -# m_spanningtree module! Please see the modules list below for # -# information on how to load this module! If you do not load this # -# module, server ports will NOT be bound! # -# # -# Leaving address empty binds to all available interfaces # -# # -# Syntax is as follows: # -# # -# <bind address="ip number" port="port" type="clients"> # -# <bind address="ip number" port="port" type="servers"> # -# # - -<bind address="" port="6660" type="clients"> -<bind address="" port="7000" type="servers"> -<bind address="" port="7001" type="servers"> - - -#-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#- -# # -# You can configure the passwords here which you wish to use for # -# the die and restart commands. Only trusted ircops who will # -# need this ability should know the die and restart password. # -# # -# Syntax is as follows: # -# <power diepass="die password" restartpass="restart password" # -# pause="secs before dying"> # -# # - -<power diepass="diepass" restartpass="restartpass" pause="2"> - - -#-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# This optional tag allows you to include another config file # -# allowing you to keep your configuration tidy. The configuration # -# file you include will be treated as part of the configuration file # -# which includes it, in simple terms the inclusion is transparent. # -# # -# All paths to config files are relative to the directory of the main # -# config file inspircd.conf, unless the filename starts with a forward# -# slash (/) in which case it is treated as an absolute path. # -# # -# Syntax is as follows: # -# <include file="file.conf"> # -# # - -#-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# -# # -# This is where you can configure which connections are allowed # -# and denied access onto your server. # -# The password is optional. # -# You may have as many of these as you require. # -# To allow/deny all connections use a * # -# # -# Syntax is as follows: # -# # -# <connect allow="ip mask"> # -# <connect allow="ip mask" password="blahblah"> # -# <connect allow="ip mask" password="blah" timeout="10"> # -# <connect allow="ip mask" timeout="blah" flood="5"> # -# <connect allow="ip mask" threshold="8" pingfreq="120"> # -# <connect allow="ip mask" sendq="99999" revcq="696969"> # -# <connect allow="ip mask" maxlocal="3" maxglobal="3"> # -# <connect deny="ip mask"> # -# # -# You may optionally include timeout="x" on any allow line, which # -# specifies the amount of time given before an unknown connection # -# is closed if USER/NICK/PASS are not given. This value is in secs # -# # -# You should also include a flood="x" line which indicates # -# the number of lines a user may place into their buffer at once # -# before they are disconnected for excess flood. This feature can # -# not be disabled, however it can be set to exremely high values, # -# rendering it effectively disabled. A recommended value is 10. # -# A counter is maintained for each user which is reset every # -# 'threshold' seconds and specifying this threshold value with # -# threshold="X" indicates how often the counter is reset. For # -# example, with flood="5" and threshold="8", the user may not send # -# more than 5 lines in 8 secs. # -# # -# You may optionally specify the sendq size and ping frequency of # -# each connect:allow line using the pingfreq="X" and sendq="X" # -# settings as shown in the full example below. # -# The ping frequency is specified in seconds, and the sendq size # -# in bytes. It is recommended, although not enforced, that you # -# should never set your sendq size to less than 8k. Send Queues are # -# dynamically allocated and can grow as needed up to the maximum # -# size specified. # -# # -# The optional recvq value is the maximum size which users in this # -# group may grow their receive queue to. This is recommended to be # -# kept pretty low compared to the sendq, as users will always # -# recieve more than they send in normal circumstances. The default # -# if not specified is 4096. # -# # -# IMPORTANT NOTE, CALL THE CONFUSION POLICE! # -# The sendq is the data waiting to be sent TO THE USER. # -# The recvq is the data being received FROM THE USER. # -# The names sendq and recvq are from the SERVER'S PERSPECTIVE not # -# that of the user... Just to clear up any confusion or complaints # -# that these are backwards :p # -# # -# The localmax and globalmax values can be used to enforce local # -# and global session limits on connections. The session limits are # -# counted against all users, but applied only to users within the # -# class. For example, if you had a class 'A' which has a session # -# limit of 3, and a class 'B' which has a session limit of 5, and # -# somehow, two users managed to get into class B which also match # -# class A, there is only one connection left for this IP now in A, # -# but if they can connect again to B, there are three. You get the # -# idea (i hope). # -# # - -<connect allow="196.12.*" password="secret"> -<connect allow="*" timeout="60" flood="10" threshold="60" pingfreq="120" sendq="262144" recvq="4096" localmax="3" globalmax="3"> - -<connect deny="69.254.*"> - - -#-#-#-#-#-#-#-#-#-#-#-#- CLASS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#- -# # -# Classes are a group of commands which are grouped together # -# and given a unique name. They used to define which commands # -# are available to certain types of Operators. # -# # -# Syntax is as follows: # -# # -# <class name="name" commands="oper commands"> # -# # -# ____ _ _____ _ _ ____ _ _ _ # -# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # -# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # -# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # -# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # -# # -# You are not forced to give these classes the names given below. # -# You can create your own named classes, if you want, in fact that # -# is the whole idea of this system! # -# # - -<class name="Shutdown" commands="DIE RESTART REHASH"> -<class name="ServerLink" commands="CONNECT SQUIT"> -<class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE"> -<class name="OperChat" commands="WALLOPS GLOBOPS"> -<class name="HostCloak" commands="SETHOST SETIDENT SETNAME"> - - -#-#-#-#-#-#-#-#-#-#-#-#- OPERATOR COMPOSITION -#-#-#-#-#-#-#-#-#-#-# -# # -# This is where you specify which types of operators you have on # -# your server, as well as the commands they are allowed to use. # -# This works alongside with the classes specified above. # -# # -# type name - a name for the combined class types # -# # -# classes - specified above, used for flexibility for the # -# server admin to decide on which operators get # -# what commands # -# # -# host - optional hostmask operators will recieve on oper-up. # -# # -# Syntax is as follows: # -# # -# <type name="name" classes="class name" host="oper hostmask"> # -# # -# ____ _ _____ _ _ ____ _ _ _ # -# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # -# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # -# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # -# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # -# # -# You are not forced to give these types the names given below. # -# You can create your own named types, if you want, in fact that # -# is the whole idea of this system! # -# # - -<type name="NetAdmin" classes="OperChat BanControl HostCloak Shutdown ServerLink" host="netadmin.omega.org.za"> -<type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za"> -<type name="Helper" classes="HostCloak" host="helper.omega.org.za"> - - -#-#-#-#-#-#-#-#-#-#-#- OPERATOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# -# # -# Opers are defined here. This is a very important section. # -# Remember to only make operators out of truthworthy people. # -# # -# name - oper name, best to use lower-case # -# # -# password - password to oper-up, # -# encryption not supported by inspircd. However, there # -# are modules that allow for oper password encryption. # -# # -# host - host of client allowed to oper-up. # -# wildcards accepted, seperate multiple hosts with space # -# # -# type - specified above, defines the kind of operator # -# # -# Syntax is as follows: # -# <oper name="login" # -# password="pass" # -# host="hostmask@of.oper" # -# type="oper type"> # -# # - -<oper name="katsklaw" - password="s3cret" - host="ident@dialup15.isp.com *@localhost *@server.com" - type="NetAdmin"> - - -#-#-#-#-#-#-#-#-#-#-#- SERVER LINK CONFIGURATION -#-#-#-#-#-#-#-#-#-# -# # -# Defines which servers can link to this one, and which servers this # -# server may create outbound links to. # -# # -# name - The name is the canocial name of the server, does # -# not have to resolve - but it is expected to be sent # -# in the remote servers connection info. # -# ipaddr - Valid host or ip address for remote server. * # -# # -# port - The TCP port for the remote server. # -# # -# sendpass - Password to send to create an outbound connection # -# to this server. # -# # -# recvpass - Password to receive to accept an inbound connection # -# from this server. # -# # -# autoconnect - Sets the server to autoconnect. Where x is the num. # -# (optional) of seconds between attempts. e.g. 300 = 5 minutes. # -# # -# encryptionkey - Encryption key to be used for AES encryption, where # -# supported. Links using the spanning tree protocol # -# support AES. The encryption key must be EXACTLY 8, # -# 16 or 32 characters in length for a 64, 128 or 256 # -# bit key, respectively. # -# # -# hidden - When using m_spanningtree.so for linking. you may # -# set this to 'yes', and if you do, the IP address/ # -# hostname of this connection will NEVER be shown to # -# any opers on the network. In /STATS c its address # -# will show as *@<hidden>, and during CONNECT and # -# inbound connections, its IP will show as <hidden> # -# UNLESS the connection fails (e.g. due to a bad # -# password or servername) # -# # -# to u:line a server (give it extra privilages required for running # -# services, Q, etc) you must include the <uline server> tag as shown # -# in the example below. You can have as many of these as you like. # -# # -# WARNING: Unlike other ircds, u:lining a server allows ALL users on # -# that server to operoverride modes. This should only be used for # -# services and protected oper servers! # -# # -# IMPORTANT NOTE: When specifying the ip address and/or host, the # -# server software will prioritize RESOLVED hostnames above ip # -# addresses, so for example if your target server resolves to a.b.com # -# you MUST put a.b.com into your link block, and NOT the IP address # -# of a.b.com. The system uses reverse resolution. # -# # -# ____ _ _____ _ _ ____ _ _ _ # -# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # -# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # -# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # -# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # -# # -# If you want to link servers to InspIRCd you must load the # -# m_spanningtree module! Please see the modules list below for # -# information on how to load this module! If you do not load this # -# module, server links will NOT work! # -# # - -<link name="hub.penguin.org" - ipaddr="penguin.box.com" - port="7000" - autoconnect="300" - sendpass="outgoing!password" - recvpass="incoming!password"> - -<link name="services.antarctic.com" - ipaddr="localhost" - port="7000" - sendpass="penguins" - recvpass="polarbears"> - -<uline server="services.antarctic.com"> - - -#-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-# -# # -# These options let you define the path to your motd and rules # -# files. # -# # - -<files motd="/home/cc/inspircd/conf/inspircd.motd" - rules="/home/cc/inspircd/conf/inspircd.rules"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# Define your DNS server address here. InspIRCd has its own resolver # -# and you must define this otherwise nobody's host will resolve. The # -# timeout value is in seconds. # -# # -# ____ _ _____ _ _ ____ _ _ _ # -# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # -# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # -# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # -# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # -# # -# When choosing a server, be sure to choose one which will do a # -# RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these # -# recursive lookups itself, to save time and resources. The dns # -# server recommended by the InspIRCd team is bind, available from the # -# ISC website. If your DNS server does not do a recursive lookup, you # -# will be able to notice this by the fact that none of your users are # -# resolving even though the DNS server appears to be up! Most ISP and # -# hosting provider DNS servers support recursive lookups. # -# # - -<dns server="127.0.0.1" timeout="5"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# Define the path to the PID file here. The PID file can be used to # -# rehash the ircd from the shell or to terminate the ircd from the # -# shell using shell scripts, perl scripts etc, and to monitor the # -# ircd's state via cron jobs. # -# # - -<pid file="/path/to/inspircd.pid"> - -#-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# Use these tags to customise the ban limits on a per channel basis. # -# the tags are read from top to bottom, and any tag found which # -# matches the channels name applies the banlimit to that channel. # -# It is advisable to put an entry with the channel as '*' at the # -# bottom of the list. If none are specified or no maxbans tag is # -# matched, the banlist size defaults to 64 entries. # -# # - -<banlist chan="#morons" limit="128"> -<banlist chan="*" limit="69"> - -#-#-#-#-#-#-#-#-#-#-#- DISABLED COMMANDS -#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# This tag is optional, and specifies one or more commands which are # -# not available to non-operators. For example you may wish to disable # -# NICK and prevent non-opers from changing their nicknames. # -# Note that any disabled commands take effect only after the user has # -# 'registered' (e.g. after the initial USER/NICK/PASS on connection) # -# so for example disabling NICK will not cripple your network. # -# # -# <disabled commands="TOPIC MODE"> # -# # - - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# Just remove this... Its here to make you read ALL of the config # -# file options ;) # - -<die value="You should probably edit your config *PROPERLY* and try again."> - - - -#-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# Settings to define which features are useable on your server. # -# # -# prefixquit - a prefix for a client's quit message # -# # -# loglevel - specifies what detail of messages to log in the # -# log file. You may select from debug, verbose, # -# default, sparse and none. # -# allowhalfop - allows the +h channel mode # -# # -# noservices - If noservices is true, yes, or 1, then the first # -# user into a channel gets founder status. This is # -# only useful on networks running the m_chanprotect # -# module without services. # -# # -# netbuffersize - size of the buffer used to receive data from # -# clients. The ircd may only read() this amount # -# of text in one go at any time. (OPTIONAL) # -# # -# maxwho - The maximum number of results returned by a /WHO # -# query. This is to prevent /WHO being used as a # -# spam vector or means of flooding an ircd. The # -# default is 128, it is not recommended to raise it # -# above 1024. Values up to 65535 are permitted. # -# # -# somaxconn - The maximum number of sockets that may be waiting # -# in the accept queue. This usually allows the ircd # -# to soak up more connections in a shorter space of # -# time when increased but please be aware there is a # -# system defined maximum value to this, the same way # -# there is a system defined maximum number of file # -# descriptors. Some systems may only allow this to # -# be up to 5 (ugh) while others such as FreeBSD will # -# default to a much nicer 128. # -# # -# moduledir - This optional value indicates a runtime change of # -# the location where modules are to be found. This # -# does not add a supplementary directory. There can # -# only be one module path. # -# # -# softlimit - This optional feature allows a defined softlimit. # -# if defined sets a soft maxconnections value, has # -# to be less than the ./configure maxclients # -# # -# operonlystats - The operonlystats field is optional and specifies # -# which stats characters in /STATS may only be # -# requested by an IRC operator. Stats characters in # -# this field are case sensitive and enforced as # -# oper-only independent of if they are in a module # -# or the core. # -# # -# customversion - If you specify this configuration item, and it is # -# not set to an empty value, then when a user does # -# a /VERSION command on the ircd, this string will # -# be displayed as the second portion of the output, # -# replacing the system 'uname', compile flags and # -# socket engine/dns engine names. You may use this # -# to enhance security, or simply for vanity. # -# # -# maxtargets - The maxtargets field is optional, and if not # -# defined, defaults to 20. It indicates the maximum # -# number of targets which may be given to commands # -# such as PRIVMSG, KICK etc. # -# # -# hidesplits - When set to 'yes', will hide split server names # -# from non-opers. Non-opers will see '*.net *.split' # -# instead of the server names in the quit message, # -# identical to the way IRCu displays them. # -# # -# hidewhois - When defined with a non-empty value, the given # -# text will be used in place of the user's server # -# in WHOIS, when a user is WHOISed by a non-oper. # -# For example, most nets will want to set this to # -# something like '*.netname.net' to conceal the # -# actual server the user is on. # -# # -# flatlinks - When you are using m_spanningtree.so, and this # -# value is set to true, yes or 1, /MAP and /LINKS # -# will be flattened when shown to a non-oper. # -# # -# hideulines - When you are using m_spanningtree.so, and this # -# value is set to true, yes or 1, then U-lined # -# servers will be hidden in /LINKS and /MAP. For non # -# opers. Please be aware that this will also hide # -# any leaf servers of a U-lined server, e.g. jupes. # -# # -# tempdir - If defined, indicates a path where modules will be # -# temporarily copied before loading. If not defined, # -# defaults to /tmp. # -# # - -<options prefixquit="Quit: " - loglevel="default" - netbuffersize="10240" - maxwho="128" - noservices="0" - somaxconn="128" - softlimit="128" - operonlystats="oclgkz" - customversion="" - maxtargets="20" - hidesplits="no" - hidewhois="" - flatlinks="no" - hideulines="no" - allowhalfop="yes"> - - - -#-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# These tags define which modules will be loaded on startup by your # -# server. Add modules without any paths. When you make your ircd # -# using the 'make' command, all compiled modules will be moved into # -# the folder you specified when you ran ./configure. The module tag # -# automatically looks for modules in this location. # -# If you attempt to load a module outside of this location, either # -# in the config, or via /LOADMODULE, you will receive an error. # -# # -# By default, ALL modules are commented out. You must uncomment them # -# or add lines to your config to load modules. Please refer to # -# http://www.inspircd.org/wiki/Modules_List for a list of modules and# -# each modules link for any additional conf tags they require. # -# # -# WINDOWS USERS PLEASE NOTE: You can still load these modules! They # -# are incorporated into the executable and can be loaded and removed # -# similarly to if they were in a ramdisk. # -# ____ _ _____ _ _ ____ _ _ _ # -# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | # -# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | # -# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| # -# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) # -# # -# To link servers to InspIRCd, you MUST load the m_spanningtree # -# module, as shown below. If you DO NOT do this, server links will # -# NOT work at all. ie. The ports will NOT bind, and /connect will not # -# work properly. This is by design, to allow for the implementation # -# of other linking protocols in modules in the future. # - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Spanning Tree module - allows linking of servers using the spanning -# tree protocol (see the READ THIS BIT section above). -# -#<module name="m_spanningtree.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Alias module: Allows you to define server-side command aliases -#<module name="m_alias.so"> -# -#-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# If you have the m_alias.so module loaded, you may also define # -# aliases as shown below. They are commonly used to provide shortcut # -# commands to services, however they are not limited to jsut this use.# -# An alias tag requires the following values to be defined in it: # -# # -# text - The text to detect at the start of the line, # -# must be at the start of the line to trigger the # -# alias. May contain spaces, but case insensitive. # -# replace - The text to replace 'text' with. Usually this # -# will be "PRIVMSG ServiceName" or similar. # -# requires - If you provide a value for 'requires' this means # -# the given nickname MUST be online for the alias # -# to successfully trigger. If they are not, then # -# the user receives a 'no such nick' 401 numeric. # -# uline - Defining this value with 'yes', 'true' or '1' # -# will ensure that the user given in 'requires' # -# must also be on a u-lined server, as well as # -# actually being on the network. If the user is # -# online, but not on a u-lined server, then an # -# oper-alert is sent out as this is possibly signs # -# of a user trying to impersonate a service. # -# # -#<alias text="NICKSERV" replace="PRIVMSG NickServ" requires="NickServ" uline="yes"> -#<alias text="CHANSERV" replace="PRIVMSG ChanServ" requires="ChanServ" uline="yes"> -#<alias text="NS" replace="PRIVMSG NickServ" requires="NickServ" uline="yes"> -#<alias text="CS" replace="PRIVMSG ChanServ" requires="ChanServ" uline="yes"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Antibottler module: Labels bottler leech bots -#<module name="m_antibottler.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Ban except module: Adds support for channel ban exceptions (+e) -#<module name="m_banexception.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Block amsg module: Attempt to block all usage of /amsg and /ame -#<module name="m_blockamsg.so"> -# -#-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# -# # -# If you have the m_blockamsg.so module loaded, you can configure it # -# with the <blockamsg> tag: # -# # -# delay - How many seconds between two messages to force # -# them to be recognised as unrelated. # -# action - Any of 'notice', 'noticeopers', 'silent', 'kill' # -# or 'killopers'. Define how to take action when # -# a user uses /amsg or /ame. # -# -#<blockamsg delay="3" action="killopers"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Block colour module: Blocking colour-coded messages with cmode +c -#<module name="m_blockcolor.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Botmode module: Adds the user mode +B -#<module name="m_botmode.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# CBAN module: Lets you disallow channels from being used at runtime. -#<module name="m_cban.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Censor module: Adds the channel mode +G -#<module name="m_censor.so"> -# -#-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# -# # -# Optional - If you specify to use the m_censor module, then specfiy # -# below the path to the censor.conf file. See also: # -# Censor file, see http://www.inspircd.org/wiki/Censor_Module # -# -#<censor file="/path/to/censor.conf"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Channel filter module: Allows channel-op defined message -# filtering using simple string matches (channel mode +g) -#<module name="m_chanfilter.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Chanprotect module: gives +q and +a channel modes -#<module name="m_chanprotect.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# CHGHOST module: Adds the /CHGHOST command -#<module name="m_chghost.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# CHGIDENT module: Adds the /CHGIDENT command -#<module name="m_chgident.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Cloaking module: Adds usermode +x and cloaking support -#<module name="m_cloaking.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Conn-Lusers: Shows the LUSERS output on connect -#<module name="m_conn_lusers.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Conn-Wait-for-Pong: Don't let a user connect until they PONG -#<module name="m_conn_waitpong.so"> -# -#-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# -# # -# If you have the m_conn_waitpong.so module loaded, configure it with # -# the <waitpong> tag: # -# # -# sendsnotice - Whether to send a snotice on connect, like Unreal# -# killonbadreply - Whether to kill the user if they send the wrong # -# PONG reply. # -# -#<waitpong sendsnotice="yes" killonbadreply="yes"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Deny Channels: Deny Channels from being used by users -#<module name="m_denychans.so"> -# -#-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-# -# # -# If you have the m_denychans.so module loaded, you need to specify # -# the channels to deny: -# # -# name - The channel name to deny. # -# allowopers - If operators are allowed to override the deny. # -# reason - Reason given for the deny. # -# -#<badchan name="#gods" allowopers="yes" reason="Tortoises!"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Devoice Module: Let users devoice themselves. -#<module name="m_devoice.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Filter module: Provides glob-based message filtering -#<module name="m_filter.so"> -#OR -# PCRE filter module: Filters messages using regular expressions -#<module name="m_filter_pcre.so"> -# -#-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# -# # -# Optional - If you specify to use the m_filter or m_filter_pcre # -# modules, then specfiy below the path to the filter.conf file. # -# -#<filter file="/path/to/inspircd/filter.conf"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Foobar module - does nothing - historical relic -#<module name="m_foobar.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Globops module: gives /GLOBOPS and usermode +g -#<module name="m_globops.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Global load module: Allows loading and unloading of modules network- -# wide (USE WITH EXTREME CAUTION!) -#<module name="m_globalload.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# HELPOP module: Provides the /HELPOP command -#<module name="m_helpop.so"> -# -#-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# -# # -# Optional - If you specify to use the m_helpop.so module, then # -# specify below the path to the helpop.conf file. # -# -#<helpop file="/path/to/inspircd/helpop.conf"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Hostchange module: Allows a different style of cloaking -#<module name="m_hostchange.so"> -# -#-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-# -# # -# Optional - If you choose to use the m_hostchange.so module. # -# Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module # -# -#<host suffix="polarbears.org"> -#<hostchange mask="*@fbi.gov" action="addnick"> -#<hostchange mask="*r00t@*" action="suffix"> -#<hostchange mask="a@b.com" action="set" value="blah.blah.blah"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Ident: Provides RFC 1413 ident lookup support -#<module name="m_ident.so"> -# -#-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# -# # -# Optional - If you are using the m_ident.so module, then you can # -# specify the timeout for ident lookups here. If not defined, it will # -# default to one second. This is a non-blocking timeout which holds # -# the user in a 'connecting' state until the lookup is complete. # -# -#<ident timeout="5"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Invite except module: Adds support for channel invite exceptions (+I) -#<module name="m_inviteexception.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Join flood module: Adds support for join flood protection (+j) -#<module name="m_joinflood.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J) -#<module name="m_kicknorejoin.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Knock module: adds the /KNOCK command and +K channel mode -#<module name="m_knock.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Msg flood module: Adds message/notice flood protection (+f) -#<module name="m_messageflood.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Nicklock module: Let opers change a user's nick and then stop that -# user from changing their nick again. /NICKLOCK and /NICKUNLOCK -#<module name="m_nicklock.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No ctcp module: Adds the channel mode +C to block CTCPs -#<module name="m_noctcp.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Noinvite module: Gives channel mode +V -#<module name="m_noinvite.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No kicks module: Adds the +Q channel mode -#<module name="m_nokicks.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No nicks module: Adds the +N channel mode -#<module name="m_nonicks.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No Notice module: adds the channel mode +T -#<module name="m_nonotice.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper channels mode: Adds the +O channel mode -#<module name="m_operchans.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper Join module: Forces opers to join a channel on oper-up -#<module name="m_operjoin.so"> -# -#-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# -# # -# If you are using the m_operjoin.so module, specify the channel here # -# -#<operjoin channel="#channel"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper MOTD module: Provides support for seperate message of the day -# on oper-up -#<module name="m_opermotd.so"> -# -#-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# -# # -# If you are using the m_opermotd.so module, specify the motd here # -# -#<opermotd file="/path/to/oper.motd"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Override module: Adds support for oper override -#<module name="m_override.so"> -# -#-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# -# # -# m_override.so is too complex it describe here, see the wiki: # -# http://www.inspircd.org/wiki/Oper_Override_Module # - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper levels module: Gives each oper a level and prevents -# actions being taken against higher level opers -# Specify the level as the 'level' parameter of the <type> tag -#<module name="m_operlevels.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper MD5 module: Allows MD5 hashed oper passwords -#<module name="m_opermd5.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper SHA256 module: Allows SHA256 hashed oper passwords -# This module is in src/modules/extra -#<module name="m_opersha256.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper modes module: Allows you to specify modes to add/remove on oper -# Specify the modes as the 'modes' parameter of the <type> tag -#<module name="m_opermodes.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Parking module: Adds parking support and /PARK and /UNPARK -#<module name="m_park.so"> -# -#-#-#-#-#-#-#-#-#-#-#-# PARK CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# -# # -# m_park.so is too complex it describe here, see the wiki: # -# http://www.inspircd.org/wiki/User_Parking_Module # - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Random Quote module: provides a random quote on connect -#<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="/path/to/inspircd/randquotes.conf"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Redirect module: Adds channel redirection (mode +L) -#<module name="m_redirect.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Remove module: Adds the /REMOVE command which is a peaceful -# alternative to /KICK -#<module name="m_remove.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Restricted channels module: Allows only opers to create channels -#<module name="m_restrictchans.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Restrict message module: Allows users to only message opers -#<module name="m_restrictmsg.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SAJOIN module: Adds the /SAJOIN command -#<module name="m_sajoin.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SAMODE module: Adds the oper /SAMODE command -#<module name="m_samode.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SANICK module: Allows opers to change user's nicks -#<module name="m_sanick.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SAPART module: Adds the oper /SAPART command -#<module name="m_sapart.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SAQUIT module: Adds the oper /SAQUIT command (abusable!!!) -#<module name="m_saquit.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Set Idle module: Adds a command for opers to change their -# idle time (mainly a toy) -#<module name="m_setidle.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Services support module: Adds several usermodes such as +R and +M -#<module name="m_services.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Sethost module: Adds the /SETHOST command -#<module name="m_sethost.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Setident module: Adds the /SETIDENT command -#<module name="m_setident.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SETNAME module: Adds the /SETNAME command -#<module name="m_setname.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Show Whois module: Adds the +W usermode which allows opers -# to see when they are whois'ed -#<module name="m_showwhois.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Spy module: Adds the commands SPYLIST and SPYNAMES that let opers -# see who is in a +s channel, and list +s channels, show keys of keyed -# channels the oper is not a member of etc. (standard 'abusive' features -# of unrealircd, modulized here in InspIRCd). -#<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://www.inspircd.org/wiki/GnuTLS_SSL_Module # - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# 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://www.inspircd.org/wiki/OpenSSL_SSL_Module # - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Strip colour module: Adds the channel mode +S -#<module name="m_stripcolor.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SILENCE module: Adds support for /SILENCE -#<module name="m_silence.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SQL module: Allows other SQL modules to access SQL databases -# through a unified API. You must copy the source for this module -# from the directory src/modules/extra -#<module name="m_sql.so"> -# -#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# m_sql.so is more complex than described here, see the wiki for more:# -# http://www.inspircd.org/wiki/SQL_Service_Provider_Module # -# -#<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="1"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SQL authentication module: Allows IRCd connections to be tied into -# a database table (for example a forum). You must copy the source for -# this module from the directory src/modules/extra -#<module name="m_sqlauth.so"> -# -#-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# -# # -# m_sqlauth.so is too complex it describe here, see the wiki: # -# http://www.inspircd.org/wiki/SQL_Authentication_Module # - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SQL logging module: Allows you to log network-wide data for your -# network in a fully normalized set of SQL tables. You must copy the -# source for this module from the directory src/modules/extra -#<module name="m_sqllog.so"> -# -#-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# -# # -# dbid - Database ID to use (see m_sql) # -# # -# See also: http://www.inspircd.org/wiki/SQL_Logging_Module # -# # -#<sqllog dbid="1"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SQL oper module: Allows you to store oper credentials in an SQL table -# You must copy the source for this module from the directory src/modules/extra -#<module name="m_sqloper.so"> -# -#-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# -# # -# dbid - Database ID to use (see m_sql) # -# # -# See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module # -# # -#<sqloper dbid="1"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SWHOIS module: Allows you to add arbitary lines to user WHOIS. -#<module name="m_swhois.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Test command module: Does nothing significant. Read: pointless. -#<module name="m_testcommand.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Timed bans module: Adds timed bans and the /TBAN command -#<module name="m_timedbans.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Uninvite module: Adds the /UNINVITE command which lets users remove -# pending invites from channels without waiting for the user to join. -#<module name="m_uninvite.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Userip module: Adds the /USERIP command -#<module name="m_userip.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Vhost module: Adds the VHOST command which allows for adding virtual -# hosts which are accessible using a username and password in the config. -#<module name="m_vhost.so"> -# -#-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# user - Username for the vhost. # -# # -# pass - Password for the vhost. # -# # -# host - Vhost to set. # -# -#<vhost user="some_username" pass="some_password" host="some.host"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Watch module: Adds the WATCH command, which is used by clients to -# maintain notify lists. -#<module name="m_watch.so"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# The ban tags define nick masks, host masks and ip ranges which are # -# banned from your server. All details in these tags are local to # -# Your server. # -# # -# # -# badip lines ban an ip range (same as a zline) # -# # -# ipmask - The ip range to ban (wildcards possible) # -# reason - Reason to display when disconnected # -# # -# badnick lines ban a nick mask (same as a qline) # -# # -# nick - Nick mask to ban (wildcards possible) # -# reason - Reason to display on /NICK # -# # -# badhost lines ban a user@host mask (same as a kline) # -# # -# host - ident@hostname (wildcards possible) # -# reason - Reason to display on disconnection # -# # -# exception lines define a hostmask that is excempt from [kzg]lines # -# # -# host - ident@hostname (wildcards possible) # -# reason - Reason, shown only in /stats e # -# # - -<badip ipmask="69.69.69.69" reason="No porn here thanks."> - -<badnick nick="ChanServ" reason="Reserved For Services"> -<badnick nick="NickServ" reason="Reserved For Services"> -<badnick nick="OperServ" reason="Reserved For Services"> -<badnick nick="MemoServ" reason="Reserved For Services"> - -<badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots"> -<badhost host="*@localhost" reason="No irc from localhost!"> - -<exception host="*@ircop.host.com" reason="Opers hostname"> - -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# # -# You should already know what to do here :) # - -<die value="You should probably edit your config *PROPERLY* and try again."> - - -######################################################################### -# # -# - InspIRCd Development Team - # -# http://www.inspircd.org # -# # -######################################################################### diff --git a/docs/inspircd.filter.example b/docs/inspircd.filter.example deleted file mode 100644 index 99e133256..000000000 --- a/docs/inspircd.filter.example +++ /dev/null @@ -1,24 +0,0 @@ -# Configuration file for m_filter.so (2.0.0.0) -# C.J.Edwards April 2004. -# - -# The tags for this module are formatted as follows: -# -# <keyword pattern="any glob pattern here" -# reason="reason for filtering" -# action="action to take"> -# -# 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. -# -# 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. - -<keyword pattern="*qwerty*" reason="You qwertied!" action="block"> -<keyword pattern="*killmenow*" reason="As you request." action="kill"> - diff --git a/docs/inspircd.helpop-full.example b/docs/inspircd.helpop-full.example deleted file mode 100644 index d0f621d63..000000000 --- a/docs/inspircd.helpop-full.example +++ /dev/null @@ -1,506 +0,0 @@ -##################### -# Helpop Standard # -##################### - -<start line1=" InspIRCd help system" - line2=" --------------------" - line3="-" - line4="This system provides help for commands and modes." - line5="Specify your question or a command name as the" - line6="parameter for this command. If you are an oper" - line7="you must prefix your query with a ? symbol." - line8="-" - line9="/HELPOP COMMANDS - To see a list of user commands" - line10="/HELPOP COPER - To see a list of oper commands" - line11="/HELPOP UMODES - To see a list of user modes" - line12="/HELPOP CHMODES - To see a list of channel modes"> - -<nohelp line1="There is no help for the topic" - line2="You searched for. Please try again."> - -<nohelpo line1="There is no help for the topic" - line2="You searched for. Please try again." - line3="-" - line4="Your Query has been forwarded to the IRCops"> - -##################### -# User Commands # -##################### - -<commands line1="User Commands" - line2="-------------" - line3="USER NICK QUIT VERSION PING" - line4="PONG ADMIN PRIVMSG INFO TIME" - line5="WHOIS NOTICE JOIN NAMES PART" - line6="KICK MODE TOPIC WHO MOTD" - line7="RULES OPER LIST LUSERS STATS" - line8="USERHOST AWAY ISON SUMMON USERS" - line9="INVITE PASS WHOWAS LINKS MAP" - line10="COMMANDS MODULES KNOCK SILENCE DEVOICE" - line11="REMOVE PARK UNPARK UNINVITE VHOST" - line12="WATCH USERIP"> - -<watch line1="/WATCH [C|S|+/-[NICK]]" - line2="Adds or deletes a user from the watch list. C clears the list" - line3="and S queries the status."> - -<vhost line1="/VHOST [username] [password]" - line2="Authenticate for a vhost."> - -<park line1="/PARK" - line2="Parks the nickname which issues the command. The session's" - line3="connection is closed, but the session remains as a ghost, to" - line4="be reclaimed later. When the user quits, they will be given a" - line5="key which is random."> - -<unpark line1="/UNPARK [nickname] [key]" - line2="Unparks the nickname specified. The nickname must already" - line3="be previously parked, and the key must match the one for" - line4="this nickname."> - -<kick line1="/REMOVE [channel] [nick] {[reason]}" - line2="Removes a user from a channel you specify. You must be" - line3="At least a channel halfoperator to remove a user." - line4="A removed user will part with a message stating they" - line5="were removed from the channel and by whom."> - -<devoice line1="/DEVOICE [channel]" - line2="Devoices yourself from the specified channel."> - -<silence line1="/SILENCE +/-[nick]" - line2="A serverside /ignore of the given nick. It does not follow" - line3="the users nick so if they change their nick you will recieve" - line4="their messages. /SILENCE without a parameter will list the nicks" - line5="that you have silenced."> - -<knock line1="/KNOCK [channel]" - line2="Sends a notice to a channel indicating you wish to join."> - -<user line1="/USER [ident] [local host] [remote host] :[GECOS]" - line2="This command is used by your client to register your irc session." - line3="You should not use it during an established connection."> - -<nick line1="/NICK [new nick]" - line2="Change your nickname to [new nick]."> - -<quit line1="/QUIT [reason]" - line2="Quit from IRC and end your current session."> - -<version line1="/VERSION" - line2="Returns the server's version number."> - -<ping line1="/PING [server]" - line2="Ping a server. Target server will answer with a PONG."> - -<pong line2="/PONG [server]" - line2="Your client should send this to answer server PINGs. You" - line3="should not issue this command manually."> - -<admin line1="/ADMIN [server]" - line2="Fetches the administrative information on the given server."> - -<privmsg line1="/MSG [target] [text]" - line2="Sends a message to a user or channel specified in [target]."> - -<notice line1="/NOTICE [target] [text]" - line2="Sends a notice to a user or channel specified in [target]."> - -<join line1="/JOIN [channel]{,[channel]} [key]{,[key]}" - line2="Joins one or more channels you provide the names for."> - -<names line1="/NAMES [channel]{,[channel]}" - line2="Return a list of users on the channels you provide."> - -<part line1="/PART [channel]{,[channel] [reason]}" - line2="Leaves one or more channels you specify."> - -<kick line1="/KICK [channel] [nick] {[reason]}" - line2="Kicks a user from a channel you specify. You must be" - line3="At least a channel halfoperator to kick a user."> - -<mode line1="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}" - line2="Sets the mode for a channel or a nickname specified in [target]" - line3="A user may only set modes upon themselves, and may not set the" - line4="+o usermode, and a user may only change channel modes of" - line5="channels where they are at least a halfoperator."> - -<topic line1="/TOPIC [channel] {topic}" - line2="Sets or retrieves the channel topic. If a channel topic is" - line3="given in teh command and the channel is either not +t, or" - line4="You are at least a halfoperator, the channel topic will be" - line5="changed to the new one you provide."> - -<who line1="/WHO [channel|nick|servermask|o 0]" - line2="Looks up the information of users matching the range you" - line3="provide. You may only /WHO nicknames in channels or on servers" - line4="where you share a common channel with them." - line5="The syntax '/WHO o 0' shows a list of online IRC operators."> - -<motd line1="/MOTD [server]" - line2="Show the message of the day for [server]. Messages of the" - line3="day contain important server rules and notice and should be" - line4="read before using a server in any way!"> - -<rules line1="/RULES" - line2="Show the rules file for the local server. This is similar in" - line3="effect to /MOTD except that rules are optional. All users are" - line4="sent the MOTD when they connect without having to request it."> - -<oper line1="/OPER [login] [password]" - line2="Attempts to authenticate a user as an IRC operator." - line3="Please be aware that both successful and unsucessful oper attempts" - line4="Are logged, and sent to online IRC operators."> - -<list line1="/LIST [pattern]" - line2="Creates a list of all existing channels matching the glob pattern" - line3="[pattern], e.g. *chat* or bot*."> - -<lusers line1="/LUSERS" - line2="Shows a count of local and remote users, servers and channels."> - -<userhost line1="/USERHOST [nickname]" - line2="Returns the hostname and nickname of a user, and some other" - line3="miscellanious information."> - -<userip line1="/USERIP [nickname]" - line2="Returns the ip and nickname of a user." - -<away line1="/AWAY {message}" - line2="If a message is given, marks you as being away, otherwise" - line3="removes your away status and previous message."> - -<ison line1="/ISON [nick] {[nick]...}" - line2="Returns a subset of the nicks you give, showing only those" - line3="that are currently online."> - -<summon line1="/SUMMON [user]" - line2="Summons a user from the shell where the ircd is running onto irc" - line3="This command is deprecated in the current protocol."> - -<users line1="/USERS" - line2="Shows users logged into the shell where the ircd is running." - line3="This command is deprecated in the current protocol."> - -<invite line1="/INVITE [nick] [channel]" - line2="Invites a user to a channel. If the channel is NOT +i, any" - line3="user, channel op or not, may invite any other user to the" - line4="channel, so long as they are a member of that channel." - line5="Otherwise, if +i is set only channel halfoperators" - line6="and above may invite users into the channel."> - -<pass line1="/PASS [password]" - line2="This command is used by your irc client when setting up" - line3="your irc session, and should not be issued by a fully" - line4="connected client."> - -<whowas line1="/WHOWAS [nick]" - line2="Returns a list of times the user was last seen on irc" - line3="along with the time they were last seen and their server."> - -<links line1="/LINKS" - line2="Shows all servers linked to this one. Note that in this" - line3="server implementation all links will be flattened as" - line4="a tree based layout is not in use."> - -<map line1="/MAP" - line2="Shows a graphical representation of all users and servers" - line3="on the network. The tree diagram is inaccurate in this" - line4="implementation as a tree based network is not in place."> - -##################### -# Oper Commands # -##################### - -<coper line1="Oper Commands" - line2="-------------" - line3="DIE RESTART KILL REHASH TRACE" - line4="CONNECT SQUIT MODULES MKPASSWD SHUN" - line5="KLINE QLINE GLINE ELINE ZLINE" - line6="SAJOIN SAPART SAMODE SAQUIT SANICK" - line7="SETIDLE SETHOST SETNAME SETIDENT SWHOIS" - line8="OPERMOTD CHGHOST CHGNAME CHGIDENT CBAN" - line9="NICKLOCK NICKUNLOCK LOADMODULE UNLOADMODULE GLOBOPS" - line10="SPYLIST SPYNAMES GLOADMODULE GUNLOADMODULE MKSHA256" - line11="PARKSTATS FREEZE UNFREEZE OPERPERMS RCONNECT"> - -<rconnect line1="/RCONNECT [source mask] [target mask]" - line2="All servers matching [source mask] will try to connect to" - line3="the first server in the config file matching [target mask]."> - -<operperms line1="/OPERPERMS [nick]" - line2="List all commands an oper has access to use."> - -<freeze line1="/FREEZE [nick]" - line2="Prevents the user from sending commands until they reconnect." - line3="User is also notified they have been frozen."> - -<unfreeze line1="/UNFREEZE [nick]" - line2="Unfreezes a user frozen by the /FREEZE command."> - -<parkstats line1="/PARKSTATS" - line2="Displays the park module's statistics"> - -<spylist line1="/SPYLIST" - line2="Operates the same as /LIST but includes +s and +p channels."> - -<spynames line1="/SPYNAMES [channel]" - line2="Operates the same as /name but works on +s and +p channels."> - -<globops line1="/GLOBOPS [message]" - line2="Sends a message to all +g users."> - -<cban line1="/CBAN [channel] {[duration] :[reason]}" - line2="Sets or removes a channel ban. You must specify at least" - line3="3 parameters to add a ban, and one parameter to remove a ban." - line4="The duration may be specified in seconds, or in the following format" - line5="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours," - line6="5 minutes and 6 seconds. All fields in this format are optional."> - -<sajoin line1="/SAJOIN [nick] [channel]" - line2="Forces the user to join the channel."> - -<sapart line1="/SAPART [nick] [channel]" - line2="Forces the user to part the channel."> - -<samode line1="/SAMODE [#chan/nick] +/-[modes] {[parameters for modes]}" - line2="Gives the channel or nick the modes specified."> - -<sanick line1="/SANICK [nick] [new nick]" - line2="Changes the users nick to the new nick."> - -<saquit line1="/SAQUIT [nick] [reason]" - line2="Forces user to quit with the specified reason."> - -<setidle line1="/SETIDLE [idle time]" - line2="Sets your idle time (in seconds)."> - -<sethost line1="/SETHOST [host]" - line2="Sets your host to the specified host."> - -<setident line1="/SETIDENT [ident]" - line2="Sets your ident to the specified ident."> - -<setname line1="/SETNAME [name]" - line2="Sets your name to the specified name."> - -<swhois line="/SWHOIS [nick] [swhois]" - line2="Sets the users swhois field to the given swhois."> - -<mkpasswd line1="/MKPASSWD [plaintext]" - line2="Encodes the plaintext to an MD5 hash and displays the result."> - -<mksha256 line1="/MKSHA256 [plaintext]" - line2="Encodes the plaintext to an SHA-256 hash and displays the result."> - -<opermotd line1="/OPERMOTD" - line2="Re-displays the Oper MOTD."> - -<nicklock line1="/NICKLOCK [nick] [new nick]" - line2="Changes user's nick to the new nick, and forces" - line3="it to remain as such for the remainder of the session."> - -<nickunlock line1="/NICKUNLOCK [nick]" - line2="Allows the user to change nicks."> - -<chghost line1="/CHGHOST [nickname] [new hostname]" - line2="Changes the hostname of the user to the new hostname>."> - -<chgname line1="/CHGNAME [nickname] [new name]" - line2="Changes the name of the user to the new name>."> - -<chgident line1="/CHGIDENT [nickname] [new ident]" - line2="Changes the ident of the user to the new ident."> - -<shun line1="/SHUN [user@host] {[duration] :[reason]}" - line2="Sets or removes a shun (serverside ignore) on a host and ident mask." - line3="You must specify at least 3 parameters to add a shun, and one" - line4="parameter to remove a shun (just the user@host section)." - line5="The duration may be specified in seconds, or in the following format" - line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours," - line7="5 minutes and 6 seconds. All fields in this format are optional."> - -<die line1="/DIE [password]" - line2="If the correct password is provided, and you are an operator," - line3="This command will shut down the local server."> - -<restart line1="/RESTART [password]" - line2="If the correct password is provided, and you are an operator," - line3="This command will restart the local server."> - -<commands line1="/COMMANDS" - line2="Shows all currently available commands."> - -<kill line1="/KILL [user] [reason]" - line2="This command will disconnect a user from IRC with the given reason."> - -<rehash line1="/REHASH" - line2="This command will cause the server configuration file to be" - line3="re-read and values re-initialised."> - -<trace line1="/TRACE [nick|user@host|servermask]" - line2="This command will provide a list of all users and servers which" - line3="must be passed through or over to reach a given object (server or user)."> - -<connect line1="/CONNECT [servermask]" - line2="Create a mesh connection to the given servermask. You must have" - line3="configured the server for linking in your configuration file," - line4="and provided a password."> - -<squit line1="/SQUIT" - line2="Disconnects the local server from the mesh network, causing every" - line3="other server in the mesh to drop it."> - -<modules line1="/MODULES" - line2="Lists currently loaded modules, their memory offsets and version" - line3="numbers and flags. If you are not an operator, you will see reduced" - line4="detail."> - -<loadmodule line1="/LOADMODULE [filename.so]" - line2="Loads a module into the IRCd."> - -<unloadmodule line1="/UNLOADMODULE [filename.so]" - line3="Unloads a module from the IRCd. The module cannot have the static" - line4="flag set (see the output of /MODULES)."> - -<gloadmodule line1="/GLOADMODULE [filename.so]" - line2="Globally loads a module into the network."> - -<gunloadmodule line1="/GUNLOADMODULE [filename.so]" - line3="Globally unloads a module from the network. The module cannot " - line4="have the static flag set (see the output of /MODULES)."> - -<kline line1="/KLINE [user@host] {[duration] :[reason]}" - line2="Sets or removes a k-line (host based ban) on a host and ident mask." - line3="You must specify at least 3 parameters to add a ban, and one" - line4="parameter to remove a ban (just the user@host section)." - line5="The duration may be specified in seconds, or in the following format" - line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours," - line7="5 minutes and 6 seconds. All fields in this format are optional."> - -<zline line1="/ZLINE [ipmask] {[duration] :[reason]}" - line2="Sets or removes a z-line (ip based ban) on an ip range mask." - line3="You must specify at least 3 parameters to add a ban, and one" - line4="parameter to remove a ban (just the user@host section)." - line5="The duration may be specified in seconds, or in the following format" - line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours," - line7="5 minutes and 6 seconds. All fields in this format are optional."> - -<qline line1="/QLINE [nickmask] {[duration] :[reason]}" - line2="Sets or removes a q-line (nick based ban) on a nick mask." - line3="You must specify at least 3 parameters to add a ban, and one" - line4="parameter to remove a ban (just the user@host section)." - line5="The duration may be specified in seconds, or in the following format" - line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours," - line7="5 minutes and 6 seconds. All fields in this format are optional."> - -<gline line1="/GLINE [user@host] {[duration] :[reason]}" - line2="Sets or removes a g-line (global host based ban) on host mask." - line3="You must specify at least 3 parameters to add a ban, and one" - line4="parameter to remove a ban (just the user@host section)." - line5="The duration may be specified in seconds, or in the following format" - line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours," - line7="5 minutes and 6 seconds. All fields in this format are optional."> - -<eline line1="/ELINE [user@host] {[duration] :[reason]}" - line2="Sets or removes a e-line (local ban exception) on host mask." - line3="You must specify at least 3 parameters to add an exception, and one" - line4="parameter to remove an exception (just the user@host section)." - line5="The duration may be specified in seconds, or in the following format" - line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours," - line7="5 minutes and 6 seconds. All fields in this format are optional."> - -###################### -# User/Channel Modes # -###################### - -<umodes line1="User Modes" - line2="----------" - line3="o Is an IRC operator" - line4="i Is invisible to /WHO" - line5="w Can receive wallops messages" - line6="s Can receive server notices" - line7="x Cloaked hostname (requires cloaking module)" - line8="g Can receive globops (requires globops module)" - line9="h Will receive helpops notification (requires helpop module)" - line10="r Nickname is registered" - line11="R Only registered users can PRIVMSG this nickname" - line12="B Is a bot" - line13="G Messages are censored to user" - line14="W Can see when a user uses WHOIS on them" - line15="S mIRC colour codes are stripped to the user" - line16="D User can not recieve PRIVMSGs"> - -<chmodes line1="Channel Modes" - line2="-------------" - line3="v [nickname] Gives voice to [nickname] (can talk on +m channel)" - line4="h [nickname] Gives halfops to [nickname]" - line5="o [nickname] Gives ops to [nickname]" - line6="b [hostmask] Bans [hostmask] on the channel" - line7="a [nickname] Give protected status to [nickname] (+q only)" - line8="q [nickname] Give founder status to [nickname] (ulines only)" - line9="i Make the channel invite only, must /INVITE users" - line10="k [key] Set the channel key (password) to [key]" - line11="l [limit] Set the maximum possible users to [limit]" - line12="m Enable moderation. Only +vo(h) can speak" - line13="n Only users who are members of the channel may message it" - line14="p Make channel private (hide from /LIST)" - line15="s Make channel secret (can't be used at the same time as +p)" - line16="O Channel is IRCops only (can only be set by IRCops)" - line17="t Only halfops and above can change the topic" - line18="Q Only U-Lined servers/nicks can kick" - line19="T Only halfops/ops can send NOTICEs to the channel" - line20="C No CTCPs allowed to the channel" - line21="c mIRC colour codes blocked on the channel" - line22="S mIRC colour codes are stripped from the channel" - line23="e [hostmask] Ban exception on [hostmask]" - line24="K No /KNOCK allowed to channel" - line25="L [channel] If the channel is full, redirect users to [channel]" - line26="N No nickchanges while on the channel" - line27="G Censors channel based on network censor config" - line28="g [word] All messages containing the word are blocked" - line29="I [hostmask] Invite exception allows user to join a channel with +i" - line30="j [joins]:[sec] Prevents join flooding" - line31="J [seconds] Prevents auto-rejoin on kick" - line32="f [*][lines]:[sec] Kick on text flood. With * user is banned" - line33="V No invites allowed" - line34="r Channel is registered" - line35="R Only registered users can join" - line36="M Non-registered users can't chat" - line37="z SSL clients only" - line38="x Join exception mask. Avoids +ibkO" - line39="-------------" - line40="NOTE: A large number of these modes are dependent upon server-side modules" - line41="being loaded by a server/network administrator. The actual modes available" - line42="on your network may be very different to this list. Please consult your" - line43="help channel if you have any questions."> - -###################### -# Stats Symbols # -###################### - -<stats line1="/STATS [symbol]" - line2="Shows various server statistics. Depending on configuration this" - line3="command may be reserved for oper-only use." - line4="-" - line5="Valid symbols are:" - line6="-" - line7="m Show command statistics, number of times commands have been used" - line8="z Show memory usage statistics" - line9="o Show a list of all valid oper usernames and hostmasks" - line10="l Show all inbound and outbound server and client connections" - line11="u Show server uptime" - line12="k Show k-lines (local bans)" - line13="g Show g-lines (global bans)" - line14="q Show q-lines (nick mask bans)" - line15="Z Show z-lines (ip mask bans)" - line16="Y Show connection classes" - line17="C Show link blocks" - line18="U Show u-lined servers" - line19="P Show online opers and their idle times" - line20="I Show connect class permissions" - line21="e Show e-lines (local ban exemptions)" - line22="C Show channel bans" - line22="s Show shuns" - line22="-" - line23="Note that all /STATS use is broadcast to online IRC operators."> - diff --git a/docs/inspircd.helpop.example b/docs/inspircd.helpop.example deleted file mode 100644 index 34f47e2db..000000000 --- a/docs/inspircd.helpop.example +++ /dev/null @@ -1,328 +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 customise the responses for your network and/or add more. -# -# WARNING!!! Do not <include> this file into your main conf, use <helpop file> tag -# instead! There are tags in this file which will conflict with the main config, -# like <admin> and <server>, and if you include it directly, inspircd will complain! -# - -<start line1=" InspIRCd help system" - line2=" --------------------" - line3="-" - line4="This system provides help for commands and modes." - line5="Specify your question or a command name as the" - line6="parameter for this command. If you are an oper" - line7="you must prefix your query with a ? symbol." - line8="-" - line9="/HELPOP COMMANDS - To see a list of user commands" - line10="/HELPOP COPER - To see a list of oper commands" - line11="/HELPOP UMODES - To see a list of user modes" - line12="/HELPOP CHMODES - To see a list of channel modes"> - -<nohelp line1="There is no help for the topic" - line2="You searched for. Please try again."> - -<nohelpo line1="There is no help for the topic" - line2="You searched for. Please try again." - line3="-" - line4="Your Query has been forwarded to the IRCops"> - -<commands line1="User Commands" - line2="-------------" - line3="USER NICK QUIT VERSION PING" - line4="PONG ADMIN PRIVMSG INFO TIME" - line5="WHOIS NOTICE JOIN NAMES PART" - line6="KICK MODE TOPIC WHO MOTD" - line7="RULES OPER LIST LUSERS STATS" - line8="USERHOST AWAY ISON SUMMON USERS" - line9="INVITE PASS WHOWAS LINKS MAP" - line10="COMMANDS MODULES"> - -<user line1="/USER [ident] [local host] [remote host] :[GECOS]" - line2="This command is used by your client to register your irc session." - line3="You should not use it during an established connection."> - -<nick line1="/NICK [new nick]" - line2="Change your nickname to [new nick]"> - -<quit line1="/QUIT [reason]" - line2="Quit from IRC and end your current session"> - -<version line1="/VERSION" - line2="Returns the server's version number"> - -<ping line1="/PING [server]" - line2="Ping a server. Target server will answer with a PONG"> - -<pong line2="/PONG [server]" - line2="Your client should send this to answer server PINGs. You" - line3="should not issue this command manually."> - -<admin line1="/ADMIN [server]" - line2="Fetches the administrative information on the given" - line3="server."> - -<privmsg line1="/MSG [target] [text]" - line2="Sends a message to a user or channel specified in [target]"> - -<notice line1="/NOTICE [target] [text]" - line2="Sends a notice to a user or channel specified in [target]"> - -<join line1="/JOIN [channel]{,[channel]} [key]{,[key]}" - line2="Joins one or more channels you provide the names for"> - -<names line1="/NAMES [channel]{,[channel]}" - line2="Return a list of users on the channels you provide"> - -<part line1="/PART [channel]{,[channel]}" - line2="Leaves one or more channels you specify"> - -<kick line1="/KICK [channel] [nick]" - line2="Kicks a user from a channel you specify. You must be" - line3-"At least a channel halfoperator to kick a user"> - -<mode line1="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}" - line2="Sets the mode for a channel or a nickname specified in [target]" - line3="A user may only set modes upon themselves, and may not set the" - line4="+o usermode, and a user may only change channel modes of" - line5="channels where they are at least a halfoperator."> - -<topic line1="/TOPIC [channel] {topic}" - line2="Sets or retrieves the channel topic. If a channel topic is" - line3="given in teh command and the channel is either not +t, or" - line4="You are at least a halfoperator, the channel topic will be" - line5="changed to the new one you provide"> - -<who line1="/WHO [channel|nick|servermask|o 0]" - line2="Looks up the information of users matching the range you" - line3="provide. You may only /WHO nicknames in channels or on servers" - line4="where you share a common channel with them." - line5="The syntax '/WHO o 0' shows a list of online IRC operators."> - -<motd line1="/MOTD [server]" - line2="Show the message of the day for [server]. Messages of the" - line3="day contain important server rules and notice and should be" - line4="read before using a server in any way!"> - -<rules line1="/RULES" - line2="Show the rules file for the local server. This is similar in" - line3="effect to /MOTD except that rules are optional. All users are" - line4="sent the MOTD when they connect without having to request it."> - -<oper line1="/OPER [login] [password]" - line2="Attempts to authenticate a user as an IRC operator." - line3="Please be aware that both successful and unsucessful oper attempts" - line4="Are logged, and sent to online IRC operators"> - - -<list line1="/LIST [pattern]" - line2="Creates a list of all existing channels matching the glob pattern" - line3="[pattern], e.g. *chat* or bot*"> - -<lusers line1="/LUSERS" - line2="Shows a count of local and remote users, servers and channels."> - -<stats line1="/STATS [symbol]" - line2="Shows various server statistics. Depending on configuration this" - line3="command may be reserved for oper-only use." - line4="-" - line5="Valid symbols are:" - line6="-" - line7="m Show command statistics, number of times commands have been used" - line8="z Show memory usage statistics" - line9="o Show a list of all valid oper usernames and hostmasks" - line10="l Show all inbound and outbound server and client connections" - line11="u Show server uptime" - line12="k Show k-lines (local bans)" - line13="g Show g-lines (global bans)" - line14="q Show q-lines (nick mask bans)" - line15="Z Show z-lines (ip mask bans)" - line16="Y Show connection classes" - line17="C Show link blocks" - line18="U Show u-lined servers" - line19="P Show online opers and their idle times" - line20="I Show connect class permissions" - line21="e Show e-lines (local ban exemptions)" - line22="-" - line23="Note that all /STATS use is broadcast to online IRC operators."> - -<kline line1="/KLINE [user@host] {[duration] :[reason]}" - line2="Sets or removes a k-line (host based ban) on a host and ident mask." - line3="You must specify at least 3 parameters to add a ban, and one" - line4="parameter to remove a ban (just the user@host section)." - line5="The duration may be specified in seconds, or in the following format" - line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours," - line7="5 minutes and 6 seconds. All fields in this format are optional."> - -<zline line1="/ZLINE [ipmask] {[duration] :[reason]}" - line2="Sets or removes a z-line (ip based ban) on an ip range mask." - line3="You must specify at least 3 parameters to add a ban, and one" - line4="parameter to remove a ban (just the user@host section)." - line5="The duration may be specified in seconds, or in the following format" - line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours," - line7="5 minutes and 6 seconds. All fields in this format are optional."> - -<qline line1="/QLINE [nickmask] {[duration] :[reason]}" - line2="Sets or removes a q-line (nick based ban) on a nick mask." - line3="You must specify at least 3 parameters to add a ban, and one" - line4="parameter to remove a ban (just the user@host section)." - line5="The duration may be specified in seconds, or in the following format" - line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours," - line7="5 minutes and 6 seconds. All fields in this format are optional."> - -<gline line1="/GLINE [user@host] {[duration] :[reason]}" - line2="Sets or removes a g-line (global host based ban) on host mask." - line3="You must specify at least 3 parameters to add a ban, and one" - line4="parameter to remove a ban (just the user@host section)." - line5="The duration may be specified in seconds, or in the following format" - line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours," - line7="5 minutes and 6 seconds. All fields in this format are optional."> - -<eline line1="/ELINE [user@host] {[duration] :[reason]}" - line2="Sets or removes a e-line (local ban exception) on host mask." - line3="You must specify at least 3 parameters to add an exception, and one" - line4="parameter to remove an exception (just the user@host section)." - line5="The duration may be specified in seconds, or in the following format" - line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours," - line7="5 minutes and 6 seconds. All fields in this format are optional."> - -<userhost line1="/USERHOST [nickname]" - line2="Returns the hostname and nickname of a user, and some other" - line3="miscellanious information."> - -<away line1="/AWAY {message}" - line2="If a message is given, marks you as being away, otherwise" - line3="removes your away status and previous message"> - -<ison line1="/ISON [nick] {[nick]...}" - line2="Returns a subset of the nicks you give, showing only those" - line3="that are currently online."> - -<summon line1="/SUMMON [user]" - line2="Summons a user from the shell where the ircd is running onto irc" - line3="This command is deprecated in the current protocol."> - -<users line1="/USERS" - line2="Shows users logged into the shell where the ircd is running." - line3="This command is deprecated in the current protocol."> - -<invite line1="/INVITE [nick] [channel]" - line2="Invites a user to a channel. If the channel is NOT +i, any" - line3="user, channel op or not, may invite any other user to the" - line4="channel, so long as they are a member of that channel." - line5="Otherwise, if +i is set only channel halfoperators" - line6="and above may invite users into the channel"> - -<pass line1="/PASS [password]" - line2="This command is used by your irc client when setting up" - line3="your irc session, and should not be issued by a fully" - line4="connected client."> - -<whowas line1="/WHOWAS [nick]" - line2="Returns a list of times the user was last seen on irc" - line3="along with the time they were last seen and their server."> - -<links line1="/LINKS" - line2="Shows all servers linked to this one. Note that in this" - line3="server implementation all links will be flattened as" - line4="a tree based layout is not in use."> - -<map line1="/MAP" - line2="Shows a graphical representation of all users and servers" - line3="on the network. The tree diagram is inaccurate in this" - line4="implementation as a tree based network is not in place."> - - -<coper line1="Oper Commands" - line2="-------------" - line3="DIE RESTART KILL REHASH TRACE" - line4="CONNECT SQUIT MODULES KLINE ZLINE" - line5="QLINE GLINE ELINE"> - -<die line1="/DIE [password]" - line2="If the correct password is provided, and you are an operator," - line3="This command will shut down the local server."> - -<restart line1="/RESTART [password]" - line2="If the correct password is provided, and you are an operator," - line3="This command will restart the local server."> - -<commands line1="/COMMANDS" - line2="Shows all currently available commands."> - -<kill line1="/KILL [user] [reason]" - line2="This command will disconnect a user from IRC with the given" - line3="reason."> - -<rehash line1="/REHASH" - line2="This command will cause the server configuration file to be" - line3="re-read and values re-initialised."> - -<trace line1="/TRACE [nick|user@host|servermask]" - line2="This command will provide a list of all users and servers which" - line3="must be passed through or over to reach a given object (server" - line4="or user)"> - -<connect line1="/CONNECT [servermask]" - line2="Create a mesh connection to the given servermask. You must have" - line3="configured the server for linking in your configuration file," - line4="and provided a password."> - -<squit line1="/SQUIT" - line2="Disconnects the local server from the mesh network, causing every" - line3="other server in the mesh to drop it."> - -<modules line1="/MODULES" - line2="Lists currently loaded modules, their memory offsets and version" - line3="numbers and flags. If you are not an operator, you will see reduced" - line4="detail."> - -<loadmodule line1="/LOADMODULE [filename.so]" - line2="Loads a module into the IRCd."> - -<unloadmodule line1="/UNLOADMODULE [filename.so]" - line3="Unloads a module from the IRCd. The module cannot have the static" - line4="flag set (see the output of /MODULES)"> - -<umodes line1="User Modes" - line2="----------" - line3="o Is an IRC operator" - line4="i Is invisible to /WHO" - line5="w Can receive wallops messages" - line6="s Can receive server notices" - line7="x Cloaked hostname (requires cloaking module)" - line8="g Can receive globops (requires globops module)" - line9="h Will receive helpops notification (requires helpop module)"> - -<chmodes line1="Channel Modes" - line2="-------------" - line3="v [nickname] Gives voice to [nickname] (can talk on +m channel)" - line4="h [nickname] Gives halfops to [nickname] (requires halfop module)" - line5="o [nickname] Gives ops to [nickname]" - line6="b [hostmask] Bans [hostmask] on the channel" - line7="a [nickname] Give protected status to [nickname] (+q only)" - line8="q [nickname] Give founder status to [nickname] (ulines only)" - line9="i Make the channel invite only, must /INVITE users" - line10="k [key] Set the channel key (password) to [key]" - line11="l [limit] Set the maximum possible users to [limit]" - line12="m Enable moderation. Only +vo(h) can speak" - line13="n Only users who are members of the channel may message it" - line14="p Make channel private (hide from /LIST)" - line15="s Make channel secret (can't be used at the same time as +p)" - line16="O Channel is IRCops only (can only be set by IRCops)" - line17="t Only halfops and above can change the topic" - line18="Q Only U-Lined servers/nicks can kick" - line19="T Only halfops/ops can send NOTICEs to the channel" - line20="C No CTCPs allowed to the channel" - line21="c mIRC colour codes blocked on the channel" - line22="K No /KNOCK allowed to channel (if knock module is loaded)" - line23="L [channel] If the channel is full, redirect users to [channel]" - line24="N No nickchanges while on the channel" - line25="-------------" - line26="NOTE: A large number of these modes are dependent upon server-side modules" - line27="being loaded by a server/network administrator. The actual modes available" - line28="on your network may be very different to this list. Please consult your" - line29="help channel if you have any questions."> - - |