.TH prgm 1 "Mon Jan 2 1995" "From trcgp/usp"
.ad b
.SH NAME
prgm - insert a \fB BRIEF \fR description of your routine. This area is picked up when doing a \fI man -k \fR so that keywording here is important. The more thought you put into this block the easier it is for a user to locate your routine within the \fB USP \fR toolkit.
.SH SYNOPSIS
\fBprgm\fR
[ \fB\-N\fIntap\fR ]
[ \fB\-O\fIotap\fR ]
[ \fB\-v\fIvel\fR ]
[ \fB\-ns\fInstr\fR ]
[ \fB\-ne\fInetr\fR ]
[ \fB\-rs\fInrst\fR ]
[ \fB\-re\fInred\fR ]
[ \fB\-V\fR ]
[ \fB\-? \fR or \fB -h\fR ]
.SH DESCRIPTION
.PP
\fIprgm\fR
: Here you can install a more detailed description of your routine including any potential pitfalls that may confound the average user.
.PP
prgm gets both its data and its parameters from command line arguments. These arguments specify the input, output, the design window, the start and end traces, start and end records and verbose printout, if desired.
.SS "Command line arguments"
.TP 5
\fB\-N\fI ntap\fR [default: stdin]
Enter the input data set name or file immediately after typing -N unless the input is from a pipe in which case the -N entry must be omitted. This input file should include the complete path name if the file resides in a different directory. Example -N/b/vsp/dummy tells the program to look for file 'dummy' in directory '/b/vsp'.
.PP
.TP 5
\fB\-O\fI otap\fR [default: stdout]
Enter the output data set name or file immediately after typing -O. This output file is not required when piping the output to another process. The output data set also requires the full path name (see above).
.PP
.TP 5
\fB\-v\fI vel\fR [default: infinite velocity]
Enter the design window velocity in m or ft/s.
.PP
.TP 5
\fB\-ns\fI nstr\fR [default: 1]
Enter the start trace number.
.PP
.TP 5
\fB\-ne\fI netr\fR [default: last trace of record]
Enter the end trace number.
.PP
.TP 5
\fB\-rs\fI nrst\fR [default: 1]
Enter start record number.
.PP
.TP 5
\fB\-re\fI nred\fR [default: last record]
Enter end record number.
.PP
.TP 5
\fB\-V\fR
Enter the command line argument '-V' to get additional printout.
.PP
.TP 5
\fB\-? or -h \fR
Enter the command line argument '-?' or \fI -h \fR to get online help. The program terminates after the help screen is printed.
.SH DISCUSSION
If you have a particularly complicated routine that requires excessive documentation, or you just like to explain things [the users usually like this], do that here. That way the user who just wants a little more detail on the command line options doesn't have to wade through this section to get to the help above.
.SH BUGS
Sometimes it's efficient to leave a bug in and document it here until you can get to it and fix it. If you think there are no bugs then simply enter \fB Unknown \fR as there always is at least one that you just don't know about yet.
.SH SEE ALSO
\fBdreck(1)\fR Here you put any associated man page references
.SH AUTHOR
[author: phone number] Make sure you own up to this mess so that the users can call you and tell you what a great job you are doing ;-). Also give credit to any co-developers here as well. This includes the general user who may have suggested the routine to you in the first place.
copyright 2001, Amoco Production Company
All rights reserved
an affiliate of BP America Inc.