BSD 4_3 release
[unix-history] / usr / man / man1 / man.1
index 308f051..c461e1a 100644 (file)
@@ -1,26 +1,33 @@
-.TH MAN 1 "18 January 1983"
+.\" Copyright (c) 1980 Regents of the University of California.
+.\" All rights reserved.  The Berkeley software License Agreement
+.\" specifies the terms and conditions for redistribution.
+.\"
+.\"    @(#)man.1       6.5 (Berkeley) 5/9/86
+.\"
+.TH MAN 1 "May 9, 1986"
 .UC 4
 .SH NAME
 man \- find manual information by keywords; print out the manual
 .SH SYNOPSIS
 .br
 .B man
 .UC 4
 .SH NAME
 man \- find manual information by keywords; print out the manual
 .SH SYNOPSIS
 .br
 .B man
-.B \-k
-keyword ...
-.br
-.B man
-.B \-f
-file ...
-.br
-.B man
 [
 .B \-
 ] [
 [
 .B \-
 ] [
-.B \-t
+.B \-M
+.I path
 ] [
 section
 ]
 title ...
 ] [
 section
 ]
 title ...
+.br
+.B man
+.B \-k
+keyword ...
+.br
+.B man
+.B \-f
+file ...
 .SH DESCRIPTION
 .I Man
 is a program which gives information from the programmers manual.
 .SH DESCRIPTION
 .I Man
 is a program which gives information from the programmers manual.
@@ -34,7 +41,7 @@ When given the option
 and a set of keywords,
 .I man
 prints out a one line synopsis of each manual sections whose
 and a set of keywords,
 .I man
 prints out a one line synopsis of each manual sections whose
-listing in the table of contents contains that keyword.
+listing in the table of contents contains one of those keywords.
 .PP
 When given the option
 .B \-f
 .PP
 When given the option
 .B \-f
@@ -54,9 +61,12 @@ If a section specifier is given
 looks in the that section of the manual for the given
 .I titles.
 .I Section
 looks in the that section of the manual for the given
 .I titles.
 .I Section
-is an Arabic section number (3 for instance).  The number may followed by
-a single letter classifier (1g for instance)
-indicating a graphics program in section 1.  If
+is either
+an Arabic section number (3 for instance), or one of the words ``new,''
+``local,'' ``old,'' or ``public.''
+A section number may be followed by
+a single letter classifier (for instance, 1g,
+indicating a graphics program in section 1).  If
 .I section
 is omitted,
 .I man
 .I section
 is omitted,
 .I man
@@ -69,31 +79,53 @@ If the standard output is a teletype, or if the flag
 is given,
 .I man
 pipes its output through
 is given,
 .I man
 pipes its output through
-.IR cat (1)
+.IR more (1)
 with the option
 .B \-s
 with the option
 .B \-s
-to crush out useless blank lines,
-.IR ul (1)
-to create proper underlines for different terminals, and through
-.IR more (1)
-to stop after each page on the screen.
+to crush out useless blank lines
+and to stop after each page on the screen.
 Hit a space to continue,
 a control-D to scroll 11 more lines when the output stops.
 .PP
 Hit a space to continue,
 a control-D to scroll 11 more lines when the output stops.
 .PP
-The
-.B \-t
-flag causes
+Normally
 .I man
 .I man
-to arrange for the specified section to be
-.I troff'ed
-to a suitable raster output device; see
-.IR vtroff (1).
+checks in a standard location for manual
+information (/usr/man).  This can be changed by supplying a search
+path (a la the shell) with the
+.B \-M
+flag.  The search path is a colon (`:') separated list
+of directories in which manual subdirectories may be found;
+e.g. ``/usr/local:/usr/man''.  
+.hw MANPATH
+If the environment variable `MANPATH' is set,
+its value is used for the default path.
+If a search path is supplied
+with the 
+.B \-k
+or
+.B \-f
+options, it must be specified first.
+.PP
+.I Man
+will look for the manual page in either of two forms, the nroff source or
+preformatted pages.
+If either version is available, the manual page will be displayed.
+If the preformatted version is available, and it has a more recent modify
+time than the nroff source,  it will be promptly displayed.
+Otherwise, the manual page will be formatted with nroff and displayed.
+If the user has permission, the formatted manual page will be deposited
+in the proper place, so that later invocations of man will not need to
+format the page again.
 .SH FILES
 .SH FILES
-/usr/man/man?/*
-.br
-/usr/man/cat?/*
+.nf
+.ta \w'/usr/man/man?/*   'u
+/usr/man       standard manual area
+/usr/man/man?/*        directories containing source for manuals
+/usr/man/cat?/*        directories containing preformatted pages
+/usr/man/whatis        keyword database
+.fi
 .SH SEE\ ALSO
 .SH SEE\ ALSO
-more(1), ul(1), whereis(1), catman(8)
+apropos(1), more(1), whereis(1), catman(8)
 .SH BUGS
 The manual is supposed to be reproducible either on the phototypesetter
 or on a typewriter.
 .SH BUGS
 The manual is supposed to be reproducible either on the phototypesetter
 or on a typewriter.