indexfolder(8) BSD System Manager's Manual indexfolder(8)
NAME
indexfolder - Invoke content indexing
SYNOPSIS
indexfolder [-v] [folder]
DESCRIPTION
indexfolder queues a task to create a content index for the specified
folder.
-v Displays the version of the tool and exits
folder The absolute or relative path to the folder to be indexed
When invoked with no arguments, indexfolder displays a usage summary and
exits.
Content indexing is normally done via the Finder's Get Info menu item.
The indexfolder tool provides an alternate means of creating or updating
a content index for a specified folder.
CONSTRAINTS
On a headless system, the indexfolder tool must be run as root.
The content indexing mechanism takes precautions to avoid exposing the
content of a folder beyond what file and folder permissions already
expose. Therefore, the indexfolder tool must run with the same effective
userid as the owner of the folder to be indexed, otherwise it will not
create or update an index. Any files in the folder not owned by that
effective userid will be ignored by the content indexing. These con-
straints apply even if a user otherwise has write permission on the
folder or read permission on the files based on group ownership.
OTHER NOTES
Although the indexfolder tool is a command-line tool, its operation is
affected by the login window. If nobody is logged in at the login window,
the tool must be run as root. If an administrator is logged in at the
login window, the tool must be run as that administrator. Attempts to do
otherwise will cause the tool to fail with messages similar to the fol-
lowing:
kCGErrorIllegalArgument : initCGDisplayState: cannot map display interlocks.
kCGErrorIllegalArgument : CGSNewConnection cannot get connection port
If the tool fails to create or update an index due to folder ownership,
or fails to add any content to an index due to file ownership, it gives
no notification of its failure.
Whether done from the Finder or the indexfolder tool, the content index-
ing operation creates a file named ".FBCIndex" either in the folder to be
indexed or in one of its parent folders.
FILES & FOLDERS
*/.FBCIndex
Mac OS X Server 7 July 2002 Mac OS X Server
Mac OS X 10.3 Server - Generated Sat Jun 14 10:27:01 CDT 2008