freebsd-skq/usr.bin/what/what.1

.\" 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
.\"
.\" $FreeBSD$
.\"
.Dd December 14, 2006
.Dt WHAT 1
.Os
.Sh NAME
.Nm what
.Nd "show what versions of object modules were used to construct a file"
.Sh SYNOPSIS
.Nm
.Op Fl qs
.Op Ar
.Sh DESCRIPTION
The
.Nm
utility searches each specified
.Ar file
for sequences of the form
.Dq Li @(#)
as inserted by the
.Tn SCCS
source code control system.
It prints the remainder
of the string following this marker, up to a NUL character, newline, double
quote,
.Ql \&>
character, or backslash.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl q
Only output the match text, rather than formatting it.
.It Fl s
Stop searching each file after the first match.
.El
.Sh EXIT STATUS
Exit status is 0 if any matches were found, otherwise 1.
.Sh SEE ALSO
.Xr ident 1 ,
.Xr strings 1
.Sh STANDARDS
The
.Nm
utility conforms to
.St -p1003.1-2001 .
The
.Fl q
option is a non-standard
.Fx
extension which may not be available on other operating systems.
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.0 .
.Sh BUGS
This is a rewrite of the
.Tn SCCS
command of the same name,
and behavior may not be identical.
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" 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`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
Add a reference to ident(1). 1996-06-30 16:06:44 +00:00			`.\"`
Polish markup and wording. 2006-12-14 00:02:44 +00:00			`.Dd December 14, 2006`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt WHAT 1`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 14:16:33 +00:00			`.Os`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh NAME`
			`.Nm what`
Just forgot a moment that mdoc macros are limited to 9 parameters. Found by: Bruce. 1997-08-26 07:04:20 +00:00			`.Nd "show what versions of object modules were used to construct a file"`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh SYNOPSIS`
Make compatible with standard what command: Implement -s option Keep going if a file is not found Append ':' to printed filenames Include backslash in terminal characters Make exit status dependent on a match having been found Revise manpage accordingly 1998-05-04 22:26:56 +00:00			`.Nm`
Add a flag (-q) which prints no header for the file and which doesn't indent the match text; it also doesn't warn() for files which can't be opened. Remove global variables. Use bool. fopen(3) the files instead of freopen(3)ing stdin. 2005-05-12 18:57:37 +00:00			`.Op Fl qs`
mdoc(7) police: markup polishing. Approved by: re 2002-11-26 17:33:37 +00:00			`.Op Ar`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh DESCRIPTION`
Make compatible with standard what command: Implement -s option Keep going if a file is not found Append ':' to printed filenames Include backslash in terminal characters Make exit status dependent on a match having been found Revise manpage accordingly 1998-05-04 22:26:56 +00:00			`The`
			`.Nm`
			`utility searches each specified`
			`.Ar file`
			`for sequences of the form`
Polish markup and wording. 2006-12-14 00:02:44 +00:00			`.Dq Li @(#)`
			`as inserted by the`
			`.Tn SCCS`
			`source code control system.`
Mechanically kill hard sentence breaks. 2004-07-02 22:22:35 +00:00			`It prints the remainder`
Make compatible with standard what command: Implement -s option Keep going if a file is not found Append ':' to printed filenames Include backslash in terminal characters Make exit status dependent on a match having been found Revise manpage accordingly 1998-05-04 22:26:56 +00:00			`of the string following this marker, up to a NUL character, newline, double`
			`quote,`
Polish markup and wording. 2006-12-14 00:02:44 +00:00			`.Ql \&>`
Make compatible with standard what command: Implement -s option Keep going if a file is not found Append ':' to printed filenames Include backslash in terminal characters Make exit status dependent on a match having been found Revise manpage accordingly 1998-05-04 22:26:56 +00:00			`character, or backslash.`
			`.Pp`
Polish markup and wording. 2006-12-14 00:02:44 +00:00			`The following options are available:`
			`.Bl -tag -width indent`
Add a flag (-q) which prints no header for the file and which doesn't indent the match text; it also doesn't warn() for files which can't be opened. Remove global variables. Use bool. fopen(3) the files instead of freopen(3)ing stdin. 2005-05-12 18:57:37 +00:00			`.It Fl q`
			`Only output the match text, rather than formatting it.`
Make compatible with standard what command: Implement -s option Keep going if a file is not found Append ':' to printed filenames Include backslash in terminal characters Make exit status dependent on a match having been found Revise manpage accordingly 1998-05-04 22:26:56 +00:00			`.It Fl s`
			`Stop searching each file after the first match.`
			`.El`
Added the EXIT STATUS section where appropriate. 2005-01-17 07:44:44 +00:00			`.Sh EXIT STATUS`
Make compatible with standard what command: Implement -s option Keep going if a file is not found Append ':' to printed filenames Include backslash in terminal characters Make exit status dependent on a match having been found Revise manpage accordingly 1998-05-04 22:26:56 +00:00			`Exit status is 0 if any matches were found, otherwise 1.`
Add a reference to ident(1). 1996-06-30 16:06:44 +00:00			`.Sh SEE ALSO`
add strings(1) to what(1) "SEE ALSO" PR: 6289 Reviewed by: phk Submitted by: Josh Gilliam <josh@quick.net> 1998-04-14 06:31:23 +00:00			`.Xr ident 1 ,`
			`.Xr strings 1`
Document standards conformance. 2002-05-29 13:45:16 +00:00			`.Sh STANDARDS`
			`The`
			`.Nm`
			`utility conforms to`
			`.St -p1003.1-2001 .`
Add a flag (-q) which prints no header for the file and which doesn't indent the match text; it also doesn't warn() for files which can't be opened. Remove global variables. Use bool. fopen(3) the files instead of freopen(3)ing stdin. 2005-05-12 18:57:37 +00:00			`The`
			`.Fl q`
			`option is a non-standard`
			`.Fx`
			`extension which may not be available on other operating systems.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`command appeared in`
			`.Bx 4.0 .`
style(9): Sort sections correctly, exit status info into DIAGNOSTICS section. 2002-05-29 13:39:34 +00:00			`.Sh BUGS`
			`This is a rewrite of the`
			`.Tn SCCS`
			`command of the same name,`
			`and behavior may not be identical.`