m

man(1)man(1)

NAME

man - ®nd manual information by keywords; print out a manual entry

SYNOPSIS

man [-M path] -k keyword...

man [-M path] -f ®le...

man [-] [-Mpath] [-Tmacro-package] [ section [ subsection ] ] entry_name...

DESCRIPTION

man accesses information from the HP-UX manual pages. It can be used to:

List all manual entries whose one-line description contains any of a speci®ed set of keywords.

Display or print one-line descriptions of entries speci®ed by name.

Search on-line manual directories by entry name and display or print the speci®ed entry or entries.

Search a speci®ed on-line manual section (directory) and display or print the speci®ed entry or entries in that section.

Searching for Entry Names by Keyword (®rst form)

The ®rst form above searches the one-line descriptions of individual entries for speci®ed keywords. Arguments are as follows:

-kkeyword -kfollowed by one or more keywords causes man to print the one-line description of each manual entry whose one-line description contains text matching one or more of the speci®ed keywords (similar to the behavior of grep(1)). Keywords are separated by blanks (space or tab).

Before this option can be used, ®le /usr/share/lib/whatis must exist. /usr/share/lib/whatis can be created by running catman(1M).

Obtaining One-Line Description of an Entry (second form)

The second form above ®nds and displays or prints the one-line descriptions of speci®ed individual entries. Arguments are as follows:

-ffile

-ffollowed by one or more ®le names causes man to print the one-line description of

 

each manual entry found whose name matches ®le. When specifying two or more

 

®les, ®le arguments are separated by blanks (space or tab). If entry names matching

 

®le exist in two or more sections, the one-line description of each matched ®le name is

 

output.

 

Before this option can be used, ®le /usr/share/lib/whatis must exist.

 

/usr/share/lib/whatis can be created by running catman(1M).

Viewing Individual Manual Entries (third form)

The third form shown above is used for viewing one or more individual manual entries. man in this form recognizes the following arguments:

-(optional) When the - argument is present, man sends the formatted manual entry directly to standard output without processing it through the output ®lter speci®ed by the PAGER environment variable.

-Mpath Change the search path for manual pages. path is a colon-separated list of directories that contain manual page directory subtrees. When used with the -kor -foptions, the -Moption must appear ®rst.

-Tmacro-package

man uses macro-package rather than the standard -man macros de®ned in /usr/share/lib/tmac/tmac.an for formatting manual pages.

When specifying the -Toption to man , the full path must be given. For example:

man -T /usr/share/lib/tmac/tmac.s ls

section[subsection]

(optional) Search in the speci®ed section for the given entry_name. section speci®es a single section number or one of the words local, new, old, or public to search

Section 1520

− 1 −

HP-UX Release 11i: December 2000