CVS: linux-atm/src/man qos.7,NONE,1.1.2.1 sap.7,NONE,1.1.2.1 Makefile.am,NONE,1.1.2.1

[Paul B. S. <pa...@us...>]

Update of /cvsroot/linux-atm/linux-atm/src/man
In directory usw-pr-cvs1:/tmp/cvs-serv10656/man

Added Files:
      Tag: V2_4_0
	qos.7 sap.7 Makefile.am 
Log Message:


--- NEW FILE: qos.7 ---
.TH QOS 7 "April 20, 2000" "Linux" "Miscellaneous"
.SH NAME
qos \- Quality of Service specification
.SH DESCRIPTION
The \fBtext2qos\fP and \fBqos2text\fP functions use the format described
in this man page. Because all standard ATM tools on Linux use those
functions to convert to or from the textual representation of QOS
specifications, they expect them in the same format too.
.P
The most fundamental parameters are the \fItraffic class\fP and the
\fIAAL (ATM Adaption Layer) type\fP. If the
connection is bi-directional, both directions have the same traffic
class and the same AAL type. The traffic class and the AAL type are the first
elements (in any order) in a QOS specification. The traffic class is the only
required element. If the AAL type is omitted, the application will provide a
default value. The following traffic classes are recognized:
.IP \fBubr\fP
Unassigned Bit Rate
.IP \fBcbr\fP
Constant Bit Rate
.IP \fBabr\fP
Available Bit Rate
.P
The following AAL types are recognized:
.IP \fBaal0\fP
("raw ATM")
.IP \fBaal5\fP
.P
If both, the traffic class and the AAL type are specified, they are separated
by a comma.
.P
If more parameters are supplied, the traffic class and AAL type must be
followed by a colon. Traffic parameters can be specified independently for
the transmit and the receive direction. Their parameter lists are prefixed
with \fBtx:\fP and \fBrx:\fP, respectively. If both parameter lists are
present, the \fBtx:\fP list must precede the \fBrx:\fP list. If a
parameter is equal for both directions, it can be placed in a common
parameter list (without prefix). The general format is as follows:
.P
\fIclass_and_aal\fB:\fIcommon_list\fP,tx:\fIlist\fB,rx:\fIlist\fP
.P
Each list consists of elements specifying a parameter. Elements can
appear in any order and they are separated with commas. The following
elements are recognized:
.IP \fBpcr=\fIrate\fP
is a synonym for \fBmax_pcr=\fIrate\fP
.IP \fBmax_pcr=\fIrate\fP
The upper limit for the peak cell rate to assign. If omitted, any rate up
to link speed may be chosen.
.IP \fBmin_pcr=\fIrate\fP
The lower limit for the peak cell rate to assign. If omitted, any rate above
zero can be chosen.
.IP \fBsdu=\fIsize\fP
is a synonym for \fBmax_sdu=\fIsize\fP
.IP \fBmax_sdu=\fIsize\fP
The size of the largest packet that may be sent or received. If omitted,
a context-dependent default value is used.
.P
Values are specified as follows:
.IP \fIrate\fP
The (decimal) rate, optionally followed by a unit. The unit may be prefixed
with one of the multipliers \fBk\fP, \fBM\fP, or \fBG\fP, meaning 1'000,
1'000'000, or 1'000'000'000, respectively. The units \fBcps\fP
(cells per second) and \fBbps\fP (bits per second) are recognized. If
multiplier and unit are omitted, cells per second are assumed. Note
that the rate is always converted to cells per second, so rounding errors
may occur when specifying the rate in bits per second. Rates measured in
bits per second are considered to be user data rates, i.e. one cell
corresponds to 384 bits. The rate can be a fractional value, e.g.
\fB1.3Mbps\fP.  It is an error to specify only a
multiplier without a unit. Link speed can be indicated by using the keyword
\fBmax\fP as the rate.
.IP \fIsize\fP
The (decimal) number of bytes.
.P
The \fBtx:\fP or \fBrx:\fP lists may also just contain the single element
\fBnone\fP, which indicates that the corresponding direction is not used.
It is an error to specify \fBnone\fP for both direction.
.P
Note that commas must never follow colons or other commas. Also,
whitespace is not allowed inside a QOS specification. QOS specifications
are case-insensitive.
.SH EXAMPLES
Each of the following lines contains a valid QOS specification:
.nf
.sp
  ubr
  ubr:pcr=100kbps
  cbr,aal0:pcr=64kbps
  CBR:max_pcr=11Mbps,min_pcr=10mbps,sdu=8192
  aal5,ubr:tx:none
  cbr:tx:pcr=30000,rx:none
