Typographical Conventions

audit(5): An HP-UX manpage reference. For example, audit is the name and 5 is the section in the HP-UX Reference. On the web and on the Instant Information CD, it may be a hyperlink to the manpage itself. From the HP-UX command line, you can enter “man audit” or “man 5 audit” to view the manpage. See man(1).
Book Title: The title of a book. On the web and on the Instant Information CD, it may be a hyperlink to the book itself.
Command: A command name or qualified command phrase.
ComputerOutput: Text displayed by the computer.
Emphasis: Text that is emphasized.
Emphasis: Text that is strongly emphasized.
ENVIRONVAR: The name of an environment variable.
ERRORNAME: The name of an error number, usually returned in the errno variable.
KeyCap: The name of a (usually) nonprinting keyboard key, such as Ctrl-X or Tab. Note that Return and Enter both refer to the same key.
Replaceable: The name for a value that you replace in a command or function, or information in a display that represents several possible values.
Term: The defined use of an important word or phrase.
UserInput: Commands and other text that you type.
$: User command prompt.
#: Superuser (root) command prompt.

Command Syntax

Literal: A word or character that you enter literally.
Replaceable: A word or phrase that you replace with an appropriate value.
-chars: One or more grouped command options, such as -ikx. The chars are usually a string of literal characters that each represent a specific option. For example, the entry -ikx is equivalent to the individual options -i, -k, and -x. The plus character (+) is sometimes used as an option prefix.
-word: A single command option, such as -help. The word is a literal keyword. The difference from - chars is usually obvious and is clarified in an Options description. The plus character (+) and the double hyphen (--) are sometimes used as option prefixes.
[ ]: The bracket metacharacters enclose optional content in formats and command descriptions.
{ }: The brace metacharacters enclose required content in formats and command descriptions.
|: The bar metacharacter separates alternatives in a list of choices, usually in brackets or braces.
...: The ellipsis metacharacter after a token (abc...) or a right bracket ([ ]...) or a right brace ({ }...) metacharacter indicates that the preceding element and its preceding whitespace, if any, may be repeated an arbitrary number of times.
...: Ellipsis is sometimes used to indicate omitted items in a range.

Function Synopsis and Syntax

HP-UX functions are described in a definition format rather than a usage format. The definition format includes type information that is omitted when the function call is actually included in a program.

The function syntax elements are the same as for commands, except for the options; see “Command Syntax”.

Function General Definition

The general definition form is:

type func ( type param [ , type param ]... );

For example:

int setuname ( const char *name , size_t namelen );

Function Usage

The usage form is:

func ( param [ , param ]... );

For example:

setuname ( name [ , namelen ]... );

Typographical Conventions

Technical documentation

» Table of Contents

» Index

Command Syntax

Function Synopsis and Syntax

Function General Definition

Function Usage