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).

XCODEINDEX(1)             BSD General Commands Manual            XCODEINDEX(1)

NAME
     xcodeindex -- indexes Xcode projects

SYNOPSIS
     xcodeindex [-project projectname] [-quiet] [-loglevel level] [indexaction ...]
     xcodeindex -help

DESCRIPTION
     xcodeindex indexes an Xcode project.

   Usage
     Run xcodeindex from the directory containing your project (i.e. the directory containing the
     projectname.xcode package). If you have multiple projects in the this directory you will need to use
     -project to indicate which project should be indexed.

     By default, xcodeindex updates the project index if it exists, otherwise it creates a new index.

   Options
     -project projectname
           Index the project specified by projectname.  Required if there are multiple project files in the
           same directory.

     -quiet
           Supresses all logging while indexing.

     -loglevel level
           Turns on varying degrees of indexing debugging. The level range is from zero to six, enabling a
           staggered number of the existing indexing defaults for the indexer. If an option greater than six
           is used, then the maximum level of logging is enabled. The logging levels are defined as:

           0           No logging

           1           Prints the name of the file being indexed. This is the default logging level.

           2           File processing output

           3           Symbol updating output

           4           Symbol insertion and creation output

           5           Parser basic output

           6           Parser error output
           The levels are inclusive (thus enabling log level 4 would also automatically include levels 1, 2,
           and 3).  Output from higher logging levels than the default (level 1) is not expected to be use-ful useful
           ful for most developers, but could be valuable in troubleshooting cases where there is a problem
           with indexing a particular Xcode project.

     indexaction ...
           Specify an index action (or actions) to perform on the project. Available build actions are:

           clean       Removes the index for the project.

           build       Updates the index for the project, creating it if necessary. This is the default
                       index action.

           stats       Prints the statistics for the index (number of classes, etc)

           dump        Dumps a tab-delimited format of the index (for major symbols - classes, methods, etc)
                       to stdout

     -help
           Displays usage information for xcodeindex.

EXAMPLES
     xcodeindex clean

             Cleans the index.

     xcodeindex -project FirstProject -project SecondProject -project ThirdProject -quiet

             Indexes three projects and suppresses all logging.

Mac OS X                        April 30, 2004                        Mac OS X