xref: /original-bsd/old/whereis/whereis.1 (revision 7717c4d4)
Copyright (c) 1980 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)whereis.1 6.3 (Berkeley) 03/10/90

WHEREIS 1 ""
C
NAME
whereis - locate source, binary, and or manual for program
SYNOPSIS
whereis [ -sbm ] [ -u ] [ -SBM dir ... -f ] name ...
DESCRIPTION
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 ``.ext'', e.g. ``.c''. Prefixes of ``s.'' resulting from use of source code control are also dealt with. Whereis then attempts to locate the desired program in a list of standard places. If any of the -b, -s or -m flags are given then whereis searches only for binaries, sources or manual sections respectively (or any two thereof). The -u flag may be used to search for unusual entries. A file is said to be unusual if it does not have one entry of each requested type. Thus ``whereis -m -u *'' asks for those files in the current directory which have no documentation. Finally, the -B -M and -S flags may be used to change or otherwise limit the places where whereis searches. The -f file flags is used to terminate the last such directory list and signal the start of file names.
EXAMPLE
The following finds all the files in /usr/bin which are not documented in /usr/man/man1 with source in /usr/src/cmd:
cd /usr/ucb

whereis -u -M /usr/man/man1 -S /usr/src/cmd -f *

FILES
/usr/src/*

/usr/{doc,man}/*

/lib, /etc, /usr/{lib,bin,ucb,old,new,local}

BUGS
Since the program uses chdir (2) to run faster, pathnames given with the -M -S and -B must be full; i.e. they must begin with a ``/''.