man(1) DG/UX R4.11MU05 man(1)
NAME
man - locate and display online reference entries (man pages)
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 characters
keyword A keyword used as a search criteria, from the NAME portion
of all the man page entries
filename The base filename of an entry for which to search
DESCRIPTION
Man locates the specified man page and displays it. (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 with
name, or one-line summaries selected either by keyword (actually, a
string match) or by the base name (i.e., without suffix) of an entry
filename.
For all name arguments, if you do not specify a section number, the
entire man page directory structure (see MANPATH information below)
is searched and all occurrences of each name are displayed.
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 Display entries 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 Indicate where the man page file is located. -w used by itself
will display the file's full pathname; man page files are
located under /usr/catman. Specifying -dw will display the
names of the man page files that are in the current directory.
-d Search the current directory rather than /usr/catman; requires
the full filename (e.g., spline.1g, rather than just spline).
-k Display (to standard output) all one-line summaries from the
whatis databases that contain any of the given keyword
strings.
-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 displays to standard output the
associated one-line summary.
Environment Variables
MANPATH Specify directories to be searched for manual page entries.
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 searches the current working
directory for a subdirectory with the entry name. If that
is unsuccessful, man will also search the directories
/usr/catman/*_man. (Thus, by default, man searches the
current working directory for a subdirectory with the entry
name and then /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,
alphabetically by section, all the manual pages that are loaded on
your DG/UX system. The index(0) manual page contains a permuted
keyword-in-context index for all the manual pages that are loaded on
your DG/UX system.
Since the contents(0) and index(0) pages are NOT dynamic, only DG-
provided man pages are represented within them.
Adding New Manual Pages
To add manual pages to the system, the superuser (on a generic DG/UX
system) or a user with appropriate privilege (on a system with DG/UX
information security) 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 either pack, compress or gzip)
or uncompressed. The filename should be of the form
name.section[x][.suf], where x is a lowercase letter and .suf is
required for compressed entries and is automatically appended by the
compression program (.z by pack, .Z by compress and .gz by gzip).
The macros normally used to format manual pages are described in the
groff_man(7) manual page. The macros, themselves, can be formatted
with groff. Both the groff_man manual page and groff are available
in Contributed Software for AViiON Systems (Data General Model
R006A).
Note that man pages added using the above procedures will not be
represented in the contents(0) and index(0) pages. DG does not
provide an interface for accomplishing this task. Therefore, the -k
and -f switch functions are not available for these man pages.
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.
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:
man -T lp 1 chmod | lp -d pslaser
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:
a_man Administrator's man pages
p_man Programmer's man pages
u_man User's man pages
/usr/catman/*_man/whatis Table of contents (whatis) databases
SEE ALSO
apropos(1), col(1), compress(1), gzip(1), iconv(1), more(1), pack(1),
postprint(1), ul(1), whatis(1), iso-88591(5), term(5), syscon(7).
groff(1), gtroff(1) are in Contributed Software for AViiON Systems
(Data General Model R006A).
NOTES
The man command displays manual entries that have been previously
formatted by nroff. 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 displayed 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.
On a generic DG/UX system, appropriate privilege is granted by having
an effective UID of 0 (root). See the appropriate_privilege(5) man
page for more information.
On a system with DG/UX information security, appropriate privilege is
granted by having one or more specific capabilities enabled in the
effective capability set of the user. See the cap_defaults(5) man
page for more information.
Licensed material--property of copyright holder(s)