A man page is provided for both the naive user, and sophisticated user who is familiar with the ChorusOSTM operating system and is in need of on-line information. A man page is intended to answer concisely the question "What does it do?" The man pages in general comprise a reference manual. They are not intended to be a tutorial.
The following is a list of sections in the ChorusOS man pages and the information it references:
ChorusOS man pages are grouped in Reference Manuals, with one reference manual per section.
Below is a generic format for man pages. The man pages of each manual section generally follow this order, but include only needed headings. For example, if there are no bugs to report, there is no BUGS section. See the intro pages for more information and detail about each section, and man(1) for more information about man pages in general.
This section gives the names of the commands or functions documented, followed by a brief description of what they do.
This section shows the syntax of commands or functions. When a command or file does not exist in the standard path, its full pathname is shown. Options and arguments are alphabetized, with single letter arguments first, and options with arguments next, unless a different argument order is required.
The option or argument enclosed in these brackets is optional. If the brackets are omitted, the argument must be specified.
Ellipses. Several values may be provided for the previous argument, or the previous argument can be specified multiple times, for example, ` "filename . . ." .
Separator. Only one of the arguments separated by this character can be specified at time.
Braces. The options and/or arguments enclosed within braces are interdependent, such that everything enclosed must be treated as a unit.
This section provides the list of features which offer an interface. An API may be associated with one or more system features. The interface will be available if one of the associated features has been configured.
This section defines the functionality and behavior of the service. Thus it describes concisely what the command does. It does not discuss OPTIONS or cite EXAMPLES.. Interactive commands, subcommands, requests, macros, functions and such, are described under USAGE.
This lists the command options with a concise summary of what each option does. The options are listed literally and in the order they appear in the SYNOPSIS section. Possible arguments to options are discussed under the option, and where appropriate, default values are supplied.
This section lists the command operands and describes how they affect the actions of the command.
This section describes the output - standard output, standard error, or output files - generated by the command.
If the man page documents functions that return values, this section lists these values and describes the conditions under which they are returned. If a function can return only constant values, such as 0 or -1, these values are listed in tagged paragraphs. Otherwise, a single paragraph describes the return values of each function. Functions declared void do not return values, so they are not discussed in RETURN VALUES.
On failure, most functions place an error code in the global variable errno indicating why they failed. This section lists alphabetically all error codes a function can generate and describes the conditions that cause each error. When more than one condition can cause the same error, each condition is described in a separate paragraph under the error code.
This section is provided as a guidance on use. This section lists special rules, features and commands that require in-depth explanations. The subsections listed below are used to explain built-in functionality:
This section provides examples of usage or of how to use a command or function. Wherever possible a complete example including command line entry and machine response is shown. Whenever an example is given, the prompt is shown as example% or if the user must be superuser, example#. Examples are followed by explanations, variable substitution rules, or returned values. Most examples illustrate concepts from the SYNOPSIS, DESCRIPTION, OPTIONS and USAGE sections.
This section lists any environment variables that the command or function affects, followed by a brief description of the effect.
This section lists the values the command returns to the calling program or shell and the conditions that cause these values to be returned. Usually, zero is returned for successful completion and values other than zero for various error conditions.
This section lists all filenames referred to by the man page, files of interest, and files created or required by commands. Each is followed by a descriptive summary or explanation.
This section lists references to other man pages, in-house documentation and outside publications.
This section lists diagnostic messages with a brief explanation of the condition causing the error.
This section lists warnings about special conditions which could seriously affect your working conditions. This is not a list of diagnostics.
This section lists additional information that does not belong anywhere else on the page. It takes the form of an aside to the user, covering points of special interest. Critical information is never covered here.
This section describes known bugs and wherever possible, suggests workarounds.