2 # Copyright (c) 2001-2003
3 # Fraunhofer Institute for Open Communication Systems (FhG Fokus).
9 # Author: Hartmut Brandt <harti@freebsd.org>
11 # Redistribution and use in source and binary forms, with or without
12 # modification, are permitted provided that the following conditions
14 # 1. Redistributions of source code must retain the above copyright
15 # notice, this list of conditions and the following disclaimer.
16 # 2. Redistributions in binary form must reproduce the above copyright
17 # notice, this list of conditions and the following disclaimer in the
18 # documentation and/or other materials provided with the distribution.
20 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 # Help file for the atmconfig utility
37 ATM configuration utility.
39 atmconfig [common-options] command [subcommand] [options]
41 Use 'atmconfig help' for general help or 'atmconfig help <command>' for
42 help on 'command' or 'atmconfig help commands' for a list of commands.
45 ^^ help show help information
46 Use one of the following commands to get help on atmconfig:
48 atmconfig help options
49 gives you help on common command line options
50 atmconfig help commands
51 prints a list of available commands (and help items)
52 atmconfig help <command>
53 prints help on the given command (including a list of subcommands)
54 atmconfig help <command> <subcommand>
55 gives help on the given subcommand
58 ^^ help options list common options
59 Common command line options can be specified for all commands. They
60 are written immediately before the command. The following options are
64 -t don't print headings for 'show'-type commands
65 -v be verbose about all actions.
68 ^^ help commands show available commands
69 The following commands are available:
74 ^^ diag show/modify ATM hardware interfaces
75 This command shows information about the ATM hardware interfaces in the
76 system. A list of ATM devices is obtained by:
78 atmconfig [common-options] diag list
80 Information about the hardware configuration of the ATM interfaces is
83 atmconfig [common-options] diag config [options] [<device> ...]
85 The phy chip can be access with:
87 atmconfig [common-options] diag phy print [options] <device>
88 atmconfig [common-options] diag phy show <device>
89 atmconfig [common-options] diag phy set <device> <reg> <msk> <val>
90 atmconfig [common-options] diag phy set stats [options] <device>
92 A list of open VCCs can be obtained with:
94 atmconfig [common-options] diag vcc [<device> ...]
96 Driver internal statistics are printed with
98 atmconfig [common-options] diag stats <device>
101 usage: atmconfig [common-options] diag list
103 List all known ATM devices in the system.
106 usage: atmconfig [common-options] diag config [-hardware] [-atm] [device ...]
108 -hardware print hardware related information
109 -atm print ATM related information
111 If now device is given as argument information about all devices is shown.
112 The default is to print only ATM related information.
115 To show the type of the PHY and its state:
117 atmconfig [common-options] diag phy show <device>
119 Change a PHY register (use with care):
121 atmconfig [common-options] diag phy set <device> <reg> <msk> <val>
123 Print the PHY registers in a human readable form:
125 atmconfig [common-options] diag phy print [-numeric] <device>
127 The PHY statistics can be printed with:
129 atmconfig [common-options] diag phy stats [-clear] <device>
132 usage: atmconfig [common-options] diag phy show <device>
134 Show configuration and state information about the PHY chip on the given
138 usage: atmconfig [common-options] diag phy set <device> <reg> <msk> <val>
140 Set the bits of given PHY chip register for which the corresponding bit in
141 <msk> is one to the value of the corresponding bit in <val>. All register
142 bits that have a zero in <msk> are written back with there original value.
145 usage: atmconfig [common-options] diag phy print [-numeric] <device>
147 -numeric print registers in hex
149 Print the registers of the PHY chip in a human readable format.
152 usage: atmconfig [common-options] diag phy stats [-clear] <device>
154 -clear clear the statistics atomically after reading them
156 Prints the PHY layer statistics of the PHY chip and optionally clears them.
159 usage: atmconfig [common-options] diag vcc [-abr] [-channel] [-traffic]
162 -abr print ABR specific traffic parameters
163 -channel print VPI, VCI, AAL, traffic type and flags (default)
164 -traffic print traffic parameters
166 Prints a list of all open vccs. The default output is -channel.
169 usage: atmconfig [common-options] diag stats <device>
171 Prints the driver-internal statistics.
174 ^^ natm simple IP over ATM management (see natmip(4))
175 The group of CLIP commands is used to manage classical IP over ATM
176 networking via NATM (see natm(4) and natmip(4)). A new PVC is added
179 atmconfig [common-options] natm add <dest> <device> <vpi> <vci>
180 <encaps> [<traffic> [<params> ...]]
182 The PVC can be deleted with:
184 atmconfig [common-options] natm del <device> <vpi> <vci>
186 The list of PVC that are currently active is retrieved with:
188 atmconfig [common-options] natm show
191 usage: atmconfig [common-options] natm add [-printonly] <dest> <device>
192 <vpi> <vci> <encaps> [<traffic> [<params> ...]]
194 -printonly don't execute, print the route(8) command
196 This subcommand adds a new CLIP PVC on the ATM interface <device>. The
197 host on the other end of the PVC has IP address <addr>. <encaps> is one
198 of llc/snap (LLC/SNAP encapsulated frames in AAL5) or aal5 (AAL5 frames
199 without LLC/SNAP). <traffic> specifies the traffic type of the PVC
200 and is one of UBR, CBR, VBR or ABR. If not given UBR is assumed. Depending
201 on the traffic type none or more parameters can follow:
205 vbr <pcr> <scr> <mbs>
206 abr <pcr> <mcr> <icr> <tbe> <nrm> <trm> <adtf> <rif> <rdf> <cdf>
209 usage: atmconfig [common-options] natm delete [-printonly] <dest>
210 or: atmconfig [common-options] natm delete [-printonly] <device> <vpi> <vci>
212 -printonly don't execute, print the route(8) command
214 This subcommand deletes and existing CLIP PVC that can bei either identified
215 by the destination address or by the <device><vpi><vci> triple.
218 usage: atmconfig [common-options] natm show [-abr] [-numeric]
220 -abr show ABR parameters for ABR connections
221 -numeric print IP addresses numerically
223 This subcommand prints all ATM routes.