]>
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 | |
2e6f289a | 33 | .TH WHEREIS 1 "October 2014" "util-linux" "User Commands" |
6dbe3af9 KZ |
34 | .SH NAME |
35 | whereis \- locate the binary, source, and manual page files for a command | |
36 | .SH SYNOPSIS | |
37 | .B whereis | |
f49ccec2 | 38 | [options] |
fd5ccc69 | 39 | .RB [ \-BMS |
2e1d40c6 BS |
40 | .IR directory "... " \fB\-f\fR ] |
41 | .IR name ... | |
6dbe3af9 KZ |
42 | .SH DESCRIPTION |
43 | .B whereis | |
2e1d40c6 | 44 | locates the binary, source and manual files for the specified command names. |
d6590ebd SK |
45 | The supplied names are first stripped of leading pathname components and any |
46 | (single) trailing extension of the form | |
2e1d40c6 BS |
47 | .BI . ext |
48 | (for example: | |
49 | .BR .c ) | |
6dbe3af9 KZ |
50 | Prefixes of |
51 | .B s. | |
52 | resulting from use of source code control are also dealt with. | |
53 | .B whereis | |
d6590ebd SK |
54 | then attempts to locate the desired program in the standard Linux places, and |
55 | in the places specified by | |
56 | .B $PATH | |
57 | and | |
58 | .BR $MANPATH . | |
2e6f289a BS |
59 | .sp |
60 | The search restrictions (options \fB\-b\fP, \fB\-m\fP and \fB\-s\fP) | |
61 | are cumulative and apply to the subsequent \fIname\fP patterns on | |
62 | the command line. Any new search restriction resets the search mask. | |
63 | For example, | |
f4802c90 KZ |
64 | .RS |
65 | .sp | |
66 | .B "whereis -bm ls tr -m gcc" | |
67 | .sp | |
68 | .RE | |
2e6f289a BS |
69 | searches for "ls" and "tr" binaries and man pages, and for "gcc" man pages only. |
70 | .sp | |
71 | The options \fB\-B\fP, \fB\-M\fP and \fB\-S\fP reset search paths for the | |
72 | subsequent \fIname\fP patterns. For example, | |
f4802c90 KZ |
73 | .RS |
74 | .sp | |
75 | .B "whereis -m ls -M /usr/share/man/man1 -f cal" | |
76 | .sp | |
77 | .RE | |
2e6f289a BS |
78 | searches for "ls" man pages in all default paths, but for "cal" in |
79 | the /usr/share/man/man1 directory only. | |
f4802c90 | 80 | |
6dbe3af9 KZ |
81 | .SH OPTIONS |
82 | .TP | |
d6590ebd | 83 | .IP \fB\-b\fP |
f4802c90 | 84 | Search for binaries. |
d6590ebd | 85 | .IP \fB\-m\fP |
f4802c90 | 86 | Search for manuals. |
d6590ebd | 87 | .IP \fB\-s\fP |
f4802c90 | 88 | Search for sources. |
d6590ebd SK |
89 | .IP \fB\-u\fP |
90 | Only show the command names that have unusual entries. A command is said to be | |
91 | unusual if it does not have just one entry of each explicitly requested type. | |
92 | Thus | |
93 | .RB ' "whereis \-m \-u *" ' | |
94 | asks for those files in the current directory which have no documentation file, | |
95 | or more than one. | |
25206ba6 | 96 | .IP "\fB\-B \fIlist\fP" |
2e1d40c6 | 97 | Limit the places where |
6dbe3af9 | 98 | .B whereis |
2e1d40c6 | 99 | searches for binaries, by a whitespace-separated list of directories. |
25206ba6 | 100 | .IP "\fB\-M \fIlist\fP" |
2e1d40c6 | 101 | Limit the places where |
6dbe3af9 | 102 | .B whereis |
db0ccb76 KZ |
103 | searches for manuals and documentation in Info format, by a |
104 | whitespace-separated list of directories. | |
25206ba6 | 105 | .IP "\fB\-S \fIlist\fP" |
2e1d40c6 | 106 | Limit the places where |
6dbe3af9 | 107 | .B whereis |
2e1d40c6 | 108 | searches for sources, by a whitespace-separated list of directories. |
25206ba6 | 109 | .IP "\fB\-f\fP" |
2e1d40c6 | 110 | Terminates the directory list and signals the start of filenames. It |
6dbe3af9 KZ |
111 | .I must |
112 | be used when any of the | |
113 | .BR \-B , | |
114 | .BR \-M , | |
115 | or | |
0bb7e904 | 116 | .B \-S |
2e1d40c6 | 117 | options is used. |
3bfb9636 | 118 | .IP "\fB\-l" |
2e6f289a | 119 | Output the list of effective lookup paths that |
3bfb9636 | 120 | .B whereis |
2e6f289a | 121 | is using. When none of |
3bfb9636 SK |
122 | .BR \-B , |
123 | .BR \-M , | |
124 | or | |
0bb7e904 | 125 | .B \-S |
2e6f289a BS |
126 | is specified, the option will output the hard-coded paths |
127 | that the command was able to find on the system. | |
5aaa966d RM |
128 | .TP |
129 | \fB\-h\fR, \fB\-\-help\fR | |
130 | Display help text and exit. | |
131 | .TP | |
132 | \fB\-V\fR, \fB\-\-version\fR | |
133 | Display version information and exit. | |
6dbe3af9 | 134 | .SH EXAMPLE |
2e1d40c6 | 135 | To find all files in |
46f057ed | 136 | .I /usr/\:bin |
6dbe3af9 KZ |
137 | which are not documented |
138 | in | |
46f057ed | 139 | .I /usr/\:man/\:man1 |
2e1d40c6 | 140 | or have no source in |
46f057ed | 141 | .IR /usr/\:src : |
6dbe3af9 | 142 | .IP |
2e6f289a | 143 | .B cd /usr/bin |
2e1d40c6 | 144 | .br |
2e6f289a | 145 | .B whereis \-u \-ms \-M /usr/man/man1 \-S /usr/src \-f * |
ccec32a1 SK |
146 | .SH "FILE SEARCH PATHS" |
147 | By default | |
25206ba6 | 148 | .B whereis |
ccec32a1 | 149 | tries to find files from hard-coded paths, which are defined with glob |
b1c9817e | 150 | patterns. The command attempts to use the contents of |
25206ba6 | 151 | .B $PATH |
ccec32a1 SK |
152 | and |
153 | .B $MANPATH | |
154 | environment variables as default search path. The easiest way to know | |
b1c9817e | 155 | what paths are in use is to add the |
ccec32a1 SK |
156 | .B \-l |
157 | listing option. Effects of the | |
158 | .BR \-B , | |
159 | .BR \-M , | |
160 | and | |
0bb7e904 | 161 | .B \-S |
b1c9817e | 162 | are displayed with |
ccec32a1 | 163 | .BR \-l . |
2b6fc908 | 164 | .PP |
47dd6918 KZ |
165 | .SH ENVIRONMENT |
166 | .IP WHEREIS_DEBUG=all | |
167 | enables debug output. | |
86d62711 | 168 | .SH AVAILABILITY |
601d12fb | 169 | The whereis command is part of the util-linux package and is available from |
d673b74e | 170 | .UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/ |
d6590ebd SK |
171 | Linux Kernel Archive |
172 | .UE . |