add .Vx so tmac.andoc will call tmac.mdoc-old
[unix-history] / usr / src / usr.bin / pascal / pxp / pxp.1
CommitLineData
b5dc1377
CL
1.\" Copyright (c) 1980, 1990 The Regents of the University of California.
2.\" All rights reserved.
55cde626 3.\"
b5dc1377 4.\" %sccs.include.redist.man%
55cde626 5.\"
d0719240 6.\" @(#)pxp.1 6.4 (Berkeley) %G%
b5dc1377 7.\"
ee9b0a0a
CL
8.Vx
9.Vx
b5dc1377
CL
10.Dd
11.Dt PXP 1
b5dc1377
CL
12.Sh NAME
13.Nm pxp
14.Nd Pascal execution profiler
15.Sh SYNOPSIS
16.Nm pxp
17.Op Fl acdefjnstuw_
18.Op Fl 23456789
19.Op Fl z Op Ar name ...
20.Ar name.p
21.Sh DESCRIPTION
22.Nm Pxp
55cde626
KM
23can be used to obtain execution profiles of Pascal programs or
24as a pretty-printer.
25To produce an execution profile all that is necessary is to translate
26the program specifying the
b5dc1377 27.Fl z
55cde626 28option to
b5dc1377 29.Xr pi 1
55cde626 30or
b5dc1377 31.Xr pix 1 ,
55cde626
KM
32to execute the program,
33and to then issue the command
b5dc1377
CL
34.Pp
35.Dl pxp -x name.p
36.Pp
55cde626 37A reformatted listing is output if none of the
b5dc1377
CL
38.Fl c ,
39.Fl t ,
55cde626 40or
b5dc1377 41.Fl z
55cde626
KM
42options are specified;
43thus
b5dc1377
CL
44.Pp
45.Dl pxp old.p > new.p
46.Pp
55cde626 47places a pretty-printed version of the program in `old.p' in the file `new.p'.
b5dc1377 48.Pp
55cde626 49The use of the following options of
b5dc1377 50.Nm pxp
55cde626 51is discussed in sections 2.6, 5.4, 5.5 and 5.10 of the
b5dc1377
CL
52.Em Berkeley Pascal User's Manual .
53.Tp Fl a
55cde626
KM
54Print the bodies of all procedures and functions in the profile;
55even those which were never executed.
b5dc1377 56.Tp Fl c
55cde626 57Extract profile data from the file
b5dc1377
CL
58.Pa core .
59.Tp Fl d
55cde626 60Include declaration parts in a profile.
b5dc1377 61.Tp Fl e
55cde626 62Eliminate
b5dc1377 63.Ic include
55cde626
KM
64directives when reformatting a file;
65the
b5dc1377 66.Ic include
55cde626
KM
67is replaced by the reformatted contents of the specified
68file.
b5dc1377 69.Tp Fl f
55cde626 70Fully parenthesize expressions.
b5dc1377 71.Tp Fl j
55cde626 72Left justify all procedures and functions.
b5dc1377
CL
73.Tp Fl n
74Eject a new page
55cde626
KM
75as each file is included;
76in profiles, print a blank line at the top of the page.
b5dc1377 77.Tp Fl s
55cde626 78Strip comments from the input text.
b5dc1377 79.Tp Fl t
55cde626 80Print a table summarizing
b5dc1377 81.Ic procedure
55cde626 82and
b5dc1377 83.Ic function
55cde626 84call counts.
b5dc1377 85.Tp Fl u
55cde626
KM
86Card image mode; only the first 72 characters of input lines
87are used.
b5dc1377 88.Tp Fl w
55cde626 89Suppress warning diagnostics.
b5dc1377 90.Tp Fl z
55cde626
KM
91Generate an execution profile.
92If no
b5dc1377
CL
93.Cx Ar name
94.Cx \&\'s
95.Cx
55cde626
KM
96are given the profile is of the entire program.
97If a list of names is given, then only any specified
b5dc1377
CL
98.Cx Ic procedure
99.Cx \&s
100.Cx
55cde626 101or
b5dc1377
CL
102.Cx Ic function
103.Cx \&s
104.Cx
55cde626 105and the contents of any specified
b5dc1377 106.Ic include
55cde626 107files will appear in the profile.
b5dc1377 108.Tp Fl \&_
55cde626 109Underline keywords.
b5dc1377 110.Tp Fl d
55cde626 111With
b5dc1377 112.Ar d
55cde626 113a digit, 2 \(<=
b5dc1377 114.Ar d
55cde626
KM
115\(<= 9,
116causes
b5dc1377 117.Nm pxp
55cde626 118to use
b5dc1377 119.Ar d
55cde626
KM
120spaces as the basic indenting unit.
121The default is 4.
b5dc1377
CL
122.Sh FILES
123.Dw /usr/lib/how_pxp
124.Di L
125.Dp Pa name.p
126input file
127.Dp Pa name.i
128include file(s)
129.Dp Pa pmon.out
130profile data
131.Dp Pa core
132profile data source with
133.Fl c
134.Dp Pa /usr/lib/how_pxp
135information on basic usage
136.Dp
137.Sh SEE ALSO
138.Em Berkeley Pascal User's Manual
55cde626 139.br
b5dc1377
CL
140.Xr pi 1 ,
141.Xr px 1
142.Sh DIAGNOSTICS
55cde626 143For a basic explanation do
b5dc1377
CL
144.Pp
145.Df I
146.Nm pxp
147.De
148.Pp
55cde626
KM
149Error diagnostics include
150`No profile data in file'
151with the
b5dc1377 152.Fl c
55cde626 153option if the
b5dc1377 154.Fl z
55cde626 155option was not enabled to
b5dc1377 156.Nm pi ;
55cde626
KM
157`Not a Pascal system core file'
158if the core is not from a
b5dc1377 159.Nm px
55cde626
KM
160execution;
161`Program and count data do not correspond'
162if the program was changed after compilation, before profiling;
163or if the wrong program is specified.
b5dc1377 164.Sh AUTHOR
55cde626 165William Joy
b5dc1377
CL
166.Sh HISTORY
167.Nm Pxp
168appeared in 3 BSD.
169.Sh BUGS
55cde626 170Does not place multiple statements per line.