BSD 4_4_Lite1 release
[unix-history] / usr / src / usr.bin / man / man.1
index c80302d..081e204 100644 (file)
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1989, 1990, 1993
+.\"    The Regents of the University of California.  All rights reserved.
 .\"
 .\"
-.\"    @(#)man.1       6.4 (Berkeley) %G%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
 .\"
 .\"
-.TH MAN 1 ""
-.UC 4
-.SH NAME
-man \- find manual information by keywords; print out the manual
-.SH SYNOPSIS
-.br
-.B man
-[
-.B \-
-] [
-.B \-M
-.I path
-] [
-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.
-It can be asked for one line descriptions of commands specified by
-name, or for all commands whose description contains any of a set of
-keywords.  It can also provide on-line access to the sections of the
-printed manual.
-.PP
-When given the option
-.B \-k
-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 one of those keywords.
-.PP
-When given the option
-.B \-f
-and a list of file names, \fIman\fR attempts to locate manual
-sections related to those files, printing out the table of contents
-lines for those sections.
-.PP
-When neither
-.B \-k
-nor
-.B \-f
-is specified,
-.I man
-formats a specified set of manual pages.
-If a section specifier is given
-.I man
-looks in the that section of the manual for the given
-.I titles.
-.I Section
-is either
-an Arabic section number (3 for instance), or one of the words ``new,''
-``local,'' ``old,'' or ``public.''
-A section number may followed by
-a single letter classifier (for instance, 1g,
-indicating a graphics program in section 1).  If
-.I section
-is omitted,
-.I man
-searches all sections of the manual, giving preference to commands
-over subroutines in system libraries, and printing the first section
-it finds, if any.
-.PP
-If the standard output is a teletype, or if the flag
-.B \-
-is given,
-.I man
-pipes its output through
-.IR more (1)
-with the option
-.B \-s
-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
-Normally
-.I man
-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
-.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
-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.
-However, on a typewriter some information is necessarily lost.
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)man.1      8.2 (Berkeley) 1/2/94
+.\"
+.Dd January 2, 1994
+.Dt MAN 1
+.Os BSD 4
+.Sh NAME
+.Nm man
+.Nd display the on-line manual pages
+.Sh SYNOPSIS
+.Nm man
+.Op Fl achw
+.Op Fl C Ar file
+.Op Fl M Ar path
+.Op Fl m Ar path
+.Op Ar section
+.Ar name Ar ...
+.Sh DESCRIPTION
+The
+.Nm man
+utility
+displays the
+.Bx
+manual pages entitled
+.Ar name .
+.Pp
+The options are as follows:
+.Bl -tag -width indent
+.It Fl a
+Display all of the manual pages for a specified
+.Ar section
+and
+.Ar name
+combination.
+(Normally, only the first manual page found is displayed.)
+.It Fl C
+Use the specified 
+.Ar file
+instead of the default configuration file.
+This permits users to configure their own manual environment.
+See
+.Xr man.conf 5
+for a description of the contents of this file.
+.It Fl c
+Copy the manual page to the standard output instead of using
+.Xr more 1
+to paginate it.
+This is done by default if the standard output is not a terminal device.
+.It Fl h
+Display only the
+.Dq Tn SYNOPSIS
+lines of the requested manual pages.
+.It Fl M
+Override the list of standard directories which
+.Nm man
+searches for manual pages.
+The supplied
+.Ar path
+must be a colon (``:'') separated list of directories.
+This search path may also be set using the environment variable
+.Ev MANPATH .
+The subdirectories to be searched, and their search order,
+is specified by the ``_subdir'' line in the
+.Nm man
+configuration file.
+.It Fl m
+Augment the list of standard directories which
+.Nm man
+searches for manual pages.
+The supplied
+.Ar path
+must be a colon (``:'') separated list of directories.
+These directories will be searched before the standard directories or
+the directories specified using the
+.Fl M
+option or the
+.Ev MANPATH
+environment variable.
+The subdirectories to be searched, and their search order,
+is specified by the ``_subdir'' line in the
+.Nm man
+configuration file.
+.It Fl w
+List the pathnames of the manual pages which
+.Nm man
+would display for the specified
+.Ar section
+and
+.Ar name
+combination.
+.El
+.Pp
+The optional
+.Ar section
+argument restricts the directories that
+.Nm man
+will search.
+The
+.Nm man
+configuration file (see
+.Xr man.conf 5 )
+specifies the possible
+.Ar section
+values that are currently available.
+If only a single argument is specified or if the first argument is
+not a valid section,
+.Nm man
+assumes that the argument is the name of a manual page to be displayed.
+.Sh ENVIRONMENT
+.Bl -tag -width MANPATHX
+.It Ev MACHINE
+As some manual pages are intended only for specific architectures,
+.Nm man
+searches any subdirectories,
+with the same name as the current architecture,
+in every directory which it searches.
+Machine specific areas are checked before general areas.
+The current machine type may be overridden by setting the environment
+variable
+.Ev MACHINE
+to the name of a specific architecture.
+.It Ev MANPATH
+The standard search path used by
+.Nm man
+may be overridden by specifying a path in the
+.Ev MANPATH
+environment
+variable.
+The format of the path is a colon (``:'') separated list of directories.
+The subdirectories to be searched as well as their search order
+is specified by the ``_subdir'' line in the
+.Nm man
+configuration file.
+.It Ev PAGER
+Any value of the environment variable
+.Ev PAGER
+will be used instead of the standard pagination program,
+.Xr more 1 .
+.El
+.Sh FILES
+.Bl -tag -width /etc/man.conf -compact
+.It Pa /etc/man.conf
+default man configuration file.
+.El
+.Sh SEE ALSO
+.Xr apropos 1 ,
+.Xr whatis 1 ,
+.Xr whereis 1 ,
+.Xr man.conf 5
+.Sh BUGS
+The on-line manual pages are, by necessity, forgiving toward stupid
+display devices, causing a few manual pages to not as nicely formatted
+as their typeset counterparts.
+.Sh HISTORY
+A
+.Nm
+command appeared in
+.At v6 .