man(1) DG/UX 5.4R3.00 man(1)
NAME
man - locate and print online reference entries
SYNOPSIS
man [ -Tterm ] [ -dw ] [ -Mpath ] [ section ] name ...
man [ -Mpath ] -k keyword ...
man [ -Mpath ] -f filename ...
where:
term A terminal type (for a list of possible values, type man
term); default = $TERM
path A colon- or space-separated list of directories to search;
default = $MANPATH
section An integer from 0 to 8 indicating the section of entry (see
Man Page Sections below)
name The name of the entry in lowercase letters
keyword A word for which to search, from the NAME portion of an
entry
filename The base file name of an entry for which to search
DESCRIPTION
Man locates and prints the specified entries of this manual. (For
historical reasons, the word "page" is often used as a synonym for
"entry" in this context.) It can display complete entries that you
select by name, or one-line summaries selected either by keyword or
by the base name (i.e., without suffix) of an entry filename.
With one or more name arguments, if you do not specify a section
number, the whole manual is searched for the specified entry name,
and all occurrences of it are printed.
In many cases, more than one command or system call or routine is
listed under a single entry name; for example, the basename and
dirname commands are described in the basename(1) manual page. You
can access such manual pages by specifying any of the entries on the
page.
You can control the display of man output by setting the environment
variables PAGER and TERM (see below).
Options
-T Print the entry as appropriate for terminal type term.
-M Change the search path for entries to path. Path contains a
colon- or space-separated list of directories that contain
manual page directory subtrees. Each directory in the path is
assumed to contain subdirectories of the form manN, where N is
a digit.
-w Print on the standard output only the pathnames of the entries
in /usr/catman, or to the current directory if -d is also
specified.
-d Search the current directory rather than /usr/catman; requires
Licensed material--property of copyright holder(s) 1
man(1) DG/UX 5.4R3.00 man(1)
the full filename (e.g., spline.1g, rather than just spline).
-k Print on the standard output all one-line summaries from the
whatis database that contain any of the given keywords.
-f Locate entries related to any of the given filenames. For
each entry in the whatis database of the form
filename(section[x]) (where section is a number and x is a
lowercase letter), man prints on the standard output the
associated one-line summary.
Environment Variables
MANPATH Specify directories to be searched for manual pages. This
variable contains a colon- or space-separated list of
directories; the entries should be in these directories or
in subdirectories with names of the form manN, where N is a
digit. These directories will be searched first by man for
each entry name specified. If no matching manual entries
are found therein, man will also search the directories
/usr/catman/*man. (Thus by default man searches only
/usr/catman/*man.) The -M option overrides the value of
MANPATH.
PAGER Specify a program into which output is to be piped. The
program will be invoked for each entry name matching the
specified name argument(s). Therefore, quitting the display
of an entry may result in displaying the next entry, if one
exists. Setting PAGER to "more -uf" will display the man
page one screen at a time. The default is no piping. (See
examples.)
TERM Specify the terminal type for which output is to be adapted
[see environ(5)]; the default is lp. The -T option
overrides the TERM setting. You should use the -Tlp option
when sending the output to a line printer, since TERM is
normally set to a value other than lp.
Man Page Sections
The manual pages are divided into the following sections:
(0) Table of contents and permuted keyword-in-context index
(1) Commands and application programs
(2) System calls
(3) Subroutines and libraries
(4) File formats
(5) Miscellaneous features
(6) Network protocols
(7) System special files
(8) System maintenance procedures
Section 0 contains two entries that pertain to all the man pages:
contents(0) and index(0). The contents(0) manual page lists all the
manual pages alphabetically by section. The index(0) manual page
contains a permuted keyword-in-context index for all the DG/UX manual
Licensed material--property of copyright holder(s) 2
man(1) DG/UX 5.4R3.00 man(1)
pages.
If your system manager installs the TCP/IP manual pages, contents(0)
and index(0) are overwritten with a version that is a superset of the
DG/UX version. If your system manager installs the NFS manual pages,
contents(0) and index(0) are overwritten with a version that is a
superset of the DG/UX and TCP/IP versions.
Adding New Manual Pages
To add manual pages to the system, the superuser can put them in
/usr/catman, or you can put them in your own directory and add that
directory's absolute pathname to the MANPATH variable (see
Environment Variables above). The manual page should be in
lineprinter format.
The manual page may be compressed (via the pack program) or
uncompressed. The filename should be of the form
name.section[x][.z], where x is a lowercase letter and .z is required
for compressed entries and is automatically appended by the pack
program.
The macros normally used to format manual pages are part of the GNU
Toolset (Data General Model R028A) and Xroff (available from Image
Network, 140 South Whisman Road, Mountain View, California) and are
described in the groffman(7) and man(7) manual pages, available with
the GNU Toolset and Xroff, respectively. These macros can be
formatted with groff and xroff, which is also part of the GNU Toolset
and Xroff. Starting with DG/UX Release 5.4, nroff and troff are only
available separate from the DG/UX package.
Character Set
Starting in DG/UX Release 5.4.2, the Latin 1 character set (ISO
standard 8859-1) is being used in formatted man pages. Latin 1 is an
8-bit superset of 7-bit ASCII.
To convert Latin 1 characters to their nearest ASCII equivalent, use
iconv with the -m b option. To laserprint a Latin 1 man page, use lp
with the -S iso-88591 option.
Two man pages, iso-88592(5) and iso-88597(5), which document those
character sets, are coded in their respective character sets. Most
display devices cannot correctly display all ISO 8859-2 and 8859-7
characters. Those man pages are, however, printable on a PostScript
printer.
EXAMPLES
To display the chmod(1) manual page:
man 1 chmod
To display the chmod(1) manual page in ASCII format:
man 1 chmod | iconv -f 88591 -t ASCII -m b
To print the chmod(1) manual page on a PostScript printer with queue
name pslaser:
Licensed material--property of copyright holder(s) 3
man(1) DG/UX 5.4R3.00 man(1)
man -T lp 1 chmod | lp -d pslaser -S iso-88591
To print the chmod(1) manual page on an ASCII lineprinter that cannot
backspace:
man -T lp 1 chmod | iconv -f 88591 -t ASCII -m b | col | lp
To display the chmod(1) and chmod(2) manual pages:
man chmod
To lineprint the manual page for basename and dirname:
man -Tlp basename | lp
or
man -Tlp dirname | lp
To laserprint the iso-88592(5) man page on a PostScript printer named
pslaser:
man -Tlp iso-88592 | lp -S iso-88592 -d pslaser
FILES
/usr/catman/*man/man[0-9]/* Formatted manual entries:
aman Administrator's man pages
pman Programmer's man pages
uman User's man pages
/usr/catman/*man/whatis Table of contents (whatis) databases
SEE ALSO
apropos(1), col(1), iconv(1), more(1), postprint(1), ul(1),
whatis(1), iso-88591(5), term(5), syscon(7).
groff(1), gtroff(1), groffman(7) in the GNU Toolset.
ditroff(1), xroff(1), man(7) in Xroff.
NOTES
The man command prints manual entries that were formatted by nroff
before the system was installed. Entries are specially formatted for
processing by ul(1), which is called by the man command. Printing a
man page on a lineprinter or a PostScript printer generally requires
filtering by a program such as col, iconv, or postprint. Printing on
other printers or typesetting requires the addition of some form of
troff and the man page source files (only formatted entries are
included for use by the man command).
When piping the output of man through the more(1) command, specify
the -f option to the pager for best results. Otherwise the man page
lines and pager prompts may sometimes be printed in the wrong places.
The mispositioning occurs when more(1) becomes confused by
nonprinting video attribute characters typically displayed to a
terminal screen. Note that if you are using the PAGER environment
variable, you can place pager options into it in addition to simple
command names.
Licensed material--property of copyright holder(s) 4