1.\" $NetBSD: getNAME.8,v 1.12 2008/05/29 14:51:25 mrg Exp $ 2.\" 3.\" Copyright (c) 1997 Matthew R. Green 4.\" 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.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 20.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 21.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 22.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 23.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.Dd October 31, 1997 28.Dt GETNAME 8 29.Os 30.Sh NAME 31.Nm getNAME 32.Nd "get NAME sections from manual source for whatis/apropos data base" 33.Sh SYNOPSIS 34.Nm 35.Op Fl itvw 36.Ar path Op Ar path ... 37.Sh DESCRIPTION 38The 39.Nm 40utility looks inside manual page sources to find the name of the page. 41It can be used to create a table of contents, report the style of manual, 42or to create an introductory manual page. 43By default, 44.Nm 45returns data for use in an 46.Xr apropos 1 47database. 48.Nm 49is designed to be called from manual grovelling tools, not to be used directly. 50.Pp 51Historically, 52.Xr makewhatis 8 53used to use 54.Nm 55to get manpage names, but that's no longer the case. 56.Sh OPTIONS 57The following options are available: 58.Bl -tag -width Ds 59.It Fl i 60Print information useful in creating an introduction manual. 61See 62.Xr intro 1 , 63.Xr intro 2 , 64etc. for examples. 65.It Fl t 66Print information useful for creating a table of contents. 67.It Fl v 68Complain about incorrectly formatted man pages. 69.It Fl w 70Print information whether the manpage uses traditional man 71.Pq Dq OLD , 72new mandoc 73.Pq Dq NEW , 74or some unknown 75.Pq Dq UNKNOWN 76macros. 77.El 78.Sh SEE ALSO 79.Xr man 1 , 80.Xr catman 8 , 81.Xr makewhatis 8 82.Sh HISTORY 83The 84.Nm 85command first appeared in 86.Bx 2.0 . 87.Sh BUGS 88It would be nice if 89.Nm 90could deal with compressed and/or preformatted manual pages. 91Looks for .S[Hh] NAME for consistency checking, but that breaks man pages 92in other languages. 93