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