.TH HTMLLinker 1 "August 16, 2009" "GNUstep" "GNUstep System Manual"

.SH NAME
HTMLLinker \- tool to fix up href references in HTML files

.SH SYNOPSIS
.B HTMLLinker
.RI [ options ]
.I input files
[
.B -l
.I relocation file
]
[
.B -d
.I destination file
]
.br

.SH DESCRIPTION
.B HTMLLinker
is a tool to fix href references in HTML files, typically API
reference manuals generated by extracting the docstrings from source
code by tools such as
.BR autogsdoc (1).
.PP
.B HTMLLinker
accepts the following options (multiple
.I input files\fR,\fR
.I -l
and
.I -d
options are allowed):

.SH OPTIONS
.TP
.B --help
Prints a short list of available options.
.TP
.B --version
Displays version information.
.TP
.B --verbose
Prints additional information while processing.
.TP
.BI -Warn " [YES|NO]"
Print additional information about unresolved links.
.TP
.BI -LinksMarker " [xxx]"
Only fix links with attribute \fBrel\fR=\fIxxx\fR
.TP
.B -FixupAllLinks YES
Attempt to fix all links (not only those that are marked with
\fI-LinksMarker\fR.
.TP
.B -PathMappingsFile \fIfile\fR
Read the relocation mappings from
.I file
(in dictionary format).
.TP
.B -PathMappings '{"\fIpath\fR\fB"="\fR\fIanother_path\fR\fB";}'\fR
Use the specified path mappings.
.TP
.BI -BuildRelocationFileForDir " dir"
Build a relocation file for the directory
.I dir
and save it into \fIdir\fR/table.htmlink.  This option is special and
prevents any other processing by the linker.

.SH SEE ALSO
.BR autogsdoc (1),
.BR GNUstep (7).

.SH AUTHORS
.B HTMLLinker
was written by Nicola Pero <nicola@brainstorm.co.uk>.
.P
This manual page was added by Yavor Doganov <yavor@gnu.org>.

.SH COPYRIGHT
Copyright (C) 2009 Free Software Foundation, Inc.
.P
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.