mirror of
https://github.com/freebsd/freebsd-src.git
synced 2024-12-04 16:49:40 +00:00
Add a minimal altq.4 manpage to tell about the kernel options and where to
find more information. Also move the "SUPPORTED DEVICES" section from altq.9 to altq.4, where is belongs. Requested by: green MFC after: 2 days
This commit is contained in:
parent
e59142714c
commit
f6b2c4eca5
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=136220
@ -13,6 +13,7 @@ MAN= aac.4 \
|
||||
ahc.4 \
|
||||
ahd.4 \
|
||||
aio.4 \
|
||||
altq.4 \
|
||||
amd.4 \
|
||||
amr.4 \
|
||||
an.4 \
|
||||
@ -346,6 +347,7 @@ MAN= aac.4 \
|
||||
|
||||
MLINKS= agp.4 agpgart.4
|
||||
MLINKS+=an.4 if_an.4
|
||||
MLINKS+=altq.4 ALTQ.4
|
||||
MLINKS+=ata.4 acd.4 \
|
||||
ata.4 ad.4 \
|
||||
ata.4 afd.4 \
|
||||
|
140
share/man/man4/altq.4
Normal file
140
share/man/man4/altq.4
Normal file
@ -0,0 +1,140 @@
|
||||
.\"
|
||||
.\" 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$
|
||||
.\"
|
||||
.Dd October 7, 2004
|
||||
.Dt ALTQ 4
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ALTQ
|
||||
.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
|
||||
.It Dv ALTQ_CBQ
|
||||
build the
|
||||
.Dq "Class Based Queuing"
|
||||
discipline.
|
||||
.It Dv ALTQ_RED
|
||||
build the
|
||||
.Dq "Random Early Drop"
|
||||
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 consumer.
|
||||
.It Dv ALTQ_PRIQ
|
||||
build the
|
||||
.Dq "Priority Queuing"
|
||||
discipline.
|
||||
.It Dv ALTQ_NOPCC
|
||||
required for SMP builds.
|
||||
.It Dv ALTQ_DEBUG
|
||||
enable additional debugging facilities.
|
||||
.El
|
||||
.Pp
|
||||
Note that
|
||||
.Nm Ns -disciplines
|
||||
can not 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
|
||||
and required to use a certain network card with
|
||||
.Nm
|
||||
have been applied to the following hardware drivers
|
||||
.Xr an 4 ,
|
||||
.Xr ath 4 ,
|
||||
.Xr awi 4 ,
|
||||
.Xr bfe 4 ,
|
||||
.Xr em 4 ,
|
||||
.Xr fxp 4 ,
|
||||
.Xr hme 4 ,
|
||||
.Xr lnc 4 ,
|
||||
.Xr wi 4 ,
|
||||
.Xr de 4 ,
|
||||
.Xr rl 4 ,
|
||||
.Xr sis 4 ,
|
||||
.Xr vr 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 pfctl 8 ,
|
||||
.Xr altq 9 .
|
@ -594,36 +594,6 @@ Queuing disciplines also need to guarantee that the same mbuf is returned if
|
||||
.Fn IFQ_DEQUEUE
|
||||
is called immediately after
|
||||
.Fn IFQ_POLL .
|
||||
.Sh SUPPORTED DEVICES
|
||||
The herein described modifications have been applied to the following
|
||||
hardware drivers
|
||||
.Xr an 4 ,
|
||||
.Xr ath 4 ,
|
||||
.Xr bfe 4 ,
|
||||
.Xr dc 4 ,
|
||||
.Xr de 4 ,
|
||||
.Xr em 4 ,
|
||||
.Xr fxp 4 ,
|
||||
.Xr hme 4 ,
|
||||
.Xr lnc 4 ,
|
||||
.Xr rl 4 ,
|
||||
.Xr sis 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 ,
|
||||
|
Loading…
Reference in New Issue
Block a user