summaryrefslogtreecommitdiff
path: root/libexec/getNAME/getNAME.8
diff options
context:
space:
mode:
authorTodd C. Miller <millert@cvs.openbsd.org>1997-11-13 04:15:28 +0000
committerTodd C. Miller <millert@cvs.openbsd.org>1997-11-13 04:15:28 +0000
commit373e68caa1478a8393ed8bcca3fccd67dd69d98c (patch)
treede027230a2508da7402ca6c50573356d5fe46e59 /libexec/getNAME/getNAME.8
parentdd23b68005df91269d7997a47d250602d06cd57a (diff)
Changes from NetBSD (mrg):
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... OpenBSD changes: use basename(3) instead of doing a half-hearted job inline. use strncat(3) because I am anal.
Diffstat (limited to 'libexec/getNAME/getNAME.8')
-rw-r--r--libexec/getNAME/getNAME.890
1 files changed, 90 insertions, 0 deletions
diff --git a/libexec/getNAME/getNAME.8 b/libexec/getNAME/getNAME.8
new file mode 100644
index 00000000000..04e4c69d3e8
--- /dev/null
+++ b/libexec/getNAME/getNAME.8
@@ -0,0 +1,90 @@
+.\" $NetBSD: getNAME.8,v 1.2.2.1 1997/11/10 19:54:39 thorpej 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.
+.\" 3. The name of the author may not be used to endorse or promote products
+.\" derived from this software without specific prior written permission.
+.\"
+.\" 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 NetBSD
+.Sh NAME
+.Nm getNAME
+.Nd get NAME sections from manual source for whatis/apropos data base
+.Sh SYNOPSIS
+.Nm ""
+.Op Fl itw
+.Ar path Op Ar path ...
+.Sh DESCRIPTION
+The
+.Nm
+program looks inside manual sources to find the name and of the manual.
+It can be used to create a table of contents, report the style of manual,
+or to create an introduction manual. By default,
+.Nm
+returns data for use in an
+.Xr apropos 1
+database.
+.Nm
+is designed to be called from
+.Xr makewhatis 8
+or other manual grovelling tools, not to be used directly.
+.Sh OPTIONS
+The following options are available:
+.Bl -tag -width Ds
+.It Fl i
+The
+.Fl i
+option returns information useful in creating an introduction manual. See
+.Xr intro 1 ,
+.Xr intro 2 ,
+etc. for examples.
+.It Fl t
+The
+.Fl t
+option returns information useful for creating a table of contents.
+.It Fl w
+The
+.Fl w
+option determines whether traditional man
+.Pq Dq OLD ,
+new mandoc
+.Pq Dq NEW ,
+or some unknown
+.Pq Dq UNKNOWN
+format exists.
+.El
+.Sh HISTORY
+The
+.Nm
+command first appeared
+.Bx 2.0
+.Sh BUGS
+It would be nice if
+.Nm
+could deal with preformatted manuals.
+.Sh SEE ALSO
+.Xr man 1 ,
+.Xr catman 8 ,
+.Xr makewhatis 8