freebsd-nq/share/man/man4/dummynet.4

.\"
.\" $FreeBSD$
.\"
.Dd October 28, 2002
.Dt DUMMYNET 4
.Os
.Sh NAME
.Nm dummynet
.Nd traffic shaper, bandwidth manager and delay emulator
.Sh DESCRIPTION
The
.Nm
system facility permits the control of traffic
going through the various network interfaces, by applying bandwidth
and queue size limitations, implementing different scheduling and queue
management policies, and emulating delays and losses.
.Pp
The user interface for
.Nm
is implemented by the
.Xr ipfw 8
utility, so please refer to the
.Xr ipfw 8
manpage 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 IPFIREWALL_VERBOSE_LIMIT" -offset indent -compact
.It Dv IPFIREWALL
enable ipfirewall (required for
.Nm )
.It Dv IPFIREWALL_VERBOSE
enable firewall output
.It Dv IPFIREWALL_VERBOSE_LIMIT
limit firewall output
.It Dv DUMMYNET
enable
.Nm
operation
.It Dv NMBCLUSTERS
set the amount of network packet buffers
.It Dv HZ
set the timer granularity
.El
.Pp
Generally, the following options are required:
.Bd -literal -offset indent
options IPFIREWALL
options DUMMYNET
options HZ=1000		# strongly recommended
.Ed
.Pp
Additionally, one may want to increase the number
of mbuf clusters (used to store network packets) according to the
sum of the bandwidth-delay products and queue sizes of all configured
pipes.
.Sh SEE ALSO
.Xr setsockopt 2 ,
.Xr bridge 4 ,
.Xr if_bridge 4 ,
.Xr ip 4 ,
.Xr ipfw 8 ,
.Xr sysctl 8
.Sh HISTORY
The
.Nm
facility
was initially implemented as a testing tool for
.Tn TCP
congestion control by
.An Luigi Rizzo Aq luigi@iet.unipi.it ,
as described on ACM Computer Communication Review, Jan.97 issue.
Later it has been modified to work at the
.Tn IP
and bridging levels, integrated with the
.Xr ipfw 4
packet filter, and extended to
support multiple queueing and scheduling policies.
Add manpages for dummynet and bridging 1998-12-21 22:37:53 +00:00			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Add manpages for dummynet and bridging 1998-12-21 22:37:53 +00:00			`.\"`
Remove stale information from these two manpage, and point the readers to the one up-to-date page which is ipfw(8). MFC after: 3 days 2002-10-28 07:24:58 +00:00			`.Dd October 28, 2002`
Add manpages for dummynet and bridging 1998-12-21 22:37:53 +00:00			`.Dt DUMMYNET 4`
			`.Os`
			`.Sh NAME`
			`.Nm dummynet`
Remove stale information from these two manpage, and point the readers to the one up-to-date page which is ipfw(8). MFC after: 3 days 2002-10-28 07:24:58 +00:00			`.Nd traffic shaper, bandwidth manager and delay emulator`
Add manpages for dummynet and bridging 1998-12-21 22:37:53 +00:00			`.Sh DESCRIPTION`
mdoc(7) police: scheduled sweep. Approved by: re 2002-11-29 11:39:20 +00:00			`The`
			`.Nm`
			`system facility permits the control of traffic`
Add manpages for dummynet and bridging 1998-12-21 22:37:53 +00:00			`going through the various network interfaces, by applying bandwidth`
Remove stale information from these two manpage, and point the readers to the one up-to-date page which is ipfw(8). MFC after: 3 days 2002-10-28 07:24:58 +00:00			`and queue size limitations, implementing different scheduling and queue`
			`management policies, and emulating delays and losses.`
Add manpages for dummynet and bridging 1998-12-21 22:37:53 +00:00			`.Pp`
Remove stale information from these two manpage, and point the readers to the one up-to-date page which is ipfw(8). MFC after: 3 days 2002-10-28 07:24:58 +00:00			`The user interface for`
mdoc(7) police: scheduled sweep. Approved by: re 2002-11-29 11:39:20 +00:00			`.Nm`
Remove stale information from these two manpage, and point the readers to the one up-to-date page which is ipfw(8). MFC after: 3 days 2002-10-28 07:24:58 +00:00			`is implemented by the`
			`.Xr ipfw 8`
mdoc(7) police: scheduled sweep. Approved by: re 2002-11-29 11:39:20 +00:00			`utility, so please refer to the`
			`.Xr ipfw 8`
			`manpage for a complete description of the`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00			`.Nm`
