next up previous contents
Next: SUHELP - List the Up: sututor Previous: Obtaining and Installing SU   Contents

Help facilities

Like the Unix operating system, Seismic Unix may be thought of as a language (or meta-language). As with any language, a certain amount of vocabulary must be mastered before useful operations may be performed. Because the SU contains many programs, there must be a ``dictionary'' to permit the inevitable questions about vocabulary can be answered. It is intended that this manual be the beginning of such a dictionary.

SU does not have ``man pages,'' in the same way that Unix does, but it does have equivalent internal documentation mechanisms. There is a general level help utilities which give an overview of what is available. For information about specific aspects of a particular code, the majority of the programs contain a selfdoc--a self-documentation paragraph, which will appear when the name of the program is typed on the commandline, with no options.

(In all of the examples that follow, the percent sign ``%'' indicates a Unix commandline prompt, and is not typed as part of the command.)

The following tools provide internal documentation at various levels of detail for the main programs, shell scripts, and library functions in the package:

This chapter discusses each of these utilities, with the intent of showing the reader how to get from the most general to the most specific information about SU programs.



Subsections
next up previous contents
Next: SUHELP - List the Up: sututor Previous: Obtaining and Installing SU   Contents
John Stockwell 2007-04-10