02.07.2013 Views

A/UX® Programmer's Reference Sections

A/UX® Programmer's Reference Sections

A/UX® Programmer's Reference Sections

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

those that contribute to the boot process and those that help with<br />

the maintenance of file systems.<br />

4. How a manual entry is organized<br />

The name for a manual page entry nonnally appears twice, once in<br />

each upper corner of a page. Like dictionary guide words, these names<br />

appear at the top of every physical page. Mter each name is the section<br />

number and, if applicable, a category letter enclosed in<br />

parenthesis, such as (1) or (2N).<br />

Some entries describe several routines or commands. For example,<br />

chown and chgrp share a page with the name chown(l) at the<br />

upper comers. If you tum to the page chgrp(1), you find a reference<br />

to chown(1). (These cross-reference pages are only included in AIUX<br />

Command <strong>Reference</strong> and AlUX System Administrator's <strong>Reference</strong>.)<br />

All of the entries have a common format, and may include any of the<br />

following parts:<br />

NAME<br />

is the name or names and a brief description.<br />

SYNOPSIS<br />

describes the syntax for using the command or routine.<br />

DESCRIPTION<br />

discusses what the program does.<br />

FLAG OPTIONS<br />

discusses the flag options.<br />

EXAMPLES<br />

gives an example or examples of usage.<br />

RETURN VALUE<br />

describes the value returned by a function.<br />

ERRORS<br />

describes the possible error conditions.<br />

FILES<br />

lists the filenames that are used by the program.<br />

6 NUX <strong>Programmer's</strong> <strong>Reference</strong><br />

RevisionC

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!