[thirdparty/util-linux.git] / misc-utils / whereis.1

.\" Copyright (c) 1980, 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" 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.
.\"
.\" 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.
.\"
.\" @(#)whereis.1 from UCB 4.2
.TH WHEREIS 1 "8 May 1994"
.SH NAME
whereis \- locate the binary, source, and manual page files for a command
.SH SYNOPSIS
.B whereis
[
.B \-bmsu
] [
.B \-BMS
.IR directory .\|.\|.
.B \-f
]
\fIfilename\fP\|
\&.\|.\|.
.IX  "whereis command"  ""  "\fLwhereis\fP \(em find program"
.IX  find "program \(em \fLwhereis\fP"
.IX  "locate program"  ""   "locate program \(em \fLwhereis\fP"
.IX  command  locate  ""   "locate \(em \fLwhereis\fP"
.SH DESCRIPTION
.B whereis
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
.BI . ext,
for example,
.BR .c .
Prefixes of
.B s.
resulting from use of source code control are also dealt with.
.B whereis
then attempts to locate the desired program in
a list of standard Linux places.
.SH OPTIONS
.TP
\fB\-b
Search only for binaries.
.TP
.B \-m
Search only for manual sections.
.TP
.B \-s
Search only for sources.
.TP
.B \-u
Search for unusual entries.  A file is said to be unusual if it does
not have one entry of each requested type.
Thus
.RB ` "whereis\ \ \-m\ \ \-u\ \ *" '
asks for those files in the current
directory which have no documentation.
.TP
.B \-B
Change or otherwise limit the places where
.B whereis
searches for binaries.
.TP
.B \-M
Change or otherwise limit the places where
.B whereis
searches for
manual sections.
.TP
.B \-S
Change or otherwise limit the places where
.B whereis
searches for sources.
.TP
.B \-f
Terminate the last directory list and signals the start of file names,
and
.I must
be used when any of the
.BR \-B ,
.BR \-M ,
or
.B \-S
options are used.
.SH EXAMPLE
Find all files in
.B /usr/bin
which are not documented
in
.B /usr/man/man1
with source in
.BR /usr/src :
.IP
.nf
.ft B
example% cd /usr/bin
example% whereis \-u \-M /usr/man/man1 \-S /usr/src \-f *
.fi
.ft R
.SH FILES
.TP 20
.B /{bin,sbin,etc}
.TP
.B /usr/{lib,bin,old,new,local,games,include,etc,src,man,sbin,
.B X386,TeX,g++-include}
.TP
.B /usr/local/{X386,TeX,X11,include,lib,man,etc,bin,games,emacs}
.SH "SEE ALSO"
.BR chdir (2V)
.SH BUGS
Since
.B whereis
uses
.BR chdir (2V)
to run faster, pathnames given with the
.BR \-M ,
.BR \-S ,
or
.B \-B
must be full; that is, they must begin with a
.RB ` / '.
.PP
.B whereis
has a hard-coded path, so may not always find what
you're looking for.
Commit	Line	Data
6dbe3af9 KZ	1	.\" Copyright (c) 1980, 1990 The Regents of the University of California.
	2	.\" 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 from UCB 4.2
	33	.TH WHEREIS 1 "8 May 1994"
	34	.SH NAME
	35	whereis \- locate the binary, source, and manual page files for a command
	36	.SH SYNOPSIS
	37	.B whereis
	38	[
	39	.B \-bmsu
	40	] [
	41	.B \-BMS
	42	.IR directory .\\|.\\|.
	43	.B \-f
	44	]
	45	\fIfilename\fP\\|
	46	\&.\\|.\\|.
	47	.IX "whereis command" "" "\fLwhereis\fP \(em find program"
	48	.IX find "program \(em \fLwhereis\fP"
	49	.IX "locate program" "" "locate program \(em \fLwhereis\fP"
	50	.IX command locate "" "locate \(em \fLwhereis\fP"
	51	.SH DESCRIPTION
	52	.B whereis
	53	locates source/binary and manuals sections for specified
	54	files.
	55	The supplied names are first stripped of leading pathname components
	56	and any (single) trailing extension of the form
	57	.BI . ext,
	58	for example,
	59	.BR .c .
	60	Prefixes of
	61	.B s.
	62	resulting from use of source code control are also dealt with.
	63	.B whereis
	64	then attempts to locate the desired program in
2b6fc908	65	a list of standard Linux places.
6dbe3af9 KZ	66	.SH OPTIONS
	67	.TP
	68	\fB\-b
	69	Search only for binaries.
	70	.TP
	71	.B \-m
	72	Search only for manual sections.
	73	.TP
	74	.B \-s
	75	Search only for sources.
	76	.TP
	77	.B \-u
	78	Search for unusual entries. A file is said to be unusual if it does
	79	not have one entry of each requested type.
	80	Thus
	81	.RB ` "whereis\ \ \-m\ \ \-u\ \ *" '
	82	asks for those files in the current
	83	directory which have no documentation.
	84	.TP
	85	.B \-B
	86	Change or otherwise limit the places where
	87	.B whereis
	88	searches for binaries.
	89	.TP
	90	.B \-M
	91	Change or otherwise limit the places where
	92	.B whereis
	93	searches for
	94	manual sections.
	95	.TP
	96	.B \-S
	97	Change or otherwise limit the places where
	98	.B whereis
	99	searches for sources.
	100	.TP
	101	.B \-f
	102	Terminate the last directory list and signals the start of file names,
	103	and
	104	.I must
	105	be used when any of the
	106	.BR \-B ,
	107	.BR \-M ,
	108	or
	109	.B \-S
	110	options are used.
	111	.SH EXAMPLE
	112	Find all files in
	113	.B /usr/bin
	114	which are not documented
	115	in
	116	.B /usr/man/man1
	117	with source in
	118	.BR /usr/src :
	119	.IP
	120	.nf
	121	.ft B
	122	example% cd /usr/bin
	123	example% whereis \-u \-M /usr/man/man1 \-S /usr/src \-f *
	124	.fi
	125	.ft R
	126	.SH FILES
6dbe3af9 KZ	127	.TP 20
	128	.B /{bin,sbin,etc}
	129	.TP
	130	.B /usr/{lib,bin,old,new,local,games,include,etc,src,man,sbin,
	131	.B X386,TeX,g++-include}
	132	.TP
2b6fc908 KZ	133	.B /usr/local/{X386,TeX,X11,include,lib,man,etc,bin,games,emacs}
2b6fc908 KZ	134	.SH "SEE ALSO"
6dbe3af9 KZ	135	.BR chdir (2V)
	136	.SH BUGS
	137	Since
	138	.B whereis
	139	uses
	140	.BR chdir (2V)
	141	to run faster, pathnames given with the
	142	.BR \-M ,
	143	.BR \-S ,
	144	or
	145	.B \-B
	146	must be full; that is, they must begin with a
	147	.RB ` / '.
2b6fc908 KZ	148	.PP
	149	.B whereis
	150	has a hard-coded path, so may not always find what
	151	you're looking for.