.\" Automatically generated from mdocxml
.Dd May 27, 2010
.Dt "RESOLVELINKS" 1
.Os "Darwin" ""
.Sh NAME
.Nm resolveLinks
.Nd Resolves link requests \&in collections \&of HTML files
.Sh SYNOPSIS
.Nm
.Op Fl \&a
.Op Fl \&b  Ar basepath
.Op Fl \&d  Ar debugflags
.Op Fl \&D
.Op Fl \&h
.Op Fl \&i  Ar installpath
.Op Fl \&n
.Op Fl \&N
.Op Fl \&P
.Op Fl \&r  Ar refanchorprefix
.Op Fl \&s  Ar seedfile
.Op Fl \&S  Ar seedfilebasepath
.Op Fl \&t  Ar nthreads
.Op Fl \&x  Ar xreffile
.Ar directory
.Sh OPTIONS
The available options are as follows:
.Bl -tag -width XXXXXXXXXX
.It Fl \&a
Treat external (seeded) paths \&as absolute.  \&If passed after \&a 
.Fl \&s
argument, modifies that argument.  \&If passed before any 
.Fl \&s
arguments, modifies all seed files.  This may \&be specified multiple times.
.It Fl \&b 
Base path. Paths \&in 
.Fl \&x
output file are generated relative \&to this path.  \&If this ends with \&a trailing \&/, 
.Sy resolveLinks
assumes that the contents \&of the specified directory will \&be installed \&in the location specified \&by the 
.Fl \&i
flag.  Otherwise, \&it \&is assumed that the directory itself will \&be installed there.  (The \&cp command behaves similarly.)  \&If unspecified, defaults \&to \&/.
.It Fl \&d 
Sets debug flags (bitmask).
.It Fl \&D
Disables dot printing (for cleaner debugging).
.It Fl \&h
Prints \&a usage summary.
.It Fl \&i 
Location where this directory will eventually \&be installed.  Used for generating relative paths for external (seeded) paths.  \&If unspecified, the value \&of the 
.Fl \&b
flag \&is used.
.It Fl \&n
Disables all file writes (except for the seed output file).
.It Fl \&N
Disables name-based matching (normally used for unknown symbol names \&in user-entered link requests).  Disabling this matching can provide \&a performance gain for large doc trees.
.It Fl \&P
Disables partial matching.  Disabling this matching can provide \&a performance gain for large doc trees.
.It Fl \&r 
Additional reference anchor prefix.  The default, "apple_ref", \&is always active; \&if you use something else, add \&a 
.Fl \&r
option.  This may \&be specified multiple times.
.It Fl \&s 
\&A seed file generated \&by the 
.Fl \&x
option from \&a previous run \&of the tool.  Used \&to add additional external cross references from other folders.  This may \&be passed multiple times.
.It Fl \&S 
\&A base path prepended \&to the immediate previous seed file for path purposes.  This may \&be passed multiple times (once per seed file).
.It Fl \&t 
The number \&of threads \&to use during resolution.  Default \&is 2.
.It Fl \&x 
\&An output cross-reference file.  You can pass this file \&to future runs \&of the tool \&by using the 
.Fl \&s
flag.
.It Ar "directory"
the directory \&to \&be processed.
.El
.Sh ENVIRONMENT
This program \&is \&a helper tool that \&is usually run \&by the 
.Nm gatherHeaderDoc
tool \&to generate links within HeaderDoc output.  Although \&it \&is usually not run directly, \&it can \&be useful \&to \&do \&so when linking together multiple documentation sets \&in \&an installed set.
.Pp
.Sh SEE ALSO
For more information \&on gatherHeaderDoc and HeaderDoc, see 
.Xr headerdoc2html 1  
and 
.Xr gatherheaderdoc 1 . 
.Pp