diff --git a/share/man/man4/altq.4 b/share/man/man4/altq.4 index 053cc732c393..eeaabd8ad4ae 100644 --- a/share/man/man4/altq.4 +++ b/share/man/man4/altq.4 @@ -1,146 +1,146 @@ .\" -.\" Copyright (c) 2004 Max Laier +.\" Copyright (c) 2004 Max Laier .\" 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$ +.\" $FreeBSD$ .\" .Dd December 24, 2004 .Dt ALTQ 4 .Os .Sh NAME .Nm ALTQ -.Nd Alternate queuing of network packets +.Nd "alternate queuing of network packets" .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 +Enable +.Nm . .It Dv ALTQ_CBQ -build the +Build the .Dq "Class Based Queuing" discipline. .It Dv ALTQ_RED -build the +Build the .Dq "Random Early Drop" extension. .It Dv ALTQ_RIO -build +Build .Dq "Random Early Drop" for input and output. .It Dv ALTQ_HFSC -build the +Build the .Dq "Hierarchical Packet Scheduler" discipline. .It Dv ALTQ_CDNR -build the traffic conditioner. +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 +Build the .Dq "Priority Queuing" discipline. .It Dv ALTQ_NOPCC -required for SMP builds. +Required for SMP builds. .It Dv ALTQ_DEBUG -enable additional debugging facilities. +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 ath 4 , .Xr awi 4 , .Xr bfe 4 , .Xr bge 4 , .Xr dc 4 , .Xr de 4 , .Xr ed 4 , .Xr em 4 , .Xr fxp 4 , .Xr hme 4 , .Xr lnc 4 , .Xr rl 4 , .Xr sf 4 , .Xr sis 4 , .Xr sk 4 , .Xr vr 4 , .Xr wi 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 pseudo driver also does support .Nm and includes the required modifications. .Sh SEE ALSO .Xr pf 4 , .Xr pf.conf 5 , .Xr ipfw 8 , .Xr pfctl 8 , -.Xr altq 9 . +.Xr altq 9