]> git.proxmox.com Git - mirror_iproute2.git/blame - man/man8/tc-hfsc.8
docs: make spacing consistent
[mirror_iproute2.git] / man / man8 / tc-hfsc.8
CommitLineData
9bac173f 1.TH HFSC 8 "31 October 2011" iproute2 Linux
41f60041
MS
2.
3.SH NAME
4HFSC \- Hierarchical Fair Service Curve's control under linux
5.
6.SH SYNOPSIS
7.nf
8tc qdisc add ... hfsc [ \fBdefault\fR CLASSID ]
9
10tc class add ... hfsc [ [ \fBrt\fR SC ] [ \fBls\fR SC ] | [ \fBsc\fR SC ] ] [ \fBul\fR SC ]
11
12\fBrt\fR : realtime service curve
13\fBls\fR : linkshare service curve
14\fBsc\fR : rt+ls service curve
15\fBul\fR : upperlimit service curve
16
17\(bu at least one of \fBrt\fR, \fBls\fR or \fBsc\fR must be specified
18\(bu \fBul\fR can only be specified with \fBls\fR or \fBsc\fR
19.
20.IP "SC := [ [ \fBm1\fR BPS ] \fBd\fR SEC ] \fBm2\fR BPS"
21\fBm1\fR : slope of the first segment
22\fBd\fR : x\-coordinate of intersection
23\fBm2\fR : slope of the second segment
24.PP
25.IP "SC := [ [ \fBumax\fR BYTE ] \fBdmax\fR SEC ] \fBrate\fR BPS"
26\fBumax\fR : maximum unit of work
27\fBdmax\fR : maximum delay
28\fBrate\fR : rate
29.PP
30.fi
31For description of BYTE, BPS and SEC \- please see \fBUNITS\fR
32section of \fBtc\fR(8).
33.
34.SH DESCRIPTION (qdisc)
a89d5329 35HFSC qdisc has only one optional parameter \- \fBdefault\fR. CLASSID specifies
41f60041
MS
36the minor part of the default classid, where packets not classified by other
37means (e.g. u32 filter, CLASSIFY target of iptables) will be enqueued. If
38\fBdefault\fR is not specified, unclassified packets will be dropped.
39.
40.SH DESCRIPTION (class)
41HFSC class is used to create a class hierarchy for HFSC scheduler. For
42explanation of the algorithm, and the meaning behind \fBrt\fR, \fBls\fR,
43\fBsc\fR and \fBul\fR service curves \- please refer to \fBtc\-hfsc\fR(7).
44
45As you can see in \fBSYNOPSIS\fR, service curve (SC) can be specified in two
46ways. Either as maximum delay for certain amount of work, or as a bandwidth
47assigned for certain amount of time. Obviously, \fBm1\fR is simply
48\fBumax\fR/\fBdmax\fR.
49
50Both \fBm2\fR and \fBrate\fR are mandatory. If you omit other
51parameters, you will specify linear service curve.
52.
53.SH "SEE ALSO"
54.
55\fBtc\fR(8), \fBtc\-hfsc\fR(7), \fBtc\-stab\fR(8)
56
57Please direct bugreports and patches to: <net...@vger.kernel.org>
58.
59.SH "AUTHOR"
60.
61Manpage created by Michal Soltys (sol...@ziu.info)