Automated sync with ssh://hg.atheme.org//hg/charybdis

[irc/rqf/shadowircd.git] / doc / sgml / oper-guide / config.sgml

diff --git a/doc/sgml/oper-guide/config.sgml b/doc/sgml/oper-guide/config.sgml
index 0163a43517fe0761de9a3ba4e3175dd58f09161a..3eabdb89ff5169325920d1b9a24dbbb8c4208105 100644 (file)
--- a/doc/sgml/oper-guide/config.sgml
+++ b/doc/sgml/oper-guide/config.sgml
@@ -22,12 +22,6 @@
        Anything from a # to the end of a line is a comment. Blank lines are ignored. C-style comments are also supported.
       </para>
     </sect1>
-    <sect1 id="configlines">
-      <title>Specific blocks and directives</title>
-      <para>
-       Not all configuration blocks and directives are listed here, only the most common ones. More blocks and directives will
-       be documented in later revisions of this manual.
-      </para>
       <sect2>
        <title>loadmodule directive</title>
        <synopsis>
@@ -69,8 +63,7 @@ serverinfo {
            <term>sid</term>
            <listitem>
              <para>
-                A unique ID which describes the server. This is required regardless of whether you are using
-               TS6 or not.
+                A unique ID which describes the server.
                This consists of one digit and two characters which can be
                digits or letters.
              </para>
@@ -293,7 +286,13 @@ auth {
          <varlistentry>
             <term>user</term>
             <listitem>
-              <para>A hostmask (user@host) that the auth{} block is matched against. You can have multiple user entries.</para>
+              <para>
+                A hostmask (user@host) that the auth {} block applies to.
+                It is matched against the hostname and IP address (using ::
+                shortening for IPv6 and prepending a 0 if it starts with
+                a colon) and can also use CIDR masks.
+                You can have multiple user entries.
+              </para>
             </listitem>
           </varlistentry>
          <varlistentry>
@@ -309,13 +308,13 @@ auth {
          <varlistentry>
             <term>spoof</term>
             <listitem>
-              <para>An optional fake hostname (or user@host) to apply to users authenticated to this auth{} block.</para>
+              <para>An optional fake hostname (or user@host) to apply to users authenticated to this auth{} block. In STATS i and TESTLINE, an equals sign (=) appears before the user@host and the spoof is shown.</para>
             </listitem>
           </varlistentry>
          <varlistentry>
             <term>flags</term>
             <listitem>
-              <para>A list of flags to apply to this auth{} block. They are listed below.</para>
+              <para>A list of flags to apply to this auth{} block. They are listed below. Some of the flags appear as a special character, parenthesized in the list, before the user@host in STATS i and TESTLINE.</para>
             </listitem>
           </varlistentry>
          <varlistentry>
@@ -340,27 +339,21 @@ auth {
            </listitem>
          </varlistentry>
          <varlistentry>
-           <term>exceed_limit</term>
+           <term>exceed_limit (&gt;)</term>
            <listitem>
              <para>Users in this auth{} block can exceed class-wide limitations.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
-           <term>dnsbl_exempt</term>
+           <term>dnsbl_exempt ($)</term>
            <listitem>
              <para>Users in this auth{} block are exempted from DNS blacklist checks. However, they will still be warned if they are listed.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
-           <term>kline_exempt</term>
-           <listitem>
-             <para>Users in this auth{} block are exempted from DNS blacklists, k:lines, g:lines and x:lines, and will not be disconnected because of d:lines.</para>
-           </listitem>
-         </varlistentry>
-         <varlistentry>
-           <term>gline_exempt</term>
+           <term>kline_exempt (^)</term>
            <listitem>
-             <para>Users in this auth{} block are exempted from g:lines.</para>
+             <para>Users in this auth{} block are exempted from DNS blacklists, k:lines, g:lines and x:lines.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
@@ -389,7 +382,7 @@ auth {
            </listitem>
          </varlistentry>
          <varlistentry>
-           <term>flood_exempt</term>
+           <term>flood_exempt (|)</term>
            <listitem>
              <para>
                 Users in this auth{} block may send arbitrary amounts of
@@ -400,13 +393,13 @@ auth {
            </listitem>
          </varlistentry>
          <varlistentry>
-           <term>no_tilde</term>
+           <term>no_tilde (-)</term>
            <listitem>
              <para>Users in this auth{} block will not have a tilde added to their username if they do not run identd.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
-           <term>need_ident</term>
+           <term>need_ident (+)</term>
            <listitem>
              <para>Users in this auth{} block must have identd, otherwise they will be rejected.</para>
            </listitem>
@@ -515,8 +508,8 @@ operator "<replaceable>name</replaceable>" {
            <listitem>
               <para>
                A listing of privileges granted to operators using this block.
-               By default, the operwall and remoteban privileges are granted;
-               use ~operwall and ~remoteban to disable them if necessary.
+               By default, the mass_notice, operwall, remoteban and resv privileges are granted;
+               use ~mass_notice, ~operwall, ~remoteban and ~resv to disable them if necessary.
              </para>
              <para>
                In addition, a flag designating if the password is encrypted is here.
@@ -555,6 +548,10 @@ connect "<replaceable>name</replaceable>" {
                Furthermore, if a hostname is used, it must have an A or AAAA
                record (no CNAME) and it must be the primary
                hostname for inbound connections to work.
+             </para><para>
+               IPv6 addresses must be in :: shortened form; addresses which
+               then start with a colon must be prepended with a zero,
+               for example 0::1.
              </para></note>
            </listitem>
          </varlistentry>
@@ -650,6 +647,7 @@ connect "<replaceable>name</replaceable>" {
            <term>topicburst</term>
            <listitem>
              <para>Topics should be bursted to this server.</para>
+             <para>This is enabled by default.</para>
            </listitem>
          </varlistentry>
        </variablelist>