usr.sbin/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 .\"
  33 .Dd January 8, 1998
  34 .Dt STLSTATS 8 i386
  35 .Os
  36 .Sh NAME
  37 .Nm stlstats
  38 .Nd "Stallion Technologies multiport serial statistics display"
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl hVi
  42 .Op Fl c Ar control-device
  43 .Op Fl b Ar board-number
  44 .Op Fl p Ar port-number
  45 .Op Fl d Ar port-device
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility
  50 is used to display statistical information about the ports on Stallion
  51 Technologies multiport serial boards.
  52 .Pp
  53 The
  54 .Nm
  55 utility normally runs as a full screen menu driven application.
  56 A help line is displayed at the bottom of each screen with the valid
  57 input keys for this screen.
  58 .Pp
  59 Generally the digit keys ('0' through '9') specify the number of the
  60 device to display statistics for.
  61 Where digits alone are not enough to access all possible devices
  62 (for example on 16 port panels) then the first letters of the alphabet
  63 are used to access the remaining devices.
  64 The letters 'a' through 'f' are used to access devices 10 through 15.
  65 .Pp
  66 The 'q' key is always used to move back to the previous level screen.
  67 The escape key can also be used to move back to the previous screen.
  68 .Pp
  69 The first screen is a display of all ports on panel 0 of board 0.
  70 Values displayed on this screen are a summary of the information for
  71 each port.  The statistics displayed are: driver and TTY state flags,
  72 termios flags (cflags, iflags, oflags, lflags), RS-232 signal values
  73 (as per TIOCM signal defines), total transmit and receive character
  74 counts.
  75 .Pp
  76 From this screen you can look at summary information
  77 about each panel and board installed in the system.
  78 Each board is accessed by the digit keys ('0' through '7'),
  79 while panels of each board can be cycled through using the 'n' key.
  80 .Pp
  81 The per port screen displays some detailed information about a
  82 particular port.
  83 This is accessed from the board screen using the 'p' key.
  84 The first port displayed will be port 0.
  85 To display other ports use the digit and alphabetic keys
  86 ('0' through '9' and 'a' through 'f').
  87 This screen displays: driver and TTY state flags, hardware ID,
  88 termios flags (cflags, iflags, oflags, lflags),
  89 total transmitted and received character counts,
  90 current transmit and receive characters buffered,
  91 receiver error counts (overruns, parity, framing, lost),
  92 software flow control characters transmitted and received,
  93 hardware flow control actions taken,
  94 count of transmitted and received breaks,
  95 modem signal transitions and
  96 current RS-232 signal states.
  97 .Pp
  98 The options are:
  99 .Bl -tag -width indent
 100 .It Fl h
 101 Output usage information.
 102 .It Fl V
 103 Output version information.
 104 .It Fl i
 105 Output only the board type information.
 106 This output is useful for scripts or other programs that need to know
 107 a little bit about the board (for example an automated download script).
 108 The
 109 .Nm
 110 utility will not enter full screen interactive mode.
 111 .It Fl c Ar control-device
 112 Specify the board control device through which to gather port statistics.
 113 The default is
 114 .Pa /dev/staliomem0 .
 115 .It Fl b Ar board-number
 116 Specify the board number to display first.
 117 The default is to display board 0.
 118 .It Fl p Ar port-number
 119 Specify the port number to display first.
 120 The
 121 .Nm
 122 utility
 123 will go straight into the port display screen (bypassing board display)
 124 when this option is used.
 125 .It Fl d Ar port-device
 126 Specify the port special device file (the
 127 .Pa /dev/ttyXXX
 128 file) to
 129 display first.
 130 The board screen is bypassed and the port statistics screen is shown
 131 immediately on start up.
 132 .El
 133 .Sh FILES
 134 .Bl -tag -width /dev/staliomem0
 135 .It Pa /dev/staliomem0
 136 driver control device used for statistics collection
 137 .El
 138 .Sh SEE ALSO
 139 .Xr stl 4
 140 .Sh HISTORY
 141 This program was originally developed by
 142 .An Greg Ungerer Aq gerg@stallion.com .