Commit 8325daf7 authored by Li Wei's avatar Li Wei Committed by Stephen Hemminger

iproute2: tc.8: update UNITS section.

- rename section UNITS to PARAMETERS.
- break section PARAMETERS down to four subsections to cover the
  common used parameter types(RATES, TIMES, SIZES, VALUES).
- add some explaination for IEC units in RATES.
- point out the max value we can set for RATES, TIMES and SIZES.
Signed-off-by: default avatarLi Wei <lw@cn.fujitsu.com>
parent 93b79863
...@@ -257,19 +257,20 @@ qdiscs applies. ...@@ -257,19 +257,20 @@ qdiscs applies.
FILTERS FILTERS
Filters have a three part ID, which is only needed when using a hashed Filters have a three part ID, which is only needed when using a hashed
filter hierarchy. filter hierarchy.
.SH UNITS
All parameters accept a floating point number, possibly followed by a unit. .SH PARAMETERS
.P The following parameters are widely used in TC. For other parameters,
Bandwidths or rates can be specified in: see the man pages for individual qdiscs.
.TP
bps
Bytes per second
.TP .TP
kbps RATES
Kilobytes per second Bandwidths or rates.
These parameters accept a floating point number, possibly followed by
a unit (both SI and IEC units supported).
.RS
.TP .TP
mbps bit or a bare number
Megabytes per second Bits per second
.TP .TP
kbit kbit
Kilobits per second Kilobits per second
...@@ -277,27 +278,41 @@ Kilobits per second ...@@ -277,27 +278,41 @@ Kilobits per second
mbit mbit
Megabits per second Megabits per second
.TP .TP
bit or a bare number gbit
Bits per second Gigabits per second
.P
Amounts of data can be specified in:
.TP .TP
kb or k tbit
Kilobytes Terabits per second
.TP .TP
mb or m bps
Megabytes Bytes per second
.TP .TP
mbit kbps
Megabits Kilobytes per second
.TP .TP
kbit mbps
Kilobits Megabytes per second
.TP .TP
b or a bare number gbps
Bytes. Gigabytes per second
.TP
tbps
Terabytes per second
.P
To specify in IEC units, replace the SI prefix (k-, m-, g-, t-) with
IEC prefix (ki-, mi-, gi- and ti-) respectively.
.P .P
Lengths of time can be specified in: TC store rates as a 32-bit unsigned integer in bps internally,
so we can specify a max rate of 4294967295 bps.
.RE
.TP
TIMES
Length of time. Can be specified as a floating point number
followed by an optional unit:
.RS
.TP .TP
s, sec or secs s, sec or secs
Whole seconds Whole seconds
...@@ -308,6 +323,51 @@ Milliseconds ...@@ -308,6 +323,51 @@ Milliseconds
us, usec, usecs or a bare number us, usec, usecs or a bare number
Microseconds. Microseconds.
.P
TC defined its own time unit (equal to microsecond) and stores
time values as 32-bit unsigned integer, thus we can specify a max time value
of 4294967295 usecs.
.RE
.TP
SIZES
Amounts of data. Can be specified as a floating point number
followed by an optional unit:
.RS
.TP
b or a bare number
Bytes.
.TP
kbit
Kilobits
.TP
kb or k
Kilobytes
.TP
mbit
Megabits
.TP
mb or m
Megabytes
.TP
gbit
Gigabits
.TP
gb or g
Gigabytes
.P
TC stores sizes internally as 32-bit unsigned integer in byte,
so we can specify a max size of 4294967295 bytes.
.RE
.TP
VALUES
Other values without a unit.
These parameters are interpreted as decimal by default, but you can
indicate TC to interpret them as octal and hexadecimal by adding a '0'
or '0x' prefix respectively.
.SH TC COMMANDS .SH TC COMMANDS
The following commands are available for qdiscs, classes and filter: The following commands are available for qdiscs, classes and filter:
.TP .TP
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment