2 .\" Copyright (c) 2001-2003
3 .\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 .\" Author: Hartmut Brandt <harti@FreeBSD.org>
36 .Nd "ATM configuration tool"
40 .Op Ar command Op Ar sub-command Op ...
46 tool is used to configure the Netgraph ATM network sub-system.
50 generally consists of common options followed by a command string, optionally
51 followed by sub-command strings, optional command specific options and
52 command specific arguments.
53 Commands and sub-commands as well as command
54 specific options may be abbreviated as
55 long as there is only one match possible.
57 The following common options change the overall behaviour of
59 .Bl -tag -width indent
61 Print a very short usage info and exit.
63 Several show-type commands output a header and then several lines
65 If this option is given, the header is omitted, simplifying the parsing
73 command has a number of useful sub-commands.
75 To get general help use:
78 To get a list of available commands use:
79 .D1 Nm Ic help Cm commands
81 To get a list of available sub-commands use:
82 .D1 Nm Ic help Ar command
84 or (if there are deeper levels of sub-commands):
85 .D1 Nm Ic help Ar command sub-command ...
87 To get a list of options and arguments for a command use:
88 .D1 Nm Ic help Ar command sub-command ...
89 (given that there are no further sub-command levels).
91 To get a list of common options use:
92 .D1 Nm Ic help Cm options
93 .Ss The Ic diag Ss Command
96 command allows the inspection of the ATM interfaces on the local host
97 and the modification of device parameters.
100 (print a list of interfaces),
102 (print hardware configuration),
106 (print statistics) and
108 (print list of VCCs).
109 .Bl -tag -width indent
110 .\"----------------------------------------
111 .It Nm Ic diag Cm list
112 This sub-command lists all ATM interfaces in the system.
113 It takes no options or arguments.
114 .\"----------------------------------------
116 .Nm Ic diag Cm config
121 This command prints the configuration of ATM interfaces.
124 is given, all devices are listed, otherwise only the specified devices.
127 instructs the command to print ATM layer configuration parameters like
128 the number of VCI and VPI bits, whereas the
130 option requests card specific information like the vendor or the serial
132 If none of the options is given, the defaults is to assume
134 .\"----------------------------------------
136 .Nm Ic diag Cm phy print
140 This command prints the PHY registers in a (potential)
141 human comprehensible format.
144 is given, the format is hex bytes.
145 Otherwise, textual representation will be printed.
146 .\"----------------------------------------
147 .It Nm Ic diag Cm phy show Op Ar device ...
148 This sub-command prints static information about the PHY device used
149 in the ATM card like the type of the PHY and the media.
150 .\"----------------------------------------
152 .Nm Ic diag Cm phy set
158 This sub-command allows one to change bits in PHY registers.
159 This should be used with great care.
160 The bits of the given PHY chip register for which the corresponding bit in
162 is one are set to the values of the corresponding bits in
164 All register bits that have a zero in
166 are written back with their original value.
167 .\"----------------------------------------
169 .Nm Ic diag Cm phy stats
173 Print the PHY statistics for the given
177 is given, the statistics are cleared atomically.
178 .\"----------------------------------------
186 Retrieve the list of currently active channels on either all
187 or the specified interfaces.
188 For each channel, the following information is printed depending
189 on the options (default is
191 .Bl -tag -width ".Fl traffic"
193 Print ABR specific traffic parameters: ICR, TBE, NRM, TRM, ADTF, RIF, RDF,
196 Print basic information: VPI, VCI, AAL, traffic type, MTU and flags.
198 Print traffic parameters: PCR, SCR, MBS, MCR.
200 .\"----------------------------------------
201 .It Nm Ic diag Cm stats Ar device
202 Print driver specific statistics.
204 .Ss The Ic natm Ss Command
207 command is used to change
209 routes on the local host.
210 The sub-commands for the routing table are:
212 (to add a new route),
214 (to delete an existing route) and
216 (to print the currently installed NATM routes).
218 .Bl -tag -width indent -compact
219 .\"----------------------------------------
253 .Cm vbr Ar pcr scr mbs
262 .Cm abr Ar pcr mcr icr tbe nrm trm adtf rif rdf cdf
264 Add a new route to the routing table.
265 The destination address (the address
266 on the other end of the link) is given in
274 are the name of the ATM device and the VPI and VCI values for the link.
282 both of which specify AAL5 encapsulation, the first one without additional
283 encapsulation, the second one with LLC/SNAP headers.
284 The first two forms of the command add an UBR (unspecified bit rate) channel,
285 where the second form allows the optional specification of a peak cell
287 The third form adds a CBR (constant bit rate) channel where a PCR
289 The fourth form adds a VBR (variable bit rate) channel.
290 The arguments are the peak cell rate, the sustainable cell rate and the
292 The last form of the command adds an ABR (available bit rate) channel.
293 .\"----------------------------------------
295 .It Nm Ic natm Cm delete Ar dest
297 .Nm Ic natm Cm delete
302 This commands deletes an NATM route.
303 The route may be specified either by the destination address or
309 .\"----------------------------------------
311 .It Nm Ic natm Cm show
312 List all NATM routes.
319 .An Hartmut Brandt Aq harti@FreeBSD.org