NAME

pman − print project manual

SYNOPSIS

pman [−P projectname] [section] topic ... 

DESCRIPTION

Pman provides on-line access to the manual belonging to the current working project.  If the manual is being printed on a terminal, pman pauses after each screenful. Hit a space to continue. 

Pman invokes the man program to format and print the manual pages corresponding to specified topics.  If a section number is given, pman looks in that section of the manual for the topics, otherwise all sections of the manual are searched until the topic is found. 

The directories containing the project manual must be set up in the project root directory like the ‘/usr/man’ directory hierarchy. In particular, ‘project/man/man1’ contains the command manual and ‘project/man/man3’ contains the manual for library utilities.  Formatted manual entries are created automatically in the corresponding ‘project/man/cat’ directories if they exist. 

OPTIONS

−P projectname
Specify a project other than the current working project.

EXAMPLES

To print the manual entry for the pgrep command from the command section (section 1) of the ‘spms’ project manual, type:

pman pgrep

To print the manual entry for the pgrep library utility from section 3 of the ‘spms’ project manual, type:

pman 3 pgrep

FILES

project/man/man?/*Unformatted manual pages. 
project/man/cat?/*Formatted on-line manual. 

SEE ALSO

man(1), man(7), more(1)

DIAGNOSTICS

Exit status 0 is normal. Exit status 1 indicates an error. 

AUTHOR

Peter J. Nicklin