atmconfig.help revision 118824
1118824Sharti# 2118824Sharti# Help file for the atmconfig utility 3118824Sharti# 4118824Sharti# $FreeBSD: head/sbin/atm/atmconfig/atmconfig.help 118824 2003-08-12 14:25:57Z harti $ 5118824Sharti# 6118824Sharti^0 intro 7118824ShartiATM configuration utility. 8118824Shartiusage: 9118824Sharti atmconfig [common-options] command [subcommand] [options] 10118824Sharti 11118824ShartiUse 'atmconfig help' for general help or 'atmconfig help <command>' for 12118824Shartihelp on 'command'. 13118824Sharti 14118824Sharti^0 help 15118824ShartiUse one of the following commands to get help on atmconfig: 16118824Sharti 17118824Sharti atmconfig help options 18118824Sharti gives you help on common command line options 19118824Sharti atmconfig help commands 20118824Sharti prints a list of available commands (and help items) 21118824Sharti atmconfig help <command> 22118824Sharti prints help on the given command (including a list of subcommands) 23118824Sharti atmconfig help <command> <subcommand> 24118824Sharti gives help on the given subcommand 25118824Sharti 26118824Sharti^0 options 27118824ShartiCommon command line options can be specified for all commands. They 28118824Shartiare written immediately before the command. The following options are 29118824Shartiavailable: 30118824Sharti 31118824Sharti -h print short help 32118824Sharti -t don't print headings for 'show'-type commands 33118824Sharti -v be verbose about all actions. 34118824Sharti 35118824Sharti^0 commands 36118824ShartiThe following commands are available: 37118824Sharti 38118824Sharti help show help information 39118824Sharti diag show/modify ATM hardware interfaces 40118824Sharti 41118824Sharti^0 diag 42118824ShartiThis command shows information about the ATM hardware interfaces in the 43118824Shartisystem. A list of ATM devices is obtained by: 44118824Sharti 45118824Sharti atmconfig [common-options] diag list 46118824Sharti 47118824ShartiInformation about the hardware configuration of the ATM interfaces is 48118824Shartireported by: 49118824Sharti 50118824Sharti atmconfig [common-options] diag config [options] [<device> ...] 51118824Sharti 52118824ShartiThe phy chip can be access with: 53118824Sharti 54118824Sharti atmconfig [common-options] diag phy print [options] <device> 55118824Sharti atmconfig [common-options] diag phy show <device> 56118824Sharti atmconfig [common-options] diag phy set <device> <reg> <msk> <val> 57118824Sharti atmconfig [common-options] diag phy set stats [options] <device> 58118824Sharti 59118824ShartiA list of open VCCs can be obtained with: 60118824Sharti 61118824Sharti atmconfig [common-options] diag vcc [<device> ...] 62118824Sharti 63118824ShartiDriver internal statistics are printed with 64118824Sharti 65118824Sharti atmconfig [common-options] diag stats <device> 66118824Sharti 67118824Sharti^1 list 68118824Shartiusage: atmconfig [common-options] diag list 69118824Sharti 70118824ShartiList all known ATM devices in the system. 71118824Sharti 72118824Sharti^1 config 73118824Shartiusage: atmconfig [common-options] diag config [-hardware] [-atm] [device ...] 74118824Shartioptions: 75118824Sharti -hardware print hardware related information 76118824Sharti -atm print ATM related information 77118824Sharti 78118824ShartiIf now device is given as argument information about all devices is shown. 79118824ShartiThe default is to print only ATM related information. 80118824Sharti 81118824Sharti^1 phy 82118824ShartiTo show the type of the PHY and its state: 83118824Sharti 84118824Sharti atmconfig [common-options] diag phy show <device> 85118824Sharti 86118824ShartiChange a PHY register (use with care): 87118824Sharti 88118824Sharti atmconfig [common-options] diag phy set <device> <reg> <msk> <val> 89118824Sharti 90118824ShartiPrint the PHY registers in a human readable form: 91118824Sharti 92118824Sharti atmconfig [common-options] diag phy print [-numeric] <device> 93118824Sharti 94118824ShartiThe PHY statistics can be printed with: 95118824Sharti 96118824Sharti atmconfig [common-options] diag phy stats [-clear] <device> 97118824Sharti 98118824Sharti^2 show 99118824Shartiusage: atmconfig [common-options] diag phy show <device> 100118824Sharti 101118824ShartiShow configuration and state information about the PHY chip on the given 102118824ShartiATM interface. 103118824Sharti 104118824Sharti^2 set 105118824Shartiusage: atmconfig [common-options] diag phy set <device> <reg> <msk> <val> 106118824Sharti 107118824ShartiSet the bits of given PHY chip register for which the corresponding bit in 108118824Sharti<msk> is one to the value of the corresponding bit in <val>. All register 109118824Shartibits that have a zero in <msk> are written back with there original value. 110118824Sharti 111118824Sharti^2 print 112118824Shartiusage: atmconfig [common-options] diag phy print [-numeric] <device> 113118824Shartioptions: 114118824Sharti -numeric print registers in hex 115118824Sharti 116118824ShartiPrint the registers of the PHY chip in a human readable format. 117118824Sharti 118118824Sharti^2 stats 119118824Shartiusage: atmconfig [common-options] diag phy stats [-clear] <device> 120118824Shartioptions: 121118824Sharti -clear clear the statistics atomically after reading them 122118824Sharti 123118824ShartiPrints the PHY layer statistics of the PHY chip and optionally clears them. 124118824Sharti 125118824Sharti^1 vcc 126118824Shartiusage: atmconfig [common-options] diag vcc [-abr] [-channel] [-traffic] 127118824Sharti [<device> ...] 128118824Shartioptions: 129118824Sharti -abr print ABR specific traffic parameters 130118824Sharti -channel print VPI, VCI, AAL, traffic type and flags (default) 131118824Sharti -traffic print traffic parameters 132118824Sharti 133118824ShartiPrints a list of all open vccs. The default output is -channel. 134118824Sharti 135118824Sharti^1 stats 136118824Shartiusage: atmconfig [common-options] diag stats <device> 137118824Sharti 138118824ShartiPrints the driver-internal statistics. 139118824Sharti 140118824Sharti^0 natm 141118824ShartiThe group of CLIP commands is used to manage classical IP over ATM 142118824Shartinetworking via NATM (see natm(4) and natmip(4)). A new PVC is added 143118824Shartito a CLIP via: 144118824Sharti 145118824Sharti atmconfig [common-options] natm add <dest> <device> <vpi> <vci> 146118824Sharti <encaps> [<traffic> [<params> ...]] 147118824Sharti 148118824ShartiThe PVC can be deleted with: 149118824Sharti 150118824Sharti atmconfig [common-options] natm del <device> <vpi> <vci> 151118824Sharti 152118824ShartiThe list of PVC that are currently active is retrieved with: 153118824Sharti 154118824Sharti atmconfig [common-options] natm list 155118824Sharti 156118824Sharti^1 add 157118824Shartiusage: atmconfig [common-options] natm add [-printonly] <dest> <device> 158118824Sharti <vpi> <vci> <encaps> [<traffic> [<params> ...]] 159118824Shartioptions: 160118824Sharti -printonly don't execute, print the route(8) command 161118824Sharti 162118824ShartiThis subcommand adds a new CLIP PVC on the ATM interface <device>. The 163118824Shartihost on the other end of the PVC has IP address <addr>. <encaps> is one 164118824Shartiof llc/snap (LLC/SNAP encapsulated frames in AAL5) or aal5 (AAL5 frames 165118824Shartiwithout LLC/SNAP). <traffic> specifies the traffic type of the PVC 166118824Shartiand is one of UBR, CBR, VBR or ABR. If not given UBR is assumed. Depending 167118824Shartion the traffic type none or more parameters can follow: 168118824Sharti 169118824Sharti ubr [<pcr>] 170118824Sharti cbr <pcr> 171118824Sharti vbr <pcr> <scr> <mbs> 172118824Sharti abr <pcr> <mcr> <icr> <tbe> <nrm> <trm> <adtf> <rif> <rdf> <cdf> 173118824Sharti 174118824Sharti^1 delete 175118824Shartiusage: atmconfig [common-options] natm delete [-printonly] <dest> 176118824Sharti or: atmconfig [common-options] natm delete [-printonly] <device> <vpi> <vci> 177118824Shartioptions: 178118824Sharti -printonly don't execute, print the route(8) command 179118824Sharti 180118824ShartiThis subcommand deletes and existing CLIP PVC that can bei either identified 181118824Shartiby the destination address or by the <device><vpi><vci> triple. 182118824Sharti 183118824Sharti^1 show 184118824Shartiusage: atmconfig [common-options] natm show [-abr] [-numeric] 185118824Shartioptions: 186118824Sharti -abr show ABR parameters for ABR connections 187118824Sharti -numeric print IP addresses numerically 188118824Sharti 189118824ShartiThis subcommand prints all ATM routes. 190