Sync usage with man page.
[netbsd-mini2440.git] / usr.bin / what / what.1
blob88bd2be44322c53a2f4cddda1ac84d3b853c12b7
1 .\"     $NetBSD: what.1,v 1.12 2002/10/02 10:07:05 wiz Exp $
2 .\"
3 .\" Copyright (c) 1980, 1991, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     @(#)what.1      8.1 (Berkeley) 6/6/93
31 .\"
32 .Dd February 22, 1999
33 .Dt WHAT 1
34 .Os
35 .Sh NAME
36 .Nm what
37 .Nd search files for SCCS identifiers
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl s
41 .Ar
42 .Sh DESCRIPTION
43 The
44 .Nm
45 utility reads each
46 .Ar file
47 operand and searches for sequences of the form
48 .Dq \&@(#)
49 as inserted by the source code control system.
50 It prints the remainder of the string following this marker, up to
51 a null character, newline, double quote, backslash, or
52 .Dq \&\*[Gt]
53 character.
54 .Pp
55 If the
56 .Fl s
57 option is specified, only the first occurrence of an identification string in
58 each file is printed.
59 .Sh EXIT STATUS
60 The
61 .Nm
62 utility exits 0 if any matches were found, and 1 otherwise.
63 .Sh STANDARDS
64 The
65 .Nm
66 utility conforms to
67 .St -xpg4.2 .
68 .Sh HISTORY
69 The
70 .Nm
71 command appeared in
72 .Bx 4.0 .
73 .Sh BUGS
75 .Bx
76 is not licensed to distribute
77 .Tn SCCS
78 this is a rewrite of the
79 .Nm
80 command which is part of
81 .Tn SCCS ,
82 and may not behave exactly the same as that command does.