NAME
prgm - insert a BRIEF description of your routine. This
area is picked up when doing a man -k 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 USP toolkit.
SYNOPSIS
prgm [ -Nntap ] [ -Ootap ] [ -vvel ] [ -nsnstr ] [ -nenetr ]
[ -rsnrst ] [ -renred ] [ -V ] [ -? or -h ]
DESCRIPTION
prgm : Here you can install a more detailed description of
your routine including any potential pitfalls that may con-
found the average user.
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.
Command line arguments
-N ntap [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'.
-O otap [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).
-v vel [default: infinite velocity]
Enter the design window velocity in m or ft/s.
-ns nstr [default: 1]
Enter the start trace number.
-ne netr [default: last trace of record]
Enter the end trace number.
-rs nrst [default: 1]
Enter start record number.
-re nred [default: last record]
Enter end record number.
-V Enter the command line argument '-V' to get additional
printout.
-? or -h
Enter the command line argument '-?' or -h to get
online help. The program terminates after the help
screen is printed.
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.
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 Unknown as there always is
at least one that you just don't know about yet.
SEE ALSO
dreck(1) Here you put any associated man page references
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
copyright 2001, Amoco Production Company
All Rights Reserved
an affiliate of BP America Inc.
Man(1) output converted with
man2html