Bring in the altq.4 man page from FreeBSD.
authorSascha Wildner <swildner@dragonflybsd.org>
Sun, 19 Mar 2006 02:57:38 +0000 (02:57 +0000)
committerSascha Wildner <swildner@dragonflybsd.org>
Sun, 19 Mar 2006 02:57:38 +0000 (02:57 +0000)
Minor modifications I have done:

* Comment out description of the ALTQ_CDNR option that we don't have.

* Update the list of adapters that support ALTQ. It's likely that
  some are still missing from this list.

Note that the altq.9 man page not there yet. It will be added later.

share/man/man4/Makefile
share/man/man4/altq.4 [new file with mode: 0644]

index 9fb506a..16bf629 100644 (file)
@@ -1,6 +1,6 @@
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 # $FreeBSD: src/share/man/man4/Makefile,v 1.83.2.66 2003/06/04 17:10:30 sam Exp $
-# $DragonFly: src/share/man/man4/Makefile,v 1.30 2005/12/20 01:54:09 corecode Exp $
+# $DragonFly: src/share/man/man4/Makefile,v 1.31 2006/03/19 02:57:38 swildner Exp $
 
 MAN=   aac.4 \
        acpi.4 \
@@ -12,6 +12,7 @@ MAN=  aac.4 \
        ahb.4 \
        ahc.4 \
        ahd.4 \
+       altq.4 \
        amd.4 \
        amr.4 \
        an.4 \
diff --git a/share/man/man4/altq.4 b/share/man/man4/altq.4
new file mode 100644 (file)
index 0000000..8b52261
--- /dev/null
@@ -0,0 +1,187 @@
+.\"
+.\" Copyright (c) 2004 Max Laier <mlaier@FreeBSD.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD: src/share/man/man4/altq.4,v 1.16 2006/03/02 19:45:59 thompsa Exp $
+.\" $DragonFly: src/share/man/man4/altq.4,v 1.1 2006/03/19 02:57:38 swildner Exp $
+.\"
+.Dd March 18, 2006
+.Dt ALTQ 4
+.Os
+.Sh NAME
+.Nm ALTQ
+.Nd "alternate queuing of network packets"
+.Sh SYNOPSIS
+.Cd options ALTQ
+.Pp
+.Cd options ALTQ_CBQ
+.Cd options ALTQ_RED
+.Cd options ALTQ_RIO
+.Cd options ALTQ_HFSC
+.\".Cd options ALTQ_CDNR
+.Cd options ALTQ_PRIQ
+.Sh DESCRIPTION
+The
+.Nm
+framework provides several disciplines for queuing outgoing network packets.
+This is done by modifications to the interface packet queues.
+See
+.Xr altq 9
+for details.
+.Pp
+The user interface for
+.Nm
+is implemented by the
+.Xr pfctl 8
+utility, so please refer to the
+.Xr pfctl 8
+and the
+.Xr pf.conf 5
+manpages for a complete description of the
+.Nm
+capabilities and how to use it.
+.Ss Kernel Options
+The following options in the kernel configuration file are related to
+.Nm
+operation:
+.Pp
+.Bl -tag -width ".Dv ALTQ_DEBUG" -compact
+.It Dv ALTQ
+Enable
+.Nm .
+.It Dv ALTQ_CBQ
+Build the
+.Dq "Class Based Queuing"
+discipline.
+.It Dv ALTQ_RED
+Build the
+.Dq "Random Early Detection"
+extension.
+.It Dv ALTQ_RIO
+Build
+.Dq "Random Early Drop"
+for input and output.
+.It Dv ALTQ_HFSC
+Build the
+.Dq "Hierarchical Packet Scheduler"
+discipline.
+.\".It Dv ALTQ_CDNR
+.\"Build the traffic conditioner.
+.\"This option is meaningless at the moment as the conditioner is not used by
+.\"any of the available disciplines or consumers.
+.It Dv ALTQ_PRIQ
+Build the
+.Dq "Priority Queuing"
+discipline.
+.It Dv ALTQ_NOPCC
+Required if the TSC is unusable.
+.It Dv ALTQ_DEBUG
+Enable additional debugging facilities.
+.El
+.Pp
+Note that
+.Nm Ns -disciplines
+cannot be loaded as kernel modules.
+In order to use a certain discipline you have to build it into a custom
+kernel.
+The
+.Xr pf 4
+interface, that is required for the configuration process of
+.Nm
+can be loaded as a module.
+.Sh SUPPORTED DEVICES
+The driver modifications described in
+.Xr altq 9
+are required to use a certain network card with
+.Nm .
+They have been applied to the following hardware drivers:
+.Xr an 4 ,
+.Xr aue 4 ,
+.Xr awi 4 ,
+.Xr axe 4 ,
+.Xr bfe 4 ,
+.Xr bge 4 ,
+.Xr cs 4 ,
+.Xr cue 4 ,
+.Xr dc 4 ,
+.Xr ed 4 ,
+.Xr el 4 ,
+.Xr em 4 ,
+.Xr ep 4 ,
+.Xr ex 4 ,
+.Xr fe 4 ,
+.Xr fwe 4 ,
+.Xr fxp 4 ,
+.Xr gx 4 ,
+.Xr ie 4 ,
+.Xr ipw 4 ,
+.Xr iwi 4 ,
+.Xr le 4 ,
+.Xr lge 4 ,
+.Xr lnc 4 ,
+.Xr my 4 ,
+.Xr nge 4 ,
+.Xr nv 4 ,
+.Xr pcn 4 ,
+.Xr ray 4 ,
+.Xr rdp 4 ,
+.Xr re 4 ,
+.Xr rl 4 ,
+.Xr sf 4 ,
+.Xr sis 4 ,
+.Xr sk 4 ,
+.Xr sn 4 ,
+.Xr ste 4 ,
+.Xr ti 4 ,
+.Xr tl 4 ,
+.Xr tx 4 ,
+.Xr txp 4 ,
+.Xr vr 4 ,
+.Xr vx 4 ,
+.Xr wb 4 ,
+.Xr wi 4 ,
+.Xr wl 4 ,
+.Xr xe 4 ,
+and
+.Xr xl 4 .
+.Pp
+The
+.Xr ndis 4
+framework also has support for
+.Nm
+and thus all encapsulated drivers.
+.Pp
+The
+.Xr tun 4
+.\"and
+.\".Xr ng_iface 4
+.\"pseudo drivers also do support
+pseudo driver also does support
+.Nm .
+.Sh SEE ALSO
+.Xr pf 4 ,
+.Xr pf.conf 5 ,
+.Xr ipfw 8 ,
+.Xr pfctl 8 ,
+.Xr altq 9