Return to bscmon.8 CVS log

Up to [Power 6/32 Unix Tahoe 4.2BSD] / cci / usr / src / usr.bin / bsc / doc

Power 6/32 Unix version 1.21

.TH BSCMON 8 DLBA 1.2
\" @(#)bscmon.8	1.4
.SH NAME 
.br
bscmon \- BISYNC Communications Monitoring Utility
.br
bsctrace \- BISYNC Monitor Information Display Utility
.br
.SH SYNOPSIS 
.nf
.I
bscmon [-data] [-host=<hostname>]  [file]
.I
       [-dev=<devname>]
.I
bsctrace [-data=tttt] [-verbose] [file]
.fi
.SH DESCRIPTION
.P
The 
.I bscmon 
utility is used to record trace information from the BISYNC
trace device (/dev/bsc*tr) while BISYNC communications are taking place.
This information may be recorded in a data file for later processing by the 
.I bsctrace 
utility, or may be sent to standard output for immediate processing by 
.I bsctrace 
via a pipe.
.P
The trace information consists of two types of information.
The first type is a transition trace of the communications states
of the BISYNC driver itself,
and indicates when BISYNC packets were sent,
when they were received, and what actions were taken.
The second type of information consists of the actual data packets
sent and received.
Obviously the second type of information requires additional system
overhead and should only be recorded if necessary.
.P
The trace device will default to /dev/bsctr, unless a specification
is made via 
.I -dev 
or via 
.I -host.
The latter form allows 
.I bscmon 
to examine
the host configuration file in /usr/lib/bscbatch/<hostname> for a
.I DEVICE 
entry, in which case 'tr' is appended to the device name.
.P
If a 
.I file 
parameter is given to 
.I bscmon,
the trace information will be recorded in that file; otherwise
it will be written to the standard output. The 
.I -data
flag is used to indicate that the actual data packets
being sent and received should be recorded.
.P
.I Bsctrace 
interprets trace information in either a terse or verbose form.
The information itself is that recorded by 
.I bscmon,
which consists of state transition information and actual data packets.
In the terse form, the state type (send, receive, decision, or function)
and state number are given, as well as packet class for receive operations.
The state information is meaningless without the state diagram attached
to this document, but is the fastest form of display.
.P
The 
.I -data 
parameter must be specified in order
to have the actual data packets displayed with the trace information.
The 
.I tttt 
portion of the parameter indicates the
code in which the data should be displayed,
and may be either
.I 
hex, ebcdic, 
or 
.I ascii.
.P
The verbose form interprets the trace information by displaying the
state description data for each state which appears in file
/usr/lib/bsc/trace.text.
.P
.SH "SEE ALSO"
.nf
batch(8) \- BISYNC Batch Terminal Emulation
.I 
General Information \- Binary Synchronous Communications,
IBM document GA27-3004
.fi
.SH FILES
.nf
/usr/lib/bscbatch/<hostname> \- host parameter file
/usr/lib/bsc/trace.text \- Descriptive trace information
/dev/bsctr \- Virtual trace device
.fi
.SH DIAGNOSTICS
.P
bscmon: invalid parameter (<flag>)
.IP
The parameter shown does not appear in the synopsis.
.P
bscmon: can't create <filename>
.IP
The file named could not be created for output.
Check write permissions or directory permissions.
.P
bscmon: <host> has no configuration file
.IP
The host configuration file should be in /usr/lib/bscbatch/<hostname>.
Either it is not there, or it could not be read.
.P
bscmon: trace device <devname> cannot be opened
.IP
Either the device name given for the trace device was incorrect,
or cannot be read, or does not exist.
.P
bsctrace: invalid parameter (<flag>)
.IP
The parameter shown does not appear in the synopsis.
.P
bsctrace: can't read trace text file
(/usr/lib/bsc/trace.text)
.IP
The 
.I -verbose 
option was given, but the file containing
the trace interpretation information could not be read.
.P
bsctrace: can't read trace information file (<filename>)
.IP
The filename shown was given as the input file containing the trace
information recorded by 
.I bscmon. 
However, the file either does not exist, or can't be read.
.SH "TRACE DISPLAY FORMAT"
.P
To represent a transition to a new state, a line of
the following form will be displayed for terse mode:
.IP
hh.mm.ss nn c
.P
The first portion is the time at which the transition to the state
occurred.
The state number was
.I nn,
and the state type was 
.I c. 
State types are 'S' for send, 'R'
for receive, 'F' for function, and 'D' for decision; additionally,
'C' is used to show the class of packet received, and 'E' shows
the type of error encountered for link-level problems.
If data recording was selected, types 'TD' and 'RD' appear (transmit
and receive data, respectively), but the data is displayed only if the
.I -data
parameter was specified.
.P
In verbose mode, text may take one of the following forms:
.P
hh.mm.ss nn S
.IP
Description of action and what is being sent
.P
hh.mm.ss nn R
.IP
Description of action and expected response
.P
hh.mm.ss nn C xx
.IP
Received <packet type>
.P
hh.mm.ss nn F
.IP
Function's purpose, e.g. check acknowledgement
.P
hh.mm.ss nn D
.IP
Description of decision to be made
.P
hh.mm.ss E xx
.IP
Description of error
.P
If data is being displayed, it will appear as follows:
.nf
     hh.mm.ss xD
              aaaaaaaaaa ... (50 characters) ... aaaaaaaaaa
              bbbbbbbbbb ...   (at a time)   ... bbbbbbbbbb
