NAME

     htmlman.csh - UNIX C shell script to create HTML man pages

SYNOPSIS

     htmlman.csh <options> [directory]

OPTIONS

     By default, htmlman.csh will generate  the  HTML  man  pages
     from  formatted  man  pages  (cat) and create the index.html
     file. Additional options can be added as:
       -u only update index.html
       -c create the HTML pages only
       -h print this help message
       directory : the directory to work on

DESCRIPTION

     htmlman.csh(1) is a driver to the man2html(1) Perl script by
     checking  all  the  formatted  man pages, and generating the
     corresponding HTML pages when applicable.   The  HTML  pages
     will  be  put in html* directory, correspoing to cat*.  Only
     independent man pages will have a corresponding  HTML  page,
     therefore symbolic links will not cause repeated generation.

     By default, htmlman.csh(1) will also generate an  index.html
     file, which is an index to the HTML files in the correspond-
     ing html directories. The index.html file also  has  entries
     for the symbolic links in the cat* direcory. For example, if
     there is a page called "fft_transform.3" in the cat3  direc-
     tory    and    a   symbolic   link   "fft.3"   pointing   to
     "fft_transform.3",  there  will  be   an   HTML   page   for
     "fft_transform.3"  in the html3 direcory, but there won't be
     such a page for "fft.3". However, there will be entries  for
     both "fft" and "fft_transform" in the index.html file.

     htmlman.csh(1) uses the windex file generated by  catman(1M)
     or dogman.csh(1) to create index.html.  It is recommended to
     run dogman.csh(1) and then htmlman.csh(1) after changing  or
     adding  any man pages to both verify and enhance the usabil-
     ity of the man pages.

EXAMPLES

     htmlman.csh
      The above command generates  the  HTML  pages  and  creates
     index.html in the current directory

FILES

     $CVIPHOME/docs/Scripts/htmlman.csh

DIAGNOSTICS

     Look at the error messages generated

NOTES

     @  and  %  characters  are  used  for  special  purpose   in
     htmlman.csh. Avoid using these characters in NAME section of
     the man pages.

BUGS

     NONE

SEE ALSO

     dogman.csh(1), perl(1), man2html(1)

AUTHOR

     Copyright (C) 1996 SIUE - by Scott E. Umbaugh  and  Yansheng
     Wei.