xref: /netbsd-src/share/man/man4/altq.4 (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1.\" $NetBSD: altq.4,v 1.2 2011/06/23 07:47:22 wiz Exp $
2.\"
3.\" Copyright (c) 2011 Jukka Ruohonen <jruohonen@iki.fi>
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\"
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd June 22, 2011
28.Dt ALTQ 4
29.Os
30.Sh NAME
31.Nm altq
32.Nd alternate queuing framework
33.Sh SYNOPSIS
34.Cd options ALTQ
35.Cd options ALTQ_BLUE
36.Cd options ALTQ_CBQ
37.Cd options ALTQ_CDNR
38.Cd options ALTQ_FIFOQ
39.Cd options ALTQ_FLOWVALVE
40.Cd options ALTQ_HFSC
41.Cd options ALTQ_LOCALQ
42.Cd options ALTQ_PRIQ
43.Cd options ALTQ_RED
44.Cd options ALTQ_RIO
45.Cd options ALTQ_WFQ
46.Sh DESCRIPTION
47The
48.Nm
49framework provides several disciplines for queuing outgoing network packets.
50While traffic shaping is perhaps the most prominent example,
51.Nm
52provides also other measures related to QoS.
53The framework has been integrated to the
54.Xr pf 4
55packet filter since
56.Nx 4.0 .
57.Pp
58At the implementation level
59.Nm
60modifies the interface packet queues.
61Therefore the driver modifications described in
62.Xr altq 9
63are required in order to use a certain network card with
64.Nm .
65.Sh FILES
66.Bd -literal
67/dev/altq
68.Ed
69.Sh SEE ALSO
70.Xr pf 4 ,
71.Xr altq.conf 5 ,
72.Xr altqd 8 ,
73.Xr altq 9
74.Rs
75.%A Kenjiro Cho
76.%T Fitting theory into reality in the ALTQ case
77.%D March, 2004
78.%C Taipei, Taiwan
79.%O Asia BSD conference
80.%U http://www.sonycsl.co.jp/~kjc/papers/fittingtheory.pdf
81.Re
82.\" .Sh HISTORY
83.\"
84.\" XXX: Write this.
85