NetBSD/usr.bin/what/what.1

.\"	$NetBSD: what.1,v 1.9 2001/12/08 19:24:57 wiz Exp $
.\"
.\" Copyright (c) 1980, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)what.1	8.1 (Berkeley) 6/6/93
.\"
.Dd February 22, 1999
.Dt WHAT 1
.Os
.Sh NAME
.Nm what
.Nd search files for SCCS identifiers
.Sh SYNOPSIS
.Nm
.Op Fl s
.Ar
.Sh DESCRIPTION
The
.Nm
utility reads each
.Ar file
operand and searches for sequences of the form
.Dq \&@(#)
as inserted by the source code control system.  It prints the remainder
of the string following this marker, up to a null character, newline, double
quote, backslash or
.Dq \&>
character.
.Pp
If the
.Fl s
option is specified, only the first occurence of an idenfication string in
each file is printed.
.Sh EXIT STATUS
The
.Nm
utility exits 0 if any matches were found, and 1 otherwise.
.Sh STANDARDS
The
.Nm
utility conforms to
.St -xpg4.2 .
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.0 .
.Sh BUGS
As
.Bx
is not licensed to distribute
.Tn SCCS
this is a rewrite of the
.Nm
command which is part of
.Tn SCCS ,
and may not behave exactly the same as that
command does.
Sort sections. 2001-12-08 22:24:57 +03:00			`.\" $NetBSD: what.1,v 1.9 2001/12/08 19:24:57 wiz Exp $`
Merged with 4.4lite Changed to conform to NetBSD's new RCS Id convention. 1994-11-17 09:59:37 +03:00			`.\"`
			`.\" Copyright (c) 1980, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
Merged with 4.4lite Changed to conform to NetBSD's new RCS Id convention. 1994-11-17 09:59:37 +03:00			`.\" @(#)what.1 8.1 (Berkeley) 6/6/93`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
XPG4.2: * Add the -s (first identifier found only) flag. * Require at least one file operand; the standard does not permit reading from stdin in case none were given. * Recogize '\' as an additional identifier end character. * Make the exit status depend on whether any matches were found. 1999-02-23 01:23:09 +03:00			`.Dd February 22, 1999`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt WHAT 1`
More and more .Os cleanups. .Os is defined in the tmac.doc-common file, so we shouldn't override it with versions in the manpages. Many more to come. 1999-03-22 21:16:34 +03:00			`.Os`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh NAME`
			`.Nm what`
XPG4.2: * Add the -s (first identifier found only) flag. * Require at least one file operand; the standard does not permit reading from stdin in case none were given. * Recogize '\' as an additional identifier end character. * Make the exit status depend on whether any matches were found. 1999-02-23 01:23:09 +03:00			`.Nd search files for SCCS identifiers`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SYNOPSIS`
deprecate register, fix .Nm usage 1997-10-20 07:16:30 +04:00			`.Nm`
XPG4.2: * Add the -s (first identifier found only) flag. * Require at least one file operand; the standard does not permit reading from stdin in case none were given. * Recogize '\' as an additional identifier end character. * Make the exit status depend on whether any matches were found. 1999-02-23 01:23:09 +03:00			`.Op Fl s`
Whitespace cleanup. 2001-12-01 19:43:07 +03:00			`.Ar`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh DESCRIPTION`
XPG4.2: * Add the -s (first identifier found only) flag. * Require at least one file operand; the standard does not permit reading from stdin in case none were given. * Recogize '\' as an additional identifier end character. * Make the exit status depend on whether any matches were found. 1999-02-23 01:23:09 +03:00			`The`
deprecate register, fix .Nm usage 1997-10-20 07:16:30 +04:00			`.Nm`
XPG4.2: * Add the -s (first identifier found only) flag. * Require at least one file operand; the standard does not permit reading from stdin in case none were given. * Recogize '\' as an additional identifier end character. * Make the exit status depend on whether any matches were found. 1999-02-23 01:23:09 +03:00			`utility reads each`
			`.Ar file`
			`operand and searches for sequences of the form`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dq \&@(#)`
			`as inserted by the source code control system. It prints the remainder`
			`of the string following this marker, up to a null character, newline, double`
XPG4.2: * Add the -s (first identifier found only) flag. * Require at least one file operand; the standard does not permit reading from stdin in case none were given. * Recogize '\' as an additional identifier end character. * Make the exit status depend on whether any matches were found. 1999-02-23 01:23:09 +03:00			`quote, backslash or`
			`.Dq \&>`
			`character.`
			`.Pp`
			`If the`
			`.Fl s`
			`option is specified, only the first occurence of an idenfication string in`
			`each file is printed.`
For commands and utilities, use EXIT STATUS rather than RETURN VALUES or DIAGNOSTICS as appropriate (and documented in mdoc(7)). 2000-09-04 11:35:15 +04:00			`.Sh EXIT STATUS`
XPG4.2: * Add the -s (first identifier found only) flag. * Require at least one file operand; the standard does not permit reading from stdin in case none were given. * Recogize '\' as an additional identifier end character. * Make the exit status depend on whether any matches were found. 1999-02-23 01:23:09 +03:00			`The`
			`.Nm`
			`utility exits 0 if any matches were found, and 1 otherwise.`
			`.Sh STANDARDS`
			`The`
			`.Nm`
			`utility conforms to`
			`.St -xpg4.2 .`
Sort sections. 2001-12-08 22:24:57 +03:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`command appeared in`
			`.Bx 4.0 .`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh BUGS`
			`As`
			`.Bx`
			`is not licensed to distribute`
			`.Tn SCCS`
			`this is a rewrite of the`
deprecate register, fix .Nm usage 1997-10-20 07:16:30 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`command which is part of`
			`.Tn SCCS ,`
			`and may not behave exactly the same as that`
			`command does.`