1 02/28/85 tty_dump
  2 
  3 Syntax as a command:  tty_dump channel_name {-control_args}
  4 
  5 
  6 Function:  displays on the user's terminal the contents of the ring
  7 zero data bases describing either the current state of selected
  8 communications channels managed by the Multics Communication System or
  9 the state of such channels at the time of a system crash.
 10 
 11 
 12 Arguments:
 13 channel_name
 14    specifies the communications channels for which the state is to be
 15    displayed.  The star convention is allowed (e.g., b.h202.**).  This
 16    argument is incompatible with the -user control argument.
 17 
 18 
 19 Control arguments:
 20 -ascii
 21    specifies that the contents of buffers are to be interpreted as
 22    ASCII characters in addition to being displayed as octal or
 23    hexadecimal values.
 24 -all, -a
 25    specifies that, for each channel selected by the above arguments,
 26    information is to be displayed from the data bases of the channel,
 27    its parent multiplexer, its grandparent multiplexer, etc., up to the
 28    top level multiplexer channel.  For example, for b.h202.prt1, all
 29    information from the data bases of b.h202.prt1, b.h202, and b that
 30    is related to b.h202.prt1 would be displayed.
 31 -brief, bf
 32    suppresses display of the buffer contents.  Only the addresses,
 33    size, and flags for each buffer are displayed.
 34 
 35 
 36 -ebcdic8
 37    specifies that the contents of buffers are to be interpreted as
 38    EBCDIC (8-bit byte) characters in addition to being displayed as
 39    octal or hexadecimal values.
 40 -ebcdic9
 41    specifies that the contents of buffers are to be interpreted as
 42    EBCDIC (9-bit byte) characters, in addition to being displayed as
 43    octal or hexadecimal values.
 44 -erf N
 45    specifies that information about the channels is to be taken from
 46    the system dump associated with error report form (ERF) N located in
 47    >dumps.  If this control argument is omitted, information about the
 48    currently running system is displayed.  This control argument is
 49    incompatible with the -user control argument.
 50 
 51 
 52 -hex8
 53    specifies that the contents of buffers are to be displayed as
 54    hexadecimal values, in addition to any character interpretation.
 55    Each 8-bit byte in a word is displayed (nine hexadecimal digits).
 56 -hex9
 57    specifies that the contents of buffers are to be displayed as
 58    hexadecimal values, in addition to any character interpretation.
 59    The low order 8 bits of each 9-bit byte in a word is displayed as
 60    two hexadecimal digits.
 61 -lcte
 62    specifies that the logical channel table entries (LTE) for the
 63    selected channels are to be displayed in addition to the other
 64    information normally displayed.  If -all is specified, the LCTEs of
 65    all parent multiplexers are also displayed.
 66 
 67 
 68 -long, -lg
 69    specifies that the contents of any input and output buffers for the
 70    channels are to be displayed.  This is the default.
 71 -octal
 72    specifies that the contents of buffers are to be displayed as octal
 73    values in addition to any character interpretation.  Octal is the
 74    default numeric mode for buffer contents display.
 75 -subchan, -sbc
 76    specifies that information from the data base of the parent
 77    multiplexer related only to the selected channels is to be
 78    displayed.
 79 
 80 
 81 -user STR
 82    specifies that the state of all communications channels attached by
 83    the specified user(s) is to be displayed.  STR is a starname used to
 84    identify the users and is matched against the Person_id.Project_id
 85    of each logged in user.  For example, "*Smith.M*" would match any
 86    user whose Person_id ends with "Smith" that is logged in on a
 87    project that starts with "M".  This control argument is incompatible
 88    with the channel_name argument and the -erf control argument.
 89 
 90 
 91 Access required:  Use of the tty_dump command without the -erf control
 92 argument requires access to the gate phcs_.
 93 
 94 
 95 Notes:  The description of the dump_segment command in the Multics
 96 Commands and Active Functions manual, Order No.  AG92, provides
 97 detailed information on the various buffer display formats.
 98 
 99 The default mode for buffer displays is to display their contents as
100 octal values without any character interpretation.
101 
102 There are two sets of conflicting control arguments in tty_dump, three
103 with which to specify the base of numeric display (-octal, -hex8, and
104 -hex9), and three with which to specify character code interpretation
105 (-ascii, -ebcdic8, and -ebcdic9).  If conflicting control arguments are
106 given on the command line, the last one specified will be used.