[unix-history] / usr / man / man1 / prof.1

.TH PROF 1  "18 January 1983"
.UC 4
.SH NAME
prof \- display profile data
.SH SYNOPSIS
.B prof
[
.B \-a
] [
.B \-l
] [
.B \-n
] [
.B \-z
] [
.B \-s
] [
.B \-v
[
.BI \- "low\fR [ \fB\-\fIhigh\fR ]"
] ]
[ a.out
[ mon.out ... ] ]
.SH DESCRIPTION
.I Prof
interprets the file
produced by the
.I monitor
subroutine.
Under default modes,
the symbol table in the
named object file
.I (a.out
default)
is read and correlated with the
profile file
.I (mon.out
default).
For each external symbol, the percentage
of time spent executing between that symbol
and the next
is printed (in decreasing order),
together with the number of times that routine was called
and the number of milliseconds per call.
If more than one profile file is specified,
the output represents the sum of the profiles.
.PP
In order for the number of calls to a routine to be tallied,
the
.B \-p
option of
.I cc,
.I f77
or
.I pc
must have been given when the file containing the
routine was compiled.
This option also arranges for the
profile file to be produced automatically.
.PP
Options are:
.TP
.B \-a
all symbols are reported rather than
just external symbols.
.TP
.B \-l
the output is sorted by symbol value.
.TP
.B \-n
the output is sorted by number of calls
.TP
.B \-s
a summary profile file is produced in
.I mon.sum.
This is really only useful
when more than one profile file is specified.
.TP
.B \-v
all printing is suppressed
and a graphic version of the profile
is produced
on the standard output for display by the
.IR  plot (1)
filters.
When plotting, the numbers
.I low
and 
.I high,
by default 0 and 100, may be given to cause a selected
percentage of the profile to be plotted
with accordingly higher resolution.
.TP
.B \-z
routines which have zero usage (as indicated by call counts
and accumulated time) are nevertheless printed in the output.
.SH FILES
.ta \w'mon.out  'u
mon.out	for profile
.br
a.out		for namelist
.br
mon.sum	for summary profile
.SH "SEE ALSO"
monitor(3), profil(2), cc(1), plot(1G)
.SH BUGS
Beware of quantization errors.
.PP
Is confused by
.I f77
which puts the entry points at the bottom of subroutines and functions.
Commit	Line	Data
31341dcc C	1	.TH PROF 1 "18 January 1983"
	2	.UC 4
	3	.SH NAME
	4	prof \- display profile data
	5	.SH SYNOPSIS
	6	.B prof
	7	[
	8	.B \-a
	9	] [
	10	.B \-l
	11	] [
	12	.B \-n
	13	] [
	14	.B \-z
	15	] [
	16	.B \-s
	17	] [
	18	.B \-v
	19	[
	20	.BI \- "low\fR [ \fB\-\fIhigh\fR ]"
	21	] ]
	22	[ a.out
	23	[ mon.out ... ] ]
	24	.SH DESCRIPTION
	25	.I Prof
	26	interprets the file
	27	produced by the
	28	.I monitor
	29	subroutine.
	30	Under default modes,
	31	the symbol table in the
	32	named object file
	33	.I (a.out
	34	default)
	35	is read and correlated with the
	36	profile file
	37	.I (mon.out
	38	default).
	39	For each external symbol, the percentage
	40	of time spent executing between that symbol
	41	and the next
	42	is printed (in decreasing order),
	43	together with the number of times that routine was called
	44	and the number of milliseconds per call.
	45	If more than one profile file is specified,
	46	the output represents the sum of the profiles.
	47	.PP
	48	In order for the number of calls to a routine to be tallied,
	49	the
	50	.B \-p
	51	option of
	52	.I cc,
	53	.I f77
	54	or
	55	.I pc
	56	must have been given when the file containing the
	57	routine was compiled.
	58	This option also arranges for the
	59	profile file to be produced automatically.
	60	.PP
	61	Options are:
	62	.TP
	63	.B \-a
	64	all symbols are reported rather than
65	just external symbols.
66	.TP
67	.B \-l
68	the output is sorted by symbol value.
69	.TP
70	.B \-n
71	the output is sorted by number of calls
72	.TP
73	.B \-s
74	a summary profile file is produced in
75	.I mon.sum.
76	This is really only useful
77	when more than one profile file is specified.
78	.TP
79	.B \-v
80	all printing is suppressed
81	and a graphic version of the profile
82	is produced
83	on the standard output for display by the
84	.IR plot (1)
85	filters.
86	When plotting, the numbers
87	.I low
88	and
89	.I high,
90	by default 0 and 100, may be given to cause a selected
91	percentage of the profile to be plotted
92	with accordingly higher resolution.
93	.TP
94	.B \-z
95	routines which have zero usage (as indicated by call counts
96	and accumulated time) are nevertheless printed in the output.
97	.SH FILES
98	.ta \w'mon.out 'u
99	mon.out for profile
100	.br
101	a.out for namelist
102	.br
103	mon.sum for summary profile
104	.SH "SEE ALSO"
105	monitor(3), profil(2), cc(1), plot(1G)
106	.SH BUGS
107	Beware of quantization errors.
108	.PP
109	Is confused by
110	.I f77
111	which puts the entry points at the bottom of subroutines and functions.