xref: /dragonfly/usr.bin/whereis/whereis.1 (revision 1de703da)
1.\" Copyright (c) 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"	@(#)whereis.1	8.2 (Berkeley) 12/30/93
33.\"
34.\" $FreeBSD: src/usr.bin/whereis/whereis.1,v 1.8.2.3 2001/08/16 13:17:14 ru Exp $
35.\" $DragonFly: src/usr.bin/whereis/whereis.1,v 1.2 2003/06/17 04:29:33 dillon Exp $
36.\"
37.Dd June 15, 1996
38.Dt WHEREIS 1
39.Os
40.Sh NAME
41.Nm whereis
42.Nd locate programs
43.Sh SYNOPSIS
44.Nm
45.Op Fl bms
46.Op Fl u
47.Op Fl BMS dir ... Fl f
48.Ar program ...
49.Sh DESCRIPTION
50The
51.Nm
52utility checks the standard binary, manual page, and source
53directories for the specified programs, printing out the paths of any
54it finds.  The supplied names are first stripped of leading path name
55components, any single trailing extension added by
56.Xr gzip 1
57or
58.Xr compress 1 ,
59and the leading
60.Ql s.\&
61or trailing
62.Ql ,v
63from a source code control system.
64.Pp
65The default path searched is the string returned by the
66.Xr sysctl 8
67utility for the
68.Dq user.cs_path
69string, with
70.Pa /usr/libexec
71and the current user's
72.Ev $PATH
73appended.  Manual pages are searched by default along the
74.Ev $MANPATH .
75Program sources are located in a list of known standard places,
76including all the subdirectories of
77.Pa /usr/src
78and
79.Pa /usr/ports .
80.Pp
81The following options are available:
82.Bl -tag -width indent
83.It Fl B
84Specify directories to search for binaries.  Requires the
85.Fl f
86option.
87.It Fl M
88Specify directories to search for manual pages.  Requires the
89.Fl f
90option.
91.It Fl S
92Specify directories to search for program sources.  Requires the
93.Fl f
94option.
95.It Fl b
96Search for binaries.
97.It Fl f
98Delimits the list of directories after the
99.Fl B ,
100.Fl M ,
101or
102.Fl S
103options, and indicates the beginning of the
104.Ar name
105list.
106.It Fl m
107Search for manual pages.
108.It Fl s
109Search for source directories.
110.It Fl u
111Search for
112.Dq unusual
113entries.  A file is said to be unusual if it does not have one entry
114of each requested type.
115.El
116.Sh EXAMPLES
117The following finds all utilities under
118.Pa /usr/bin
119that do not have documentation:
120.Dl whereis -m -u /usr/bin/*
121.Sh SEE ALSO
122.Xr find 1 ,
123.Xr locate 1 ,
124.Xr man 1 ,
125.Xr which 1 ,
126.Xr sysctl 8
127.Sh BUGS
128The search for sources is implemented as a quick search as the
129first-level subdirectory of each element of the list of source
130directories first.  If this didn't succeed, the utility
131.Xr locate 1
132is requested to do the search in deeper nested subdirectories.  This
133might take some time, and will only succeed if the locate database is
134up-to-date.
135.Sh HISTORY
136The
137.Nm
138command appeared in
139.Bx 3.0 .
140This version re-implements the historical
141functionality that was lost in
142.Bx 4.4 .
143