[bwm-tools-devel] COMMIT - r59 - trunk/doc

[SVN C. <sv...@li...>]

Author: nkukard
Date: 2005-01-21 10:10:48 +0200 (Fri, 21 Jan 2005)
New Revision: 59

Modified:
   trunk/doc/bwmtools.texi
   trunk/doc/stamp-vti
   trunk/doc/version.texi
Log:
* Minor documentation fixed, added explanation of prio-classifier parameter


Modified: trunk/doc/bwmtools.texi
===================================================================
--- trunk/doc/bwmtools.texi	2005-01-21 06:54:49 UTC (rev 58)
+++ trunk/doc/bwmtools.texi	2005-01-21 08:10:48 UTC (rev 59)
@@ -89,32 +89,32 @@
 for small to large enterprises@dots{}
 @*
 @itemize
-
 @item Traffic Shaping
 @itemize
 @item Hierarchical flows
 Allows you to embed flows within flows to form complex traffic shaping rules.
+@*
 @item Parent burst thresholds
 Parent burst thresholds allow child flows to burst until their parent flow
 has reached a specific utilization threshold.
 @end itemize
-
+@*
 @item Graphing
 @itemize
 @item RRD Tool file support
 Generation of rrdtool files which can be used to create custom graphs.
+@*
 @item Builtin RRD Tool graphing support
 BWM Tools can generate pretty looking graphs all by itself. Parameters for
 graphing are discussed in the Graphing section.
 @end itemize
-
+@*
 @item Logging
 @itemize
 @item Logging of traffic
 BWM Tools logs can log traffic stats to file at pre-defined intervals
 for use in reporting or graphing.
 @end itemize
-
 @end itemize
 
 
@@ -128,11 +128,11 @@
 @*
 @itemize
 @item
-glib2 >= 2.4.0
+glib2 >= 2.2.0
 @item
-libxml2 >= 2.6.0
+libxml2 >= 2.5.0
 @item
-rrdtool >= 1.0.49  (only required for graphing)
+rrdtool >= 1.0.49  (required for graphing)
 @end itemize
 @*
 Next you need to download BWM Tools, compile it and install
@@ -753,7 +753,55 @@
 time increments the traffic statistics are logged to file. For example, if this
 parameter is set to 60, @command{bwmd} will log traffic stats to file every 60
 seconds. Minimum value for this parameter is 30.
+@*
+@item
+@cindex prio-classifier
+@code{prio-classifier="@dots{}"} - Optional parameter to specify an automatic
+traffic prioritization classifier. This parameter defaults to the @dfn{none}
+classifier, where no prioritization takes place. Available classifiers are
+discussed below@dots{}
+@*
+@itemize
+@item The "@dfn{port}" classifier
+With this classification prioritization happens automatically with the following
+ports mapped to their corrosponding priorities.
+(1 = highest, 100 = lowest)@dots{}
+@*@*
+@cindex traffic priority
+TCP Traffic
+@table @samp
+@item port 113 (AUTH)
+@samp{Priority 20}
+@item port 22, 23 (SSH, TELNET)
+@samp{Priority 25}
+@item port 80, 443, 8080, 3128, 3130 (HTTP, HTTPS, PROXY PORTS)
+@samp{Priority 65}
+@item port 2401 (CVS)
+@samp{Priority 70}
+@item port 110, 143 (POP3, IMAP4)
+@samp{Priority 75}
+@item port 20, 21 (FTP)
+@samp{Priority 80}
+@end table
+@*
+UDP Traffic
+@table @samp
+@item port 53 (DNS)
+@samp{Priority 10}
+@item port 123 (NTP)
+@samp{Priority 15}
+@item port 1645/6, 1812/3 (RADIUS)
+@samp{Priority 30}
+@item port 33434-33465 (Normally traceroute)
+@samp{Priority 5}
+@end table	
+@*
+The default priority for traffic not matching any of the above is 50.
 @end itemize
+@item The "@dfn{none}" classifier
+This is the default classifier, no priorization will occur and all trafic will
+be dumped in the default priority 50 queue.
+@end itemize
 	
 Between the opening and closing tags, classes defined in the @code{<global>}
 section can be listed, if you want to list multiple classes use one per line,
@@ -786,48 +834,14 @@
 @item
 @cindex prio
 @code{prio="@dots{}"} - Mandatory parameter to specify the priority of the
-matched traffic.
+matched traffic. (1 = highest, 100 = lowest).
 @*
 @item
 @cindex nfmark
 @code{nfmark="@dots{}"} - Mandatory parameter to specify the mark value of the
 traffic.
 @end itemize
-@*
-Queue classifaction normally happens automatically with the following
-priorities (1 = highest, 100 = lowest)@dots{}
 @*@*
-@cindex traffic priority
-TCP Traffic
-@table @samp
-@item port 113 (AUTH)
-@samp{Priority 20}
-@item port 22, 23 (SSH, TELNET)
-@samp{Priority 25}
-@item port 80, 443, 8080, 3128, 3130 (HTTP, HTTPS, PROXY PORTS)
-@samp{Priority 65}
-@item port 2401 (CVS)
-@samp{Priority 70}
-@item port 110, 143 (POP3, IMAP4)
-@samp{Priority 75}
-@item port 20, 21 (FTP)
-@samp{Priority 80}
-@end table
-@*
-UDP Traffic
-@table @samp
-@item port 53 (DNS)
-@samp{Priority 10}
-@item port 123 (NTP)
-@samp{Priority 15}
-@item port 1645/6, 1812/3 (RADIUS)
-@samp{Priority 30}
-@item port 33434-33465 (Normally traceroute)
-@samp{Priority 5}
-@end table	
-@*
-The default priority for traffic not matching any of the above is 50.
-@*@*
 Below is an example of using the @code{<queue> @dots{} </queue>} tags to give
 VNC traffic highest priority@dots{}
 @*

Modified: trunk/doc/stamp-vti
===================================================================
--- trunk/doc/stamp-vti	2005-01-21 06:54:49 UTC (rev 58)
+++ trunk/doc/stamp-vti	2005-01-21 08:10:48 UTC (rev 59)
@@ -1,4 +1,4 @@
-@set UPDATED 19 January 2005
+@set UPDATED 21 January 2005
 @set UPDATED-MONTH January 2005
 @set EDITION devel
 @set VERSION devel

Modified: trunk/doc/version.texi
===================================================================
--- trunk/doc/version.texi	2005-01-21 06:54:49 UTC (rev 58)
+++ trunk/doc/version.texi	2005-01-21 08:10:48 UTC (rev 59)
@@ -1,4 +1,4 @@
-@set UPDATED 19 January 2005
+@set UPDATED 21 January 2005
 @set UPDATED-MONTH January 2005
 @set EDITION devel
 @set VERSION devel