From: Florian Westphal <fw@strlen.de>
Date: Sun, 28 Aug 2011 10:35:43 +0000 (+0000)
Subject: tc: man: add man page for choke scheduler
X-Git-Tag: v3.0.0~31
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b1978178facdfbce8d4dd6dec3a0e732fd258a75;p=thirdparty%2Fiproute2.git

tc: man: add man page for choke scheduler
---

diff --git a/man/man8/tc-choke.8 b/man/man8/tc-choke.8
new file mode 100644
index 000000000..7b213be18
--- /dev/null
+++ b/man/man8/tc-choke.8
@@ -0,0 +1,62 @@
+.TH TC 8 "August 2011" "iproute2" "Linux"
+.SH NAME
+choke \- choose and keep scheduler
+.SH SYNOPSIS
+.B tc qdisc ... choke
+.B limit
+bytes
+.B min
+bytes
+.B max
+bytes
+.B avpkt
+bytes
+.B burst
+packets
+.B [ ecn ] [ bandwidth
+rate
+.B ] probability
+chance
+
+.SH DESCRIPTION
+
+CHOKe (CHOose and Keep for responsive flows, CHOose and Kill for unresponsive flows)
+is a classless qdisc designed to both identify and penalize flows that monopolize the
+queue.  CHOKe is a variation of RED, and the configuration is the same as RED.
+
+.SH ALGORITHM
+Once the queue hits a certain average length, a random packet is drawn from the
+queue.  If both the to-be-queued and the drawn packet belong to the same flow,
+both packets are dropped.  Otherwise, if the queue length is still below the maximum length,
+the new packet has a configurable chance of being marked (which may mean dropped).
+If the queue length exceeds
+.B max
+, the new packet will always be marked (or dropped).
+If the queue length exceeds
+.B limit
+, the new packet is always dropped.
+
+The marking probability computation is the same as used by the RED qdisc.
+
+.SH PARAMETERS
+The parameters are the same as for RED, see
+.BR tc-red (8)
+for a description.
+
+.SH SOURCE
+.TP
+o
+R. Pan, B. Prabhakar, and K. Psounis, "CHOKe, A Stateless
+Active Queue Management Scheme for Approximating Fair Bandwidth Allocation",
+IEEE INFOCOM, 2000.
+.TP
+o
+A. Tang, J. Wang, S. Low, "Understanding CHOKe: Throughput and Spatial
+Characteristics", IEEE/ACM Transactions on Networking, 2004
+
+.SH SEE ALSO
+.BR tc (8),
+.BR tc-red (8)
+
+.SH AUTHOR
+sched_choke was contributed by Stephen Hemminger.
diff --git a/man/man8/tc-red.8 b/man/man8/tc-red.8
index fa8367542..32a47b892 100644
--- a/man/man8/tc-red.8
+++ b/man/man8/tc-red.8
@@ -112,7 +112,8 @@ queue size hits
 bytes. Needs a tc binary with RED support compiled in. Recommended.
 
 .SH SEE ALSO
-.BR tc (8)
+.BR tc (8),
+.BR tc-choke (8)
 
 .SH SOURCES
 .TP 
diff --git a/man/man8/tc.8 b/man/man8/tc.8
index e17ce68bd..bfc7f2672 100644
--- a/man/man8/tc.8
+++ b/man/man8/tc.8
@@ -367,6 +367,7 @@ print rates in IEC units (ie. 1K = 1024).
 was written by Alexey N. Kuznetsov and added in Linux 2.2.
 .SH SEE ALSO
 .BR tc-cbq (8),
+.BR tc-choke (8),
 .BR tc-drr (8),
 .BR tc-htb (8),
 .BR tc-sfq (8),