HXINCL
Section: HTML-XML-utils (1)
Updated: 21 Nov 2008
Index
Return to Main Contents
NAME
hxincl - expand included HTML or XML files
SYNOPSIS
hxincl
[ -x ]
[ -f ]
[ -s
name=subst ]
[ -s
name=subst ]...
[ -b
base ]
[ file-or-URL ]
DESCRIPTION
The
hxincl
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
example:
...<!-- include "foo.html" -->...
will be replaced by the content of the file foo.html. It is
important to note that you must quote filenames if they contain
white space.
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
hxincl
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.
OPTIONS
The following options are supported:
- -x
-
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.
- -f
-
Removes the comments after including the files. This means
hxincl
connot be run on the resulting file later to update the inclusions.
(Mnemonic:
final
or
frozen.)
- -s name=substitution
-
Include a different file than the one mentioned in the directive. If
the comment is
<!-- include "name" -->
the file
substitution
is included instead. The option
-s
may occur multiple times.
OPERANDS
The following operand is supported:
- file-or-URL
-
The name of an HTML or XML file or the URL of one. If absent, standard
input is read instead.
DIAGNOSTICS
The following exit values are returned:
- 0
-
Successful completion.
- > 0
-
An error occurred in the parsing of one of the HTML or XML files.
SEE ALSO
asc2xml(1),
hxnormalize(1),
hxnum(1),
hxprune(1),
hxtoc(1),
hxunent(1),
xml2asc(1),
UTF-8 (RFC 2279)
BUGS
Assumes UTF-8 as input. Doesn't expand character entities. Instead
pipe the input through
hxunent(1)
and
asc2xml(1)
to convert it to UTF-8.
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- OPTIONS
-
- OPERANDS
-
- DIAGNOSTICS
-
- SEE ALSO
-
- BUGS
-
This document was created by
man2html,
using the manual pages.
Time: 14:31:19 GMT, July 15, 2009