Annotation of cci/usr/src/usr.bin/bsc/doc/bscmon.8, revision 1.1.1.1

1.1       root        1: .TH BSCMON 8 DLBA 1.2
                      2: \" @(#)bscmon.8        1.4
                      3: .SH NAME 
                      4: .br
                      5: bscmon \- BISYNC Communications Monitoring Utility
                      6: .br
                      7: bsctrace \- BISYNC Monitor Information Display Utility
                      8: .br
                      9: .SH SYNOPSIS 
                     10: .nf
                     11: .I
                     12: bscmon [-data] [-host=<hostname>]  [file]
                     13: .I
                     14:        [-dev=<devname>]
                     15: .I
                     16: bsctrace [-data=tttt] [-verbose] [file]
                     17: .fi
                     18: .SH DESCRIPTION
                     19: .P
                     20: The 
                     21: .I bscmon 
                     22: utility is used to record trace information from the BISYNC
                     23: trace device (/dev/bsc*tr) while BISYNC communications are taking place.
                     24: This information may be recorded in a data file for later processing by the 
                     25: .I bsctrace 
                     26: utility, or may be sent to standard output for immediate processing by 
                     27: .I bsctrace 
                     28: via a pipe.
                     29: .P
                     30: The trace information consists of two types of information.
                     31: The first type is a transition trace of the communications states
                     32: of the BISYNC driver itself,
                     33: and indicates when BISYNC packets were sent,
                     34: when they were received, and what actions were taken.
                     35: The second type of information consists of the actual data packets
                     36: sent and received.
                     37: Obviously the second type of information requires additional system
                     38: overhead and should only be recorded if necessary.
                     39: .P
                     40: The trace device will default to /dev/bsctr, unless a specification
                     41: is made via 
                     42: .I -dev 
                     43: or via 
                     44: .I -host.
                     45: The latter form allows 
                     46: .I bscmon 
                     47: to examine
                     48: the host configuration file in /usr/lib/bscbatch/<hostname> for a
                     49: .I DEVICE 
                     50: entry, in which case 'tr' is appended to the device name.
                     51: .P
                     52: If a 
                     53: .I file 
                     54: parameter is given to 
                     55: .I bscmon,
                     56: the trace information will be recorded in that file; otherwise
                     57: it will be written to the standard output. The 
                     58: .I -data
                     59: flag is used to indicate that the actual data packets
                     60: being sent and received should be recorded.
                     61: .P
                     62: .I Bsctrace 
                     63: interprets trace information in either a terse or verbose form.
                     64: The information itself is that recorded by 
                     65: .I bscmon,
                     66: which consists of state transition information and actual data packets.
                     67: In the terse form, the state type (send, receive, decision, or function)
                     68: and state number are given, as well as packet class for receive operations.
                     69: The state information is meaningless without the state diagram attached
                     70: to this document, but is the fastest form of display.
                     71: .P
                     72: The 
                     73: .I -data 
                     74: parameter must be specified in order
                     75: to have the actual data packets displayed with the trace information.
                     76: The 
                     77: .I tttt 
                     78: portion of the parameter indicates the
                     79: code in which the data should be displayed,
                     80: and may be either
                     81: .I 
                     82: hex, ebcdic, 
                     83: or 
                     84: .I ascii.
                     85: .P
                     86: The verbose form interprets the trace information by displaying the
                     87: state description data for each state which appears in file
                     88: /usr/lib/bsc/trace.text.
                     89: .P
                     90: .SH "SEE ALSO"
                     91: .nf
                     92: batch(8) \- BISYNC Batch Terminal Emulation
                     93: .I 
                     94: General Information \- Binary Synchronous Communications,
                     95: IBM document GA27-3004
                     96: .fi
                     97: .SH FILES
                     98: .nf
                     99: /usr/lib/bscbatch/<hostname> \- host parameter file
                    100: /usr/lib/bsc/trace.text \- Descriptive trace information
                    101: /dev/bsctr \- Virtual trace device
                    102: .fi
                    103: .SH DIAGNOSTICS
                    104: .P
                    105: bscmon: invalid parameter (<flag>)
                    106: .IP
                    107: The parameter shown does not appear in the synopsis.
                    108: .P
                    109: bscmon: can't create <filename>
                    110: .IP
                    111: The file named could not be created for output.
                    112: Check write permissions or directory permissions.
                    113: .P
                    114: bscmon: <host> has no configuration file
                    115: .IP
                    116: The host configuration file should be in /usr/lib/bscbatch/<hostname>.
                    117: Either it is not there, or it could not be read.
                    118: .P
                    119: bscmon: trace device <devname> cannot be opened
                    120: .IP
                    121: Either the device name given for the trace device was incorrect,
                    122: or cannot be read, or does not exist.
                    123: .P
                    124: bsctrace: invalid parameter (<flag>)
                    125: .IP
                    126: The parameter shown does not appear in the synopsis.
                    127: .P
                    128: bsctrace: can't read trace text file
                    129: (/usr/lib/bsc/trace.text)
                    130: .IP
                    131: The 
                    132: .I -verbose 
                    133: option was given, but the file containing
                    134: the trace interpretation information could not be read.
                    135: .P
                    136: bsctrace: can't read trace information file (<filename>)
                    137: .IP
                    138: The filename shown was given as the input file containing the trace
                    139: information recorded by 
                    140: .I bscmon. 
                    141: However, the file either does not exist, or can't be read.
                    142: .SH "TRACE DISPLAY FORMAT"
                    143: .P
                    144: To represent a transition to a new state, a line of
                    145: the following form will be displayed for terse mode:
                    146: .IP
                    147: hh.mm.ss nn c
                    148: .P
                    149: The first portion is the time at which the transition to the state
                    150: occurred.
                    151: The state number was
                    152: .I nn,
                    153: and the state type was 
                    154: .I c. 
                    155: State types are 'S' for send, 'R'
                    156: for receive, 'F' for function, and 'D' for decision; additionally,
                    157: 'C' is used to show the class of packet received, and 'E' shows
                    158: the type of error encountered for link-level problems.
                    159: If data recording was selected, types 'TD' and 'RD' appear (transmit
                    160: and receive data, respectively), but the data is displayed only if the
                    161: .I -data
                    162: parameter was specified.
                    163: .P
                    164: In verbose mode, text may take one of the following forms:
                    165: .P
                    166: hh.mm.ss nn S
                    167: .IP
                    168: Description of action and what is being sent
                    169: .P
                    170: hh.mm.ss nn R
                    171: .IP
                    172: Description of action and expected response
                    173: .P
                    174: hh.mm.ss nn C xx
                    175: .IP
                    176: Received <packet type>
                    177: .P
                    178: hh.mm.ss nn F
                    179: .IP
                    180: Function's purpose, e.g. check acknowledgement
                    181: .P
                    182: hh.mm.ss nn D
                    183: .IP
                    184: Description of decision to be made
                    185: .P
                    186: hh.mm.ss E xx
                    187: .IP
                    188: Description of error
                    189: .P
                    190: If data is being displayed, it will appear as follows:
                    191: .nf
                    192:      hh.mm.ss xD
                    193:               aaaaaaaaaa ... (50 characters) ... aaaaaaaaaa
                    194:               bbbbbbbbbb ...   (at a time)   ... bbbbbbbbbb
                    195: .fi
                    196: .P
                    197: The 'xD' will be 'RD' for received data, 'TD' for transmitted data.
                    198: If the data is being displayed in hexadecimal format, the 'a' line
                    199: will be the first four bits of each byte, the 'b' line the last four
                    200: bits. Otherwise, printable characters will be shown in their normal
                    201: form on the 'b' line with the 'a' column above each such character
                    202: blank; non-printable control
                    203: characters will be shown as a two-character
                    204: abbreviation reading down the column, non-control, non-printable
                    205: characters are printed in hexadecimal form.
                    206: .P
                    207: Characters display as shown in the following table. In each entry,
                    208: first is the hexadecimal form, then EBCDIC, then ASCII.
                    209: .P
                    210: .nf
                    211: .ta .4i .8i 1.5i 1.9i 2.3i 2.7i 3i 3.4i 3.8i 4.2i 4.5i 4.9i 5.3i 5.7i
                    212: 00     NU      NU      |       20      20      SP      |       40      SP      @       |       60      -       `
                    213: 01     SH      SH      |       21      21      !       |       41      41      A       |       61      /       a
                    214: 02     SX      SX      |       22      FS      "       |       42      42      B       |       62      62      b
                    215: 03     EX      EX      |       23      23      #       |       43      43      C       |       63      63      c
                    216: 04     04      ET      |       24      24      $       |       44      44      D       |       64      64      d
                    217: 05     HT      EQ      |       25      LF      %       |       45      45      E       |       65      65      e
                    218: 06     06      AK      |       26      EB      &       |       46      46      F       |       66      66      f
                    219: 07     RB      BL      |       27      EC      '       |       47      47      G       |       67      67      g
                    220: 08     08      BS      |       28      28      (       |       48      48      H       |       68      68      h
                    221: 09     09      HT      |       29      29      )       |       49      49      I       |       69      69      i
                    222: 0A     0A      LF      |       2A      2A      *       |       4A      4A      J       |       6A      |       j
                    223: 0B     VT      VT      |       2B      2B      +       |       4B      .       K       |       6B      ,       k
                    224: 0C     FF      FF      |       2C      2C      ,       |       4C      <       L       |       6C      %       l
                    225: 0D     CR      CR      |       2D      EQ      -       |       4D      (       M       |       6D      _       m
                    226: 0E     SO      SO      |       2E      AK      .       |       4E      +       N       |       6E      >       n
                    227: 0F     SI      SI      |       2F      BL      /       |       4F      4F      O       |       6F      ?       o
                    228: 10     DL      DL      |       30      30      0       |       50      &       P       |       70      70      p
                    229: 11     D1      D1      |       31      31      1       |       51      51      Q       |       71      71      q
                    230: 12     D2      D2      |       32      SY      2       |       52      52      R       |       72      72      r
                    231: 13     D3      D3      |       33      33      3       |       53      53      S       |       73      73      s
                    232: 14     14      D4      |       34      34      4       |       54      54      T       |       74      74      t
                    233: 15     15      NK      |       35      RS      5       |       55      55      U       |       75      75      u
                    234: 16     BS      SY      |       36      36      6       |       56      56      V       |       76      76      v
                    235: 17     17      EB      |       37      ET      7       |       57      57      W       |       77      77      w
                    236: 18     CN      CN      |       38      38      8       |       58      58      X       |       78      78      x
                    237: 19     EM      EM      |       39      39      9       |       59      59      Y       |       79      `       y
                    238: 1A     1A      SB      |       3A      3A      :       |       5A      !       Z       |       7A      :       z
                    239: 1B     1B      EC      |       3B      3B      ;       |       5B      $       [       |       7B      #       {
                    240: 1C     1C      FS      |       3C      D4      <       |       5C      *       \       |       7C      @       :
                    241: 1D     GS      GS      |       3D      NK      =       |       5D      )       ]       |       7D      '       }
                    242: 1E     1E      RS      |       3E      3E      >       |       5E      ;       ^       |       7E      =       ~
                    243: 1F     US      US      |       3F      SB      ?       |       5F      ^       _       |       7F      "       RB
                    244: .fi
                    245: .P
                    246: Hexadecimal value, EBCDIC form:
                    247: .nf
                    248: .ta .4i 1i 1.4i 1.8i 2.5i 2.9i 3.3i 4i 4.4i 4.8i
                    249: 80     80      |       A0      A0      |       C0      {       |       E0      \\
                    250: 81     a       |       A1      ~       |       C1      A       |       E1      E1
                    251: 82     b       |       A2      s       |       C2      B       |       E2      S
                    252: 83     c       |       A3      t       |       C3      C       |       E3      T
                    253: 84     d       |       A4      u       |       C4      D       |       E4      U
                    254: 85     e       |       A5      v       |       C5      E       |       E5      V
                    255: 86     f       |       A6      w       |       C6      F       |       E6      W
                    256: 87     g       |       A7      x       |       C7      G       |       E7      X
                    257: 88     h       |       A8      y       |       C8      H       |       E8      Y
                    258: 89     i       |       A9      z       |       C9      I       |       E9      Z
                    259: 8A     8A      |       AA      AA      |       CA      CA      |       EA      EA
                    260: 8B     8B      |       AB      AB      |       CB      CB      |       EB      EB
                    261: 8C     8C      |       AC      AC      |       CC      CC      |       EC      EC
                    262: 8D     8D      |       AD      [       |       CD      CD      |       ED      ED
                    263: 8E     8E      |       AE      AE      |       CE      CE      |       EE      EE
                    264: 8F     8F      |       AF      AF      |       CF      CF      |       EF      EF
                    265: 90     90      |       B0      B0      |       D0      }       |       F0      0
                    266: 91     j       |       B1      B1      |       D1      J       |       F1      1
                    267: 92     k       |       B2      B2      |       D2      k       |       F2      2
                    268: 93     l       |       B3      B3      |       D3      L       |       F3      3
                    269: 94     m       |       B4      B4      |       D4      M       |       F4      4
                    270: 95     n       |       B5      B5      |       D5      N       |       F5      5
                    271: 96     o       |       B6      B6      |       D6      O       |       F6      6
                    272: 97     p       |       B7      B7      |       D7      P       |       F7      7
                    273: 98     q       |       B8      B8      |       D8      Q       |       F8      8
                    274: 99     r       |       B9      B9      |       D9      R       |       F9      9
                    275: 9A     9A      |       BA      BA      |       DA      DA      |       FA      FA
                    276: 9B     9B      |       BB      BB      |       DB      DB      |       FB      FB
                    277: 9C     9C      |       BC      BC      |       DC      DC      |       FC      FC
                    278: 9D     9D      |       BD      ]       |       DD      DD      |       FD      FD
                    279: 9E     9E      |       BE      BE      |       DE      DE      |       FE      FE
                    280: 9F     9F      |       BF      BF      |       DF      DF      |       FF      FF
                    281: .fi

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.