This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

This manual page is associated with the Mac OS X developer tools. The software or headers described may not be present on your Mac OS X installation until you install the developer tools package. This package is available on your Mac OS X installation DVD, and the latest versions can be downloaded from developer.apple.com.

For more information about the manual page format, see the manual page for manpages(5).

HEADERDOC2HTML(1)         BSD General Commands Manual        HEADERDOC2HTML(1)

NAME
     headerdoc2html -- header documentation processor

SYNOPSIS
     headerdoc2html [-HXdhquvx] [-o output_dir] file [file ...]

DESCRIPTION
     Headerdoc2html processes the header file or files and generates HTML documentation based on specially-formatted speciallyformatted
     formatted comments.

     The options are as follows:

     -H    The -H option turns on inclusion of the htmlHeader line, as specified in the config file.

     -X    The -X option switches from HTML to XML output

     -d    The -d option turns on extra debugging output.

     -h    The -h option causes headerdoc to output an XML file containing metadata about the resulting doc-ument. document.
           ument.

     -p    The -p option turns on the C preprocessor.

     -q    The -q option causes headerdoc to be excessively quiet.

     -u    The -u option causes headerdoc to produce unsorted output.

     -v    The -v option causes headerdoc to print version information.

     -x    The -x option causes headerdoc to export fils in a format suitable for inclusion in a database.

     If no options are specified, headerdoc will produce directories containing its standard HTML output.

FILES
     /$HOME/Library/Preferences/com.apple.headerDoc2HTML.config

SEE ALSO
     gatherheaderdoc(1)

     For more information, see the headerdoc documentation.  It can be found in
     /Developer/Documentation/DeveloperTools if you have the developer tools package installed, or at
     http://developer.apple.com in the developer tools documentation section.

Darwin                           June 13, 2003                          Darwin