Cray Documentation [5]
Cray delivers two kinds of documentation: books (also known as manuals)
and man pages. Books are available in both HTML and PDF formats and are
delivered on the CrayDoc CD. Man pages are available in both formatted (also
known as catman) ASCII and HTML formats. Catman ASCII man pages are
normally installed automatically along with your software on your Cray system
and are accessed with the
man command. HTML man pages are a new feature of
CrayDoc version 2.0 and are delivered on the CrayDoc CD.
We recommend that when you install Cray documentation on your CrayDoc
system, you choose to install both man page and book packages for each software
release, so that the complete set of documentation for each release is available
through the CrayDoc user interface. You may choose to use the documentation
without installing the CrayDoc server software, but you will not be able to search
all the HTML files without the server software. Whether you choose to install the
documentation on a CrayDoc server or simply view it locally from the CD, you
should understand the organization of the documentation. Man pages and books
are structured differently, so this chapter discusses their organization.
5.1 Man Pages
Man pages describe uniquely identifiable components of your software, such as
commands, libraries, and system calls. Each software release may contain one or
more sets of man pages, which are grouped together into packages. A package is a
set of documentation that supports a specific release of a software product, for
example, C/C++ 4.2 or UNICOS/mp 2.0.
Each man page is identified by four pieces of data:
name The name of the man page, usually the same as the
software component it documents.
volume number The kind of component the man page documents.
See the conventions section, "Conventions," page .
product name Name of the product that the man page supports.
This usually, but not always, corresponds to the
package name.
product version Version of the product that the man page supports.
This usually, but not always, corresponds to the
package name.
S–2340–21 23
