BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.bin / pascal / pdx / pdx.1

diff --git a/usr/src/usr.bin/pascal/pdx/pdx.1 b/usr/src/usr.bin/pascal/pdx/pdx.1
index ee29e0c..1c41492 100644 (file)
--- a/usr/src/usr.bin/pascal/pdx/pdx.1
+++ b/usr/src/usr.bin/pascal/pdx/pdx.1
@@ -1,13 +1,37 @@
 .\" Copyright (c) 1983, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1983, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"

-.\" %sccs.include.redist.man%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"     @(#)pdx.1      6.3 (Berkeley) %G%
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.Vx
-.Vx
-.Dd 
+.\"    @(#)pdx.1       6.4 (Berkeley) 7/24/91
+.\"
+.Dd July 24, 1991

 .Dt PDX 1
 .Os BSD 4.2
 .Sh NAME
 .Dt PDX 1
 .Os BSD 4.2
 .Sh NAME


@@ -42,7 +66,8 @@ If the file
 exists in the current directory, then the
 debugger commands in it are executed.
 .Pp
 exists in the current directory, then the
 debugger commands in it are executed.
 .Pp

-.Tp Fl r
+.Bl -tag -width flag r
+.It Fl r

 The
 .Fl r
 option causes the
 The
 .Fl r
 option causes the


@@ -61,19 +86,17 @@ If
 is not specified,
 .Nm pdx
 just prompts and waits for a command.
 is not specified,
 .Nm pdx
 just prompts and waits for a command.

-.Tp
+.El

 .Pp
 The commands are:
 .Pp
 The commands are:

-.Dw Fl
-.Di L
-.Dp Cx Ic run
-.Cx \&\ \&
+.Pp
+.Bl -tag -width flag -compact
+.It Xo
+.Ic run

 .Op Ar args
 .Op Ar args

-.Cx \&\ \&

 .Op Ic \&< Ar filename
 .Op Ic \&< Ar filename

-.Cx \&\ \&

 .Op Ic \&> Ar filename
 .Op Ic \&> Ar filename

-.Cx
+.Xc

 Start executing
 .Ar objfile  ,
 passing
 Start executing
 .Ar objfile  ,
 passing


@@ -84,45 +107,33 @@ or
 .Ic \&>
 can be used to redirect input or output in the usual manner.
 .Pp
 .Ic \&>
 can be used to redirect input or output in the usual manner.
 .Pp

-.Dp Cx Ic trace
-.Pp
-.Cx \&\ \&
+.It Xo
+.Ic trace

 .Op Ic in Ar procedure/function
 .Op Ic in Ar procedure/function

-.Cx \&\ \&
-.Op Ic if Ar condition
-.Cx
-.Dp Cx Ic trace
-.Cx \&\ \&
+.Op Ic if Ar condition 
+.Xc
+.It Xo
+.Ic trace

 .Ar source-line-number
 .Op Ic if Ar condition
 .Ar source-line-number
 .Op Ic if Ar condition

-.Cx \&\ \&
-.Cx
-.Dp Cx Ic trace
-.Cx \&\ \&
+.Xc
+.It Xo
+.Ic trace

 .Ar procedure/function
 .Ar procedure/function

-.Cx \&\ \&

 .Op Ic in Ar procedure/function
 .Op Ic in Ar procedure/function

-.Cx \&\ \&
-.Op Ic if Ar condition
-.Cx
-.Dp Cx Ic trace
-.Cx \&\ \&
-.Ar expression
-.Cx \&\ \&
-.Ic at
-.Cx \&\ \&
-.Ar source-line-number
-.Cx \&\ \&
-.Op Ic if Ar condition
-.Cx
-.Dp Cx Ic trace
-.Cx \&\ \&
+.Op Ic if Ar condition 
+.Xc
+.It Xo
+.Ic trace
+.Ar expression Ic at Ar source-line-number
+.Op Ic if Ar condition 
+.Xc
+.It Xo
+.Ic trace

 .Ar variable
 .Ar variable

-.Cx \&\ \&

 .Op Ic in Ar procedure/function
 .Op Ic in Ar procedure/function

-.Cx \&\ \&
-.Op Ic if Ar condition
-.Cx
+.Op Ic if Ar condition 
+.Xc

 Have tracing information printed when the program is executed.
 A number is associated with the command that is used
 to turn the tracing off (see the
 Have tracing information printed when the program is executed.
 A number is associated with the command that is used
 to turn the tracing off (see the


@@ -162,10 +173,7 @@ before they are executed.
 Execution is substantially slower during this form of tracing.
 .Pp
 The clause
 Execution is substantially slower during this form of tracing.
 .Pp
 The clause

-.Dq Cx Ic in
-.Cx \&\ \&
-.Ar procedure/function
-.Cx
+.Dq Ic in Ar procedure/function 

 restricts tracing information
 to be printed only while executing inside the given procedure
 or function.
 restricts tracing information
 to be printed only while executing inside the given procedure
 or function.


@@ -179,51 +187,30 @@ There is no restriction on the amount of information
 that can be traced.
 .Pp
 .ne 10
 that can be traced.
 .Pp
 .ne 10

-.Dp Cx Ic stop
-.Cx \&\ \&
-.Ic if
-.Cx \&\ \&
-.Ar condition
-.Cx
-.Dp Cx Ic stop
-.Cx \&\ \&
-.Ic at
-.Cx \&\ \&
-.Ar source-line-number
-.Cx \&\ \&
-.Op Ic if Ar condition
-.Cx
-.Dp Cx Ic stop
-.Cx \&\ \&
-.Ic in
-.Cx \&\ \&
-.Ar procedure /function
-.Cx \&\ \&
-.Op Ic if Ar condition
-.Cx
-.Dp Cx Ic stop
-.Cx \&\ \&
-.Ar variable
-.Cx \&\ \&
-.Op Ic if Ar condition
-.Cx
+.It Ic stop if Ar condition 
+.It Xo
+.Ic stop at Ar source-line-number
+.Op Ic if Ar condition 
+.Xc
+.It Xo
+.Ic stop in Ar procedure/function
+.Op Ic if Ar condition 
+.Xc
+.It Xo
+.Ic stop Ar variable
+.Op Ic if Ar condition 
+.Xc

 Stop execution when the given line is reached, procedure or function
 called, variable changed, or condition true.
 .Pp
 Stop execution when the given line is reached, procedure or function
 called, variable changed, or condition true.
 .Pp

-.Dp Cx Ic delete
-.Cx \&\ \&
-.Ar command-number
-.Cx
+.It Ic delete Ar command-number 

 The trace or stop corresponding to the given number is removed.
 The numbers associated with traces and stops are printed by
 the
 .Ic status
 command.
 .Pp
 The trace or stop corresponding to the given number is removed.
 The numbers associated with traces and stops are printed by
 the
 .Ic status
 command.
 .Pp

-.Dp Cx Ic status
-.Cx \&\ \&
-.Op Ic \&> Ar filename
-.Cx
+.It Ic status Op Ic \&> Ar filename 

 Print out
 the currently active
 .Ic trace
 Print out
 the currently active
 .Ic trace


@@ -231,7 +218,7 @@ and
 .Ic stop
 commands.
 .Pp
 .Ic stop
 commands.
 .Pp

-.Dp Ic cont
+.It Ic cont

 Continue execution from where it stopped.
 This can only be
 done when the program was stopped by an interrupt
 Continue execution from where it stopped.
 This can only be
 done when the program was stopped by an interrupt


@@ -239,10 +226,10 @@ or through use of the
 .Ic stop
 command.
 .Pp
 .Ic stop
 command.
 .Pp

-.Dp Ic step
+.It Ic step

 Execute one source line.
 .Pp
 Execute one source line.
 .Pp

-.Dp Ic next
+.It Ic next

 Execute up to the next source line.
 The difference between this and
 .Ic step
 Execute up to the next source line.
 The difference between this and
 .Ic step


@@ -255,63 +242,44 @@ block, while the
 .Ic next
 command will not.
 .Pp
 .Ic next
 command will not.
 .Pp

-.Dp Cx Ic print
-.Cx \&\ \&
-.Ar expression
-.Cx \&\ \&
-.Op Ic \&, Ar expression ...
-.Cx
+.It Xo
+.Ic print Ar expression
+.Op Ic \&, Ar expression ... 
+.Xc

 Print out the values of the Pascal expressions.
 Variables declared in an outer block but having
 the same identifier as one in the current block may be
 referenced as
 .Dq Ar block-name \&. variable
 .Pp
 Print out the values of the Pascal expressions.
 Variables declared in an outer block but having
 the same identifier as one in the current block may be
 referenced as
 .Dq Ar block-name \&. variable
 .Pp

-.Dp Cx Ic whatis
-.Cx \&\ \&
-.Ar identifier
-.Cx
+.It Ic whatis Ar identifier 

 Print the declaration of the given identifier.
 .Pp
 Print the declaration of the given identifier.
 .Pp

-.Dp Cx Ic which
-.Cx \&\ \&
-.Ar identifier
-.Cx
+.It Ic which Ar identifier 

 Print the full qualification of the given identifer, i.e.
 the outer blocks that the identifier is associated with.
 .Pp
 Print the full qualification of the given identifer, i.e.
 the outer blocks that the identifier is associated with.
 .Pp

-.Dp Cx Ic assign
-.Cx \&\ \&
-.Ar variable
-.Cx \&\ \&
-.Ar expression
-.Cx
+.It Ic assign Ar variable Ar expression 

 Assign the value of the expression to the variable.
 .Pp
 Assign the value of the expression to the variable.
 .Pp

-.Dp Cx Ic call
-.Cx \&\ \&
-.Ar procedure (parameters)
-.Cx
+.It Ic call Ar procedure Ns (parameters) 

 Execute the object code associated with the named procedure or function.
 .Pp
 Execute the object code associated with the named procedure or function.
 .Pp

-.Dp Ic help
+.It Ic help

 Print out a synopsis of
 .Nm pdx
 commands.
 .Pp
 Print out a synopsis of
 .Nm pdx
 commands.
 .Pp

-.Dp Ic gripe
+.It Ic gripe

 Invokes a mail program to send a message to the person in charge of
 .Nm pdx  .
 .Pp
 Invokes a mail program to send a message to the person in charge of
 .Nm pdx  .
 .Pp

-.Dp Ic where
+.It Ic where

 Print out
 a list of the active procedures and functions and the respective source
 line where they are called.
 .Pp
 Print out
 a list of the active procedures and functions and the respective source
 line where they are called.
 .Pp

-.Dp Cx Ic source
-.Cx \&\ \&
-.Ar filename
-.Cx
+.It Ic source Ar filename 

 Read
 .Nm pdx
 commands from the given
 Read
 .Nm pdx
 commands from the given


@@ -323,24 +291,16 @@ a
 .Ic status
 command from an earlier debugging session.
 .Pp
 .Ic status
 command from an earlier debugging session.
 .Pp

-.Dp Cx Ic dump
-.Cx \&\ \&
-.Op Ic \&> Ar filename
-.Cx
+.It Ic dump Op Ic \&> Ar filename 

 Print the names and values of all active
 data.
 .Pp
 Print the names and values of all active
 data.
 .Pp

-.Dp Cx Ic list
-.Cx \&\ \&[
-.Ar source-line-number
-.Cx \&\ \&
-.Op \&, Ar source-line-number
-.Cx \&]
-.Cx
-.Dp Cx Ic list
-.Cx \&\ \&
-.Ar procedure/function
-.Cx
+.It Xo
+.Ic list
+.Oo Ar source-line-number
+.Op \&, Ar source-line-number Oc
+.Xc
+.It Ic list Ar procedure/function 

 List the lines in the current source file from the first line number to
 the second inclusive.
 As in the editor
 List the lines in the current source file from the first line number to
 the second inclusive.
 As in the editor


@@ -358,22 +318,13 @@ in the procedure or function and
 .Ar k
 is small.
 .Pp
 .Ar k
 is small.
 .Pp

-.Dp Cx Ic file
-.Cx \&\ \&
-.Op Ar filename
-.Cx
+.It Ic file Op Ar filename 

 Change the current source file name to
 .Ar filename  .
 If none is specified then the current source file name is printed.
 .Pp
 Change the current source file name to
 .Ar filename  .
 If none is specified then the current source file name is printed.
 .Pp

-.Dp Cx Ic edit
-.Cx \&\ \&
-.Op Ar filename
-.Cx
-.Dp Cx Ic edit
-.Cx \&\ \&
-.Ar procedure/function-name
-.Cx
+.It Ic edit Op Ar filename 
+.It Ic edit Ar procedure Ns / Ns Ar function-name 

 Invoke an editor on
 .Ar filename
 or the current source file if none
 Invoke an editor on
 .Ar filename
 or the current source file if none


@@ -386,24 +337,17 @@ name is specified,
 the editor is invoked on the file that contains it.
 Which editor is invoked by default depends on the installation.
 The default can be overridden by setting the environment variable
 the editor is invoked on the file that contains it.
 Which editor is invoked by default depends on the installation.
 The default can be overridden by setting the environment variable

-EDITOR to the name of the desired editor.
+.Ev EDITOR
+to the name of the desired editor.

 .Pp
 .Pp

-.Dp Ic pi
+.It Ic pi

 Recompile the program and read in the new symbol table information.
 .Pp
 Recompile the program and read in the new symbol table information.
 .Pp

-.Dp Cx Ic sh
-.Cx \&\ \&
-.Ar command-line
-.Cx
+.It Ic sh Ar command-line 

 Pass the command line to the shell for execution.
 The SHELL environment variable determines which shell is used.
 .Pp
 Pass the command line to the shell for execution.
 The SHELL environment variable determines which shell is used.
 .Pp

-.Dp Cx Ic alias
-.Cx \&\ \&
-.Ar new-command-name
-.Cx \&\ \&
-.Ar old-command-name
-.Cx
+.It Ic alias Ar new-command-name Ar old-command-name 

 This command makes
 .Nm pdx
 respond to
 This command makes
 .Nm pdx
 respond to


@@ -411,57 +355,49 @@ respond to
 the way it used to respond to
 .Ar old-command-name  .
 .Pp
 the way it used to respond to
 .Ar old-command-name  .
 .Pp

-.Dp Ic quit
+.It Ic quit

 Exit
 .Nm pdx  .
 Exit
 .Nm pdx  .

-.Dp
+.El

 .Pp
 The following commands deal with the program at the
 .Ar px
 instruction
 level rather than source level.
 They are not intended for general use.
 .Pp
 The following commands deal with the program at the
 .Ar px
 instruction
 level rather than source level.
 They are not intended for general use.

-.Dw Fl
-.Di L
-.Dp Cx Ic tracei
-.Cx \&\ \&
+.Pp
+.Bl -tag -width Fl -compact
+.It Xo
+.Ic tracei

 .Op Ar address
 .Op Ar address

-.Cx \&\ \&
-.Op Ic if Ar cond
-.Cx
-.Dp Cx Ic tracei
-.Cx \&\ \&
+.Op Ic if Ar cond 
+.Xc
+.It Xo
+.Ic tracei

 .Op Ar variable
 .Op Ar variable

-.Cx \&\ \&

 .Op Ic at Ar address
 .Op Ic at Ar address

-.Cx \&\ \&
-.Op Ic if Ar cond
-.Cx
-.Dp Cx Ic stopi
-.Cx \&\ \&
+.Op Ic if Ar cond 
+.Xc
+.It Xo
+.Ic stopi

 .Op Ar address
 .Op Ar address

-.Cx \&\ \&
-.Op Ic if Ar cond
-.Cx
-.Dp Cx Ic stopi
-.Cx \&\ \&
+.Op Ic if Ar cond 
+.Xc
+.It Xo
+.Ic stopi

 .Op Ic at
 .Op Ic at

-.Cx \&\ \&

 .Op Ar address
 .Op Ar address

-.Cx \&\ \&
-.Op Ic if Ar cond
-.Cx
+.Op Ic if Ar cond 
+.Xc

 Turn on tracing or set a stop using a
 .Ic px
 machine
 instruction addresses.
 .Pp
 Turn on tracing or set a stop using a
 .Ic px
 machine
 instruction addresses.
 .Pp

-.Dp Cx Ic xi
-.Cx \&\ \&
-.Ar address
-.Cx \&\ \&
-.Op Ic \&, Ar address
-.Cx
+.It Xo
+.Ic xi Ar address
+.Op Ic \&, Ar address 
+.Xc

 Print the instructions starting at the first
 .Ar address  .
 Instructions up to
 Print the instructions starting at the first
 .Ar address  .
 Instructions up to


@@ -469,47 +405,46 @@ the second
 .Ar address
 are printed.
 .Pp
 .Ar address
 are printed.
 .Pp

-.Dp Cx Ic xd
-.Cx \&\ \&
-.Ar address
-.Cx \&\ \&
-.Op Ic \&, Ar address
-.Cx
+.It Xo
+.Ic xd Ar address
+.Op Ic \&, Ar address 
+.Xc

 Print in octal the specified data location(s).
 Print in octal the specified data location(s).

-.Dp
+.El

 .Sh ENVIRONMENT
 .Sh ENVIRONMENT

-.Tw Ar
-.Tp Ev EDITOR
+.Bl -tag -width Ar
+.It Ev EDITOR

 The
 .Ic edit
 function uses the
 .Ev EDITOR
 environment variable to see what editor to use.
 The
 .Ic edit
 function uses the
 .Ev EDITOR
 environment variable to see what editor to use.

-.Tp Ev SHELL
+.It Ev SHELL

 The function
 .Ic sh
 checks the
 .Ev SHELL
 variable to see which shell to
 execute.
 The function
 .Ic sh
 checks the
 .Ev SHELL
 variable to see which shell to
 execute.

-.Tp
+.El

 .Sh FILES
 .Sh FILES

-.Dw .pdxinit
-.Di L
-.Dp Pa \&obj
+.Bl -tag -width .pdxinit -compact
+.It Pa obj

 Pascal object file
 Pascal object file

-.Dp Pa \&.pdxinit
+.It Pa .pdxinit

 .Nm Pdx
 initialization file
 .Nm Pdx
 initialization file

-.Dp
+.El

 .Sh SEE ALSO
 .Xr pi 1 ,
 .Xr px 1
 .Sh SEE ALSO
 .Xr pi 1 ,
 .Xr px 1

-.br
-.Em Ar An Introduction to Pdx
+.Rs
+.%T "An Introduction to Pdx"
+.Re

 .Sh HISTORY
 .Nm Pdx
 .Sh HISTORY
 .Nm Pdx

-appeared in 4.2 BSD.
+appeared in
+.Bx 4.2 .

 .Sh BUGS
 .Nm Pdx
 does not understand sets,
 .Sh BUGS
 .Nm Pdx
 does not understand sets,


@@ -551,5 +486,5 @@ Most of the command names are too long.
 The alias facility is quite weak.
 .Pp
 A
 The alias facility is quite weak.
 .Pp
 A

-.Xr csh 1
-\- like history capability would improve the situation.
+.Xr csh 1 Ns \-like
+history capability would improve the situation.