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.

man(5) man(5)<br />

EXAMPLES<br />

The man macros are provided to process manual pages already<br />

on-line at a given location and to enable users to make their own<br />

manual pages. The preceding section demonstrated the usage of<br />

the macros themselves; the following section provides examples<br />

of command lines typically used to process the completed files.<br />

man macros are designed to run with either nroff or troff.<br />

The first command line will process a file using only macros and<br />

nroff requests:<br />

nroff -TIp -man file I lp<br />

The file is piped to the local line printer, lp.<br />

The next command line will process a file containing tables as<br />

well as macros and nroff requests:<br />

tbl I nroff -TIp -man file I col I lp<br />

Notice that before it is sent to the line printer, the output is first<br />

filtered through col, to process the reverse line feeds used by<br />

tbl.<br />

The final example is a command line that processes an unusual<br />

manual page, one using pic. If the manual pages created with<br />

man are intended for an on-line facility, components requiring<br />

troff, such as pic (or grap) should be avoided since the average<br />

installation of terminals will not be able to process typeset documents.<br />

pic file I tbl I troff -Taps -man I typesetter<br />

grap precedes pic because it is a preprocessor to pic; the reverse<br />

order, of course, will not format correctly. The file contains<br />

one or more tables, requiring tbl, but col is no longer necessary<br />

because typeset documents do not use reverse line feeds with<br />

which to make tables. The -T flag option for specifying the output<br />

device (terminal type) takes the argument aps here, readying<br />

the document for processing on the APS-5 phototypesetter.<br />

CAVEATS<br />

Special macros, strings, and number registers exist, internal to<br />

man, in addition to those mentioned above. Except for names<br />

predefined by troff(1) and number registers d, m, and y, all<br />

such internal names are of the form XA, where X is one of ) , ],<br />

and }, and A stands for any alphanumeric character.<br />

February, 1990<br />

Revision C<br />

3

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

Saved successfully!

Ooh no, something went wrong!