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