Make realname Kill blocks more predictable, and add username="x" field.
[ircu2.10.12-pk.git] / doc / example.conf
index ee44712c8d1d1913751517f65bf0de8863611352..5b81cf4f143897594d994eeb81815b3f3550d9ad 100644 (file)
@@ -189,7 +189,7 @@ Class {
  # exist:
  #
  # local (or propagate, with the opposite sense)
- # whox  (can use x flag with /WHO)
+ # whox  (log oper's use of x flag with /WHO)
  # display (oper status visible to lusers)
  # chan_limit (can join local channels when in
  #                              MAXCHANNELSPERUSER channels)
@@ -218,10 +218,11 @@ Class {
  # opmode (can use /OPMODE)
  # badchan (can issue Gchans to other servers)
  # force_opmode (can use OPMODE/CLEARMODE on quarantined global channels)
+ # apass_opmode (can use OPMODE/CLEARMODE on +A and +U keys)
  #
  # For global opers (with propagate = yes or local = no), the default
- # is to grant all of the above privileges.  For local opers, the
- # default is to grant ONLY the following privileges:
+ # is to grant all of the above privileges EXCEPT apass_opmode.  For
+ # local opers, the default is to grant ONLY the following privileges:
  #  chan_limit, mode_lchan, show_invis, show_all_invis, local_kill,
  #  rehash, local_gline, local_jupe, local_opmode, whox, display,
  #  force_local_opmode
@@ -408,9 +409,7 @@ motd {
 # assigned one or two uplinks to which your server can connect.
 # If your uplink(s) also connect to other servers than yours (which is
 # probable), you need to define your uplink as being allowed to "hub".
-# To do this, set "hub = yes;"
-# You can also force a server(even one that doesn't connect to you)
-# to be a leaf with "leaf = yes;"
+# See the Connect block documentation for details on how to do that.
 
 UWorld {
  name = "uworld.eu.undernet.org";
@@ -440,14 +439,17 @@ UWorld {
  name = "channels6.undernet.org";
 };
 
-# As of ircu2.10.05 is it possible to Jupe nicks. As per CFV-0095, the
-# following nicks must be juped, it is not allowed to jupe others as well.
+# As of ircu2.10.05 is it possible to Jupe nicks. As per CFV-0095 and
+# CFV-0255, the following nicks must be juped, it is not allowed to
+# jupe others as well.
 Jupe {
- nick = "EuWorld,E,StatServ,NoteServ";
- nick = "UWorld2,ChanSvr,ChanSaver,ChanServ";
- nick = "Uworld,NickSvr,NickSaver,NickServ";
- nick = "LPT1,X,login,LPT2,W,Undernet,COM1,V,protocol,COM2";
- nick = "U,pass,COM3,Y,AUX,COM4,Z,newpass";
+ nick = "A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,{,|,},~,-,_,`";
+ nick = "EuWorld,UWorld,UWorld2";
+ nick = "login,undernet,protocol,pass,newpass,org";
+ nick = "StatServ,NoteServ";
+ nick = "ChanSvr,ChanSaver,ChanServ";
+ nick = "NickSvr,NickSaver,NickServ";
+ nick = "LPT1,LPT2,COM1,COM2,COM3,COM4,AUX";
 };
 
 # [Kill]
@@ -481,8 +483,12 @@ Jupe {
 Kill { host = "*.au"; reason = "Please use a nearer server"; };
 Kill { host = "*.edu"; reason = "Please use a nearer server"; };
 
+# You can also kill based on username.
+Kill { username = "sub7"; realname = "s*7*"; reason = "You are infected with a Trojan";
+
 # The file can contain for example, a reason, a link to the
-# server rules and a contact address.
+# server rules and a contact address.  Note the combination
+# of username and host in the host field.
 Kill
 {
  host = "*luser@unixbox.flooder.co.uk";
@@ -547,7 +553,7 @@ Connect {
  host = "1.2.3.4";
  password = "passwd";
  port = 4400;
- class = "Servers";
+ class = "Server";
  hub;
 };
 
@@ -608,9 +614,11 @@ CRULE
 #  # and the default setting.
 # };
 #
-# 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.
+# By default, the password is hashed using the system's native crypt()
+# function.  Other password mechanisms are available; the umkpasswd
+# utility from the ircd directory can hash passwords using those
+# mechanisms.
+#
 # 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
@@ -624,7 +632,7 @@ Operator {
 };
 Operator {
  host = "*@*.uu.net";
- password = "notencryptedpass";
+ password = "$PLAIN$notencryptedpass";
  name = "Niels";
  class = "Opers";
 };
@@ -691,18 +699,28 @@ Port {
 Port { port = 6667; };
 Port { port = 6668; };
 Port {
+ # This only accepts clients with IPs like 192.168.*.
  mask = "192.168.*";
  port = 6666;
 };
 
-# This is a hidden client port, listening on the interface associated
-# with the IP address 168.8.21.107
+# This is a hidden client port, listening on 168.8.21.107.
 Port {
mask = "168.8.21.107";
vhost = "168.8.21.107";
  hidden = yes;
  port = 7000;
 };
 
+# Quarantine blocks disallow operators from using OPMODE and CLEARMODE
+# on certain channels.  Opers with the force_opmode (for local
+# channels, force_local_opmode) privilege may override the quarantine
+# by prefixing the channel name with an exclamation point ('!').
+# Wildcards are NOT supported; the channel name must match exactly.
+Quarantine {
+  "#shells" = "Thou shalt not support the h4><0rz";
+  "&kiddies" = "They can take care of themselves";
+};
+
 # 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
@@ -817,9 +835,9 @@ features
 #  "HIS_STATS_e" = "TRUE";
 #  "HIS_STATS_f" = "TRUE";
 #  "HIS_STATS_g" = "TRUE";
-#  "HIS_STATS_h" = "TRUE";
 #  "HIS_STATS_i" = "TRUE";
 #  "HIS_STATS_j" = "TRUE";
+#  "HIS_STATS_J" = "TRUE";
 #  "HIS_STATS_k" = "TRUE";
 #  "HIS_STATS_l" = "TRUE";
 #  "HIS_STATS_L" = "TRUE";