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