summaryrefslogtreecommitdiffstats
path: root/share/man/man4/dummynet.4
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2002-11-29 11:39:20 +0000
committerru <ru@FreeBSD.org>2002-11-29 11:39:20 +0000
commit6d3a461a4f20776be1a83de2eada39cb152efd48 (patch)
treee178090675cafc86fcb97bb414bb098780299953 /share/man/man4/dummynet.4
parentda32bc58a0c07d9ab5fab6a3dc0c10e746ac2dbd (diff)
downloadFreeBSD-src-6d3a461a4f20776be1a83de2eada39cb152efd48.zip
FreeBSD-src-6d3a461a4f20776be1a83de2eada39cb152efd48.tar.gz
mdoc(7) police: scheduled sweep.
Approved by: re
Diffstat (limited to 'share/man/man4/dummynet.4')
-rw-r--r--share/man/man4/dummynet.467
1 files changed, 42 insertions, 25 deletions
diff --git a/share/man/man4/dummynet.4 b/share/man/man4/dummynet.4
index 624f451..56d3140 100644
--- a/share/man/man4/dummynet.4
+++ b/share/man/man4/dummynet.4
@@ -8,42 +8,53 @@
.Nm dummynet
.Nd traffic shaper, bandwidth manager and delay emulator
.Sh DESCRIPTION
-.Em dummynet
-is a system facility that permits the control of traffic
+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
-.Em dummynet
+.Nm
is implemented by the
-.Nm ipfw
-program, so the reader is referred to the
.Xr ipfw 8
-manpage for a complete description of the capabilities of
+utility, so please refer to the
+.Xr ipfw 8
+manpage for a complete description of the
.Nm
-and on how to use it.
-.Sh KERNEL OPTIONS
+capabilities and how to use it.
+.Ss Kernel Options
The following options in the kernel configuration file are related to
.Nm
operation:
-.Bd -literal
- IPFIREWALL - enable ipfirewall (required for dummynet).
- IPFIREWALL_VERBOSE - enable firewall output.
- IPFIREWALL_VERBOSE_LIMIT - limit firewall output.
- DUMMYNET - enable dummynet operation.
- NMBCLUSTERS - set the amount of network packet buffers
- HZ - sets the timer granularity
-.Ed
+.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
- options IPFIREWALL
- options DUMMYNET
- options HZ=1000 # strongly recommended
+.Bd -literal -offset indent
+options IPFIREWALL
+options DUMMYNET
+options HZ=1000 # strongly recommended
.Ed
.Pp
-additionally, one may want to increase the number
+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.
@@ -54,11 +65,17 @@ pipes.
.Xr ipfw 8 ,
.Xr sysctl 8
.Sh HISTORY
+The
.Nm
-was initially implemented as a testing tool for TCP congestion control
-by
+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 then modified to work at the ip and bridging
-level, integrated with the IPFW packet filter, and extended to
+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.
OpenPOWER on IntegriCloud