introduction.9 (2010 09)

introduction(9) introduction(9)
Italic strings represent variable elements that should be replaced with appropriate values.
Roman square brackets ([ ]) indicate that the contents are optional.
Roman braces ({ }) indicate a required element, usually in a choice.
Ellipses (...) indicate that the previous element and its preceding whitespace (if any) can be
repeated.
Note : An argument beginning with a dash (
-), a plus sign (+), or an equal sign (=) is often defined
as a command option, even if it appears in a position where a file name could appear. Therefore, it
is unwise to have files names that begin with
-, +,or=.
Optional subsections can include the following:
Parameters For functions, a description of the parameters in the preceding syn-
tax.
Structure Members For structures, a description of the structure elements in the
preceding syntax.
Remarks Information about special software or hardware requirements.
DESCRIPTION
Discusses the function and behavior of each entry.
Optional subsections can include the following:
Options For commands, a description of the switch arguments.
Operands For commands, a description of the nonswitch arguments and key-
words.
Access Control Lists
Multithread Usage
Security Restrictions Information on restrictions and privileges required to use the item.
EXTERNAL INFLUENCES
Information on what external factors, such as environment variables, may affect system behavior.
Optional subsections can include the following:
Environment Variables The effect of language-related and other environment variables on
system behavior,
International Code Set Support
Whether there is support for single- and multibyte characters,
NETWORKING FEATURES
Information under this heading is applicable only if you are using the network feature described
there.
Optional subsections can include the following:
NFS Information on the network file system.
RETURN VALUE
Describes the values returned by function calls or in the return code (
$?) by commands.
DIAGNOSTICS
For commands, the diagnostic information that may be produced. Self-explanatory messages are not
listed.
Optional subsections can include the following:
Errors
Warnings
ERRORS
For functions, the function error values (set in
errno) and their corresponding error conditions.
EXAMPLES
Examples of typical usage.
HP-UX 11i Version 3: September 2010 − 3 − Hewlett-Packard Company 3