Allow the resolver source address to be specified in the configuration.
[ircu2.10.12-pk.git] / doc / Configure.help
index 6b1046dba1ff55498d8f639f35d71ce3d68e2e2f..d66b16e36b547400b321ccaa938f7dfa6f8e0544 100644 (file)
@@ -302,6 +302,24 @@ UNIXPORT
   or when your local IRC client doesn't support UNIX domain sockets,
   specify 'n' here.  Otherwise specify 'y'.
 
+Do you need virtual hosting
+VIRTUAL_HOST
+  This is only needed when you want to run two or more servers on the
+  same machine and on the same port (but different devices).
+  In general you will only need this if you have at least two ethernet
+  cards in your machine with a different IP-number.
+  If you specify 'y' here, then you can "bind" a server to one of your
+  interfaces.  You should use the command line option '-w' to tell the
+  server to which interface to bind to.  No error is reported if this
+  fails, the server will simply not run.
+  If no '-w' option is given then the server name specified in the
+  'M: line' of the "ircd.conf" file of the server is used, provided it
+  resolves to an IP-number of one of your interfaces.  Note that
+  normally the name does not have to resolve, but when you define this,
+  it MUST resolve or you must use the -w command line option, or the
+  "bind" will fail.
+  If you are unsure, specify 'n'.
+
 Will you connect to more then one server at a time
 HUB
   All servers of one IRC "network" are connected in a "tree" (no loops).
@@ -314,23 +332,6 @@ HUB
   too bad to route traffic).  Note that on Undernet all newly linked servers
   are linked as leafs during their test phase, and should specify 'n' here.
 
-Do you want support for the old I:*:ONE:*:: construct
-USEONE
-  Server versions prior to ircu2.10.05 used to use the string "ONE"
-  as password in an I: line to indicate that only one connection was
-  allowed for any given IP number that matched that I: line.
-  This method only counted the *local* connections though.
-  As of ircu2.10.05 you can specifiy a single(!) digit as password
-  which then will allow that many connections from the same IP number.
-  However, now the IP numbers of ALL clients are counted, also those
-  that are connected to other servers.
-  If you do not use the depricated "ONE" password in your ircd.conf,
-  specify 'n' here.  Note that if you you DO use the "ONE" password
-  and you specify 'n' here, then you should change all occurances of
-  "ONE" to "1" (this is the recommended procedure).
-  If you are lazy and you don't want to change the "ONE" passwords
-  into a "1", then specify 'y' here.
-
 Send a short message instead of the MOTD to connecting clients
 NODEFAULTMOTD
   Every time a client connects to your server, the full Message Of
@@ -430,6 +431,19 @@ MEMTIMESTATS
   counted blocks must be returned.  This allows to ignore recently allocated
   blocks and permanently allocated blocks (since the start of the server).
 
+Are you testing on a host without DNS
+NODNS
+  If you are playing with the server off-line, and no DNS is available, then
+  long delays occur before the server starts up because it tries to resolv
+  the name given on the M:line (which usually isn't given in /etc/hosts) and
+  for each connecting client.
+  If you specify 'y' here, then a call to gethostbyname() will be done only
+  for the real hostname, and the server will not try to resolv clients that
+  connect to `localhost'.
+  Note that other calls to gethostbyname() are still done anyway if you
+  use VIRTUAL_HOST and that the server still tries to resolv clients
+  that connect to the real IP-number of the server.
+
 Directory where all ircd stuff sits
 DPATH
   DPATH is provided so that the other path names may be provided in just
@@ -473,125 +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 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 m4 as a preprocessor on CPATH
-M4_PREPROC
-  If you use m4 macro's in your "ircd.conf" file, then you need to specify 'y',
-  which will enable m4 preprocessing of the "ircd.conf" file.
-  If you are unsure specify 'n'.  Note using m4 macros has often lead to
-  problems (passwords or server names that match a macro name for instance),
-  while the benefits of using m4 are highly doubtful.  Unless you are
-  already a m4 wizard and insist on using it I recommend to specify 'n' here.
-
-Use crypted passwords for N: lines
-CRYPT_LINK_PASSWORD
-  In order to allow other servers to connect to you, you need to specify
-  two configuration lines in the "ircd.conf" configuration file (CPATH).
-  Each of these lines contains a password; the C: line is used for connecting
-  to a remote server and contains the password that is sent to the remote
-  server for authentication, thus this password must be in plain text.
-  The other is the N: line and contains the password that the remote server
-  is sending to you.  For security reasons it is advised to store this
-  password in DES encrypted form.  If you specify 'y' here, you will be
-  allowed to use the DES encrypted password in the password field of the
-  N: line, see doc/example.conf for more details.  Note that you should
-  use *different* passwords in the C: and N: lines respectively for obvious
-  reasons.
-
 Use crypted passwords for operators
 CRYPT_OPER_PASSWORD
   In order to allow certain users to become IRC OPERators, they must
@@ -640,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
@@ -667,16 +571,6 @@ MAXCONNECTIONS
   hacking.  Find an experienced admin with the same Operating System and
   ask him what the maximum is and how to achieve it.
 
-Default client listen port
-PORTNUM
-  This is the default listen port.  You can specify more listen ports
-  in the "ircd.conf" file with 'P: lines'; see doc/example.conf for more
-  details on P: lines.  Note that /stats p currently only shows P: lines,
-  which might be a reason for you to use a less often used value here.
-  Note that there is actually no difference between client and server
-  listen ports, but it is good practice to separate them for statistical
-  purpose (bandwidth usage statistics).
-
 Nickname history length
 NICKNAMEHISTORYLENGTH
   This value specifies the length of the nick name history list, which
@@ -734,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
@@ -933,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