diff options
Diffstat (limited to 'misc-utils/whereis.1')
-rw-r--r-- | misc-utils/whereis.1 | 140 |
1 files changed, 140 insertions, 0 deletions
diff --git a/misc-utils/whereis.1 b/misc-utils/whereis.1 new file mode 100644 index 0000000..988462f --- /dev/null +++ b/misc-utils/whereis.1 @@ -0,0 +1,140 @@ +.\" 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 "June 2012" "util-linux" "User Commands" +.SH NAME +whereis \- locate the binary, source, and manual page files for a command +.SH SYNOPSIS +.B whereis +.RB [ options ] +.RB [ \-BMS +.IR directory ... +.BR \-f ] +.IR filename ... +.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\fR,\fP +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 +.IP "\fB\-b\fP" +Search only for binaries. +.IP "\fB\-m\fP" +Search only for manual sections. +.IP "\fB\-s\fP" +Search only for sources. +.IP "\fB\-u\fP" +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. +.IP "\fB\-B \fIlist\fP" +Change or otherwise limit the places where +.B whereis +searches for binaries by white-space separated list of directories. +.IP "\fB\-M \fIlist\fP" +Change or otherwise limit the places where +.B whereis +searches for manual sections by white-space separated list of directories. +.IP "\fB\-S \fIlist\fP" +.B \-S +Change or otherwise limit the places where +.B whereis +searches for sources white-space separated list of directories. +.IP "\fB\-f\fP" +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 +.BR \-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 +$ cd /usr/bin +$ whereis \-u \-M /usr/man/man1 \-S /usr/src \-f * +.fi +.ft R +.SH FILES +.B whereis +has basic set of hard-coded paths (see below). If the option +.B \-B +is not specified then also follows +.B $PATH +environment variable (since version 2.21). + +.TP 20 +/{bin,sbin,etc} +.TP +/usr/{lib,bin,old,new,local,games,include,etc,src,man,sbin,X386,TeX,g++-include} +.TP +/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 +.SH AVAILABILITY +The whereis command is part of the util-linux package and is available from +ftp://ftp.kernel.org/pub/linux/utils/util-linux/. |