diff --git a/docs/traffic_shaping.xml b/docs/traffic_shaping.xml index 9c04741e8..074690ba1 100644 --- a/docs/traffic_shaping.xml +++ b/docs/traffic_shaping.xml @@ -522,6 +522,43 @@ ppp0 6000kbit 500kbit role="bold">class per interface. + + + occurs=number - Typically used with + an IPMARK entry in tcrules. Causes the rule to be replicated for + a total of number rules. Each rule has a + successively class number and mark value. + + When 'occurs' is used: + + + + The associated device may not have the 'classify' + option. + + + + The class may not be the default class. + + + + The class may not have any 'tos=' options (including + 'tcp-ack'). + + + + The class should not specify a MARK value. If one is + specified, it will be ignored with a warning message. + + + + The 'RATE' and 'CEIL' parameters apply to each instance of + the class. So the total RATE represented by an entry with + 'occurs' will be the listed RATE multiplied by + number. For additional information, see + tcrules + (5). + diff --git a/manpages/shorewall-tcclasses.xml b/manpages/shorewall-tcclasses.xml index c9b6e671d..4b8f82a3b 100644 --- a/manpages/shorewall-tcclasses.xml +++ b/manpages/shorewall-tcclasses.xml @@ -113,7 +113,7 @@ INTERFACE - - interface[:class] + interface[:parent][:class] Name of interface. Each interface may be @@ -121,13 +121,16 @@ alias (e.g., eth0:0) here; see http://www.shorewall.net/FAQ.htm#faq18 - If you are running Shorewall-perl 4.1.6 or later, you may - specify the interface number rather than the interface name. If the - classify option is given for the - interface in You may specify the interface number rather than the interface + name. If the classify option is + given for the interface in shorewall-tcdevices(5), then you must also specify an interface class (an integer that must be - unique within classes associated with this interface). + unique within classes associated with this interface). If the + classify option is not given, you may still specify a + class or you may have Shorewall generate a + class number from the MARK value. Interface numbers and class + numbers are always assumed to be specified in hex. You may NOT specify wildcards here, e.g. if you have multiple ppp interfaces, you need to put them all in here! @@ -135,7 +138,15 @@ Please note that you can only use interface names in here that have a bandwidth defined in the shorewall-tcdevices(5) - file + file. + + Normally, all classes defined here are sub-classes of a root + class that is implicitly defined from the entry in shorewall-tcdevices(5). You + can establish a class hierarchy by specifying a + parent class -- the number of a class that you + have previously defined. The sub-class may borrow unused bandwidth + from its parent. @@ -165,7 +176,9 @@ The minimum bandwidth this class should get, when the traffic load rises. If the sum of the rates in this column exceeds the INTERFACE's OUT-BANDWIDTH, then the OUT-BANDWIDTH limit may not be - honored. + honored. Similarly, if the sum of the rates of sub-classes of a + class exceed the CEIL of the parent class, things don't work + well.