Allow the resolver source address to be specified in the configuration.
[ircu2.10.12-pk.git] / doc / Configure.help
index 965c7f92c69b7fe6fabd152444e5463508619387..d66b16e36b547400b321ccaa938f7dfa6f8e0544 100644 (file)
@@ -487,123 +487,6 @@ PPATH
   server's PID so a ps(1) isn't necessary.
   Note that you should not include quotes here.
 
-Do you want to log the use of /WHO x% (recommended)
-CONFIG_LOG_WHOX
-  Specify 'y' here if you want to log the use of /WHO ... x%... by your
-  Opers (see doc/readme.who).  This is highly recommended since it will
-  reduce the abuse of this `spy' function.  Note: You can disable this
-  spy function completely below, in which case you can give 'n' here.
-  If unsure specify 'y'.
-
-Give the path and(or) filename of this log file
-WPATH
-  WPATH is the filename, relative to DPATH, or the full path, of the
-  log file where the use of /WHO ... x% ... by your Opers will be logged
-  (see doc/readme.who), mostly called "whox.log".
-  Note that you should not include quotes here.
-
-Do you want to log G-lines to a separate file
-CONFIG_LOG_GLINES
-  Specify 'y' here if you want to log G-lines (Global access bans)
-  to a local file.
-
-Give the path and(or) filename of this log file
-GPATH
-  GPATH is the filename, relative to DPATH, or the full path, of the
-  log file where the G-lines will be stored, mostly called "gline.log".
-  Note that you should not include quotes here.
-
-Do you want to log JUPEs to a separate file
-CONFIG_LOG_JUPES
-  Specify 'y' here if you want to log JUPEs (Jupiters) to a local file.
-
-Give the path and(or) filename of this log file
-JPATH
-  JPATH is the filename, relative to DPATH, or the full path, of the
-  log file where the logs of JUPEs will be stored; it is usually called
-  "jupe.log".  Note that you should not include quotes here.
-
-Do you want to log OPMODEs and CLEARMODEs to a separate file
-CONFIG_LOG_OPMODES
-  Specify 'y' here if you want to log OPMODEs and CLEARMODEs to a local
-  file.
-
-Give the path and(or) filename of this log file
-OPATH
-  OPATH is the filename, relative to DPATH, or the full path, of the
-  log file where the logs of OPMODEs and CLEARMODEs will be stored; it
-  is usually called "opmode.log".  Note that you should not include
-  quote here.
-
-Do you want to log connecting users to a separate file
-CONFIG_LOG_USERS
-  Specify 'y' here if you want to log who is connecting to your server.
-  This file can grow VERY fast on a large net work, so you probably
-  want to specify 'n' here.
-
-Give the path and(or) filename of this log file
-FNAME_USERLOG
-  Here you need to specify the name of the log file where the server
-  should write the data about connecting users to. You can also specify
-  a full path.  Note that you should not include quotes here.
-
-Do you want to log Opers to a separate file
-CONFIG_LOG_OPERS
-  Specify 'y' here if you want to log who is successfully becoming an
-  IRC Operator on your server.
-
-Give the path and(or) filename of this log file
-FNAME_OPERLOG
-  Here you need to specify the name of the log file where the server
-  should write the data about Opering users.  You can also specify a
-  full path.  Note that you should not include quotes here.
-
-Do you want to use syslog
-USE_SYSLOG
-  If you are the sys admin of this machine, or if you have permission
-  of the sys admin to do so, you can let the server write data about
-  certain events to the syslog.  You will be prompted for the events
-  that you want to log being one or more of: KILL's, SQUIT's, CONNECT's,
-  OPERing, Connecting Users and finally the log facility.
-  If you are unsure, specify 'n'.  It is probably not a good idea to use
-  this on a large IRC net work.
-
-Log all operator kills to syslog
-SYSLOG_KILL
-  Specify 'y' here if you want all KILLs to be written to syslog.
-  Note that on a large IRC net work this is a LOT of data.
-
-Log all remote squits for all servers to syslog
-SYSLOG_SQUIT
-  Specify 'y' here if you want all SQUITs to be written to syslog.
-  Note that on a large IRC net work this is a LOT of data.
-
-Log remote connect messages for other all servers
-SYSLOG_CONNECT
-  Specify 'y' here if you want all CONNECTs to be written to syslog.
-  Note that on a large IRC net work this is a LOT of data.
-
-Log all users who successfully become an Oper
-SYSLOG_OPER
-  Specify 'y' here if you want all OPERs to be written to syslog.
-  Note that on a large IRC net work this is a LOT of data.
-
-Send userlog stuff to syslog
-SYSLOG_USERS
-  Specify 'y' here if you want all connecting users to be written to syslog.
-  Note that on a large IRC net work this is EXTREMELY MUCH data.
-  You really want to specify 'n' here.
-
-Log facility (daemon, user, local0-7)
-CONFIG_DAEMON
-  Well if you got this far and still need help, then I think you should
-  go back and specify 'n' at the question "Do you want to use syslog".
-
-Which local facility (0-7)
-INT_LOCAL
-  Well if you got this far and still need help, then I think you should
-  go back and specify 'n' at the question "Do you want to use syslog".
-
 Use crypted passwords for operators
 CRYPT_OPER_PASSWORD
   In order to allow certain users to become IRC OPERators, they must
@@ -652,6 +535,15 @@ BUFFERPOOL
   have less than 4000 local clients.
   Don't forget to specify this value in bytes.
 
+Aggressively empty the sendqpool (Read Help!)
+HAS_FERGUSON_FLUSHER
+  Instead of dropping clients with 'Buffer Allocation Error', try to send
+  data to clients to try and drop the sendq buffer size as a last resort
+  before dropping clients.  This doesn't get rid of the problem, it just
+  tries hard to limit it's impact.
+  WARNING: *THIS PANICS UNCONFIGURED FREEBSD MACHINES*, make sure you've
+  read doc/freebsd.txt before enabling this feature on a FreeBSD machine.
+
 Max receive queue for clients (bytes)
 CLIENT_FLOOD
   Currently, everything that a client sends to a server is read by the server
@@ -736,119 +628,6 @@ R_LINES_OFTEN
   Note that this is -very- likely to cause a severe drain on your resources.
   Use at your own risk, specify 'n' unless your really sure.
 
-Allow (local) Opers to see all local invisible users
-SHOW_INVISIBLE_USERS
-  If you specify 'y' here, then your (local) IRC Operators will be able to
-  see all local invisible users (clients connected to your own server).
-  The reason for this is to hunt for clone bots, make sure your Operators do
-  not use this "feature" for spying on individuals and respect the user that
-  wishes to be invisible (mostly meaning that they don't want to be found when
-  on certain channels).
-  Note: If you answer 'n' here, then you will also not be able to see remote
-  invisible users (if you specify 'y' you will also get a configuration
-  question that asks you to specify whether or not you want your Opers to see
-  remote invisible users or not).
-
-Allow Opers to see all invisible users
-SHOW_ALL_INVISIBLE_USERS
-  If you specify 'y' here, then your global IRC Operators (O:) will be able
-  to see ALL invisible users.  The reason for this is to hunt for clone bots,
-  make sure your Operators do not use this "feature" for spying on individuals
-  and respect the user that wishes to be invisible (mostly meaning that they
-  don't want to be found when on certain channels).
-
-Allow global Opers (O:) to see inside secret channels
-OPERS_SEE_IN_SECRET_CHANNELS
-  If you specify 'y' here, then your global IRC Operators (O:) will be able
-  to see who is on a specified, secret channel, without joining themselfs.
-  This can be needed to make a reasonable judgement in the case of a "channel
-  takeover" being reported, while the channel is set invite only.
-  See doc/readme.who for more details.
-
-Allow local Opers (o:) to see inside secret channels
-LOCOP_SEE_IN_SECRET_CHANNELS
-  If you specify 'y' here, then your local IRC Operators (o:) will be able
-  to see who is on a specified, secret channel, without joining themselfs.
-  This can be needed to make a reasonable judgement in the case of a "channel
-  takeover" being reported, while the channel is set invite only.
-  See doc/readme.who for more details.
-  If unsure, specify 'n'.
-
-Don't truncate obnoxiously long /who output for opers
-UNLIMIT_OPER_QUERY
-  A /who command can sometimes return several hundred lines of info. To
-  reduce flooding and sending too much, the output is truncated. By
-  answering 'y' to this, when an IRC Operator uses /who, the output will
-  not be truncated, no matter how much data is returned.
-
-Allow Opers to use the KILL command
-OPER_KILL
-  You can select 'n' if you don't think operators should be able
-  to use the KILL command, and wish to prevent your operators from
-  using it.  This will not, however, prevent operators on other
-  servers from issuing KILLs to your clients.  You probably want to
-  select 'y' for this unless you really really don't think KILL
-  should -ever- be used by an operator.
-
-Allow Opers to use the REHASH command
-OPER_REHASH
-  Allows operators to use the REHASH command to reload the servers
-  configuration file (ircd.conf) if you select 'n', you can still
-  reload the configuration file with a unix command,
-  kill -HUP `cat ircd.pid`.  If unsure, select 'y'.
-
-Allow Opers to use the RESTART command
-OPER_RESTART
-  Allows an operator to use the RESTART command to cause the server
-  to restart, using the ircd executable in SPATH.  If unsure, select 'y'.
-
-Allow Opers to use the DIE command
-OPER_DIE
-  Allows an operator to use the DIE command to shutdown the server
-  online.  If you select 'n' you will need to send the server a kill
-  signal to shutdown the server.  If unsure, select 'y'.
-
-Allow Opers to add local G-lines
-OPER_LGLINE
-  Allows operators to add local G-lines with the GLINE command.  This is
-  like a *local* KILL, except that the user being killed can't immediately
-  reconnect: He will have to wait for the G-line to expire.
-  The reason for adding this is that a KILL is rather useless for removing
-  (or 'warning') abusers (it is still THE command to remove ghosts and
-  a-like, the reason KILL was added in the first place).  However, adding
-  G-lines for a dynamic IP with expire times larger then 10 minutes is highly
-  discouraged: The user will already have dialed in via another IP or account
-  and the G-line would only harm other, innocent, users.
-
-Allow Opers to connect from a remote site
-OPER_REMOTE
-  If you select 'n' for this, clients must be on the 'same network' as
-  the server in order to gain oper privledges.  If you're not sure, just
-  select 'y'.
-
-Allow local opers to use the REHASH command
-LOCOP_REHASH
-  Allows a local operator (defined by a lowercase o:line in ircd.conf)
-  to cause the server to reload its configuration file (ircd.conf) with
-  the REHASH command.  If unsure, select 'n'.
-
-Allow local opers to use the RESTART command
-LOCOP_RESTART
-  Allows a local operator (defined by a lowercase o:line in ircd.conf)
-  to use the RESTART command.  If unsure, select 'n'.
-
-Allow local opers to use the DIE command
-LOCOP_DIE
-  Allows a local operator (defined by a lowercase o:line in ircd.conf)
-  to use the DIE command.  If unsure, select 'n'.
-
-Allow local opers to add local G-lines
-LOCOP_LGLINE
-  Allows a local operator (defined by a lowercase o:line in ircd.conf)
-  to add local G-lines with the GLINE command.  This is like a *local* KILL,
-  except that the user being killed can't immediately reconnect: He will
-  have to wait for the G-line to expire.
-
 Do you want to have a default LIST parameter
 CONFIG_LIST
   Pre-Undernet, the LIST command could either be given with one channel
@@ -935,14 +714,6 @@ MSGLOG_SIZE
   of _static_ memory! Recommended value is 128. You must include this even if
   you selected 'n' for MSGLOG_ENABLED.
 
-Only allow KILLs of local clients
-LOCAL_KILL_ONLY
-  This only allows operators of this server to KILL clients directly connected
-  to this server.  Operators will not be able to issue KILLs for clients on
-  other servers.  Some networks (not Undernet) require that this be defined
-  for newly linking servers, but if you haven't been told to do otherwise,
-  specify 'n' here.
-
 Max server idle time (60)
 TIMESEC
   This is the maximum idle time for the server. If no messages are received
@@ -1045,17 +816,3 @@ DEFAULTMAXSENDQLENGTH
   (see doc/example.conf for details on Y: lines).  You will probably
   always override this value in your "ircd.conf" with the Y: lines.
   The given value used to be an often used value for client sendqs.
-
-Use new MODE implementation
-CONFIG_NEW_MODE
-  This enables a new implementation of m_mode.  THIS IS AN EXPERIMENTAL
-  FEATURE; DO NOT ENABLE UNLESS YOU KNOW WHAT YOU ARE DOING!  Note that,
-  due to apparent stability, this new implementation has been enabled.
-
-Use new oper commands (JUPE, CLEARMODE, OPMODE, GLINE)
-CONFIG_OPERCMDS
-  Several new oper-only commands were added to the server source
-  during the Uworld integration project.  Until all servers are
-  upgraded to versions that understand the new server<->server
-  traffic, they must remain disabled, however.  This option activates
-  the client-side part of those changes.