|Skip Navigation Links|
|Exit Print View|
|Oracle Solaris Administration: Common Tasks Oracle Solaris 11 Information Library|
The following table describes each man page section and the information that each man page references.
Table 1-1 Description of Man Page Sections
Man pages use a standard format that includes some or all of the following subsections. The order of the subsections here matches the order in which the information appears in the individual man page sections.
Provides the name of the command, library function, file, or device driver, including a brief description of what the construct does.
Shows the syntax of the command, library function, file, or device driver.
Defines the functionality and behavior of the service.
Used for a particular class of devices, all of which have an io ending, such as mtio(7I). This section appears on pages in Section 7 only.
Lists the command options, including a concise summary of what each option does.
Lists the command operands and describes how the operands affect the actions of the command.
Describes the output, standard output, standard error, or output files that are generated by the command, library function, file, or device driver.
Lists values and describes the conditions under which they are returned (applies only to man pages that document functions that return values).
Lists alphabetically all error codes that a function library can generate and describes the conditions that cause each error.
Lists special rules, features, and commands that require in-depth explanations.
Provides examples of usage or how to use a command, library function, file, or device driver.
Lists any environment variables that the command, library function, file, or device driver affects, followed by a brief description of the effect.
Lists the values that the command returns to the calling program or shell, and the conditions that cause these values to be returned.
Lists all file names that are referred to by the man page, including files of interest, and files that are created or required by commands.
Lists characteristics of commands, utilities, and device drivers by defining the attribute type and its corresponding value. See the attributes(5) man page.
Includes any related commands or library functions.
Lists diagnostic messages with a brief explanation of the condition causing the error.
Lists warnings about special conditions that could seriously affect working conditions. This is not a list of diagnostics.
Lists additional information that does not belong anywhere else on the page.
Describes known bugs and, wherever possible, suggests a workaround.