sbin/atm/atmconfig/atmconfig.help

   1 #
   2 # Copyright (c) 2001-2003
   3 #       Fraunhofer Institute for Open Communication Systems (FhG Fokus).
   4 #       All rights reserved.
   5 # Copyright (c) 2004
   6 #       Hartmut Brandt.
   7 #       All rights reserved.
   8 #
   9 # Author: Hartmut Brandt <harti@freebsd.org>
  10 #
  11 # Redistribution and use in source and binary forms, with or without
  12 # modification, are permitted provided that the following conditions
  13 # are met:
  14 # 1. Redistributions of source code must retain the above copyright
  15 #    notice, this list of conditions and the following disclaimer.
  16 # 2. Redistributions in binary form must reproduce the above copyright
  17 #    notice, this list of conditions and the following disclaimer in the
  18 #    documentation and/or other materials provided with the distribution.
  19 #
  20 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 # SUCH DAMAGE.
  31 #
  32 # Help file for the atmconfig utility
  33 #
  34 # $FreeBSD$
  35 #
  36 ^0 intro
  37 ATM configuration utility.
  38 usage:
  39         atmconfig [common-options] command [subcommand] [options]
  40
  41 Use 'atmconfig help' for general help or 'atmconfig help <command>' for
  42 help on 'command' or 'atmconfig help commands' for a list of commands.
  43
  44 ^0 help
  45 ^^  help                show help information
  46 Use one of the following commands to get help on atmconfig:
  47
  48   atmconfig help options
  49         gives you help on common command line options
  50   atmconfig help commands
  51         prints a list of available commands (and help items)
  52   atmconfig help <command>
  53         prints help on the given command (including a list of subcommands)
  54   atmconfig help <command> <subcommand>
  55         gives help on the given subcommand
  56
  57 ^0 options
  58 ^^  help options        list common options
  59 Common command line options can be specified for all commands. They
  60 are written immediately before the command. The following options are
  61 available:
  62
  63  -h             print short help
  64  -t             don't print headings for 'show'-type commands
  65  -v             be verbose about all actions.
  66
  67 ^0 commands
  68 ^^  help commands       show available commands
  69 The following commands are available:
  70
  71 $MAIN
  72
  73 ^0 diag
  74 ^^  diag                show/modify ATM hardware interfaces
  75 This command shows information about the ATM hardware interfaces in the
  76 system. A list of ATM devices is obtained by:
  77
  78   atmconfig [common-options] diag list
  79
  80 Information about the hardware configuration of the ATM interfaces is
  81 reported by:
  82
  83   atmconfig [common-options] diag config [options] [<device> ...]
  84
  85 The phy chip can be access with:
  86
  87   atmconfig [common-options] diag phy print [options] <device>
  88   atmconfig [common-options] diag phy show <device>
  89   atmconfig [common-options] diag phy set <device> <reg> <msk> <val>
  90   atmconfig [common-options] diag phy set stats [options] <device>
  91
  92 A list of open VCCs can be obtained with:
  93
  94   atmconfig [common-options] diag vcc [<device> ...]
  95
  96 Driver internal statistics are printed with
  97
  98   atmconfig [common-options] diag stats <device>
  99
 100 ^1 list
 101 usage: atmconfig [common-options] diag list
 102
 103 List all known ATM devices in the system.
 104
 105 ^1 config
 106 usage: atmconfig [common-options] diag config [-hardware] [-atm] [device ...]
 107 options:
 108   -hardware     print hardware related information
 109   -atm          print ATM related information
 110
 111 If now device is given as argument information about all devices is shown.
 112 The default is to print only ATM related information.
 113
 114 ^1 phy
 115 To show the type of the PHY and its state:
 116
 117   atmconfig [common-options] diag phy show <device>
 118
 119 Change a PHY register (use with care):
 120
 121   atmconfig [common-options] diag phy set <device> <reg> <msk> <val>
 122
 123 Print the PHY registers in a human readable form:
 124
 125   atmconfig [common-options] diag phy print [-numeric] <device>
 126
 127 The PHY statistics can be printed with:
 128
 129   atmconfig [common-options] diag phy stats [-clear] <device>
 130
 131 ^2 show
 132 usage: atmconfig [common-options] diag phy show <device>
 133
 134 Show configuration and state information about the PHY chip on the given
 135 ATM interface.
 136
 137 ^2 set
 138 usage: atmconfig [common-options] diag phy set <device> <reg> <msk> <val>
 139
 140 Set the bits of given PHY chip register for which the corresponding bit in
 141 <msk> is one to the value of the corresponding bit in <val>. All register
 142 bits that have a zero in <msk> are written back with there original value.
 143
 144 ^2 print
 145 usage: atmconfig [common-options] diag phy print [-numeric] <device>
 146 options:
 147   -numeric      print registers in hex
 148
 149 Print the registers of the PHY chip in a human readable format.
 150
 151 ^2 stats
 152 usage: atmconfig [common-options] diag phy stats [-clear] <device>
 153 options:
 154   -clear        clear the statistics atomically after reading them
 155
 156 Prints the PHY layer statistics of the PHY chip and optionally clears them.
 157
 158 ^1 vcc
 159 usage: atmconfig [common-options] diag vcc [-abr] [-channel] [-traffic]
 160                  [<device> ...]
 161 options:
 162   -abr          print ABR specific traffic parameters
 163   -channel      print VPI, VCI, AAL, traffic type and flags (default)
 164   -traffic      print traffic parameters
 165
 166 Prints a list of all open vccs. The default output is -channel.
 167
 168 ^1 stats
 169 usage: atmconfig [common-options] diag stats <device>
 170
 171 Prints the driver-internal statistics.
 172
 173 ^0 natm
 174 ^^  natm                simple IP over ATM management (see natmip(4))
 175 The group of CLIP commands is used to manage classical IP over ATM
 176 networking via NATM (see natm(4) and natmip(4)). A new PVC is added
 177 to a CLIP via:
 178
 179   atmconfig [common-options] natm add <dest> <device> <vpi> <vci>
 180     <encaps> [<traffic> [<params> ...]]
 181
 182 The PVC can be deleted with:
 183
 184   atmconfig [common-options] natm del <device> <vpi> <vci>
 185
 186 The list of PVC that are currently active is retrieved with:
 187
 188   atmconfig [common-options] natm show
 189
 190 ^1 add
 191 usage: atmconfig [common-options] natm add [-printonly] <dest> <device>
 192                  <vpi> <vci> <encaps> [<traffic> [<params> ...]]
 193 options:
 194   -printonly    don't execute, print the route(8) command
 195
 196 This subcommand adds a new CLIP PVC on the ATM interface <device>. The
 197 host on the other end of the PVC has IP address <addr>. <encaps> is one
 198 of llc/snap (LLC/SNAP encapsulated frames in AAL5) or aal5 (AAL5 frames
 199 without LLC/SNAP). <traffic> specifies the traffic type of the PVC
 200 and is one of UBR, CBR, VBR or ABR. If not given UBR is assumed. Depending
 201 on the traffic type none or more parameters can follow:
 202
 203   ubr [<pcr>]
 204   cbr <pcr>
 205   vbr <pcr> <scr> <mbs>
 206   abr <pcr> <mcr> <icr> <tbe> <nrm> <trm> <adtf> <rif> <rdf> <cdf>
 207
 208 ^1 delete
 209 usage: atmconfig [common-options] natm delete [-printonly] <dest>
 210    or: atmconfig [common-options] natm delete [-printonly] <device> <vpi> <vci>
 211 options:
 212   -printonly    don't execute, print the route(8) command
 213
 214 This subcommand deletes and existing CLIP PVC that can bei either identified
 215 by the destination address or by the <device><vpi><vci> triple.
 216
 217 ^1 show
 218 usage: atmconfig [common-options] natm show [-abr] [-numeric]
 219 options:
 220   -abr          show ABR parameters for ABR connections
 221   -numeric      print IP addresses numerically
 222
 223 This subcommand prints all ATM routes.