*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->OpenBSD man pages -> getNAME (8)              



NAME    [Toc]    [Back]

     getNAME  -  get  NAME  sections  from  manual   source   for
whatis/apropos data

SYNOPSIS    [Toc]    [Back]

     getNAME [-itw] path [path ...]

DESCRIPTION    [Toc]    [Back]

     The  getNAME program looks inside manual sources to retrieve
the NAME section
 of the manual page.  It can be used to create  a  table
of contents,
     report  the style of manual, or to create an introduction to
the manual
     section.  By default, getNAME returns data  for  use  in  an
     database.   getNAME  is  designed  to  be  called from makewhatis(8) or other
     manual grovelling tools, not to be used directly.

     The options are as follows:

     -i      Returns information useful in creating an  introduction to a manual
  section.  See intro(1), intro(2), etc. for examples.

     -t      Returns information useful for creating a  table  of

     -w       Determines  whether  traditional man (``OLD''), new
             (``NEW''), or some unknown (``UNKNOWN'') format  exists.

SEE ALSO    [Toc]    [Back]

     apropos(1), man(1), whatis(1), makewhatis(8)

HISTORY    [Toc]    [Back]

     The getNAME command first appeared in 2.0BSD.

BUGS    [Toc]    [Back]

     It  would  be  nice  if getNAME could deal with preformatted

OpenBSD     3.6                        October      31,      1997
[ Back ]
 Similar pages
Name OS Title
makewhatis IRIX make manual page "whatis" database for use with apropos
getNAME FreeBSD get name sections from manual pages
sdoc FreeBSD guide to adding security considerations sections to manual pages
c2man Linux generate manual pages from C source code
whereis IRIX locate source, binary, and or manual for program
whereis HP-UX locate source, binary, and/or manual for program
whereis Linux locate the binary, source, and manual page files for a command
man HP-UX find manual information by keywords; print out a manual entry
protocols HP-UX protocol name data base
protocols FreeBSD protocol name data base
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service