1.\" $NetBSD: altq.4,v 1.8 2024/09/07 20:33:53 rillig 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 March 20, 2018 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 49system is a framework which provides several disciplines for queuing outgoing 50network packets. 51While traffic shaping is perhaps the most prominent example, 52.Nm 53provides also other measures related to QoS. 54The framework has been integrated to the 55.Xr pf 4 56packet filter since 57.Nx 4.0 . 58.Pp 59At the implementation level 60.Nm 61modifies the interface packet queues. 62Therefore the driver modifications described in 63.Xr altq 9 64are required in order to use a certain network card with 65.Nm . 66.Sh FILES 67.Bd -literal 68/dev/altq 69.Ed 70.Sh SEE ALSO 71.Xr pf 4 , 72.Xr altq.conf 5 , 73.Xr altqd 8 , 74.Xr altq 9 75.Rs 76.%A Kenjiro Cho 77.%T Fitting theory into reality in the ALTQ case 78.%D March, 2004 79.%C Taipei, Taiwan 80.%O Asia BSD conference 81.%U http://www.sonycsl.co.jp/person/kjc/papers/fittingtheory.pdf 82.Re 83.Sh HISTORY 84The 85.Nm 86system first appeared in March 1997 and found its home in the KAME project 87.Lk ( https://www.kame.net ) . 88It was imported into 89.Nx 1.6 . 90.Sh CAVEATS 91Please note that you must compile 92.Xr pf 4 93in the kernel, using the PF 94.Xr module 7 95alongside 96.Nm 97built in the kernel will not work. 98