Notational conventions

This section discusses notational conventions used in this book.

Table 1 Title not available (Notational conventions)

`bold monospace`	In command examples, `bold monospace` identifies input that must be typed exactly as shown.
`monospace`	In paragraph text, `monospace` identifies command names, system calls, and data structures and types. In command examples, `monospace` identifies command output, including error messages.
`italic`	In paragraph text, `italic` identifies titles of documents. In command syntax diagrams, `italic` identifies variables that you must provide. The following command example uses brackets to indicate that the variable `output_file` is optional: `command` `input_file` [`output_file`]
Brackets ( [ ] )	In command examples, square brackets designate optional entries.
Curly brackets ({}), Pipe (\|)	In command syntax diagrams, text surrounded by curly brackets indicates a choice. The choices available are shown inside the curly brackets and separated by the pipe sign (\|). The following command example indicates that you can enter either `a` or `b`: `command {a \| b}`
Horizontal ellipses (...)	In command examples, horizontal ellipses show repetition of the preceding items.
Vertical ellipses	Vertical ellipses show that lines of code have been left out of an example.
Keycap	Keycap indicates the keyboard keys you must press to execute the command example.

References to man pages appear in the form mnpgname(1), where “mnpgname” is the name of the man page and is followed by its section number enclosed in parentheses. To view this man page, type:

% man 1 mnpgname




	NOTE: A Note highlights important supplemental information.

Command syntax

Consider this example:

COMMAND input_file [...] {a | b} [output_file]

COMMAND must be typed as it appears.
input_file indicates a file name that must be supplied by the user.
The horizontal ellipsis in brackets indicates that additional, optional input file names may be supplied.
Either a or b must be supplied.
[output_file] indicates an optional file name.

Notational conventions

Technical documentation

» Table of Contents

» Glossary

» Index

Command syntax