NetBSD/libexec/getNAME/getNAME.8

.\"	$NetBSD: getNAME.8,v 1.12 2008/05/29 14:51:25 mrg Exp $
.\"
.\" Copyright (c) 1997 Matthew R. Green
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
.\"
.Dd October 31, 1997
.Dt GETNAME 8
.Os
.Sh NAME
.Nm getNAME
.Nd "get NAME sections from manual source for whatis/apropos data base"
.Sh SYNOPSIS
.Nm
.Op Fl itvw
.Ar path Op Ar path ...
.Sh DESCRIPTION
The
.Nm
utility looks inside manual page sources to find the name of the page.
It can be used to create a table of contents, report the style of manual,
or to create an introductory manual page.
By default,
.Nm
returns data for use in an
.Xr apropos 1
database.
.Nm
is designed to be called from manual grovelling tools, not to be used directly.
.Pp
Historically,
.Xr makewhatis 8
used to use
.Nm
to get manpage names, but that's no longer the case.
.Sh OPTIONS
The following options are available:
.Bl -tag -width Ds
.It Fl i
Print information useful in creating an introduction manual.
See
.Xr intro 1 ,
.Xr intro 2 ,
etc. for examples.
.It Fl t
Print information useful for creating a table of contents.
.It Fl v
Complain about incorrectly formatted man pages.
.It Fl w
Print information whether the manpage uses traditional man
.Pq Dq OLD ,
new mandoc
.Pq Dq NEW ,
or some unknown
.Pq Dq UNKNOWN
macros.
.El
.Sh SEE ALSO
.Xr man 1 ,
.Xr catman 8 ,
.Xr makewhatis 8
.Sh HISTORY
The
.Nm
command first appeared in
.Bx 2.0 .
.Sh BUGS
It would be nice if
.Nm
could deal with compressed and/or preformatted manual pages.
Looks for .S[Hh] NAME for consistency checking, but that breaks man pages
in other languages.
remove clause #3 from my license where there are no other copyright holders involved. 2008-05-29 18:51:25 +04:00			`.\" $NetBSD: getNAME.8,v 1.12 2008/05/29 14:51:25 mrg Exp $`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`.\"`
			`.\" Copyright (c) 1997 Matthew R. Green`
			`.\" 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.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.`
			`.\"`
			`.Dd October 31, 1997`
			`.Dt GETNAME 8`
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:25:43 +03:00			`.Os`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`.Sh NAME`
			`.Nm getNAME`
Don't pass so many args to .Nd macro. It just overflows. 1999-11-19 04:12:39 +03:00			`.Nd "get NAME sections from manual source for whatis/apropos data base"`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`.Sh SYNOPSIS`
.Nm does not need a dummy argument ("") before punctuation or for correct formatting of the SYNOPSIS any longer. 2003-02-25 13:34:36 +03:00			`.Nm`
From chopps: be more picky about handling incorrectly formatted man pages. Look for .Sh NAME; this breaks internationalized man pages. Someone could put NLS support for it. 1998-05-22 03:21:48 +04:00			`.Op Fl itvw`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`.Ar path Op Ar path ...`
			`.Sh DESCRIPTION`
			`The`
			`.Nm`
edit a bit, and bewail inability to handle compressed manpages 1997-12-04 09:41:42 +03:00			`utility looks inside manual page sources to find the name of the page.`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`It can be used to create a table of contents, report the style of manual,`
Begin new sentences on new lines. Patch from Robert Elz (kre at munnari oz au). 2002-09-29 18:05:52 +04:00			`or to create an introductory manual page.`
			`By default,`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`.Nm`
			`returns data for use in an`
			`.Xr apropos 1`
			`database.`
			`.Nm`
makewhatis(8) doesn't use getNAME(8) nowadays 2002-03-08 23:40:00 +03:00			`is designed to be called from manual grovelling tools, not to be used directly.`
			`.Pp`
			`Historically,`
