PBHELPINDEXER(1)          BSD General Commands Manual         PBHELPINDEXER(1)

NAME
     pbhelpindexer -- index installed HTML documentation for Mac OS X devel-
     oper tools

SYNOPSIS
     pbhelpindexer [-h] [-d] [-m sectionList] [-i lprojDesignations]
                   [-l pbhelpindexloaderpath] [-p plistfolderpath]
                   [-o outputroot]

DESCRIPTION
     pbhelpindexer indexes the installed HTML documentation for Mac OS X
     developer tools, letting Xcode find the appropriate excerpt for a given
     symbol. Since this script must write an index to a location not normally
     writable by the user, it must be run with administrator privileges
     (either as root or using sudo ).

   Options
     -h    Print a help message and exit.

     -d    Output diagnostic messages to /tmp/pbhelpindexer.debug.

     -m sectionList
           Comma separated list of man sections to index, or 'none' to turn
           off man indexing.  Default is '2,3'.

     -i lprojDesignations
           Comma separated list of localization identifiers. The identifiers
           are concatenated with '.lproj' to determine which documentation
           localizations to index. By default, all lproj folders are indexed.

     -l pbhelpindexloaderpath
           Use pbhelpindexloaderpath as the path to the pbhelpindexloader
           binary to use for indexing.  If this flag is not provided, then
           /Developer/Private/pbhelpindexloader will be used.

     -p plistfolderpath
           Use plistfolderpath as the path to the plist folder to use for
           indexing.  If this flag is not provided, then /Developer/ADC
           Reference Library/indexes will be used.

     -o outputroot
           Use outputroot as the output directory for the help index gener-
           ated.  If this flag is not provided, then /Developer/ADC Reference
           Library/indexes will be used.

EXAMPLES
     sudo pbhelpindexer

             Regenerate API index on local machine.

     sudo pbhelpindexer -l
             "/Volumes/buildServer/Developer/Private/pbhelpindexloader" -p
             "/Volumes/buildServer/Developer/ADC Reference Library/indexes" -o
             "/Volumes/buildRoot/Developer/ADC Reference Library/indexes"

             Create index given plist and loader on one machine and destina-
             tion on another machine.

     sudo pbhelpindexer -i en -l
             "/Volumes/buildServer/Developer/Private/pbhelpindexloader" -p
             "/Volumes/buildServer/Developer/ADC Reference Library/indexes" -o
             "/Volumes/buildRoot/Developer/ADC Reference Library/indexes"

             The same as the previous command, but skip all localizations
             except those in a folder named 'en.lproj'.

Mac OS X                        August 26, 2004                       Mac OS X