[unix-history] / usr / man / man1 / whereis.1

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