atmconfig.help revision 132495
1# 2# Help file for the atmconfig utility 3# 4# $FreeBSD: head/sbin/atm/atmconfig/atmconfig.help 132495 2004-07-21 09:44:27Z harti $ 5# 6^0 intro 7ATM configuration utility. 8usage: 9 atmconfig [common-options] command [subcommand] [options] 10 11Use 'atmconfig help' for general help or 'atmconfig help <command>' for 12help on 'command' or 'atmconfig help commands' for a list of commands. 13 14^0 help 15^^ help show help information 16Use one of the following commands to get help on atmconfig: 17 18 atmconfig help options 19 gives you help on common command line options 20 atmconfig help commands 21 prints a list of available commands (and help items) 22 atmconfig help <command> 23 prints help on the given command (including a list of subcommands) 24 atmconfig help <command> <subcommand> 25 gives help on the given subcommand 26 27^0 options 28^^ help options list common options 29Common command line options can be specified for all commands. They 30are written immediately before the command. The following options are 31available: 32 33 -h print short help 34 -t don't print headings for 'show'-type commands 35 -v be verbose about all actions. 36 37^0 commands 38^^ help commands show available commands 39The following commands are available: 40 41$MAIN 42 43^0 diag 44^^ diag show/modify ATM hardware interfaces 45This command shows information about the ATM hardware interfaces in the 46system. A list of ATM devices is obtained by: 47 48 atmconfig [common-options] diag list 49 50Information about the hardware configuration of the ATM interfaces is 51reported by: 52 53 atmconfig [common-options] diag config [options] [<device> ...] 54 55The phy chip can be access with: 56 57 atmconfig [common-options] diag phy print [options] <device> 58 atmconfig [common-options] diag phy show <device> 59 atmconfig [common-options] diag phy set <device> <reg> <msk> <val> 60 atmconfig [common-options] diag phy set stats [options] <device> 61 62A list of open VCCs can be obtained with: 63 64 atmconfig [common-options] diag vcc [<device> ...] 65 66Driver internal statistics are printed with 67 68 atmconfig [common-options] diag stats <device> 69 70^1 list 71usage: atmconfig [common-options] diag list 72 73List all known ATM devices in the system. 74 75^1 config 76usage: atmconfig [common-options] diag config [-hardware] [-atm] [device ...] 77options: 78 -hardware print hardware related information 79 -atm print ATM related information 80 81If now device is given as argument information about all devices is shown. 82The default is to print only ATM related information. 83 84^1 phy 85To show the type of the PHY and its state: 86 87 atmconfig [common-options] diag phy show <device> 88 89Change a PHY register (use with care): 90 91 atmconfig [common-options] diag phy set <device> <reg> <msk> <val> 92 93Print the PHY registers in a human readable form: 94 95 atmconfig [common-options] diag phy print [-numeric] <device> 96 97The PHY statistics can be printed with: 98 99 atmconfig [common-options] diag phy stats [-clear] <device> 100 101^2 show 102usage: atmconfig [common-options] diag phy show <device> 103 104Show configuration and state information about the PHY chip on the given 105ATM interface. 106 107^2 set 108usage: atmconfig [common-options] diag phy set <device> <reg> <msk> <val> 109 110Set the bits of given PHY chip register for which the corresponding bit in 111<msk> is one to the value of the corresponding bit in <val>. All register 112bits that have a zero in <msk> are written back with there original value. 113 114^2 print 115usage: atmconfig [common-options] diag phy print [-numeric] <device> 116options: 117 -numeric print registers in hex 118 119Print the registers of the PHY chip in a human readable format. 120 121^2 stats 122usage: atmconfig [common-options] diag phy stats [-clear] <device> 123options: 124 -clear clear the statistics atomically after reading them 125 126Prints the PHY layer statistics of the PHY chip and optionally clears them. 127 128^1 vcc 129usage: atmconfig [common-options] diag vcc [-abr] [-channel] [-traffic] 130 [<device> ...] 131options: 132 -abr print ABR specific traffic parameters 133 -channel print VPI, VCI, AAL, traffic type and flags (default) 134 -traffic print traffic parameters 135 136Prints a list of all open vccs. The default output is -channel. 137 138^1 stats 139usage: atmconfig [common-options] diag stats <device> 140 141Prints the driver-internal statistics. 142 143^0 natm 144^^ natm simple IP over ATM management (see natmip(4)) 145The group of CLIP commands is used to manage classical IP over ATM 146networking via NATM (see natm(4) and natmip(4)). A new PVC is added 147to a CLIP via: 148 149 atmconfig [common-options] natm add <dest> <device> <vpi> <vci> 150 <encaps> [<traffic> [<params> ...]] 151 152The PVC can be deleted with: 153 154 atmconfig [common-options] natm del <device> <vpi> <vci> 155 156The list of PVC that are currently active is retrieved with: 157 158 atmconfig [common-options] natm show 159 160^1 add 161usage: atmconfig [common-options] natm add [-printonly] <dest> <device> 162 <vpi> <vci> <encaps> [<traffic> [<params> ...]] 163options: 164 -printonly don't execute, print the route(8) command 165 166This subcommand adds a new CLIP PVC on the ATM interface <device>. The 167host on the other end of the PVC has IP address <addr>. <encaps> is one 168of llc/snap (LLC/SNAP encapsulated frames in AAL5) or aal5 (AAL5 frames 169without LLC/SNAP). <traffic> specifies the traffic type of the PVC 170and is one of UBR, CBR, VBR or ABR. If not given UBR is assumed. Depending 171on the traffic type none or more parameters can follow: 172 173 ubr [<pcr>] 174 cbr <pcr> 175 vbr <pcr> <scr> <mbs> 176 abr <pcr> <mcr> <icr> <tbe> <nrm> <trm> <adtf> <rif> <rdf> <cdf> 177 178^1 delete 179usage: atmconfig [common-options] natm delete [-printonly] <dest> 180 or: atmconfig [common-options] natm delete [-printonly] <device> <vpi> <vci> 181options: 182 -printonly don't execute, print the route(8) command 183 184This subcommand deletes and existing CLIP PVC that can bei either identified 185by the destination address or by the <device><vpi><vci> triple. 186 187^1 show 188usage: atmconfig [common-options] natm show [-abr] [-numeric] 189options: 190 -abr show ABR parameters for ABR connections 191 -numeric print IP addresses numerically 192 193This subcommand prints all ATM routes. 194