Document the <burst> option in the manpages

This commit is contained in:
Tom Eastep 2011-02-24 15:49:35 -08:00
parent 951f641a6c
commit dcdfb60483
2 changed files with 28 additions and 13 deletions

View File

@ -121,7 +121,7 @@
<varlistentry>
<term><emphasis role="bold">IN-BANDWIDTH</emphasis> -
<emphasis>bandwidth</emphasis></term>
<replaceable>bandwidth</replaceable>[:<replaceable>burst</replaceable>]</term>
<listitem>
<para>The incoming <emphasis>bandwidth</emphasis> of that interface.
@ -136,6 +136,13 @@
value to zero in which case Shorewall will not create an ingress
qdisc.Must be set to zero if the REDIRECTED INTERFACES column is
non-empty.</para>
<para>The optional burst option was added in Shorewall 4.4.13. The
default <replaceable>burst</replaceable> is 10kb. A larger
<replaceable>burst</replaceable> can help make the
<replaceable>bandwidth</replaceable> more accurate; often for fast
lines, the enforced rate is well below the specified
<replaceable>bandwidth</replaceable>.</para>
</listitem>
</varlistentry>
@ -219,12 +226,13 @@
url="http://shorewall.net/traffic_shaping.htm">http://shorewall.net/traffic_shaping.htm</ulink></para>
<para>shorewall(8), shorewall-accounting(5), shorewall-actions(5),
shorewall-blacklist(5), shorewall-hosts(5), shorewall_interfaces(5), shorewall-ipsets(5),
shorewall-maclist(5), shorewall-masq(5), shorewall-nat(5),
shorewall-netmap(5), shorewall-params(5), shorewall-policy(5),
shorewall-providers(5), shorewall-proxyarp(5), shorewall-route_rules(5),
shorewall-routestopped(5), shorewall-rules(5), shorewall.conf(5), shorewall-secmarks(5),
shorewall-tcclasses(5), shorewall-tcrules(5), shorewall-tos(5),
shorewall-tunnels(5), shorewall-zones(5)</para>
shorewall-blacklist(5), shorewall-hosts(5), shorewall_interfaces(5),
shorewall-ipsets(5), shorewall-maclist(5), shorewall-masq(5),
shorewall-nat(5), shorewall-netmap(5), shorewall-params(5),
shorewall-policy(5), shorewall-providers(5), shorewall-proxyarp(5),
shorewall-route_rules(5), shorewall-routestopped(5), shorewall-rules(5),
shorewall.conf(5), shorewall-secmarks(5), shorewall-tcclasses(5),
shorewall-tcrules(5), shorewall-tos(5), shorewall-tunnels(5),
shorewall-zones(5)</para>
</refsect1>
</refentry>

View File

@ -121,8 +121,8 @@
</varlistentry>
<varlistentry>
<term><emphasis role="bold">IN-BANDWIDTH</emphasis> -
<emphasis>bandwidth</emphasis></term>
<term><emphasis role="bold">IN-BANDWIDTH</emphasis> - <emphasis
role="bold"><replaceable>bandwidth</replaceable>[:<replaceable>burst</replaceable>]</emphasis></term>
<listitem>
<para>The incoming <emphasis>bandwidth</emphasis> of that interface.
@ -137,6 +137,13 @@
value to zero in which case Shorewall6 will not create an ingress
qdisc.Must be set to zero if the REDIRECTED INTERFACES column is
non-empty.</para>
<para>The optional burst option was added in Shorewall6 4.4.13. The
default <replaceable>burst</replaceable> is 10kb. A larger
<replaceable>burst</replaceable> can help make the
<replaceable>bandwidth</replaceable> more accurate; often for fast
lines, the enforced rate is well below the specified
<replaceable>bandwidth</replaceable>.</para>
</listitem>
</varlistentry>
@ -224,8 +231,8 @@
shorewall6-blacklist(5), shorewall6-hosts(5), shorewall6-interfaces(5),
shorewall6-maclist(5), shorewall6-params(5), shorewall6-policy(5),
shorewall6-providers(5), shorewall6-route_rules(5),
shorewall6-routestopped(5), shorewall6-rules(5), shorewall6.conf(5), shorewall6-secmarks(5),
shorewall6-tcclasses(5), shorewall6-tcrules(5), shorewall6-tos(5),
shorewall6-tunnels(5), shorewall6-zones(5)</para>
shorewall6-routestopped(5), shorewall6-rules(5), shorewall6.conf(5),
shorewall6-secmarks(5), shorewall6-tcclasses(5), shorewall6-tcrules(5),
shorewall6-tos(5), shorewall6-tunnels(5), shorewall6-zones(5)</para>
</refsect1>
</refentry>