Author: Kev <klmitch@mit.edu>

[ircu2.10.12-pk.git] / doc / example.conf

diff --git a/doc/example.conf b/doc/example.conf
index 72f1a4908ed60f603793fd0b8c4f591fedbe3d33..588bc76d1e74ef075fb5ce446c1b4a1e6ff78382 100644 (file)
--- a/doc/example.conf
+++ b/doc/example.conf
@@ -185,6 +185,8 @@ I:*@193.37.*::*@*.london.ac.uk::10
 # It is possible to show a different Message of the Day to a connecting
 # client depending on its origin.
 # T:<hostmask>:<path to motd file>
+# or:
+# T:<classnumber>:<path to motd file>
 #
 # DPATH/net_com.motd contains a special MOTD where users are encouraged
 # to register their domains and get their own I: lines if they're in
@@ -248,6 +250,11 @@ K:unixbox.flooder.co.uk:!kline/youflooded.txt:*luser
 # even if an IP address has a properly resolving host name.
 k:192.168.*:!klines/martians:*
 
+# Additionally, you may specify a hostmask prefixed with $R to indicate
+# a match should be performed against the "real-name" / "info" field
+# instead of the host/IP.
+K:$R*sub7*:"You are infected with a Trojan":*
+
 #
 # You probably want your server connected to other servers, so your users
 # have other users to chat with.
@@ -377,6 +384,66 @@ P:192.168.*:::6666
 # with the IP address 168.8.21.107
 #P:*:168.8.21.107:CH:7000
 
+# [F:lines]
+# IRC servers have a large number of options and features.  Most of these
+# are set at compile time through the use of #define's--see "make config"
+# for more details--but we are working to move many of these into the
+# configuration file.  Feature lines are the hook we're using for this.
+#
+# F:<key>:<value>[:<value>[...]]
+#
+# Currently, the only defined value for <key> is "LOG," and it allows you
+# to customize the settings of the logging architecture.  You can set the
+# default logging facility to, say, local7 (F:LOG:LOCAL7), or set a log
+# file for one of the subsystems (F:LOG:GLINE:FILE:gline.log).  More than
+# one subsystem can log to the same file without danger of interleaving.
+#
+# The currently defined subsystems are SYSTEM, CONFIG, OPERMODE (used by
+# /opmode and /clearmode), GLINE, JUPE, WHO (used by /whox), NETWORK
+# (connects and disconnects), OPERKILL, SERVKILL, USER, OPER, OPERLOG,
+# USERLOG, RESOLVER, SOCKET, DEBUG, and OLDLOG.  You can set log files
+# for these subsystems to log to, or you can tell them to syslog their
+# data, or even send server notices.  You can do any of these in
+# combination, but you can't log to more than one file.  You can also set
+# minimum log levels per subsystem, if you wish.
+#
+# The format for LOG Feature lines is as follows:
+#
+# F:LOG:<facility>
+# F:LOG:<subsystem>:<type>[:<value>]
+#
+# The first sets the default facility for ircu to log to to <facility>.
+# Valid <facility> values are listed in the syslog(3) man page; just
+# remove the "LOG_" prefix.
+#
+# The list of subsystems is given above.  The valid values for <type> are
+# FILE, FACILITY, SNOMASK, and LEVEL, which respectively set the log file,
+# the syslog facility, a server notice mask value, and the minimum log
+# level.  If no <value> is given, or if <value> is empty, the default
+# value for that type is set.
+#
+# Valid <value>'s for the FACILITY type are the normal syslog values (with
+# the "LOG_" prefix removed) or the special values "NONE" (which specifies
+# that syslogging should not be attempted) and "DEFAULT" (which specifies
+# that the server-wide facility should be used); the default for all
+# subsystems is "NONE."
+#
+# Valid <value>'s for the SNOMASK type are OLDSNO, SERVKILL, OPERKILL,
+# HACK2, HACK3, UNAUTH, TCPCOMMON, TOOMANY, HACK4, GLINE, NETWORK,
+# IPMISMATCH, THROTTLE, OLDREALOP, and CONNEXIT, as well as the special
+# values NONE, which specifies that no server notices should be sent,
+# and DEBUG, which is only available if DEBUGMODE has been enabled.
+#
+# Valid <value>'s for the LEVEL type are CRIT, ERR, WARNING, NOTICE,
+# TRACE, INFO, and DEBUG.  Note that logs with level CRIT always result
+# in server notices to mask SNO_OLDSNO, and logs with level DEBUG always
+# send server notices to mask SNO_DEBUG.
+#
+# A couple of things to note: log settings are not reset to defaults prior
+# to a rehash; this means that if you delete F-lines and rehash, logs will
+# continue going to the same place.  Also, all subsystems are defaulted to
+# minimum log level INFO (or DEBUG if DEBUGMODE is #define'd).
+
 #
 # Well, you have now reached the end of this sample configuration file
 # If you have any questions, feel free to mail <doco-com@undernet.org>