.sp
.fi
The following specificiations are equivalent:
.nf
.sp
  CBR,AAL5:PCR=48Mbps
  cbr,aal5:max_pcr=125000
  cbr,aal5:tx:pcr=125kcps,rx:pcr=125kcps
.sp
.fi
.SH AUTHOR
Werner Almesberger, EPFL LRC/ICA <wer...@ep...>
.\" .SH "SEE ALSO"
.\" atmsigd(8), syslogd(8)
.\"{{{}}}

--- NEW FILE: sap.7 ---
.TH SAP 7 "November 6, 1997" "Linux" "Miscellaneous"
.SH NAME
sap \- Service Access Point specification
.SH DESCRIPTION
The \fBtext2sap\fP and \fBsap2text\fP functions use the format described
in this man page. Because all standard ATM tools on Linux use those
functions to convert to or from the textual representation of SAP
specifications, they expect them in the same format too.
.P
The SAP is divided into two parts: the \fIbroadband high layer information\fP
(BHLI) and the \fIbroadband low layer information\fP (BLLI). A SAP can contain
one, both, or none of them. In the latter case, the SAP is usually considered
as a wildcard SAP, i.e. a SAP that is compatible with any other SAP.
.P
Each part begins with its name (\fBbhli\fP or \fBblli\fP), followed by a
colon and a (non-empty) list of attributes, which are of the form
\fIattribute\fP\fB=\fP\fIvalue\fP. Some attributes have sub-attributes,
which follow them. Everything that isn't separated by a colon or an equal
sign is separated by a comma.
.P
Values which are a number of bytes are specified as the corresponding
sequence of pairs of hex digits. The sequence can be optionally prefixed
with \fB0x\fP. Values with are integers in a given range can be specified
in decimal (no prefix), octal (\fB0\fP prefix), and hexadecimal (\fB0x\fP
prefix).
.P
The following, mutually exclusive attributes are allowed in the \fBbhli\fP
part (see the corresponding ATM Forum and ITU documents for the semantics):
.IP \fBiso=\fI1\-8\ bytes\fP
ISO
.IP \fBuser=\fI1\-8\ bytes\fP
User-specific
.IP \fBhlp=\fI4\ bytes\fP
High layer profile.
Note that this attribute only exists on UNI 3.0. \fBtext2sap\fP only
recognizes it if your system is configured to accept UNI 3.0 message formats.
.IP \fBoui=\fI3\ bytes\fB,id=\fI4\ bytes\fP
Vendor-specific application identifier
.P
The structure of the \fBbhli\fP part is more complex. It distinguishes three
layers, \fBl1\fP, \fBl2\fP, and \fBl3\fP, of which the first one is presently
unsupported. For layer two, the following (mutually exclusive) possibilities
exist:
.IP \fBl2=iso1745\fP
Basic mode ISO 1745
.IP \fBl2=q291\fP
ITU-T Q.291 (Rec. I.441)
.IP \fBl2=lapb\fP
Extended LAPB, half-duplex (Rec. T.71)
.IP \fBl2=iso8802\fP
LAN LLC (ISO/IEC 8802/2)
.IP \fBl2=x75\fP
ITU-T X.75, SLP
.IP \fBl2=x25_ll\fP\ ...
ITU-T X.25, link layer. This attribute and the following attributes through
\fBl2=iso7776\fP can optionally be followed by one or more of the following
sub-attributes: \fBmode=\fP\fImode\fP (mode of operation, either \fBnorm\fP or
\fBext\fP), and \fBwindow=\fP\fIwindow size\fP (window size in k, 1\-127).
.IP \fBl2=x25_ml\fP\ ...
ITU-T X.25, multilink
.IP \fBl2=hdlc_arm\fP\ ...
HDLC ARM (ISO/IEC 4335)
.IP \fBl2=hdlc_nrm\fP\ ...
HDLC NRM (ISO/IEC 4335)
.IP \fBl2=hdlc_abm\fP\ ...
HDLC ABM (ISO/IEC 4335)
.IP \fBl2=q992\fP\ ...
ITU-T Q.922
.IP \fBl2=iso7776\fP\ ...
ISO 7776 DTE-DTE
.IP \fBl2=user,info=\fIinformation\fP
User-specified. \fIinformation\fP is an integer in the range 0 to 255.
.P
For layer three, the following (again, mutually exclusive) possibilities
exist:
.IP \fBl3=iso8473\fP
ITU-T X.233 | ISO/IEC 8473
.IP \fBl3=t70\fP
ITU-T T.70 minimum network layer
.IP \fBl3=h321\fP
ITU-T Recommendation H.321
.IP \fBl3=x25\fP\ ...
ITU-T X.25, packet layer. This attribute and the following attributes through
\fBl3=x223\fP can optionally be followed by one or more of the following
sub-attributes: \fBmode=\fP\fImode\fP (see above), \fBsize=\fP\fIdefault packet
size\fP (4\-12, corresponding to 16\-4096), \fBwindow=\fP\fIwindow size\fP
(see above).
.IP \fBl3=iso8208\fP\ ...
ISO/IEC 8208
.IP \fBl3=x223\fP\ ...
ITU-T X.223 | ISO/IEC 8878
.IP \fBl3=tr9577,ipi=\fP\fIidentifier\fP\ ...
ISO/IEC TR 9577. \fIidentifier\fP is the initial protocol identifier in
the range 0\-255. For SNAP (0x80), the keyword \fBsnap\fP can be used, and
the following sub-attributes have to be specified: \fBoui=\fP\fI3 bytes\fP,
and \fBpid=\fP\fI2 bytes\fP.
.IP \fBl2=user,info=\fIinformation\fP
User-specified, see above.
.IP \fBl3=h310\fP\ ...
ITU-T Recommendation H.310. The sub-attribute \fBterm=\fP\fItype\fP (terminal
type, \fBrx\fP, \fBtx\fP, or \fBrxtx\fP) is recognized. If present, it
enables the two additional sub-attributes \fBfw_mpx=\fP\fIcapability\fP
(forward multiplexing capability, \fBts\fP, \fBts_fec\fP, \fBps\fP,
\fBps_fec\fP, or \fBh221\fP) and \fBbw_mpx=\fP\fIcapability\fP. Both are
optional.
.P
Note that commas must never follow colons or other commas. Also,
whitespace is not allowed inside a SAP specification. SAP specifications
are case-insensitive. On input, items must be written in exactly the order
used in this document.
.P
.SH EXAMPLES
.IP \fBblli:l2=iso8802\fP
Classical IP over ATM (RFC1577)
.IP \fBbhli:oui=0x0060D7,id=0x01000001,blli:l2=iso8802\fP
Arequipa (RFC2170)
.IP \fBblli:l3=tr9577,ipi=snap,oui=0x00A03E,pid=0x0002\fP
LAN Emulation
.SH AUTHOR
Werner Almesberger, EPFL LRC <wer...@lr...>
.\"{{{}}}

--- NEW FILE: Makefile.am ---
man_MANS = qos.7 sap.7

EXTRA_DIST = $(man_MANS)