man.1 (2010 09)

ManualsBrandsHP ManualsSoftwareHP-UX Manpages

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 [-][-M path] [

-T macro-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. Argu-

ments are as follows:

-k keyword -k followed 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:

-f file -f followed 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 match-

ing ﬁ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.

-M path Change the search path for manual pages. path is a colon-separated list of direc-

tories that contain manual page directory subtrees. When used with the -k or -f

options, the -M option must appear ﬁrst.

-T macro-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

-T option 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,orpublic to

HP-UX 11i Version 3: September 2010 − 1 − Hewlett-Packard Company 1

Summary of content (4 pages)

PAGE 1
man(1) man(1) NAME man - find manual information by keywords; print out a manual entry SYNOPSIS man [-M path] -k keyword ... man [-M path] -f file ... man [-] [-M path] [-T macro-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 specified set of keywords. • Display or print one-line descriptions of entries specified by name.
PAGE 2
man(1) man(1) search for one or more of the entries indicated. section corresponds to the section number where the entry appears in the HP-UX Reference . It can be followed by an optional uppercase/lowercase subsection identifier such as 3C which would indicate a library routine in Section 3. 3, 3c, and 3C are interpreted as equivalent, since all Section 3 manual entries are stored in the same or in related directories (such as /usr/share/man/man3.Z and /usr/share/man/man3.
PAGE 3
man(1) man(1) man*.Z The entry is uncompressed, formatted, and displayed. If the cat*.Z directory exists, the formatted entry is compressed and installed in cat*.Z. If the cat* directory exists, the formatted entry is installed in cat*. cat*.Z The entry is uncompressed and displayed. man* The entry is formatted, and displayed. If the cat*.Z directory exists, it is compressed, and installed in cat*.Z. If the cat* directory exists, the formatted entry is installed in cat*.
PAGE 4
man(1) man(1) man mypage Display the manual entry for id(1), with the output piped through pg -c: PAGER="pg -c" export PAGER man id Display intro (4) and intro (3): man 4 intro man 3 intro WARNINGS Manual entries are structured such that they can be printed on a phototypesetter, conventional line printer, and screen display devices. However, due to line printer and display device limitations, some information may be lost in certain situations. FILES /usr/share/lib/whatis /usr/share/man/cat*[.