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