usr.sbin/stallion/stlstats/stlstats.8

   1 .\" Copyright (c) 1996-1998 Greg Ungerer (gerg@stallion.oz.au).
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Greg Ungerer.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD: src/usr.sbin/stallion/stlstats/stlstats.8,v 1.5.2.6 2003/03/11 22:31:33 trhodes Exp $
  32 .\" $DragonFly: src/usr.sbin/stallion/stlstats/stlstats.8,v 1.3 2005/08/01 01:49:18 swildner Exp $
  33 .\"
  34 .Dd January 8, 1998
  35 .Os
  36 .Dt STLSTATS 8 i386
  37 .Sh NAME
  38 .Nm stlstats
  39 .Nd "Stallion Technologies multiport serial statistics display"
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl hVi
  43 .Op Fl c Ar control-device
  44 .Op Fl b Ar board-number
  45 .Op Fl p Ar port-number
  46 .Op Fl d Ar port-device
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility
  51 is used to display statistical information about the ports on Stallion
  52 Technologies multiport serial boards.
  53 .Pp
  54 The
  55 .Nm
  56 utility normally runs as a full screen menu driven application.
  57 A help line is displayed at the bottom of each screen with the valid
  58 input keys for this screen.
  59 .Pp
  60 Generally the digit keys ('0' through '9') specify the number of the
  61 device to display statistics for.
  62 Where digits alone are not enough to access all possible devices
  63 (for example on 16 port panels) then the first letters of the alphabet
  64 are used to access the remaining devices.
  65 The letters 'a' through 'f' are used to access devices 10 through 15.
  66 .Pp
  67 The 'q' key is always used to move back to the previous level screen.
  68 The escape key can also be used to move back to the previous screen.
  69 .Pp
  70 The first screen is a display of all ports on panel 0 of board 0.
  71 Values displayed on this screen are a summary of the information for
  72 each port.  The statistics displayed are: driver and TTY state flags,
  73 termios flags (cflags, iflags, oflags, lflags), RS-232 signal values
  74 (as per TIOCM signal defines), total transmit and receive character
  75 counts.
  76 .Pp
  77 From this screen you can look at summary information
  78 about each panel and board installed in the system.
  79 Each board is accessed by the digit keys ('0' through '7'),
  80 while panels of each board can be cycled through using the 'n' key.
  81 .Pp
  82 The per port screen displays some detailed information about a
  83 particular port.
  84 This is accessed from the board screen using the 'p' key.
  85 The first port displayed will be port 0.
  86 To display other ports use the digit and alphabetic keys
  87 ('0' through '9' and 'a' through 'f').
  88 This screen displays: driver and TTY state flags, hardware ID,
  89 termios flags (cflags, iflags, oflags, lflags),
  90 total transmitted and received character counts,
  91 current transmit and receive characters buffered,
  92 receiver error counts (overruns, parity, framing, lost),
  93 software flow control characters transmitted and received,
  94 hardware flow control actions taken,
  95 count of transmitted and received breaks,
  96 modem signal transitions and
  97 current RS-232 signal states.
  98 .Pp
  99 The options are:
 100 .Bl -tag -width indent
 101 .It Fl h
 102 Output usage information.
 103 .It Fl V
 104 Output version information.
 105 .It Fl i
 106 Output only the board type information.
 107 This output is useful for scripts or other programs that need to know
 108 a little bit about the board (for example an automated download script).
 109 The
 110 .Nm
 111 utility will not enter full screen interactive mode.
 112 .It Fl c Ar control-device
 113 Specify the board control device through which to gather port statistics.
 114 The default is
 115 .Pa /dev/staliomem0 .
 116 .It Fl b Ar board-number
 117 Specify the board number to display first.
 118 The default is to display board 0.
 119 .It Fl p Ar port-number
 120 Specify the port number to display first.
 121 The
 122 .Nm
 123 utility
 124 will go straight into the port display screen (bypassing board display)
 125 when this option is used.
 126 .It Fl d Ar port-device
 127 Specify the port special device file (the
 128 .Pa /dev/ttyXXX
 129 file) to
 130 display first.
 131 The board screen is bypassed and the port statistics screen is shown
 132 immediately on start up.
 133 .El
 134 .Sh FILES
 135 .Bl -tag -width /dev/staliomem0
 136 .It Pa /dev/staliomem0
 137 driver control device used for statistics collection
 138 .El
 139 .Sh SEE ALSO
 140 .Xr stl 4 ,
 141 .Xr stli 4 ,
 142 .Xr stlload 8
 143 .Sh HISTORY
 144 This program was originally developed by
 145 .An Greg Ungerer Aq gerg@stallion.com .