doc/readme.features

   1 Many of the old compile-time options are now configured through the
   2 server configuration file, ircd.conf.  This file is intended to
   3 document each of these features.  Logging, although also configured
   4 through the use of F-lines, is documented in doc/readme.log.  NOTE
   5 THAT THESE NAMES ARE CASE SENSITIVE!  Values are not case sensitive
   6 unless stated otherwise in the documentation for that feature.
   7
   8 DOMAINNAME
   9  * Type: string
  10  * Default: picked by ./configure from /etc/resolv.conf
  11
  12 This option allows you to specify what you consider to be "local."  It
  13 is only used for statistics.  When you issue the IRC command /STATS w,
  14 the server will respond with statistics of how many clients have been
  15 connecting to your server in the last minute, hour and day.  It will
  16 give these statistics for all connections (including the servers), all
  17 clients (from anywhere) and also for clients whose hostname ends on
  18 the domain you specify here.  So if you are an ISP and you want to
  19 know what the client load from your own domain is, specify that domain
  20 here.  If you are unsure what to do, then it isn't really important
  21 what you give here, just don't give an empty string.  A good guess is
  22 the last two parts of your own hostname (i.e., if your hostname is
  23 foo.bar.nowhere.org, specify "nowhere.org").  Note that the string you
  24 give should NOT start with a "." and you should not use quotes.
  25
  26 RELIABLE_CLOCK
  27  * Type: boolean
  28  * Default: FALSE
  29
  30 You should really ONLY specify "TRUE" here when your system clock is
  31 stable and accurate at all times (within a few seconds).  If you are
  32 running ntpdate on a regular basis, or an equivalent like xntpd, to
  33 keep your system clock synchronized over the network, then you might
  34 have an accurate clock.  However, this is not guaranteed; for example,
  35 it is known that xntpd gives unstable results on Linux in some cases.
  36 Note that an unstable clock is worse then an clock that has a constant
  37 offset, because the servers attempt to correct for a constant offset,
  38 but do not correct jumps of your system clock!  In general you SHOULD
  39 be running ntpdate or equivalent AND make sure it works when you run a
  40 production server on Undernet.  Otherwise leave your clock alone and
  41 specify "FALSE" here.  If unsure specify "FALSE"!
  42
  43 BUFFERPOOL
  44  * Type: integer
  45  * Default: 27000000
  46
  47 This specifies the maximum amount of RAM that your server will
  48 allocate for buffering sendQs.  Small leafs can use a value as little
  49 as 1000000, while large HUBs need to specify a value as high as
  50 20000000.  If you run out of memory, clients and/or servers are
  51 dropped with the error "Buffer allocation error"; then you will have
  52 to increase this number (and install more RAM if appropriate).  If you
  53 want a more educated guess for this value then realize that any value
  54 is good if you _really_ would rather drop servers and clients than
  55 allocate more memory; this will be the case when there is the danger
  56 you may run out of memory for other allocations.  Even if you run the
  57 daemon on a dedicated machine, specifying all of the RAM you have is a
  58 bad thing, because running out of memory is a lot worse than dropping
  59 clients in a controlled way; if possible you should have memory left
  60 for all the internal structures (channels, clients, ban lists, receive
  61 buffers) at all times.  On average, clients seem to use 150 bytes of
  62 sendQ, but at peak moments this can easily increase to 2032 bytes per
  63 client (sendQs are allocated in chunks of 2032 bytes).  The maximum
  64 possible amount that can be allocated for sendQs is the number of
  65 connected clients times whatever you specified as the maximum sendQ in
  66 your Y: lines in the ircd.conf file.  That value will likely be larger
  67 then the amount of RAM you have.  The educated guess I talked about
  68 earlier would be "number of clients" times * 2048 bytes + "size of
  69 net.burst" * n, where "n" is 1 for leafs and up to 5 for HUBs.  The
  70 "size of net.burst" is about 125 bytes per online client (on the whole
  71 network).  For large HUBs with 4000 clients on a network with 30,000
  72 users, this results in 27 Mb.  Leafs could use 12 Mb.  Of course you
  73 can use less when you have less than 4000 local clients.  This value
  74 is in bytes.
  75
  76 HAS_FERGUSON_FLUSHER
  77  * Type: boolean
  78  * Default: FALSE
  79
  80 If you have a server with a lot of resources available, this option
  81 will cause the server to attempt to flush its internal buffers before
  82 dropping clients during a net break.  Don't define this if you don't
  83 know for certain; if you're not careful this can end up rebooting
  84 FreeBSD boxes.  For more information, refer to freebsd.txt, also in
  85 this directory.
  86
  87 CLIENT_FLOOD
  88  * Type: integer
  89  * Default: 1024
  90
  91 Currently, everything that a client sends to a server is read by the
  92 server and stored in a buffer (the clients receive queue).  The server
  93 will process messages from this queue one by one (running over all
  94 clients each time).  When a client sends new messages faster they get
  95 processed, and the size of its receive buffer reaches this value, the
  96 client is dropped with the error "Excess flood."  A reasonable value
  97 is 1024 bytes.  The maximum size is 8000 bytes.
  98
  99 SERVER_PORT
 100  * Type: integer
 101  * Default: 4400
 102
 103 When an IRC operator attempts a connect to another server, he or she
 104 may not know which port the connect should go to.  In this server
 105 version, that operator may use the special port 0, in which case the
 106 server will take the port from the C-line.  If no port is specified in
 107 the C-line, however, the port specified by this option will be used
 108 instead.
 109
 110 NODEFAULTMOTD
 111  * Type: boolean
 112  * Default: TRUE
 113
 114 Every time a client connects to your server, the full Message of the
 115 Day (as specified by the T-lines or by the file specified by the MPATH
 116 option) is sent to the client.  The server sends the Message of the
 117 Day even though many clients permit the user to ignore it.  Many users
 118 never read the message of the day anyway, making it a huge waste of
 119 bandwidth.  If you specify "TRUE" here, then the server won't send the
 120 MOTD to the client by default; instead, it will only tell the client
 121 when the MOTD was last changed, and give instructions on how to obtain
 122 it by typing /MOTD.
 123
 124 MOTD_BANNER
 125  * Type: string
 126  * Default: NULL
 127
 128 If you enable NODEFAULTMOTD, this specifies a one-line banner to be sent
 129 to the client in addition to the instructions mentioned above.
 130
 131 PROVIDER
 132  * Type: string
 133  * Default: NULL
 134
 135 This string as added to the 001 numeric prefixed with "via" before the nick.
 136 It's used for providing promotional space to providers as per CFV-202
 137
 138 KILL_IPMISMATCH
 139  * Type: boolean
 140  * Default: FALSE
 141
 142 When a client connects to your server, the IP address of the client is
 143 reverse-resolved to obtain a hostname.  Then that hostname is resolved
 144 to an IP address and compared with the IP address of the client.  If
 145 they don't match, the client will appear with the IP address instead
 146 of the hostname, unless KILL_IPMISMATCH is "TRUE," in which case the
 147 client is simply disconnected.
 148
 149 IDLE_FROM_MSG
 150  * Type: boolean
 151  * Default: TRUE
 152
 153 The IRC command WHOIS gives an idle time for clients.  If you want
 154 this idle time to be set to zero only when the client sends a PRIVMSG,
 155 then you should specify "TRUE" here.  If you specify "FALSE," then the
 156 idle time will be nullified on all messages except the server
 157 PING/PONG.
 158
 159 HUB
 160  * Type: boolean
 161  * Default: FALSE
 162
 163 All servers of an IRC "network" are connected in a "tree" (no loops).
 164 Servers that are only connected to one other server (called the
 165 "uplink") are called "leafs"; servers that are connected to more than
 166 one other server are called HUBs.  If you specify "FALSE" here then
 167 your server will prevent itself from accidentally connecting to two
 168 servers at once, thus keeping servers in poor network locations from
 169 routing traffic.  Note that on Undernet, all newly linked servers are
 170 linked as leafs during their test phase, and should specify "FALSE"
 171 here.
 172
 173 WALLOPS_OPER_ONLY
 174  * Type: boolean
 175  * Default: FALSE
 176
 177 Setting this option removes the ability for clients that are not IRC
 178 operators to see wallops messages.
 179
 180 NODNS
 181  * Type: boolean
 182  * Default: FALSE
 183
 184 If you are playing with the server off-line, and no DNS is available,
 185 then long delays occur before the server starts up because it tries to
 186 resolve the name given on the M-line (which usually isn't given in
 187 /etc/hosts) and for each connecting client.  If you specify "TRUE"
 188 here, then a call to gethostbyname() will be done only for the real
 189 hostname, and the server will not try to resolve clients that connect
 190 to "localhost."  Note that other calls to gethostbyname() are still
 191 done if you use VIRTUAL_HOST; also note that the server still tries to
 192 resolve clients that connect to the real IP address of the server.
 193
 194 RANDOM_SEED
 195  * Type: string
 196  * Default: none
 197
 198 When a client connects, the server sends the client a "cookie,"
 199 consisting of a random number.  The client must return the cookie to
 200 the server verbatim.  This is done to prevent IP spoofing.  The cookie
 201 is generated by a pseudorandom number generator included in ircd.
 202 This generator must be seeded with a phrase that is kept secret, to
 203 ensure that the numbers it generates are not easily guessed.  The
 204 value given to RANDOM_SEED may be a string of any length.  It should
 205 not contain any characters that are considered special by the
 206 configuration file system, such as ":" or "#"; the string should be at
 207 least 8 characters long, but longer strings are better.  The
 208 RANDOM_SEED may not be retrieved online.
 209
 210 DEFAULT_LIST_PARAM
 211  * Type: string
 212  * Default: none
 213
 214 The LIST command takes a single optional argument.  If given, that
 215 argument is either a channel or a filter.  If that argument is not
 216 given, then by default, /LIST will list all channels on the network.
 217 Needless to say, this can generate a large amount of data on large
 218 networks with many channels, as well as chewing up a lot of CPU time.
 219 Server administrators can therefore set a default filter to be applied
 220 to the channel list if the optional argument to LIST is omitted.
 221
 222 NICKNAMEHISTORYLENGTH
 223  * Type: integer
 224  * Default: 800
 225
 226 This value specifies the length of the nick name history list, which
 227 is used for /WHOWAS and some nickname chasing in /KILL and /KICK.  It
 228 uses about 300 to 400 bytes per entry.  Note that at a net break, so
 229 many client disappear that the whole "whowas" list is refreshed a few
 230 times (unless you make it rather large).  A reasonable value is "total
 231 number of clients" / 25.
 232
 233 HOST_HIDING
 234  * Type: boolean
 235  * Default: TRUE
 236
 237 This selects whether local users can set umode +x, thus allowing them
 238 to hide their hostname if they have also registered with a channel
 239 service (i.e. they have the ACCOUNT flag set).
 240
 241 HIDDEN_HOST
 242  * Type: string
 243  * Default: users.undernet.org
 244
 245 This selects the suffix for the hidden hostmask (see HOST_HIDING).
 246
 247 HIDDEN_IP
 248  * Type: string
 249  * Default: 127.0.0.1
 250
 251 This selects a fake IP to be shown on /USERIP and /WHO %i when the
 252 target has a hidden host (see HOST_HIDING).
 253
 254 CONNEXIT_NOTICES
 255  * Type: boolean
 256  * Default: FALSE
 257
 258 This feature controls the generation of server notices when a user
 259 connects to or disconnects from the server.  Enabling this feature may
 260 have a performance impact.
 261
 262 KILLCHASETIMELIMIT
 263  * Type: integer
 264  * Default: 30
 265
 266 If a user changes his or her nickname just before an operator issues a
 267 /KILL, the /KILL will be changed to follow the user the operator
 268 intended to get.  This option specifies the time limit, in seconds,
 269 for this nickname change; if the user changed his or her nickname more
 270 than this many seconds ago, the /KILL will not be changed.  Don't
 271 change this unless you really need to.
 272
 273 MAXCHANNELSPERUSER
 274  * Type: integer
 275  * Default: 10
 276
 277 This is the maximum number of channels a user can be in at a time.
 278 The "mandatory" value on Undernet is currently 10.  Since it only
 279 influences the local server when you decrease it, its up to you to
 280 decide if you want to use a smaller value.  Do not use a larger value
 281 however, because it DOES cost more memory and bandwidth on all other
 282 servers when you allow users to join more channels simultaneously.
 283 One of the most important reasons to choose a smaller value is the
 284 fact that the "GUI" clients tend to stay on every channel they join
 285 (they aren't bothered by flooding in other channels).  It DOES take
 286 your bandwidth however to send all those messages for 10 different
 287 channels to all your users.
 288
 289 AVBANLEN
 290  * Type: integer
 291  * Default: 40
 292
 293 This is the expected average ban mask length.  Leave it at 40.
 294
 295 MAXBANS
 296  * Type: integer
 297  * Default: 30
 298
 299 This is the maximum number of bans a user may set on a given channel.
 300
 301 MAXSILES
 302  * Type: integer
 303  * Default: 15
 304
 305 This is the maximum number of masks a user can silence at a time.  The
 306 silence command allows users to filter messages directed at them from
 307 certain users or domains, at the source server.  Increasing this
 308 number allows users to use up more memory with inefficient use of the
 309 command.  If you're not sure, don't change this.
 310
 311 HANGONGOODLINK
 312  * Type: integer
 313  * Default: 300
 314
 315 Often the net breaks for a short time and it is useful to try to
 316 reestablish the same connection faster than CONNECTFREQUENCY would
 317 allow, but to keep from trying again on a bad connection, we require
 318 that the connection be open for a certain minimum time. The
 319 recommended value is 300 seconds.
 320
 321 HANGONRETRYDELAY
 322  * Type: integer
 323  * Default: 10
 324
 325 When attempting to quickly reestablish a connection to a good link, we
 326 give the net a few seconds to calm down. This time must be long enough
 327 for the other end to also notice that the connection is broken. The
 328 recommended value is 10 seconds.
 329
 330 CONNECTTIMEOUT
 331  * Type: integer
 332  * Default: 90
 333
 334 Number of seconds to wait for a connect(2) call to complete.  NOTE:
 335 this must be at *LEAST* 10.  When a client connects, it has
 336 CONNECTTIMEOUT - 10 seconds for its host to respond to an ident lookup
 337 query and for a DNS lookup to complete. It is recommended that you not
 338 change this value, but if you do, consider the fact that users whose
 339 clients do not support NOSPOOF will have to type /QUOTE PING <big
 340 number> before registration.
 341
 342 TIMESEC
 343  * Type: integer
 344  * Default: 60
 345
 346 This is the maximum idle time for the server. If no messages are
 347 received in TIMESEC seconds, PINGFREQUENCY and CONNECTFREQUENCY are
 348 checked.  Recommended value is 60 seconds.
 349
 350 MAXIMUM_LINKS
 351  * Type: integer
 352  * Default: 1
 353
 354 This is the maximum number of links for the built-in client class 0.
 355 Leave this value at 1.
 356
 357 PINGFREQUENCY
 358  * Type: integer
 359  * Default: 120
 360
 361 If the daemon doesn't receive anything from any of its links within
 362 PINGFREQUENCY seconds, then the it will attempt to check for an active
 363 link with a PING message.  If no reply is received within
 364 (PINGFREQUENCY * 2) seconds, then the connection will be closed.  This
 365 value may be overridden by a Y-line in "ircd.conf" if the connection's
 366 I- or C-line in "ircd.conf" assigns a specific class to the connection
 367 (recommended).
 368
 369 CONNECTFREQUENCY
 370  * Type: integer
 371  * Default: 600
 372
 373 This is the default frequency that the server attempts to reconnect
 374 with its uplink server if it is set to auto connect to it. Note that
 375 this value is overridden by a Y-line in ircd.conf if the C-lines in
 376 ircd.conf assign a specific class to the connection (recommended).
 377
 378 DEFAULTMAXSENDQLENGTH
 379  * Type: integer
 380  * Default: 40000
 381
 382 This is the default value of the maximum sendQ length of Y-line
 383 classes (see doc/example.conf for details on Y-lines).  You will
 384 probably always override this value in your "ircd.conf" with the
 385 Y-lines.  The given value used to be an often used value for client
 386 sendQs.
 387
 388 GLINEMAXUSERCOUNT
 389  * Type: integer
 390  * Default: 20
 391
 392 G-lines that affect too many users have to be set with a special
 393 command, to prevent accidental G-lines of large blocks of users.  This
 394 feature sets that particular threshold.
 395
 396 MPATH
 397  * Type: string
 398  * Default: "ircd.motd"
 399
 400 MPATH is the filename (relative to DPATH) or the full path of the
 401 "Message of the Day" file.  The contents of this file will be sent to
 402 every client that connects to the server, after registration.
 403
 404 RPATH
 405  * Type: string
 406  * Default: "remote.motd"
 407
 408 RPATH is the filename (relative to DPATH) or the full path of the
 409 "Remote Message of the Day" file.  The contents of this file will be
 410 sent to every remote client that issues a /MOTD <your server name>.
 411 Only the first three lines are sent, so you might want to keep that in
 412 mind while writing the file.
 413
 414 PPATH
 415  * Type: string
 416  * Default: "ircd.pid"
 417
 418 PPATH is the filename (relative to DPATH) or the full path of the
 419 "PID" file.  It is used for storing the server's process ID so that a
 420 ps(1) isn't necessary.
 421
 422 VIRTUAL_HOST
 423  * Type: boolean
 424  * Default: FALSE
 425
 426 This option is only needed when you wish to run multiple IRC servers
 427 on the same machine, and they must share at least one port.  This will
 428 require having multiple IP addresses for the machine that will be
 429 hosting the servers.  If you specify "TRUE" here, you can cause the
 430 server to bind to one of these IP addresses.  Use the second field of
 431 the M-line (the "password" field) to specify the IP address.  If you
 432 are unsure, stick with "FALSE."
 433
 434 TOS_SERVER
 435  * Type: integer
 436  * Default: 0x08
 437
 438 This option is used to specify the type of service that will be
 439 requested for connections to other servers.  The value may be given as
 440 a hexadecimal integer.
 441
 442 TOS_CLIENT
 443  * Type: integer
 444  * Default: 0x08
 445
 446 This option is used to specify the type of service that will be
 447 requested for connections to users.  The value may be given as a
 448 hexadecimal integer.
 449
 450 POLLS_PER_LOOP
 451  * Type: integer
 452  * Default: 200
 453
 454 Some of the engines used by the event interface get a number of events
 455 from the kernel at once.  Since the number retrieved can impact
 456 performance, it can be tuned by modifying this value.  The engines
 457 enforce a lower limit of 20.
 458
 459 CRYPT_OPER_PASSWORD
 460  * Type: boolean
 461  * Default: TRUE
 462
 463 In order to allow certain users to become IRC operators, they must
 464 authenticate themselves with a password.  This password is matched
 465 against an O-line in the "ircd.conf" configuration file; see
 466 doc/example.conf for more details.  If you specify "TRUE" here, you
 467 must use the crypted form of these passwords in your "ircd.conf" file.
 468 Since compromises of the "ircd.conf" file have happened in the past,
 469 you are highly encouraged to use this option.  You can find a program
 470 called "mkpasswd" in the tools directory that will allow you to
 471 generate crypted passwords.
 472
 473 OPER_NO_CHAN_LIMIT
 474  * Type: boolean
 475  * Default: TRUE
 476
 477 If this option is set to "TRUE," IRC operators may join as many
 478 channels as they need to.  This is primarily intended to permit
 479 administrators to run a channel service for local ("&") channels.
 480
 481 OPER_MODE_LCHAN
 482  * Type: boolean
 483  * Default: TRUE
 484
 485 If this option is set to "TRUE," IRC operators may change the channel
 486 modes on local ("&") channels.  This is primarily intended to permit
 487 administrators to run a channel service for local channels.
 488
 489 OPER_WALK_THROUGH_LMODES
 490  * Type: boolean
 491  * Default: FALSE
 492
 493 If this option is set to "TRUE," IRC operators may join local ("&")
 494 channels regardless of any restrictive modes, including bans.  This
 495 requires giving the special password "OVERRIDE."  This is primarily
 496 intended to permit administrators to run a channel service for local
 497 channels.
 498
 499 NO_OPER_DEOP_LCHAN
 500  * Type: boolean
 501  * Default: FALSE
 502
 503 If this option is set to "TRUE," IRC operators may not be deopped on
 504 local ("&") channels.  This is primarily intended to permit
 505 administrators to run a channel service for local channels.
 506
 507 SHOW_INVISIBLE_USERS
 508  * Type: boolean
 509  * Default: TRUE
 510
 511 If you specify "TRUE" here, then your (local) IRC Operators will be
 512 able to see all local invisible users (clients connected to your own
 513 server).  This should be used only for investigating instances of
 514 abuse; make sure your operators do not use this for spying on
 515 individuals.
 516
 517 SHOW_ALL_INVISIBLE_USERS
 518  * Type: boolean
 519  * Default: TRUE
 520
 521 If you specify "TRUE" here, then your global IRC Operators will be
 522 able to see ALL invisible users.  This should be used only for
 523 investigating instances of abuse; make sure your operators do not use
 524 this for spying on individuals.
 525
 526 UNLIMIT_OPER_QUERY
 527  * Type: boolean
 528  * Default: FALSE
 529
 530 A /WHO command can sometimes return several hundred lines of
 531 information.  To reduce the flood potential, the output is truncated.
 532 By setting this option to "TRUE," when an IRC Operator uses /WHO, the
 533 output will not be truncated, no matter how much data is returned.
 534
 535 LOCAL_KILL_ONLY
 536  * Type: boolean
 537  * Default: FALSE
 538
 539 If this option is set to "TRUE," operators of this server may only
 540 KILL clients directly connected to this server.  Operators will not be
 541 able to issue KILLs for clients on other servers.  Some networks may
 542 require that this be turned on for newly linking servers.
 543
 544 CONFIG_OPERCMDS
 545  * Type: boolean
 546  * Default: FALSE
 547
 548 For u2.10.11, several new oper-only features have been added that
 549 involve changes to the server<->server protocol.  Until the entire
 550 network is running the new version, these features cannot be enabled.
 551 This configuration option provides a single switch to prevent the use
 552 of these features until the entire network has been upgraded.  It is
 553 not required that all servers set this to "TRUE" in order for the
 554 features to be used.
 555
 556 OPER_KILL
 557  * Type: boolean
 558  * Default: TRUE
 559
 560 This selects whether global IRC operators on this server are permitted
 561 to issue the /KILL command.
 562
 563 OPER_REHASH
 564  * Type: boolean
 565  * Default: TRUE
 566
 567 This selects whether global IRC operators on this server are permitted
 568 to issue the /REHASH command.
 569
 570 OPER_RESTART
 571  * Type: boolean
 572  * Default: TRUE
 573
 574 This selects whether global IRC operators on this server are permitted
 575 to issue the /RESTART command.
 576
 577 OPER_DIE
 578  * Type: boolean
 579  * Default: TRUE
 580
 581 This selects whether global IRC operators on this server are permitted
 582 to issue the /DIE command.
 583
 584 OPER_GLINE
 585  * Type: boolean
 586  * Default: TRUE
 587
 588 This selects whether global IRC operators on this server are permitted
 589 to issue global G-lines.
 590
 591 OPER_LGLINE
 592  * Type: boolean
 593  * Default: TRUE
 594
 595 This selects whether global IRC operators on this server are permitted
 596 to issue local G-lines.
 597
 598 OPER_JUPE
 599  * Type: boolean
 600  * Default: TRUE
 601
 602 This selects whether global IRC operators on this server are permitted
 603 to issue global jupes.
 604
 605 OPER_LJUPE
 606  * Type: boolean
 607  * Default: TRUE
 608
 609 This selects whether global IRC operators on this server are permitted
 610 to issue local jupes.
 611
 612 OPER_OPMODE
 613  * Type: boolean
 614  * Default: TRUE
 615
 616 This selects whether global IRC operators on this server are permitted
 617 to use /OPMODE and /CLEARMODE on ordinary ("#") channels.
 618
 619 OPER_LOPMODE
 620  * Type: boolean
 621  * Default: TRUE
 622
 623 This selects whether global IRC operators on this server are permitted
 624 to use /OPMODE and /CLEARMODE on local ("&") channels.
 625
 626 OPER_FORCE_OPMODE
 627  * Type: boolean
 628  * Default: TRUE
 629
 630 This selects whether global IRC operators on this server are permitted
 631 to override Q-lines set for /OPMODE and /CLEARMODE on ordinary ("#") channels
 632
 633 OPER_FORCE_LOPMODE
 634  * Type: boolean
 635  * Default: TRUE
 636
 637 This selects whether global IRC operators on this server are permitted
 638 to override Q-lines set for /OPMODE and /CLEARMODE on local ("&") channels
 639
 640 OPER_BADCHAN
 641  * Type: boolean
 642  * Default: FALSE
 643
 644 This selects whether global IRC operators on this server are permitted
 645 to issue global BADCHANs.  USE OF THIS ON THE UNDERNET IS STRICTLY
 646 REGULATED BY THE UNDERNET ADMINISTRATION.
 647
 648 OPER_LBADCHAN
 649  * Type: boolean
 650  * Default: FALSE
 651
 652 This selects whether global IRC operators on this server are permitted
 653 to issue local BADCHANs.  USE OF THIS ON THE UNDERNET IS STRICTLY
 654 REGULATED BY THE UNDERNET ADMINISTRATION.
 655
 656 OPER_SET
 657  * Type: boolean
 658  * Default: FALSE
 659
 660 This selects whether global IRC operators on this server are permitted
 661 to use the /SET command to set various feature values.
 662
 663 OPERS_SEE_IN_SECRET_CHANNELS
 664  * Type: boolean
 665  * Default: TRUE
 666
 667 If you specify "TRUE" here, then your global IRC Operators will be
 668 able to see who is on a specified secret channel, without joining
 669 themselves.  This can be used to make a reasonable judgment in the
 670 case of a "channel takeover" being reported, while the channel is set
 671 invite-only.  See doc/readme.who for more details.
 672
 673 OPER_WIDE_GLINE
 674  * Type: boolean
 675  * Default: TRUE
 676
 677 This selects whether global IRC operators on this server are permitted
 678 to use the /GLINE command with the ! flag to force slightly wide
 679 G-lines to be set.
 680
 681 OPER_LIST_CHAN
 682  * Type: boolean
 683  * Default: TRUE
 684
 685 This selects whether global IRC operators are permitted to list secret
 686 (+s) channels.
 687
 688 LOCOP_KILL
 689  * Type: boolean
 690  * Default: TRUE
 691
 692 This selects whether local IRC operators are permitted to use the
 693 /KILL command on local clients.
 694
 695 LOCOP_REHASH
 696  * Type: boolean
 697  * Default: TRUE
 698
 699 This selects whether local IRC operators are permitted to use the
 700 /REHASH command.
 701
 702 LOCOP_RESTART
 703  * Type: boolean
 704  * Default: FALSE
 705
 706 This selects whether local IRC operators are permitted to use the
 707 /RESTART command.
 708
 709 LOCOP_DIE
 710  * Type: boolean
 711  * Default: FALSE
 712
 713 This selects whether local IRC operators are permitted to use the /DIE
 714 command.
 715
 716 LOCOP_LGLINE
 717  * Type: boolean
 718  * Default: TRUE
 719
 720 This selects whether local IRC operators are permitted to issue local
 721 G-lines.
 722
 723 LOCOP_LJUPE
 724  * Type: boolean
 725  * Default: TRUE
 726
 727 This selects whether local IRC operators are permitted to issue local
 728 jupes.
 729
 730 LOCOP_LOPMODE
 731  * Type: boolean
 732  * Default: TRUE
 733
 734 This selects whether local IRC operators are permitted to use /OPMODE
 735 and /CLEARMODE on local ("&") channels.
 736
 737 LOCOP_FORCE_LOPMODE
 738  * Type: boolean
 739  * Default: TRUE
 740
 741 This selects whether local IRC operators on this server are permitted
 742 to override Q-lines set for /OPMODE and /CLEARMODE on local ("&") channels
 743
 744 LOCOP_LBADCHAN
 745  * Type: boolean
 746  * Default: FALSE
 747
 748 This selects whether local IRC operators are permitted to issue local
 749 BADCHANs.  USE OF THIS ON THE UNDERNET IS STRICTLY REGULATED BY THE
 750 UNDERNET ADMINISTRATION.
 751
 752 LOCOP_SET
 753  * Type: boolean
 754  * Default: FALSE
 755
 756 This selects whether local IRC operators are permitted to use the /SET
 757 command to set various feature values.
 758
 759 LOCOP_SEE_IN_SECRET_CHANNELS
 760  * Type: boolean
 761  * Default: FALSE
 762
 763 If you specify "TRUE" here, then your local IRC Operators will be
 764 able to see who is on a specified secret channel, without joining
 765 themselves.  This can be used to make a reasonable judgment in the
 766 case of a "channel takeover" being reported, while the channel is set
 767 invite-only.  See doc/readme.who for more details.
 768
 769 LOCOP_WIDE_GLINE
 770  * Type: boolean
 771  * Default: FALSE
 772
 773 This selects whether local IRC operators are permitted to use the
 774 /GLINE command with the ! flag to force slightly wide G-lines to be
 775 set.
 776
 777 LOCOP_LIST_CHAN
 778  * Type: boolean
 779  * Default: FALSE
 780
 781 This selects whether local IRC operators are permitted to list secret
 782 (+s) channels.
 783
 784 HIS_MAP
 785  * Type: boolean
 786  * Default: TRUE
 787
 788 As per UnderNet CFV-165, this removes /MAP from users.
 789
 790 HIS_SNOTICES
 791  * Type: boolean
 792  * Default: TRUE
 793
 794 As per UnderNet CFV-165, this removes server notices from users.
 795
 796 HIS_SNOTICES_OPER_ONLY
 797  * Type: boolean
 798  * Default: TRUE
 799
 800 As per UnderNet CFV-165, this removes server notices from users.
 801
 802 HIS_DESYNCS
 803  * Type: boolean
 804  * Default: TRUE
 805
 806 As per UnderNet CFV-165, this removes server wallops from users.
 807
 808 HIS_DEBUG_OPER_ONLY
 809  * Type: boolean
 810  * Default: TRUE
 811
 812 As per UnderNet CFV-165, this removes server wallops from users.
 813
 814 HIS_WALLOPS
 815  * Type: boolean
 816  * Default: TRUE
 817
 818 As per UnderNet CFV-165, this removes operator wallops from users.
 819
 820 HIS_LINKS
 821  * Type: boolean
 822  * Default: TRUE
 823
 824 As per UnderNet CFV-165, this removes /LINKS from users.
 825
 826 HIS_TRACE
 827  * Type: boolean
 828  * Default: TRUE
 829
 830 As per UnderNet CFV-165, this removes /TRACE from users.
 831
 832 HIS_STATS_l
 833  * Type: boolean
 834  * Default: TRUE
 835
 836 As per UnderNet CFV-165, this removes /STATS l from users.
 837
 838 HIS_STATS_c
 839  * Type: boolean
 840  * Default: TRUE
 841
 842 As per UnderNet CFV-165, this removes /STATS c from users.
 843
 844 HIS_STATS_g
 845  * Type: boolean
 846  * Default: TRUE
 847
 848 As per UnderNet CFV-165, this removes /STATS g from users.
 849
 850 HIS_STATS_h
 851  * Type: boolean
 852  * Default: TRUE
 853
 854 As per UnderNet CFV-165, this removes /STATS h from users.
 855
 856 HIS_STATS_k
 857  * Type: boolean
 858  * Default: TRUE
 859
 860 As per UnderNet CFV-165, this removes /STATS k from users.
 861
 862 HIS_STATS_f
 863  * Type: boolean
 864  * Default: TRUE
 865
 866 As per UnderNet CFV-165, this removes /STATS f from users.
 867
 868 HIS_STATS_i
 869  * Type: boolean
 870  * Default: TRUE
 871
 872 As per UnderNet CFV-165, this removes /STATS i from users.
 873
 874 HIS_STATS_j
 875  * Type: boolean
 876  * Default: TRUE
 877
 878 As per UnderNet CFV-165, this removes /STATS j from users.
 879
 880 HIS_STATS_M
 881  * Type: boolean
 882  * Default: TRUE
 883
 884 As per UnderNet CFV-165, this removes /STATS M from users.
 885
 886 HIS_STATS_m
 887  * Type: boolean
 888  * Default: TRUE
 889
 890 As per UnderNet CFV-165, this removes /STATS m from users.
 891
 892 HIS_STATS_o
 893  * Type: boolean
 894  * Default: TRUE
 895
 896 As per UnderNet CFV-165, this removes /STATS o from users.
 897
 898 HIS_STATS_p
 899  * Type: boolean
 900  * Default: TRUE
 901
 902 As per UnderNet CFV-165, this removes /STATS p from users.
 903
 904 HIS_STATS_q
 905  * Type: boolean
 906  * Default: TRUE
 907
 908 As per UnderNet CFV-165, this removes /STATS q from users.
 909
 910 HIS_STATS_r
 911  * Type: boolean
 912  * Default: TRUE
 913
 914 As per UnderNet CFV-165, this removes /STATS r from users.
 915
 916 HIS_STATS_d
 917  * Type: boolean
 918  * Default: TRUE
 919
 920 As per UnderNet CFV-165, this removes /STATS d from users.
 921
 922 HIS_STATS_e
 923  * Type: boolean
 924  * Default: TRUE
 925
 926 As per UnderNet CFV-165, this removes /STATS e from users.
 927
 928 HIS_STATS_t
 929  * Type: boolean
 930  * Default: TRUE
 931
 932 As per UnderNet CFV-165, this removes /STATS t from users.
 933
 934 HIS_STATS_T
 935  * Type: boolean
 936  * Default: TRUE
 937
 938 As per UnderNet CFV-165, this removes /STATS T from users.
 939
 940 HIS_STATS_u
 941  * Type: boolean
 942  * Default: FALSE
 943
 944 As per UnderNet CFV-165, this allows users to perform /STATS u.
 945
 946 HIS_STATS_U
 947  * Type: boolean
 948  * Default: TRUE
 949
 950 As per UnderNet CFV-165, this removes /STATS U from users.
 951
 952 HIS_STATS_v
 953  * Type: boolean
 954  * Default: TRUE
 955
 956 As per UnderNet CFV-165, this removes /STATS v from users.
 957
 958 HIS_STATS_w
 959  * Type: boolean
 960  * Default: FALSE
 961
 962 As per UnderNet CFV-165, this allows users to perform /STATS w.
 963
 964 HIS_STATS_x
 965  * Type: boolean
 966  * Default: TRUE
 967
 968 As per UnderNet CFV-165, this removes /STATS x from users.
 969
 970 HIS_STATS_y
 971  * Type: boolean
 972  * Default: TRUE
 973
 974 As per UnderNet CFV-165, this removes /STATS y from users.
 975
 976 HIS_STATS_z
 977  * Type: boolean
 978  * Default: TRUE
 979
 980 As per UnderNet CFV-165, this removes /STATS z from users.
 981
 982 HIS_WHOIS_SERVERNAME
 983  * Type: boolean
 984  * Default: TRUE
 985
 986 As per UnderNet CFV-165, this removes server names in replies to /WHOIS.
 987
 988 HIS_WHOIS_IDLETIME
 989  * Type: boolean
 990  * Default: TRUE
 991
 992 As per UnderNet CFV-165, this removes idle time in replies to /WHOIS.
 993
 994 HIS_WHO_SERVERNAME
 995  * Type: boolean
 996  * Default: TRUE
 997
 998 As per UnderNet CFV-165, this removes server names in replies to /WHO.
 999
1000 HIS_WHO_HOPCOUNT
1001  * Type: boolean
1002  * Default: TRUE
1003
1004 As per UnderNet CFV-165, this replaces hopcount to a static 3 in replies to /WHO.
1005
1006 HIS_BANWHO
1007  * Type: boolean
1008  * Default: TRUE
1009
1010 As per UnderNet CFV-165, this doesn't show which server set a ban.
1011
1012 HIS_KILLWHO
1013  * Type: boolean
1014  * Default: TRUE
1015
1016 As per UnderNet CFV-165, this doesn't show which server or oper performed a
1017 kill.
1018
1019 HIS_REWRITE
1020  * Type: boolean
1021  * Default: TRUE
1022
1023 As per UnderNet CFV-165, this remaps remote numerics to come from the local
1024 server.
1025
1026 HIS_REMOTE
1027  * Type: integer
1028  * Default: 1
1029
1030 As per UnderNet CFV-165, this disallows remote queries. (*sob!*)
1031
1032 HIS_NETSPLIT
1033  * Type: boolean
1034  * Default: TRUE
1035
1036 As per UnderNet CFV-165, this removes server names in net break sign-offs.
1037
1038 HIS_SERVERNAME
1039  * Type: string
1040  * Default: "*.undernet.org"
1041
1042 As per UnderNet CFV-165, this is the "name" of the server shown to users on a
1043 /WHOIS of another user.
1044
1045 HIS_SERVERINFO
1046  * Type: string
1047  * Default: "The Undernet Underworld"
1048
1049 As per UnderNet CFV-165, this is the "info" of the server shown to users on a
1050 /WHOIS of another user.
1051
1052 HIS_URLSERVERS
1053  * Type: string
1054  * Default: "http://www.undernet.org/servers.php"
1055
1056 As per UnderNet CFV-165, this is the URL shown to users when they do a /MAP or
1057 /LINKS.
1058
1059 NETWORK
1060  * Type: string
1061  * Default: "UnderNet"
1062
1063 This defines the network name as reported in the 005 "supported features"
1064 numeric, and as used by the "Failed to deliver" message.
1065
1066 URL_CLIENTS
1067  * Type: string
1068  * Default: "ftp://ftp.undernet.org/pub/irc/clients"
1069
1070 This defines a URL that users may visit to find compatible IRC clients.
1071
1072 NICKLEN
1073  * Type: integer
1074  * Default: 9
1075
1076 This is the allowed length of the nickname length.  It may not be
1077 larger than the NICKLEN #define, and should usually be the same
1078 length.  The real purpose of this feature is to permit easy increases
1079 in nickname length for a network.
1080
1081 IRCD_RES_RETRIES
1082  * Type: integer
1083  * Default: 2
1084
1085 This is the number of attempts the irc daemon's resolver will have at
1086 trying to solicit a response from the DNS server.
1087 NOTE: Has no effect when using the adns resolver.
1088
1089 IRCD_RES_TIMEOUT
1090  * Type: integer
1091  * Default: 4
1092
1093 When a DNS query is sent, the irc daemon's resolver will wait this many
1094 seconds for a reply.  After this timeout has expired, it will retry again,
1095 for as many retries as IRCD_RES_RETRIES allows.  This can be cut short by
1096 AUTH_TIMEOUT expiring.
1097 NOTE: Has no effect when using the adns resolver.
1098
1099 AUTH_TIMEOUT
1100  * Type: integer
1101  * Default: 9
1102
1103 This is the maximum number of seconds to wait for the ident lookup and
1104 the DNS query to succeed.  On older (pre 2.10.11.06) servers this was
1105 hard coded to 60 seconds.
1106
1107 IPCHECK_CLONE_LIMIT
1108  * Type: integer
1109  * Default: 4
1110
1111 The number of times you are allowed to connect within IPCHECK_CLONE_PERIOD
1112 seconds before you are considered abusing the server and throttled.
1113
1114 IPCHECK_CLONE_PERIOD
1115  * Type: integer
1116  * Defualt: 40
1117
1118 The number of seconds you are allowed to connect IPCHECK_CLONE_LIMIT times
1119 within before you are considered abusing the server and throttled.
1120 For instance if you set IPCHECK_CLONE_LIMIT to 1, and IPCHECK_CLONE_PERIOD
1121 to 10, then a user is only allowed to connect once in 10s, if they connect
1122 again within 10s, then they are considered to be connecting too fast and
1123 they are throttled.
1124
1125 IPCHECK_CLONE_DELAY
1126  * Type: integer
1127  * Default: 600
1128
1129 The number of seconds grace after restarting the server before the throttle
1130 code kicks in.  Even if a user connects repeditively during this period,
1131 they will never get throttled.  This is so after a restart users on a
1132 multiuser box can all connect to a server simultaniously without being
1133 considered an attack.