docs/78096: Add info on setting up ATLQ

[Tom Rhodes]

Hi Brad,


This is extremely useful and I agree we need it in the docs, but
I have some comments on it.

--- doc-ori/en_US.ISO8859-1/books/handbook/firewalls/chapter.sgml	Fri Feb 25 13:31:41 2005
+++ doc/en_US.ISO8859-1/books/handbook/firewalls/chapter.sgml	Fri Feb 25 14:05:54 2005
@@ -198,7 +198,7 @@
   </sect1>
 
   <sect1 id="firewalls-pf">
-    <title>The Packet Filter (PF) Firewall</title>
+    <title>The Packet Filter (PF) Firewall and ALTQ</title>
 
     <indexterm>
       <primary>firewall</primary>
@@ -211,9 +211,9 @@
       contained <acronym>PF</acronym> as an integrated part of the
       base system was &os; 5.3 in November 2004.
       <acronym>PF</acronym> is a complete, fully featured firewall
-      that contains <acronym>ALTQ</acronym> for bandwidth usage
-      management in a way similar to what DUMMYNET provides in
-      <acronym>IPFW</acronym>.  The OpenBSD project does an
+      that contains <acronym>ALTQ</acronym> (Alternate Queuing) for
+      bandwidth usage management in a way similar to what DUMMYNET
+      provides in <acronym>IPFW</acronym>.  The OpenBSD project does an
       outstanding job of maintaining the PF users' guide that it will
       not be made part of this handbook firewall section as that would
       just be duplicated effort.</para>

Good, here is where we introduce what ALTQ stands for.  Now, I
may be out of context, but what does it do?  :)

@@ -356,6 +356,61 @@
         enable the following option as well:</para>
 
       <programlisting>gateway_enable="YES"            # Enable as Lan gateway</programlisting>
+
+    </sect2>
+    <sect2>
+      <title>Enabling ALTQ</title>
+
+      <para>ALTQ is only avaliable by compiling the options into the
+        &os; Kernel.</para>
+
+      <para>ALTQ is not supported by all of the avaliable network card
+        drivers.  Please see the &man.altq.4; manual page for a list of
+        drivers that are supported in your release of &os;.

Missing <para>, <acronym> tags here.

These two can probably be merged together, something like:

While <acronym>ALTQ</acronym> is a useful option ... explain why
... it is not yet supported by all network interface card
drivers.  Please see the &man.altq.4; manual page for an up
to date list on supported drivers.  To gain <acronym>ALTQ</acronym>
support, the following options must be compiled into the kernel:

Then list the kernel options, like you do here:


+
+      <programlisting>options         ALTQ
+options         ALTQ_CBQ        # Class Bases Queuing
+options         ALTQ_RED        # Random Early Detection
+options         ALTQ_RIO        # RED In/Out
+options         ALTQ_HFSC       # Hierarchical Packet Scheduler
+options         ALTQ_PRIQ       # Priority Queuing
+options         ALTQ_NOPCC      # Required for SMP build</programlisting>
+
+      <para><literal>options ALTQ</literal> enables the ALTQ framework.</para>
+
+      <para><literal>options ALTQ_CBQ</literal> enables Class Based
+        Queuing (CBQ).  CBQ allows you to divide a connections's
+        bandwidth into different classes or queues.</para>
+
+      <para><literal>options ALTQ_RED</literal> enables Random Early
+        Detection (RED).  RED is used to avoid network congestion.  RED
+        does this by measuring the length of the queue and comparing
+        it to the minimum and maximum thresholds for the queue.  If the
+        queue is over the maximum all new packets will be dropped.  True
+        to its name, RED drops packets from different connections
+        randomly.</para>
+
+      <para><literal>options ALTQ_RIO</literal> enables Random Early
+        Detection In and Out.</para>
+
+      <para><literal>options ALTQ_HFSC</literal> enables Hierarchical
+        Fair Service Curve Packet Scheduler.  See <ulink
+        url="http://www-2.cs.cmu.edu/~hzhang/HFSC/main.html"></ulink>
+        for more info.</para>
+
+      <para><literal>options ALTQ_PRIQ</literal> enables Priority
+        Queuing (PRIQ).  PRIQ will always pass traffic that is in a
+        higher queue first.</para>
+
+      <para><literal>options ALTQ_NOPCC</literal> enables SMP support
+        for ALTQ.  This option is required on SMP systems.</para>
 

This will give you better content in a single section in place
of scattered information.

And don't forget the other comment in the PR trail.  :)

-- 
Tom Rhodes