BSD 4_4_Lite1 release

[unix-history] / usr / src / usr.bin / man / man.1

diff --git a/usr/src/usr.bin/man/man.1 b/usr/src/usr.bin/man/man.1
index 5c29f97..081e204 100644 (file)
--- a/usr/src/usr.bin/man/man.1
+++ b/usr/src/usr.bin/man/man.1
@@ -1,127 +1,188 @@
-.\" Copyright (c) 1989, 1990 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.11 (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 "%Q"
-.UC 4
-.SH NAME
-man \- display the on-line manual pages
-.SH SYNOPSIS
-.nf
-.ft B
-man [ -acw ] [ -M path ] [ -m path ] [ section ] name ...
-.ft R
-.fi
-.SH DESCRIPTION
-.I Man
-displays the UNIX manual pages entitled
-.IR name .
-.PP
+.\" 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:
 The options are as follows:

-.TP
-a
+.Bl -tag -width indent
+.It Fl a

 Display all of the manual pages for a specified
 Display all of the manual pages for a specified

-.I section
+.Ar section

 and
 and

-.I name
+.Ar name

 combination.
 (Normally, only the first manual page found is displayed.)
 combination.
 (Normally, only the first manual page found is displayed.)

-.TP
-c
+.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
 Copy the manual page to the standard output instead of using

-.IR more (1)
+.Xr more 1

 to paginate it.
 This is done by default if the standard output is not a terminal device.
 to paginate it.
 This is done by default if the standard output is not a terminal device.

-.TP
-M
+.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
 Override the list of standard directories which

-.I man
+.Nm man

 searches for manual pages.
 The supplied
 searches for manual pages.
 The supplied

-.I path
+.Ar path

 must be a colon (``:'') separated list of directories.
 This search path may also be set using the environment variable
 must be a colon (``:'') separated list of directories.
 This search path may also be set using the environment variable

-.IR MANPATH .
-The subdirectories to be searched as well as their search order
+.Ev MANPATH .
+The subdirectories to be searched, and their search order,

 is specified by the ``_subdir'' line in the
 is specified by the ``_subdir'' line in the

-.I man
+.Nm man

 configuration file.
 configuration file.

-.TP
-m
+.It Fl m

 Augment the list of standard directories which
 Augment the list of standard directories which

-.I man
+.Nm man

 searches for manual pages.
 The supplied
 searches for manual pages.
 The supplied

-.I path
+.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
 must be a colon (``:'') separated list of directories.
 These directories will be searched before the standard directories or
 the directories specified using the

-.I M
+.Fl M

 option or the
 option or the

-.I MANPATH
+.Ev MANPATH

 environment variable.
 environment variable.

-.TP
-.I w
+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
 List the pathnames of the manual pages which

-.I man
+.Nm man

 would display for the specified
 would display for the specified

-.I section
+.Ar section

 and
 and

-.I name
+.Ar name

 combination.
 combination.

-.PP
+.El
+.Pp

 The optional
 The optional

-.I section
-restricts the directories that
-.I man
+.Ar section
+argument restricts the directories that
+.Nm man

 will search.
 The
 will search.
 The

-.I man
+.Nm man

 configuration file (see
 configuration file (see

-.IR man_conf (5))
+.Xr man.conf 5 )

 specifies the possible
 specifies the possible

-.I section
+.Ar section

 values that are currently available.
 If only a single argument is specified or if the first argument is
 not a valid section,
 values that are currently available.
 If only a single argument is specified or if the first argument is
 not a valid section,

-.I man
+.Nm man

 assumes that the argument is the name of a manual page to be displayed.
 assumes that the argument is the name of a manual page to be displayed.

-.SH ENVIRONMENT
-.TP
-MACHINE
-As some manual pages are intended only for use on certain architectures,
-.I man
-searches certain directories applicable to the current machine.
-.I Man's
-determination of the current machine type may be overridden by setting
-the environment variable MACHINE to the name of an architecture (see
-.IR machine (1)).
+.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.
 Machine specific areas are checked before general areas.

-.TP
-MANPATH
+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
 The standard search path used by

-.I man
-may be overridden by specifying a path in the MANPATH environment
+.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
 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

-.I man
+.Nm man

 configuration file.
 configuration file.

-.TP
-PAGER
+.It Ev PAGER

 Any value of the environment variable
 Any value of the environment variable

-.I PAGER
-will be used instead of the standard pagination program
-.IR more (1).
-.SH FILES
-/etc/man.conf  man configuration file (see
-.IR man_conf (5))
-.SH "SEE ALSO"
-apropos(1), machine(1), whatis(1), whereis(1), man_conf(5)
-.SH BUGS
+.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
 The on-line manual pages are, by necessity, forgiving toward stupid

-display devices, causing some manual pages to not be as good as their
-typeset counterparts.
+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 .