From 7420ab6613ec801fe99aaa0dded538ce04120f8c Mon Sep 17 00:00:00 2001
From: teastep <teastep@fbd18981-670d-0410-9b5c-8dc0c1a9a2bb>
Date: Tue, 2 Jan 2007 22:51:06 +0000
Subject: [PATCH] Clarify bandwidth units in tcdevices file

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@5189 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
---
 manpages/shorewall-tcdevices.xml | 61 ++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)

diff --git a/manpages/shorewall-tcdevices.xml b/manpages/shorewall-tcdevices.xml
index e1a08707a..b60e74d34 100644
--- a/manpages/shorewall-tcdevices.xml
+++ b/manpages/shorewall-tcdevices.xml
@@ -28,6 +28,67 @@
     in here as it limits the troughput of that device to the limits you set
     here.</para>
 
+    <para>A note on the <emphasis>bandwidth</emphasis> definitions used in
+    this file:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>don't use a space between the integer value and the unit: 30kbit
+        is valid while 30 kbit is not.</para>
+      </listitem>
+
+      <listitem>
+        <para>you can use one of the following units:</para>
+
+        <variablelist>
+          <varlistentry>
+            <term><emphasis role="bold">kpbs</emphasis></term>
+
+            <listitem>
+              <para>Kilobytes per second.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><emphasis role="bold">mbps</emphasis></term>
+
+            <listitem>
+              <para>Megabytes per second.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><emphasis role="bold">kbit</emphasis></term>
+
+            <listitem>
+              <para>Kilobits per second.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><emphasis role="bold">mbit</emphasis></term>
+
+            <listitem>
+              <para>Megabits per second.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><emphasis role="bold">bps</emphasis> or <emphasis
+            role="bold">number</emphasis></term>
+
+            <listitem>
+              <para>Bytes per second.</para>
+            </listitem>
+          </varlistentry>
+        </variablelist>
+      </listitem>
+
+      <listitem>
+        <para>Only whole integers are allowed.</para>
+      </listitem>
+    </itemizedlist>
+
     <para>The columns in the file are as follows.</para>
 
     <variablelist>