extern/shorewall_code
1
0
Fork 1
mirror of https://gitlab.com/shorewall/code.git synced 2024-11-14 03:34:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

New syntax convention in tcclasses manpage

Browse Source 
git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@4989 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
This commit is contained in:
teastep 2006-11-23 16:01:54 +00:00
parent f44e5d44e9
commit bd309643a1
1 changed files with 29 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
manpages/shorewall-tcclasses.xml
View File

@ -21,7 +21,8 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<para>A note on the rate/bandwidth definitions used in this file:</para> <para>A note on the <emphasis>rate</emphasis>/bandwidth definitions used
in this file:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -109,12 +110,14 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><emphasis role="bold">INTERFACE</emphasis></term> <term><emphasis role="bold">INTERFACE</emphasis> —
<emphasis>interface</emphasis></term>
<listitem> <listitem>
<para>Name of interface. Each interface may be listed only once in <para>Name of <emphasis>interface</emphasis>. Each interface may be
this file. You may NOT specify the name of an alias (e.g., eth0:0) listed only once in this file. You may NOT specify the name of an
here; see http://www.shorewall.net/FAQ.htm#faq18</para> alias (e.g., eth0:0) here; see
http://www.shorewall.net/FAQ.htm#faq18</para>
<para>You may NOT specify wildcards here, e.g. if you have multiple <para>You may NOT specify wildcards here, e.g. if you have multiple
ppp interfaces, you need to put them all in here!</para> ppp interfaces, you need to put them all in here!</para>
@ -125,19 +128,21 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><emphasis role="bold">MARK</emphasis></term> <term><emphasis role="bold">MARK</emphasis> —
<emphasis>value</emphasis></term>
<listitem> <listitem>
<para>The mark value which is an integer in the range 1-255. You set <para>The mark <emphasis>value</emphasis> which is an integer in the
mark values in the tcrules file, marking the traffic you want to fit range 1-255. You set mark values in the tcrules file, marking the
in the classes defined in here.</para> traffic you want to fit in the classes defined in here.</para>
<para>You can use the same marks for different interfaces.</para> <para>You can use the same marks for different interfaces.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><emphasis role="bold">RATE</emphasis></term> <term><emphasis role="bold">RATE</emphasis> —
<emphasis>rate</emphasis></term>
<listitem> <listitem>
<para>The minimum bandwidth this class should get, when the traffic <para>The minimum bandwidth this class should get, when the traffic
@ -148,25 +153,29 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><emphasis role="bold">CEIL</emphasis></term> <term><emphasis role="bold">CEIL</emphasis> —
<emphasis>rate</emphasis></term>
<listitem> <listitem>
<para>The maximum bandwidth this class is allowed to use when the <para>The maximum bandwidth this class is allowed to use when the
link is idle. Useful if you have traffic which can get full speed link is idle. Useful if you have traffic which can get full speed
when more needed services (e.g. ssh) are not used.</para> when more needed services (e.g. ssh) are not used.</para>
<para>You can use the value "full" in here for setting the maximum <para>You can use the value <emphasis role="bold">full</emphasis> in
bandwidth to the defined output bandwidth of that interface.</para> here for setting the maximum bandwidth to the defined output
bandwidth of that interface.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><emphasis role="bold">PRIORITY</emphasis></term> <term><emphasis role="bold">PRIORITY</emphasis> —
<emphasis>priority</emphasis></term>
<listitem> <listitem>
<para>The priority in which classes will be serviced by the packet <para>The <emphasis>priority</emphasis> in which classes will be
shaping scheduler and also the priority in which bandwidth in excess serviced by the packet shaping scheduler and also the priority in
of the rate will be given to each class.</para> which bandwidth in excess of the rate will be given to each
class.</para>
<para>Higher priority classes will experience less delay since they <para>Higher priority classes will experience less delay since they
are serviced first. Priority values are serviced in ascending order are serviced first. Priority values are serviced in ascending order
@ -178,7 +187,9 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><emphasis role="bold">OPTIONS</emphasis></term> <term><emphasis role="bold">OPTIONS</emphasis> (Optional) —
[<emphasis>option</emphasis>[<emphasis
role="bold">,</emphasis><emphasis>option</emphasis>]...]</term>
<listitem> <listitem>
<para>A comma-separated list of options including the <para>A comma-separated list of options including the