1.\" 2.\" Copyright (c) 2004 Max Laier <mlaier@FreeBSD.org> 3.\" All rights reserved. 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.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" 26.\" $FreeBSD: src/share/man/man4/altq.4,v 1.16 2006/03/02 19:45:59 thompsa Exp $ 27.\" $DragonFly: src/share/man/man4/altq.4,v 1.4 2007/09/26 18:13:14 swildner Exp $ 28.\" 29.Dd March 18, 2006 30.Dt ALTQ 4 31.Os 32.Sh NAME 33.Nm ALTQ 34.Nd "alternate queuing of network packets" 35.Sh SYNOPSIS 36.Cd options ALTQ 37.Pp 38.Cd options ALTQ_CBQ 39.Cd options ALTQ_RED 40.Cd options ALTQ_RIO 41.Cd options ALTQ_HFSC 42.\".Cd options ALTQ_CDNR 43.Cd options ALTQ_PRIQ 44.Cd options ALTQ_NOPCC 45.Cd options ALTQ_DEBUG 46.Sh DESCRIPTION 47The 48.Nm 49framework provides several disciplines for queuing outgoing network packets. 50This is done by modifications to the interface packet queues. 51See 52.Xr altq 9 53for details. 54.Pp 55The user interface for 56.Nm 57is implemented by the 58.Xr pfctl 8 59utility, so please refer to the 60.Xr pfctl 8 61and the 62.Xr pf.conf 5 63manpages for a complete description of the 64.Nm 65capabilities and how to use it. 66.Ss Kernel Options 67The following options in the kernel configuration file are related to 68.Nm 69operation: 70.Pp 71.Bl -tag -width ".Dv ALTQ_DEBUG" -compact 72.It Dv ALTQ 73Enable 74.Nm . 75.It Dv ALTQ_CBQ 76Build the 77.Dq "Class Based Queuing" 78discipline. 79.It Dv ALTQ_RED 80Build the 81.Dq "Random Early Detection" 82extension. 83.It Dv ALTQ_RIO 84Build 85.Dq "Random Early Drop" 86for input and output. 87.It Dv ALTQ_HFSC 88Build the 89.Dq "Hierarchical Packet Scheduler" 90discipline. 91.\".It Dv ALTQ_CDNR 92.\"Build the traffic conditioner. 93.\"This option is meaningless at the moment as the conditioner is not used by 94.\"any of the available disciplines or consumers. 95.It Dv ALTQ_PRIQ 96Build the 97.Dq "Priority Queuing" 98discipline. 99.It Dv ALTQ_NOPCC 100Required if the TSC is unusable. 101.It Dv ALTQ_DEBUG 102Enable additional debugging facilities. 103.El 104.Pp 105Note that 106.Nm Ns -disciplines 107cannot be loaded as kernel modules. 108In order to use a certain discipline you have to build it into a custom 109kernel. 110The 111.Xr pf 4 112interface, that is required for the configuration process of 113.Nm 114can be loaded as a module. 115.Sh SEE ALSO 116.Xr pf 4 , 117.Xr pf.conf 5 , 118.Xr ipfw 8 , 119.Xr pfctl 8 , 120.Xr altq 9 121