.fi
.P
The 'xD' will be 'RD' for received data, 'TD' for transmitted data.
If the data is being displayed in hexadecimal format, the 'a' line
will be the first four bits of each byte, the 'b' line the last four
bits. Otherwise, printable characters will be shown in their normal
form on the 'b' line with the 'a' column above each such character
blank; non-printable control
characters will be shown as a two-character
abbreviation reading down the column, non-control, non-printable
characters are printed in hexadecimal form.
.P
Characters display as shown in the following table. In each entry,
first is the hexadecimal form, then EBCDIC, then ASCII.
.P
.nf
.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
00	NU	NU	|	20	20	SP	|	40	SP	@	|	60	-	`
01	SH	SH	|	21	21	!	|	41	41	A	|	61	/	a
02	SX	SX	|	22	FS	"	|	42	42	B	|	62	62	b
03	EX	EX	|	23	23	#	|	43	43	C	|	63	63	c
04	04	ET	|	24	24	$	|	44	44	D	|	64	64	d
05	HT	EQ	|	25	LF	%	|	45	45	E	|	65	65	e
06	06	AK	|	26	EB	&	|	46	46	F	|	66	66	f
07	RB	BL	|	27	EC	'	|	47	47	G	|	67	67	g
08	08	BS	|	28	28	(	|	48	48	H	|	68	68	h
09	09	HT	|	29	29	)	|	49	49	I	|	69	69	i
0A	0A	LF	|	2A	2A	*	|	4A	4A	J	|	6A	|	j
0B	VT	VT	|	2B	2B	+	|	4B	.	K	|	6B	,	k
0C	FF	FF	|	2C	2C	,	|	4C	<	L	|	6C	%	l
0D	CR	CR	|	2D	EQ	-	|	4D	(	M	|	6D	_	m
0E	SO	SO	|	2E	AK	.	|	4E	+	N	|	6E	>	n
0F	SI	SI	|	2F	BL	/	|	4F	4F	O	|	6F	?	o
10	DL	DL	|	30	30	0	|	50	&	P	|	70	70	p
11	D1	D1	|	31	31	1	|	51	51	Q	|	71	71	q
12	D2	D2	|	32	SY	2	|	52	52	R	|	72	72	r
13	D3	D3	|	33	33	3	|	53	53	S	|	73	73	s
14	14	D4	|	34	34	4	|	54	54	T	|	74	74	t
15	15	NK	|	35	RS	5	|	55	55	U	|	75	75	u
16	BS	SY	|	36	36	6	|	56	56	V	|	76	76	v
17	17	EB	|	37	ET	7	|	57	57	W	|	77	77	w
18	CN	CN	|	38	38	8	|	58	58	X	|	78	78	x
19	EM	EM	|	39	39	9	|	59	59	Y	|	79	`	y
1A	1A	SB	|	3A	3A	:	|	5A	!	Z	|	7A	:	z
1B	1B	EC	|	3B	3B	;	|	5B	$	[	|	7B	#	{
1C	1C	FS	|	3C	D4	<	|	5C	*	\	|	7C	@	:
1D	GS	GS	|	3D	NK	=	|	5D	)	]	|	7D	'	}
1E	1E	RS	|	3E	3E	>	|	5E	;	^	|	7E	=	~
1F	US	US	|	3F	SB	?	|	5F	^	_	|	7F	"	RB
.fi
.P
Hexadecimal value, EBCDIC form:
.nf
.ta .4i 1i 1.4i 1.8i 2.5i 2.9i 3.3i 4i 4.4i 4.8i
80	80	|	A0	A0	|	C0	{	|	E0	\\
81	a	|	A1	~	|	C1	A	|	E1	E1
82	b	|	A2	s	|	C2	B	|	E2	S
83	c	|	A3	t	|	C3	C	|	E3	T
84	d	|	A4	u	|	C4	D	|	E4	U
85	e	|	A5	v	|	C5	E	|	E5	V
86	f	|	A6	w	|	C6	F	|	E6	W
87	g	|	A7	x	|	C7	G	|	E7	X
88	h	|	A8	y	|	C8	H	|	E8	Y
89	i	|	A9	z	|	C9	I	|	E9	Z
8A	8A	|	AA	AA	|	CA	CA	|	EA	EA
8B	8B	|	AB	AB	|	CB	CB	|	EB	EB
8C	8C	|	AC	AC	|	CC	CC	|	EC	EC
8D	8D	|	AD	[	|	CD	CD	|	ED	ED
8E	8E	|	AE	AE	|	CE	CE	|	EE	EE
8F	8F	|	AF	AF	|	CF	CF	|	EF	EF
90	90	|	B0	B0	|	D0	}	|	F0	0
91	j	|	B1	B1	|	D1	J	|	F1	1
92	k	|	B2	B2	|	D2	k	|	F2	2
93	l	|	B3	B3	|	D3	L	|	F3	3
94	m	|	B4	B4	|	D4	M	|	F4	4
95	n	|	B5	B5	|	D5	N	|	F5	5
96	o	|	B6	B6	|	D6	O	|	F6	6
97	p	|	B7	B7	|	D7	P	|	F7	7
98	q	|	B8	B8	|	D8	Q	|	F8	8
99	r	|	B9	B9	|	D9	R	|	F9	9
9A	9A	|	BA	BA	|	DA	DA	|	FA	FA
9B	9B	|	BB	BB	|	DB	DB	|	FB	FB
9C	9C	|	BC	BC	|	DC	DC	|	FC	FC
9D	9D	|	BD	]	|	DD	DD	|	FD	FD
9E	9E	|	BE	BE	|	DE	DE	|	FE	FE
9F	9F	|	BF	BF	|	DF	DF	|	FF	FF
.fi

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