Section: HTML-XML-utils (1)
Updated: 10 Jul 2011Index
Return to Main Contents
hxincl - expand included HTML or XML files
[ -G ]
[ file-or-URL ]
command copies an HTML or XML file to standard output, looking for
comments with a certain structure. Such a comment is replaced by
the file whose name is given as the attribute of the directive. For
...<!-- include "foo.html" -->...
will be replaced by the content of the file foo.html.
The comment is replaced by
<!-- begin-include "foo.html" -->
before the included text and
<!-- end-include "foo.html" -->
after it. These comments make it possible to run
on the resulting file again to update the inclusions.
Single quotes are allowed instead of double quotes. And if the file
name contains no spaces, the quotes may also be omitted.
command outputs a line of dependencies that is suitable for inclusion
in a Makefile. The
is the target of the Makefile rule and
will list after the ':' all the files that are included,
recursively. E.g., the result of
hxincl -M myfile.html inputfile
myfile.html: foo.html bar.html
The following options are supported:
Use XML conventions: empty elements are written with a slash at the
end: <IMG />.
- -b base
Sets the base URL for resolving relative URLs. By default the file
given as argument is the base URL.
Removes the comments after including the files. This means
connot be run on the resulting file later to update the inclusions.
- -s name=substitution
Include a different file than the one mentioned in the directive. If
the comment is
<!-- include "name" -->
is included instead. And if the file name in the comment includes a
delimited by %, e.g.,
<!-- include "xxx-%name%" -->
is replaced by
and thus the file
is included. The option
may occur multiple times. %-delimited variables are expanded
recursively, i.e., if the substitution text contains a variable, that
variable is expanded, too. E.g., if the two options
are given, then the "xxx-%name%" will expand to "xxx-subst.rrr".
- -M target
Instead of outputing the input file with all inclusions expanded,
output just the list of all files that the input includes,
recursively, in the form of a rule that is suitable for a
is printed as the target of that rule.
Suppress error messages if a file to include cannot be found. (Only
The following operand is supported:
The name of an HTML or XML file or the URL of one. If absent, standard
input is read instead.
The following exit values are returned:
- > 0
An error occurred in the parsing of one of the HTML or XML files.
To use a proxy to retrieve remote files, set the environment variables
Assumes UTF-8 as input. Doesn't expand character entities. Instead
pipe the input through
to convert it to UTF-8.
Remote files (specified with a URL) are currently only supported for
HTTP. Password-protected files or files that depend on HTTP "cookies"
are not handled. (You can use tools such as
to retrieve such files.)
- EXIT STATUS
- SEE ALSO