mdoc(7) police: scheduled sweep. Approved by: re 2002-11-29 11:39:20 +00:00			`capabilities and how to use it.`
			`.Ss Kernel Options`
Remove stale information from these two manpage, and point the readers to the one up-to-date page which is ipfw(8). MFC after: 3 days 2002-10-28 07:24:58 +00:00			`The following options in the kernel configuration file are related to`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00			`.Nm`
Add manpages for dummynet and bridging 1998-12-21 22:37:53 +00:00			`operation:`
mdoc(7) police: scheduled sweep. Approved by: re 2002-11-29 11:39:20 +00:00			`.Pp`
			`.Bl -tag -width ".Dv IPFIREWALL_VERBOSE_LIMIT" -offset indent -compact`
			`.It Dv IPFIREWALL`
			`enable ipfirewall (required for`
			`.Nm )`
			`.It Dv IPFIREWALL_VERBOSE`
			`enable firewall output`
			`.It Dv IPFIREWALL_VERBOSE_LIMIT`
			`limit firewall output`
			`.It Dv DUMMYNET`
			`enable`
			`.Nm`
			`operation`
			`.It Dv NMBCLUSTERS`
			`set the amount of network packet buffers`
			`.It Dv HZ`
			`set the timer granularity`
			`.El`
Add manpages for dummynet and bridging 1998-12-21 22:37:53 +00:00			`.Pp`
			`Generally, the following options are required:`
mdoc(7) police: scheduled sweep. Approved by: re 2002-11-29 11:39:20 +00:00			`.Bd -literal -offset indent`
			`options IPFIREWALL`
			`options DUMMYNET`
			`options HZ=1000 # strongly recommended`
Add manpages for dummynet and bridging 1998-12-21 22:37:53 +00:00			`.Ed`
Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00			`.Pp`
mdoc(7) police: scheduled sweep. Approved by: re 2002-11-29 11:39:20 +00:00			`Additionally, one may want to increase the number`
Add manpages for dummynet and bridging 1998-12-21 22:37:53 +00:00			`of mbuf clusters (used to store network packets) according to the`
			`sum of the bandwidth-delay products and queue sizes of all configured`
			`pipes.`
			`.Sh SEE ALSO`
			`.Xr setsockopt 2 ,`
mdoc(7) police: sort xrefs. 2001-09-30 12:49:21 +00:00			`.Xr bridge 4 ,`
Add dummynet(4) support to if_bridge, this code is largely based on bridge.c. This is the final piece to match bridge.c in functionality, we can now be a drop-in replacement. Approved by: mlaier (mentor) 2005-06-10 01:25:22 +00:00			`.Xr if_bridge 4 ,`
Add manpages for dummynet and bridging 1998-12-21 22:37:53 +00:00			`.Xr ip 4 ,`
			`.Xr ipfw 8 ,`
remove fullstops from the end of .Xr lines in SEE ALSO sections. 2000-11-15 16:00:07 +00:00			`.Xr sysctl 8`
Add manpages for dummynet and bridging 1998-12-21 22:37:53 +00:00			`.Sh HISTORY`
mdoc(7) police: scheduled sweep. Approved by: re 2002-11-29 11:39:20 +00:00			`The`
Add manpages for dummynet and bridging 1998-12-21 22:37:53 +00:00			`.Nm`
mdoc(7) police: scheduled sweep. Approved by: re 2002-11-29 11:39:20 +00:00			`facility`
			`was initially implemented as a testing tool for`
			`.Tn TCP`
			`congestion control by`
Mdoc style fixes. PR: docs/22445 2000-11-01 11:17:33 +00:00			`.An Luigi Rizzo Aq luigi@iet.unipi.it ,`
Remove stale information from these two manpage, and point the readers to the one up-to-date page which is ipfw(8). MFC after: 3 days 2002-10-28 07:24:58 +00:00			`as described on ACM Computer Communication Review, Jan.97 issue.`
mdoc(7) police: scheduled sweep. Approved by: re 2002-11-29 11:39:20 +00:00			`Later it has been modified to work at the`
			`.Tn IP`
			`and bridging levels, integrated with the`
			`.Xr ipfw 4`
			`packet filter, and extended to`
Remove stale information from these two manpage, and point the readers to the one up-to-date page which is ipfw(8). MFC after: 3 days 2002-10-28 07:24:58 +00:00			`support multiple queueing and scheduling policies.`