Document operator privilege settings.
[ircu2.10.12-pk.git] / doc / example.conf
index d40de5d2bb06b45e63c2d1e04cc95d33a63e9265..39c3f1dce3733c1d7d91c2f6d4ade7c2993168e7 100644 (file)
@@ -10,9 +10,6 @@
 # Rewritten by A1kmm(Andrew Miller)<a1kmm@mware.virtualave.net> to support
 # the new flex/bison configuration parser.
 #
-# Rewritten by A1kmm(Andrew Miller)<a1kmm@mware.virtualave.net> to support
-# the new flex/bison configuration parser.
-#
 # Thanks and credits to: Run, Trillian, Cym, Morrissey, Chaos, Flynn,
 #                        Xorath, WildThang, Mmmm, SeKs, Ghostwolf and
 #                        all other Undernet IRC Admins and Operators,
@@ -84,8 +81,6 @@ Admin {
   Location = "The University of London";
   # At most two contact lines are allowed...
   Contact = "Undernet IRC server";
-# Note that times can be specified as a number, or by giving something
-# like: 1 minutes 20 seconds, or 1*60+20.
   Contact = "IRC Admins <irc@london.ac.uk>";
 };
 
@@ -103,6 +98,7 @@ Admin {
 #  connectfreq = time;
 #  maxlinks = number;
 #  sendq = size;
+#  usermode = "+i";
 # };
 #
 # <connect freq> applies only to servers, and specifies the frequency 
@@ -146,6 +142,7 @@ Class {
  pingfreq = 1 minutes 30 seconds;
  sendq = 160000;
  maxlinks = 100;
+ usermode = "+iw";
 };
 Client
 {
@@ -568,18 +565,58 @@ CRULE
 # can squit, connect and kill - but only locally: their +o user mode
 # is not not passed along to other servers. On Undernet, this prevents
 # them from using Uworld as well.
-# Depending on some defines in include/config.h, local operators are also
-# not allowed to /DIE and /RESTART the server.
+#
 # Operator {
-#  local = no;
+#  local = yes;
 #  host = "host/IP mask";
 #  name = "opername";
 #  password = "encryptedpass";
 #  class = "classname";
+#
+#  # You can also specify per-operator privileges, many of which can
+#  # be globally disabled by settings in the "features" block (as
+#  # indicated).
+#  extended_who_information = yes;
+#  oper_status_display = yes;
+#  globally_opered = no;              # inverted alias for local
+#  bypass_local_channel_limits = yes; # unless OPER_NO_CHAN_LIMIT = FALSE
+#  set_local_channel_modes = yes;     # unless OPER_MODE_LCHAN = FALSE
+#  protected_local_channel = yes;     # unless NO_OPER_DEOP_LCHAN = FALSE
+#  bypass_join_local_channels = yes;  # unless OPER_WALK_THROUGH_LMODES = FALSE
+#  see_invisible_users = yes;         # unless SHOW_INVISIBLE_USERS = FALSE
+#  list_all_invisible_users = yes;    # unless SHOW_ALL_INVISIBLE_USERS = FALSE
+#  unlimited_who_queries = yes;       # unless UNLIMIT_OPER_QUERY = FALSE
+#
+#  # The following privileges have two settings in the "features" block;
+#  # one to globally disable for local operators, one to globally disable
+#  # the privilege for global operators.
+#  local_kill = yes;                  # unless {OPER,LOCOP}_KILL = FALSE
+#  rehash = yes;                      # unless {OPER,LOCOP}_REHASH = FALSE
+#  die = yes;                         # unless {OPER,LOCOP}_DIE = FALSE
+#  local_gline = yes;                 # unless {OPER,LOCOP}_LGLINE = FALSE
+#  local_jupe_server = yes;           # unless {OPER,LOCOP}_LJUPE = FALSE
+#  change_settings = yes;             # unless {OPER,LOCOP}_SET = FALSE
+#  local_gline_channels = yes;        # unless {OPER,LOCOP}_LBADCHAN = FALSE
+#  see_private_channels = yes;        # unless {OPER,LOCOP}_SEE_IN_SECRET_CHANNELS = FALSE
+#  wide_glines = yes;                 # unless {OPER,LOCOP}_WIDE_GLINE = FALSE
+#
+#  # The following privileges default to yes for global operators and
+#  # to no for local operators.
+#  see_other_opers = yes;             # unless local
+#  global_kill = yes;                 # unless local or LOCAL_KILL_ONLY = TRUE
+#  gline = yes;                       # unless local or OPER_GLINE = FALSE
+#  jupe_server = yes;                 # unless local or OPER_JUPE = FALSE
+#  hack_channel_modes = yes;          # unless local or OPER_OPMODE = FALSE
+#  gline_channels = yes;              # unless local or OPER_BADCHAN = FALSE
 # };
 #
-# The encrypted password is optional.  If you wish to encrypt your password,
-# there is a utility in the ircd.  Please read the file tools/README.  
+# The encrypted password is optional.  If you wish to encrypt your
+# password, there is a utility in the ircd.  Please read the file
+# tools/README.
+# All privileges are shown with their default values; if you wish to
+# override defaults, you should set only those privileges for the
+# operator.  Listing defaulted privileges just makes things harder to
+# find.
 Operator {
  local = no;
  host = "*@*.cs.vu.nl";
@@ -669,6 +706,22 @@ Port {
  port = 7000;
 };
 
+# This is a server-implemented alias to send a message to a service.
+# The string after Pseudo is the command name; the name entry inside
+# is the service name, used for error messages.  More than one nick
+# entry can be provided; the last one listed has highest priority.
+Pseudo "CHANSERV" {
+ name = "X";
+ nick = "X@channels.undernet.org";
+};
+
+# You can also prepend text before the user's message.
+Pseudo "LOGIN" {
+ name = "X";
+ prepend = "LOGIN ";
+ nick = "X@channels.undernet.org";
+};
+
 # [features]
 # 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"
@@ -706,8 +759,10 @@ features
 #  "NICKNAMEHISTORYLENGTH"="800";
 #  "HOST_HIDING"="FALSE";
 #  "HIDDEN_HOST"="users.undernet.org";
+#  "HIDDEN_IP"="127.0.0.1";
 #  "KILLCHASETIMELIMIT"="30";
 #  "MAXCHANNELSPERUSER"="10";
+#  "NICKLEN" = "9";
 #  "AVBANLEN"="40";
 #  "MAXBANS"="30";
 #  "MAXSILES"="15";
@@ -727,6 +782,12 @@ features
 # "TOS_SERVER" = "0x08";
 # "TOS_CLIENT" = "0x08";
 # "POLLS_PER_LOOP" = "200";
+# "IRCD_RES_TIMEOUTS" = "4";
+# "IRCD_RES_RETRIES" = "2";
+# "AUTH_TIMEOUT" = "9";
+# "IPCHECK_CLONE_LIMIT" = "4";
+# "IPCHECK_CLONE_PERIOD" = "40";
+# "IPCHECK_CLONE_DELAY" = "600";
 # "CRYPT_OPER_PASSWORD" = "TRUE";
 # "OPER_NO_CHAN_LIMIT" = "TRUE";
 # "OPER_MODE_LCHAN" = "TRUE";
@@ -765,6 +826,8 @@ features
 # "LOCOP_SEE_IN_SECRET_CHANNELS" = "FALSE";
 # "LOCOP_WIDE_GLINE" = "FALSE";
 # "LOCOP_LIST_CHAN" = "FALSE";
+# "OPLEVELS" = "TRUE";
+# "LOCAL_CHANNELS" = "TRUE";
 };
 
 # Well, you have now reached the end of this sample configuration