BSD 4_3_Net_2 release

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

diff --git a/usr/src/usr.bin/man/whatis/whatis.1 b/usr/src/usr.bin/man/whatis/whatis.1
index 18fe6bb..be52ab7 100644 (file)
--- a/usr/src/usr.bin/man/whatis/whatis.1
+++ b/usr/src/usr.bin/man/whatis/whatis.1
@@ -1,75 +1,105 @@
 .\" Copyright (c) 1989, 1990 The Regents of the University of California.
 .\" Copyright (c) 1989, 1990 The Regents of the University of California.

-.\" Copyright (c) 1990 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" 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.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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.

 .\"
 .\"

-.\"     @(#)whatis.1   6.7 (Berkeley) 6/24/90
+.\" 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.

 .\"
 .\"

-.TH WHATIS 1 "%Q"
-.UC 4
-.SH NAME
-whatis \- describe what a command is
-.SH SYNOPSIS
-.nf
-.ft B
-whatis [-M path] [-m path] command ...
-.ft R
-.fi
-.SH DESCRIPTION
-.I Whatis
+.\"     @(#)whatis.1   6.7 (Berkeley) 4/23/91
+.\"
+.Dd April 23, 1991
+.Dt WHATIS 1
+.Os BSD 4
+.Sh NAME
+.Nm whatis
+.Nd describe what a command is
+.Sh SYNOPSIS
+.Nm whatis
+.Op Fl M Ar path
+.Op Fl m Ar path
+.Ar command Ar ...
+.Sh DESCRIPTION
+.Nm Whatis

 looks up a given command and gives the header line from the manual page.
 You can then use the
 looks up a given command and gives the header line from the manual page.
 You can then use the

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

 command to get more information.
 command to get more information.

-.PP
+.Pp

 The options are as follows:
 The options are as follows:

-.TP
-.I M
-Override the list of standard directories where
-.I whatis
-searches for its database named ``whatis.db''.
+.Bl -tag -width Fl
+.It Fl M Ar path
+Override the list of standard directories
+.Nm whatis
+searches for its database named
+.Dq Pa whatis.db .

 The supplied
 The supplied

-.I path
-must be a colon (``:'') separated list of directories.
+.Ar path
+must be a colon
+.Dq \&:
+separated list of directories.

 This search path may also be set using the environment variable
 This search path may also be set using the environment variable

-.IR MANPATH .
-.TP
-.I m
-Augment the list of standard directories where
-.I whatis
-searches for its database named ``whatis.db''.
+.Ev MANPATH .
+.It Fl m Ar path
+Augment the list of standard directories
+.Nm whatis
+searches for its database named
+.Dq Pa whatis.db .

 The supplied
 The supplied

-.I path
-must be a colon (``:'') separated list of directories.
+.Ar path
+must be a colon
+.Dq \&:
+separated list of directories.

 These directories will be searched before the standard directories
 or the directories supplied with the
 These directories will be searched before the standard directories
 or the directories supplied with the

-.I M
+.Fl M

 option or the
 option or the

-.I MANPATH
+.Ev MANPATH

 environment variable are searched.
 environment variable are searched.

-.SH ENVIRONMENT
-.TP
-.I MANPATH
+.El
+.Sh ENVIRONMENT
+.Bl -tag -width MANPATH
+.It Ev MANPATH

 The standard search path used by
 The standard search path used by

-.I man
+.Xr man 1

 may be overridden by specifying a path in the
 may be overridden by specifying a path in the

-.I MANPATH
+.Ev MANPATH

 environment variable.
 environment variable.

-The format of the path is a colon (``:'') separated list of directories.
-.SH FILES
-whatis.db              name of the whatis database
-.SH "SEE ALSO"
-apropos(1), man(1), whereis(1)
+.El
+.Sh FILES
+.Bl -tag -width whatis.db
+.It Pa whatis.db
+name of the whatis database
+.El
+.Sh SEE ALSO
+.Xr apropos 1 ,
+.Xr man 1 ,
+.Xr whereis 1
+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 3.0 .