Commit | Line | Data |
---|---|---|
70e18513 BJ |
1 | .TH WHEREIS UCB 2/24/79 UCB |
2 | .SH NAME | |
3 | whereis \- locate source/binary/manual for program | |
4 | .SH SYNOPSIS | |
5 | .B whereis | |
6 | [ | |
7 | .B \-sbmu | |
8 | ] [ | |
9 | .B \-SBM | |
10 | dir ... [ -f ] | |
11 | ] | |
12 | name ... | |
13 | .SH DESCRIPTION | |
14 | .I Whereis | |
15 | locates source/binary and manuals sections for specified files. | |
16 | The supplied names are first stripped of leading pathname components | |
17 | and any (single) trailing extension of the form `.ext', e.g. `.c'. | |
18 | Prefixes of `s.' resulting from use of source code control are also | |
19 | dealt with. | |
20 | .I Whereis | |
21 | then attempts to locate the desired program in a list of standard places. | |
22 | If any of the | |
23 | .B \-b, | |
24 | .B \-s | |
25 | or | |
26 | .B \-m | |
27 | flags are given then | |
28 | .I whereis | |
29 | searches only for binaries, sources or manual sections | |
30 | (or any two thereof). | |
31 | .sp | |
32 | The | |
33 | .B \-u | |
34 | flag may be used to search for unusual entries. | |
35 | A file is said to be unusual if it does not have one entry of | |
36 | each requested type. | |
37 | Thus `whereis -m -u *' asks for those files in the current | |
38 | directory which have no documentation. | |
39 | .sp | |
40 | Finally, the | |
41 | .B \-B | |
42 | .B \-M | |
43 | and | |
44 | .B \-S | |
45 | flags may be used to change the places where | |
46 | .I whereis | |
47 | searches to the specified directories only. | |
48 | The | |
49 | .B \-f | |
50 | file flags may be used to terminate the last such directory list | |
51 | and signal the start of file names. | |
52 | .SH EXAMPLE | |
53 | The following finds all the files in /usr/ucb which are not documented | |
54 | in /usr/man/mann with source in /usr/ucb/src/ucb: | |
55 | .sp | |
56 | .ti +5 | |
57 | cd /usr/ucb | |
58 | .ti +5 | |
59 | whereis -u -M /usr/man/mann -S /usr/ucb/src/ucb -f * | |
60 | .SH FILES | |
61 | /usr/src/* | |
62 | .br | |
63 | /usr/ucb/src/* | |
64 | .br | |
65 | /usr/man/* | |
66 | .br | |
67 | /bin, /etc, /usr/{bin,ucb} | |
68 | .SH AUTHOR | |
69 | Bill Joy | |
70 | .SH DIAGNOSTICS | |
71 | None. | |
72 | .SH BUGS | |
73 | This program makes it too easy to find out what needs to be done. | |
74 | .sp | |
75 | Since the program uses | |
76 | .IR chdir (1) | |
77 | to run faster, pathnames given with the | |
78 | .B \-M | |
79 | .B \-S | |
80 | and | |
81 | .B \-B | |
82 | flags should start at the root or they will not work. |