man/man5/whatis.5

   1 .TH WHATIS 5
   2 .SH NAME
   3 whatis \- database of online manual pages
   4 .SH SYNOPSIS
   5 .B /usr/man/*/whatis
   6 .br
   7 .B /usr/man/whatis
   8 .SH DESCRIPTION
   9 The
  10 .B whatis
  11 file in each manual page directory is a database of titles for manual pages.
  12 This database is used by
  13 .BR man (1)
  14 to map titles to manual pages names.  The database is created by
  15 .BR makewhatis (1)
  16 from the NAME sections of the manual pages.
  17 .PP
  18 The NAME secions must be simple lines with no troff fluff but one
  19 backslash like these two:
  20 .PP
  21 .RS
  22 whatis \e\- database of online manual pages
  23 .br
  24 cawf, nroff \e\- C version of the nroff-like, Amazingly Workable (text)
  25 Formatter
  26 .RE
  27 .PP
  28 These lines are transformed by
  29 .B makewhatis
  30 to these two lines for the database:
  31 .PP
  32 .RS
  33 cawf, nroff (1) \- C version of the nroff-like, Amazingly Workable (text)
  34 Formatter
  35 .br
  36 whatis (5) \- database of online manual pages
  37 .RE
  38 .PP
  39 As you can see they are in section number order, so that
  40 .B man
  41 searches them in section order.
  42 .PP
  43 Each entry is just a single line, restricting the NAME section to a single
  44 line too with just one dash, and commas and spaces before the dash as you
  45 see above.
  46 .SH "SEE ALSO"
  47 .BR man (1),
  48 .BR whatis (1),
  49 .BR makewhatis (1),
  50 .BR man (7).
  51 .SH BUGS
  52 It seems to be impossible for many manual page writers to keep the NAME
  53 section simple.  They also like to use every font available in their
  54 documents.  My simple scripts can't read their NAME sections, my simple
  55 me can't read their texts.
  56 .SH AUTHOR
  57 Kees J. Bot (kjb@cs.vu.nl)