Adding documents to the help system

Man index files

The man directory also contains the man index file.

Man index files map command names to actual man page files. This permits a single man page file to cover multiple command names, all accessible through the man(1) command.

The format of the man index files is a sequence of records, one per line:

name filename section

name: a name the user looks up using the man command
filename: the name of the man page file describing that name (without the man section suffix)
section: the man section suffix that contains the man page

Here is a small sample:

   .
   .
   .
   FillSpans FillSpans D3nfb
   FsTable FsTable 4
   Grades Grades 4bnu
   HeightMMOfScreen BlackPixelOfScreen X3xlib
   HeightOfScreen BlackPixelOfScreen X3xlib
   .
   .
   .

NOTE: The last two lines map specific function names to the same man page BlackPixelOfScreen.X3xlib.html in the html.X3xlib man page subdirectory.