extern/shorewall_code
1
0
Fork 1
mirror of https://gitlab.com/shorewall/code.git synced 2025-06-20 09:47:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

New syntax convention in tcdevices manpage

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

51
manpages/shorewall-tcdevices.xml
View File

@ -32,12 +32,14 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><emphasis role="bold">INTERFACES</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 <ulink
url="http://www.shorewall.net/FAQ.htm#faq18">http://www.shorewall.net/FAQ.htm#faq18</ulink></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>
@ -49,37 +51,41 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><emphasis role="bold">IN-BANDWIDTH</emphasis></term> <term><emphasis role="bold">IN-BANDWIDTH</emphasis> —
<emphasis>bandwidth</emphasis></term>
<listitem> <listitem>
<para>The incoming Bandwidth of that interface. Please note that you <para>The incoming <emphasis>bandwidth</emphasis> of that interface.
are not able to do traffic shaping on incoming traffic, as the Please note that you are not able to do traffic shaping on incoming
traffic is already received before you could do so. But this allows traffic, as the traffic is already received before you could do so.
you to define the maximum traffic allowed for this interface in But this allows you to define the maximum traffic allowed for this
total, if the rate is exceeded, the packets are dropped. You want interface in total, if the rate is exceeded, the packets are
this mainly if you have a DSL or Cable connection to avoid queuing dropped. You want this mainly if you have a DSL or Cable connection
at your providers side.</para> to avoid queuing at your providers side.</para>
<para>If you don't want any traffic to be dropped, set this to a <para>If you don't want any traffic to be dropped, set this to a
value to zero in which case Shorewall will not create an ingress value to zero in which case Shorewall will not create an ingress
qdisc.</para> qdisc.</para>
<para>Use kbit or kbps(for Kilobytes per second) for speed, and make <para>Use <emphasis role="bold">kbit</emphasis> or <emphasis
sure there is NO space between the number and the unit.</para> role="bold">kbps</emphasis>(for Kilobytes per second) for speed, and
make sure there is NO space between the number and the unit.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><emphasis role="bold">OUT-BANDWIDTH</emphasis></term> <term><emphasis role="bold">OUT-BANDWIDTH</emphasis> —
<emphasis>bandwidth</emphasis></term>
<listitem> <listitem>
<para>The outgoing Bandwidth of that interface. This is the maximum <para>The outgoing <emphasis>bandwidth</emphasis> of that interface.
speed your connection can handle. It is also the speed you can refer This is the maximum speed your connection can handle. It is also the
as "full" if you define the tc classes. Outgoing traffic above this speed you can refer as "full" if you define the tc classes. Outgoing
rate will be dropped.</para> traffic above this rate will be dropped.</para>
<para>Use kbit or kbps(for Kilobytes per second) for speed, and make <para>Use <emphasis role="bold">kbit</emphasis> or <emphasis
sure there is NO space between the number and the unit.</para> role="bold">kbps</emphasis>(for Kilobytes per second) for speed, and
make sure there is NO space between the number and the unit.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -98,8 +104,7 @@
and an incoming bandwidth of 6000kbit</para> and an incoming bandwidth of 6000kbit</para>
<programlisting> #INTERFACE IN-BANDWIDTH OUT-BANDWIDTH <programlisting> #INTERFACE IN-BANDWIDTH OUT-BANDWIDTH
ppp0 6000kbit 500kbit ppp0 6000kbit 500kbit</programlisting>
</programlisting>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>