From cf1d6749f16996d9ba74ffe0282a3234afdeacc3 Mon Sep 17 00:00:00 2001 From: teastep Date: Fri, 9 Jan 2009 19:33:37 +0000 Subject: [PATCH] Update docs for IPP2P change git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@9262 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb --- docs/IPP2P.xml | 12 ++++++------ docs/traffic_shaping.xml | 38 ++++++++++++++++++++++---------------- 2 files changed, 28 insertions(+), 22 deletions(-) diff --git a/docs/IPP2P.xml b/docs/IPP2P.xml index 01f5a229a..a13d7e7f7 100644 --- a/docs/IPP2P.xml +++ b/docs/IPP2P.xml @@ -83,21 +83,21 @@ iptables -m ipp2p --help - You must not include the leading "--" on the option; Shorewall will - supply those characters for you. If you do not include an option + You must not include the leading "--" on the option(s); Shorewall + will supply those characters for you. If you do not include an option then: Shorewall-shell and Shorewall-perl up through 4.2.4 will assume - "ipp2p". Note that the xtables version of IPP2P does not support this - option. + "ipp2p". Note that the xtables version of IPP2P no longer supports + that option. Shorewall-perl 4.2.5 and later will assume "ipp2p" if that - option is supported by the installed iptables/Netfilter. Otherwise, it - will assume "edk,kazza,gnu,dc" + option is supported by the installed iptables/Netfilter. Otherwise, + Shorewall-perl will assume "edk,kazza,gnu,dc" diff --git a/docs/traffic_shaping.xml b/docs/traffic_shaping.xml index 7e3068f52..8c5c0d445 100644 --- a/docs/traffic_shaping.xml +++ b/docs/traffic_shaping.xml @@ -129,8 +129,8 @@ HTB allows you to define a set of classes, and you can put the traffic you want into these classes. You can define minimum and maximum bandwidth settings for those classes and order them hierarchically (the less - prioritized classes only get bandwidth if the more important have what they - need). Shorewall builtin traffic shaping allows you to define these + prioritized classes only get bandwidth if the more important have what + they need). Shorewall builtin traffic shaping allows you to define these classes (and their bandwidth limits), and it uses SFQ inside these classes to make sure, that different data streams are handled equally. @@ -161,16 +161,15 @@ any). The reason why queuing is bad in these cases is, that you might - have packets which need to be prioritized over others, e.g. VoIP or ssh. - For this type of connections it is important that packets arrive in a - certain amount of time. For others like HTTP downloads, it does not - really matter if it takes a few seconds more. + have packets which need to be prioritized over others, e.g. VoIP or + ssh. For this type of connections it is important that packets arrive + in a certain amount of time. For others like HTTP downloads, it does + not really matter if it takes a few seconds more. If you have a large queue on the other side and the router there does not care about QoS or the QoS bits are not set properly, your - important packets will go into the same queue as your less - time critical download packets which will result in a large - delay. + important packets will go into the same queue as your less time + critical download packets which will result in a large delay. If you are running Shorewall-perl 4.1.6 or @@ -488,9 +487,9 @@ ppp0 6000kbit 500kbit MARK - The mark value which is an integer in the range 1-255. You define these marks in the tcrules file, marking the traffic you - want to go into the queuing classes defined in here. You can use - the same marks for different Interfaces. You must specify "-' in - this column if the device specified in the INTERFACE column has the + want to go into the queuing classes defined in here. You can use the + same marks for different Interfaces. You must specify "-' in this + column if the device specified in the INTERFACE column has the classify option in /etc/shorewall/tcdevices. @@ -748,9 +747,9 @@ ppp0 6000kbit 500kbit addresses and/or subnets. If your kernel and iptables include iprange match support, IP address ranges are also allowed. List elements may also consist of an interface name followed by ":" and - an address (e.g., eth1:192.168.1.0/24). If the MARK column - specifies a classification of the form <major>:<minor> - then this column may also contain an interface name. + an address (e.g., eth1:192.168.1.0/24). If the MARK column specifies + a classification of the form <major>:<minor> then this + column may also contain an interface name. @@ -767,7 +766,14 @@ ppp0 6000kbit 500kbit If the protocol is ipp2p, this column is interpreted as an ipp2p option without the leading "--" (example "bit" for - bit-torrent). If no PORT is given, "ipp2p" is assumed. + bit-torrent). If no PORT is given, "ipp2p" is assumed. Note that the + xtables-addons version of IPP2P does not support the "ipp2p" option; + to use that version of IPP2P with Shorewall-shell or with + Shorewall-perl 4.2.4 or earlier, you must specify an option other + than "ipp2p". Shorewall-perl 4.2.5 and later support a + comma-separated list of IPP2P options in this column; if the column + is empty or contains "ipp2p", then those versions of Shorewall-perl + will substitute "edk,kazaa,gnu,dc". This column is ignored if PROTOCOL = all but must be entered if any of the following field is supplied. In that case, it is