atmconfig.help revision 133565
1118824Sharti# 2133565Sharti# Copyright (c) 2001-2003 3133565Sharti# Fraunhofer Institute for Open Communication Systems (FhG Fokus). 4133565Sharti# All rights reserved. 5133565Sharti# Copyright (c) 2004 6133565Sharti# Hartmut Brandt. 7133565Sharti# All rights reserved. 8133565Sharti# 9133565Sharti# Author: Hartmut Brandt <harti@freebsd.org> 10133565Sharti# 11133565Sharti# Redistribution and use in source and binary forms, with or without 12133565Sharti# modification, are permitted provided that the following conditions 13133565Sharti# are met: 14133565Sharti# 1. Redistributions of source code must retain the above copyright 15133565Sharti# notice, this list of conditions and the following disclaimer. 16133565Sharti# 2. Redistributions in binary form must reproduce the above copyright 17133565Sharti# notice, this list of conditions and the following disclaimer in the 18133565Sharti# documentation and/or other materials provided with the distribution. 19133565Sharti# 20133565Sharti# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 21133565Sharti# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22133565Sharti# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23133565Sharti# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 24133565Sharti# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25133565Sharti# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26133565Sharti# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27133565Sharti# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28133565Sharti# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29133565Sharti# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30133565Sharti# SUCH DAMAGE. 31133565Sharti# 32118824Sharti# Help file for the atmconfig utility 33118824Sharti# 34118824Sharti# $FreeBSD: head/sbin/atm/atmconfig/atmconfig.help 133565 2004-08-12 12:31:43Z harti $ 35118824Sharti# 36118824Sharti^0 intro 37118824ShartiATM configuration utility. 38118824Shartiusage: 39118824Sharti atmconfig [common-options] command [subcommand] [options] 40118824Sharti 41118824ShartiUse 'atmconfig help' for general help or 'atmconfig help <command>' for 42132494Shartihelp on 'command' or 'atmconfig help commands' for a list of commands. 43118824Sharti 44118824Sharti^0 help 45132494Sharti^^ help show help information 46118824ShartiUse one of the following commands to get help on atmconfig: 47118824Sharti 48118824Sharti atmconfig help options 49118824Sharti gives you help on common command line options 50118824Sharti atmconfig help commands 51118824Sharti prints a list of available commands (and help items) 52118824Sharti atmconfig help <command> 53118824Sharti prints help on the given command (including a list of subcommands) 54118824Sharti atmconfig help <command> <subcommand> 55118824Sharti gives help on the given subcommand 56118824Sharti 57118824Sharti^0 options 58132494Sharti^^ help options list common options 59118824ShartiCommon command line options can be specified for all commands. They 60118824Shartiare written immediately before the command. The following options are 61118824Shartiavailable: 62118824Sharti 63118824Sharti -h print short help 64118824Sharti -t don't print headings for 'show'-type commands 65118824Sharti -v be verbose about all actions. 66118824Sharti 67118824Sharti^0 commands 68132494Sharti^^ help commands show available commands 69118824ShartiThe following commands are available: 70118824Sharti 71132494Sharti$MAIN 72118824Sharti 73118824Sharti^0 diag 74132494Sharti^^ diag show/modify ATM hardware interfaces 75118824ShartiThis command shows information about the ATM hardware interfaces in the 76118824Shartisystem. A list of ATM devices is obtained by: 77118824Sharti 78118824Sharti atmconfig [common-options] diag list 79118824Sharti 80118824ShartiInformation about the hardware configuration of the ATM interfaces is 81118824Shartireported by: 82118824Sharti 83118824Sharti atmconfig [common-options] diag config [options] [<device> ...] 84118824Sharti 85118824ShartiThe phy chip can be access with: 86118824Sharti 87118824Sharti atmconfig [common-options] diag phy print [options] <device> 88118824Sharti atmconfig [common-options] diag phy show <device> 89118824Sharti atmconfig [common-options] diag phy set <device> <reg> <msk> <val> 90118824Sharti atmconfig [common-options] diag phy set stats [options] <device> 91118824Sharti 92118824ShartiA list of open VCCs can be obtained with: 93118824Sharti 94118824Sharti atmconfig [common-options] diag vcc [<device> ...] 95118824Sharti 96118824ShartiDriver internal statistics are printed with 97118824Sharti 98118824Sharti atmconfig [common-options] diag stats <device> 99118824Sharti 100118824Sharti^1 list 101118824Shartiusage: atmconfig [common-options] diag list 102118824Sharti 103118824ShartiList all known ATM devices in the system. 104118824Sharti 105118824Sharti^1 config 106118824Shartiusage: atmconfig [common-options] diag config [-hardware] [-atm] [device ...] 107118824Shartioptions: 108118824Sharti -hardware print hardware related information 109118824Sharti -atm print ATM related information 110118824Sharti 111118824ShartiIf now device is given as argument information about all devices is shown. 112118824ShartiThe default is to print only ATM related information. 113118824Sharti 114118824Sharti^1 phy 115118824ShartiTo show the type of the PHY and its state: 116118824Sharti 117118824Sharti atmconfig [common-options] diag phy show <device> 118118824Sharti 119118824ShartiChange a PHY register (use with care): 120118824Sharti 121118824Sharti atmconfig [common-options] diag phy set <device> <reg> <msk> <val> 122118824Sharti 123118824ShartiPrint the PHY registers in a human readable form: 124118824Sharti 125118824Sharti atmconfig [common-options] diag phy print [-numeric] <device> 126118824Sharti 127118824ShartiThe PHY statistics can be printed with: 128118824Sharti 129118824Sharti atmconfig [common-options] diag phy stats [-clear] <device> 130118824Sharti 131118824Sharti^2 show 132118824Shartiusage: atmconfig [common-options] diag phy show <device> 133118824Sharti 134118824ShartiShow configuration and state information about the PHY chip on the given 135118824ShartiATM interface. 136118824Sharti 137118824Sharti^2 set 138118824Shartiusage: atmconfig [common-options] diag phy set <device> <reg> <msk> <val> 139118824Sharti 140118824ShartiSet the bits of given PHY chip register for which the corresponding bit in 141118824Sharti<msk> is one to the value of the corresponding bit in <val>. All register 142118824Shartibits that have a zero in <msk> are written back with there original value. 143118824Sharti 144118824Sharti^2 print 145118824Shartiusage: atmconfig [common-options] diag phy print [-numeric] <device> 146118824Shartioptions: 147118824Sharti -numeric print registers in hex 148118824Sharti 149118824ShartiPrint the registers of the PHY chip in a human readable format. 150118824Sharti 151118824Sharti^2 stats 152118824Shartiusage: atmconfig [common-options] diag phy stats [-clear] <device> 153118824Shartioptions: 154118824Sharti -clear clear the statistics atomically after reading them 155118824Sharti 156118824ShartiPrints the PHY layer statistics of the PHY chip and optionally clears them. 157118824Sharti 158118824Sharti^1 vcc 159118824Shartiusage: atmconfig [common-options] diag vcc [-abr] [-channel] [-traffic] 160118824Sharti [<device> ...] 161118824Shartioptions: 162118824Sharti -abr print ABR specific traffic parameters 163118824Sharti -channel print VPI, VCI, AAL, traffic type and flags (default) 164118824Sharti -traffic print traffic parameters 165118824Sharti 166118824ShartiPrints a list of all open vccs. The default output is -channel. 167118824Sharti 168118824Sharti^1 stats 169118824Shartiusage: atmconfig [common-options] diag stats <device> 170118824Sharti 171118824ShartiPrints the driver-internal statistics. 172118824Sharti 173118824Sharti^0 natm 174132494Sharti^^ natm simple IP over ATM management (see natmip(4)) 175118824ShartiThe group of CLIP commands is used to manage classical IP over ATM 176118824Shartinetworking via NATM (see natm(4) and natmip(4)). A new PVC is added 177118824Shartito a CLIP via: 178118824Sharti 179118824Sharti atmconfig [common-options] natm add <dest> <device> <vpi> <vci> 180118824Sharti <encaps> [<traffic> [<params> ...]] 181118824Sharti 182118824ShartiThe PVC can be deleted with: 183118824Sharti 184118824Sharti atmconfig [common-options] natm del <device> <vpi> <vci> 185118824Sharti 186118824ShartiThe list of PVC that are currently active is retrieved with: 187118824Sharti 188132495Sharti atmconfig [common-options] natm show 189118824Sharti 190118824Sharti^1 add 191118824Shartiusage: atmconfig [common-options] natm add [-printonly] <dest> <device> 192118824Sharti <vpi> <vci> <encaps> [<traffic> [<params> ...]] 193118824Shartioptions: 194118824Sharti -printonly don't execute, print the route(8) command 195118824Sharti 196118824ShartiThis subcommand adds a new CLIP PVC on the ATM interface <device>. The 197118824Shartihost on the other end of the PVC has IP address <addr>. <encaps> is one 198118824Shartiof llc/snap (LLC/SNAP encapsulated frames in AAL5) or aal5 (AAL5 frames 199118824Shartiwithout LLC/SNAP). <traffic> specifies the traffic type of the PVC 200118824Shartiand is one of UBR, CBR, VBR or ABR. If not given UBR is assumed. Depending 201118824Shartion the traffic type none or more parameters can follow: 202118824Sharti 203118824Sharti ubr [<pcr>] 204118824Sharti cbr <pcr> 205118824Sharti vbr <pcr> <scr> <mbs> 206118824Sharti abr <pcr> <mcr> <icr> <tbe> <nrm> <trm> <adtf> <rif> <rdf> <cdf> 207118824Sharti 208118824Sharti^1 delete 209118824Shartiusage: atmconfig [common-options] natm delete [-printonly] <dest> 210118824Sharti or: atmconfig [common-options] natm delete [-printonly] <device> <vpi> <vci> 211118824Shartioptions: 212118824Sharti -printonly don't execute, print the route(8) command 213118824Sharti 214118824ShartiThis subcommand deletes and existing CLIP PVC that can bei either identified 215118824Shartiby the destination address or by the <device><vpi><vci> triple. 216118824Sharti 217118824Sharti^1 show 218118824Shartiusage: atmconfig [common-options] natm show [-abr] [-numeric] 219118824Shartioptions: 220118824Sharti -abr show ABR parameters for ABR connections 221118824Sharti -numeric print IP addresses numerically 222118824Sharti 223118824ShartiThis subcommand prints all ATM routes. 224