178 lines
6.4 KiB
HTML
178 lines
6.4 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<TITLE>man(1)</TITLE>
|
|
</HEAD>
|
|
<BODY>
|
|
<H1>man(1)</H1>
|
|
<HR>
|
|
<PRE>
|
|
|
|
</PRE>
|
|
<H2>NAME</H2><PRE>
|
|
man - display online manual pages
|
|
|
|
|
|
</PRE>
|
|
<H2>SYNOPSIS</H2><PRE>
|
|
<STRONG>man</STRONG> [<STRONG>-antkf</STRONG>] [<STRONG>-M</STRONG> <EM>path</EM>] [<STRONG>-s</STRONG> <EM>section</EM>] <EM>title</EM> ...
|
|
|
|
|
|
</PRE>
|
|
<H2>DESCRIPTION</H2><PRE>
|
|
<STRONG>Man</STRONG> displays the online manual pages for the specified titles in the
|
|
specified sections. The sections are as follows:
|
|
|
|
<STRONG>1</STRONG> User Commands
|
|
Generic commands such as <STRONG>ls</STRONG>, <STRONG>cp</STRONG>, <STRONG>grep</STRONG>.
|
|
|
|
<STRONG>2</STRONG> System Calls
|
|
Low level routines that directly interface with the kernel.
|
|
|
|
<STRONG>3</STRONG> Library Routines
|
|
Higher level C language subroutines.
|
|
|
|
<STRONG>4</STRONG> Device Files
|
|
Describes devices in <STRONG>/dev</STRONG>.
|
|
|
|
<STRONG>5</STRONG> File Formats
|
|
Formats of files handled by various utilities and subroutines.
|
|
|
|
<STRONG>6</STRONG> Games
|
|
It's not UNIX without an adventure game.
|
|
|
|
<STRONG>7</STRONG> Miscellaneous
|
|
Macro packages, miscellaneous tidbits.
|
|
|
|
<STRONG>8</STRONG> System Utilities
|
|
Commands for the System Administrator.
|
|
|
|
<STRONG>9</STRONG> Documents
|
|
Larger manuals explaining some commands in more detail.
|
|
|
|
(If you are new to Minix then try <STRONG>man</STRONG> <STRONG>hier</STRONG>, it will show you around the
|
|
file system and give you many pointers to other manual pages.)
|
|
|
|
By default, <STRONG>man</STRONG> will try the following files in a manual page directory
|
|
for the command <STRONG>man</STRONG> <STRONG>-s</STRONG> <STRONG>1</STRONG> <STRONG>ls</STRONG>:
|
|
|
|
<STRONG>cat1/ls.1</STRONG>
|
|
<STRONG>cat1/ls.1.Z</STRONG>
|
|
<STRONG>man1/ls.1</STRONG>
|
|
<STRONG>man1/ls.1.Z</STRONG>
|
|
|
|
|
|
|
|
Files in the man[1-8] directories are formatted with <STRONG>nroff</STRONG> <STRONG>-man</STRONG>. Those
|
|
in man9 are formatted with <STRONG>nroff</STRONG> <STRONG>-mnx</STRONG>. Files in the cat? directories are
|
|
preformatted. Files with names ending in <STRONG>.Z</STRONG> are decompressed first with
|
|
<STRONG>zcat</STRONG> (see <STRONG><A HREF="../man1/compress.1.html">compress(1)</A></STRONG>). The end result is presented to the user using a
|
|
pager if displaying on the screen.
|
|
|
|
For each manual page directory in its search path, <STRONG>man</STRONG> will first try all
|
|
the subdirectories of the manual page directory for the files above, and
|
|
then the directory itself. The directory <STRONG>/usr/man</STRONG> contains the standard
|
|
manual pages, with manual pages for optional packages installed in a
|
|
subdirectory of /usr/man, with the same structure as /usr/man. The
|
|
directory <STRONG>/usr/local/man</STRONG> contains manual pages for locally added
|
|
software. By default /usr/local/man is searched first, then /usr/man.
|
|
|
|
A title is not simply used as a filename, because several titles may
|
|
refer to the same manual page. Each manual page directory contains a
|
|
database of titles in the <STRONG><A HREF="../man5/whatis.5.html">whatis(5)</A></STRONG> file that is created by <STRONG><A HREF="../man8/makewhatis.8.html">makewhatis(8)</A></STRONG>
|
|
from the NAME sections of all the manual pages. A title is searched in
|
|
this database and the first title on a whatis line is used as a filename.
|
|
|
|
|
|
</PRE>
|
|
<H2>OPTIONS</H2><PRE>
|
|
The options may be interspersed with the titles to search, and take
|
|
effect for the titles after them.
|
|
|
|
<STRONG>-a</STRONG> Show all the manual pages or one line descriptions with the given
|
|
title in all the specified sections in all the manual directories in
|
|
the search path. Normally only the first page found is shown.
|
|
|
|
<STRONG>-n</STRONG> Use <STRONG>nroff</STRONG> <STRONG>-man</STRONG> to format manual pages (default).
|
|
|
|
<STRONG>-t</STRONG> Use <STRONG>troff</STRONG> <STRONG>-man</STRONG> to format manual pages.
|
|
|
|
<STRONG>-f</STRONG> Use <STRONG><A HREF="../man1/whatis.1.html">whatis(1)</A></STRONG> to show a one line description of the title from the
|
|
<STRONG><A HREF="../man5/whatis.5.html">whatis(5)</A></STRONG> file.
|
|
|
|
<STRONG>-k</STRONG> Use <STRONG><A HREF="../man1/apropos.1.html">apropos(1)</A></STRONG> to show all the one line descriptions of the title
|
|
anywhere in the <STRONG><A HREF="../man5/whatis.5.html">whatis(5)</A></STRONG> files (implies <STRONG>-a</STRONG>).
|
|
|
|
<STRONG>-M</STRONG> <EM>path</EM>
|
|
Use <EM>path</EM> as the search path for manual directories.
|
|
|
|
<STRONG>-s</STRONG> <EM>section</EM>
|
|
<EM>Section</EM> is the section number the page is to be found in, or a comma
|
|
separated list of sections to use. Normally all sections are
|
|
searched. The search is always in numerical order no matter what
|
|
your section list looks like. A single digit is treated as a
|
|
section number without the <STRONG>-s</STRONG> for compatibility with BSD-style <STRONG>man</STRONG>
|
|
commands.
|
|
|
|
|
|
|
|
</PRE>
|
|
<H2>ENVIRONMENT</H2><PRE>
|
|
|
|
<STRONG>MANPATH</STRONG> This is a colon separated list of directories to search
|
|
for manual pages, by default <STRONG>/usr/local/man:/usr/man</STRONG>.
|
|
|
|
<STRONG>PAGER</STRONG> The program to use to display the manual page or one line
|
|
descriptions on the screen page by page. By default <STRONG>more</STRONG>.
|
|
|
|
|
|
</PRE>
|
|
<H2>FILES</H2><PRE>
|
|
|
|
/usr/man/whatis One of the <STRONG><A HREF="../man5/whatis.5.html">whatis(5)</A></STRONG> databases.
|
|
|
|
|
|
</PRE>
|
|
<H2>SEE ALSO</H2><PRE>
|
|
<STRONG><A HREF="../man1/nroff.1.html">nroff(1)</A></STRONG>, <STRONG><A HREF="../man1/troff.1.html">troff(1)</A></STRONG>, <STRONG><A HREF="../man1/more.1.html">more(1)</A></STRONG>, <STRONG><A HREF="../man1/whatis.1.html">whatis(1)</A></STRONG>, <STRONG><A HREF="../man1/makewhatis.1.html">makewhatis(1)</A></STRONG>, <STRONG><A HREF="../man1/catman.1.html">catman(1)</A></STRONG>,
|
|
<STRONG><A HREF="../man5/whatis.5.html">whatis(5)</A></STRONG>, <STRONG><A HREF="../man7/man.7.html">man(7)</A></STRONG>.
|
|
|
|
|
|
</PRE>
|
|
<H2>AUTHOR</H2><PRE>
|
|
Kees J. Bot (kjb@cs.vu.nl)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
</BODY>
|
|
</HTML>
|