BSD 4_3_Net_2 release

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

diff --git a/usr/src/usr.bin/whereis/whereis.1 b/usr/src/usr.bin/whereis/whereis.1
index 7fa59cb..3c13dbd 100644 (file)
--- a/usr/src/usr.bin/whereis/whereis.1
+++ b/usr/src/usr.bin/whereis/whereis.1
@@ -1,92 +1,131 @@
-.\" Copyright (c) 1980 The Regents of the University of California.
+.\" Copyright (c) 1980, 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 the above copyright notice and this paragraph are
-.\" duplicated in all such forms and that any documentation,
-.\" advertising materials, and other materials related to such
-.\" distribution and use acknowledge that the software was developed
-.\" by the University of California, Berkeley.  The name of the
-.\" University may not 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.

 .\"
 .\"

-.\"    @(#)whereis.1   6.3 (Berkeley) 3/10/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 WHEREIS 1 "March 10, 1990"
-.UC
-.SH NAME
-whereis \- locate source, binary, and or manual for program
-.SH SYNOPSIS
-.B whereis
-[
-.B \-sbm
-] [
-.B \-u
-] [
-.B \-SBM
-dir ...
-.B \-f
-] name ...
-.SH DESCRIPTION
-.I Whereis
+.\"     @(#)whereis.1  6.5 (Berkeley) 4/23/91
+.\"
+.Dd April 23, 1991
+.Dt WHEREIS 1
+.Os BSD 3
+.Sh NAME
+.Nm whereis
+.Nd locate binary, manual, and or source for program
+.Sh SYNOPSIS
+.Nm whereis
+.Op Fl bms
+.Op Fl u
+.Op Fl BMS Ar dir Ar ... Fl f
+.Ar name Ar ...
+.Sh DESCRIPTION
+.Nm Whereis

 locates source/binary and manuals sections for specified files.
 The supplied names are first stripped of leading pathname components
 locates source/binary and manuals sections for specified files.
 The supplied names are first stripped of leading pathname components

-and any (single) trailing extension of the form ``.ext'', e.g. ``.c''.
-Prefixes of ``s.'' resulting from use of source code control are also
+and of any (single) trailing extension of the form
+.Ql .ext ,
+e.g. 
+.Ql \&.c .
+Prefixes of
+.Ql \&.s
+resulting from use of source code control are also

 dealt with.
 dealt with.

-.I Whereis
+.Nm Whereis

 then attempts to locate the desired program in a list of standard places.
 then attempts to locate the desired program in a list of standard places.

-If any of the
-.B \-b,
-.B \-s
+.Pp
+Available options:
+.Bl -tag -width Ds
+.It Fl B
+Change or limit directories searched for binaries. Requires the
+.Fl f
+flag.
+.It Fl M
+Change or limit directories searched for manual entries. Requires the
+.Fl f
+flag.
+.It Fl S
+Change or limit directories searched for source. Requires the
+.Fl f
+flag.
+.It Fl b
+Search for binaries.
+.It Fl f
+Signals the end of a directory list specified by one or more of the
+.Fl B , M

 or
 or

-.B \-m
-flags are given then
-.I whereis
-searches only for binaries, sources or manual sections respectively
-(or any two thereof).
-The
-.B \-u
-flag may be used to search for unusual entries.
+.Fl S
+options and the start of file
+.Ar names .
+.It Fl m
+Search for manual entries.
+.It Fl s
+Search for source.
+.It Fl u
+Search for unusual entries.

 A file is said to be unusual if it does not have one entry of
 each requested type.
 A file is said to be unusual if it does not have one entry of
 each requested type.

-Thus ``whereis -m -u *'' asks for those files in the current
+Thus:
+.Pp
+.Dl whereis -m -u *
+.Pp
+asks for those files in the current

 directory which have no documentation.
 directory which have no documentation.

-.sp
-Finally, the
-.B \-B
-.B \-M
-and
-.B \-S
-flags may be used to change or otherwise limit the places where
-.I whereis
-searches.
-The
-.B \-f
-file flags is used to terminate the last such directory list
-and signal the start of file names.
-.SH EXAMPLE
-The following finds all the files in /usr/bin which are not documented
-in /usr/man/man1 with source in /usr/src/cmd:
-.IP
+.El
+.Sh EXAMPLE
+The following finds all the files in
+.Pa /usr/bin
+which are not documented
+in
+.Pa /usr/share/man/man1
+with source in
+.Pa /usr/src/cmd:
+.Bd -literal -offset indent -compact

 cd /usr/ucb
 cd /usr/ucb

-.br
-whereis \-u \-M /usr/man/man1 \-S /usr/src/cmd \-f *
-.SH FILES
-/usr/src/*
-.br
-/usr/{doc,man}/*
-.br
-/lib, /etc, /usr/{lib,bin,ucb,old,new,local}
-.SH BUGS
+whereis \-u \-M /usr/share/man/man1 \-S /usr/src/cmd \-f *
+.Ed
+.Sh FILES
+.Bl -tag -width /lib,x/etc,x/usr/{lib,bin,ucb,old,new,local} -compact
+.It Pa /usr/src/*
+.It Pa /usr/{doc,man}/*
+.It Pa /lib, /etc, /usr/{lib,bin,ucb,old,new,local}
+.El
+.Sh BUGS

 Since the program uses
 Since the program uses

-.IR chdir (2)
+.Xr chdir 2

 to run faster, pathnames given with the
 to run faster, pathnames given with the

-.B \-M
-.B \-S
+.Fl M
+.Fl S

 and
 and

-.B \-B
-must be full; i.e. they must begin with a ``/''.
+.Fl B
+must be full; i.e. they must begin with a
+.Ql \&/ .
+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 3.0 .