* use (``foo'') instead of (<em>foo</em>) * order SEE ALSO on man section then alphabetical * add -w to usage string * deprecate register * minor code move in newman section, to follow style of oldman section 1997-11-02 03:23:36 +03:00			`.Xr makewhatis 8`
makewhatis(8) doesn't use getNAME(8) nowadays 2002-03-08 23:40:00 +03:00			`used to use`
			`.Nm`
			`to get manpage names, but that's no longer the case.`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`.Sh OPTIONS`
			`The following options are available:`
Whitespace nits, sort sections, end sentences with dots. 2002-01-15 05:21:13 +03:00			`.Bl -tag -width Ds`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`.It Fl i`
Begin new sentences on new lines. Patch from Robert Elz (kre at munnari oz au). 2002-09-29 18:05:52 +04:00			`Print information useful in creating an introduction manual.`
			`See`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`.Xr intro 1 ,`
			`.Xr intro 2 ,`
			`etc. for examples.`
			`.It Fl t`
improve description of options - particularily, avoid repeating the option in the description, and use 'print' instead of 'returns' or 'determines' 2002-03-08 23:59:08 +03:00			`Print information useful for creating a table of contents.`
From chopps: be more picky about handling incorrectly formatted man pages. Look for .Sh NAME; this breaks internationalized man pages. Someone could put NLS support for it. 1998-05-22 03:21:48 +04:00			`.It Fl v`
			`Complain about incorrectly formatted man pages.`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`.It Fl w`
improve description of options - particularily, avoid repeating the option in the description, and use 'print' instead of 'returns' or 'determines' 2002-03-08 23:59:08 +03:00			`Print information whether the manpage uses traditional man`
* use (``foo'') instead of (<em>foo</em>) * order SEE ALSO on man section then alphabetical * add -w to usage string * deprecate register * minor code move in newman section, to follow style of oldman section 1997-11-02 03:23:36 +03:00			`.Pq Dq OLD ,`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`new mandoc`
* use (``foo'') instead of (<em>foo</em>) * order SEE ALSO on man section then alphabetical * add -w to usage string * deprecate register * minor code move in newman section, to follow style of oldman section 1997-11-02 03:23:36 +03:00			`.Pq Dq NEW ,`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`or some unknown`
* use (``foo'') instead of (<em>foo</em>) * order SEE ALSO on man section then alphabetical * add -w to usage string * deprecate register * minor code move in newman section, to follow style of oldman section 1997-11-02 03:23:36 +03:00			`.Pq Dq UNKNOWN`
improve description of options - particularily, avoid repeating the option in the description, and use 'print' instead of 'returns' or 'determines' 2002-03-08 23:59:08 +03:00			`macros.`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`.El`
Whitespace nits, sort sections, end sentences with dots. 2002-01-15 05:21:13 +03:00			`.Sh SEE ALSO`
			`.Xr man 1 ,`
			`.Xr catman 8 ,`
			`.Xr makewhatis 8`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`.Sh HISTORY`
			`The`
			`.Nm`
edit a bit, and bewail inability to handle compressed manpages 1997-12-04 09:41:42 +03:00			`command first appeared in`
Whitespace nits, sort sections, end sentences with dots. 2002-01-15 05:21:13 +03:00			`.Bx 2.0 .`
add a manual for getNAME. also, change the `default' output to be in a form much more useful for an apropos(1) database. this will be used by makewhatis(1) to generate the whatis.db file's now... 1997-11-01 18:03:51 +03:00			`.Sh BUGS`
			`It would be nice if`
			`.Nm`
edit a bit, and bewail inability to handle compressed manpages 1997-12-04 09:41:42 +03:00			`could deal with compressed and/or preformatted manual pages.`
From chopps: be more picky about handling incorrectly formatted man pages. Look for .Sh NAME; this breaks internationalized man pages. Someone could put NLS support for it. 1998-05-22 03:21:48 +04:00			`Looks for .S[Hh] NAME for consistency checking, but that breaks man pages`
			`in other languages.`