1HXINCL(1)                       HTML-XML-utils                       HXINCL(1)
2
3
4

NAME

6       hxincl - expand included HTML or XML files
7

SYNOPSIS

9       hxincl  [ -x ] [ -f ] [ -s name=subst ] [ -s name=subst ]...  [ -b base
10       ] [ file-or-URL ]
11

DESCRIPTION

13       The hxincl command copies an HTML or XML file to standard output, look‐
14       ing  for comments with a certain structure.  Such a comment is replaced
15       by the file whose name is given as the attribute of the directive.  For
16       example:
17
18           ...<!-- include "foo.html" -->...
19
20       will  be replaced by the content of the file foo.html.  It is important
21       to note that you must quote filenames if they contain white space.
22
23       The comment is replaced by
24
25           <!-- begin-include "foo.html" -->
26
27       before the included text and
28
29           <!-- end-include "foo.html" -->
30
31       after it. These comments make it possible to run hxincl on the  result‐
32       ing file again to update the inclusions.
33
34       Single  quotes  are  allowed  instead of double quotes. And if the file
35       name contains no spaces, the quotes may also be omitted.
36

OPTIONS

38       The following options are supported:
39
40       -x        Use XML conventions: empty elements are written with a  slash
41                 at the end: <IMG />.
42
43       -b base   Sets the base URL for resolving relative URLs. By default the
44                 file given as argument is the base URL.
45
46       -f        Removes the comments after including the  files.  This  means
47                 hxincl  connot  be  run on the resulting file later to update
48                 the inclusions.  (Mnemonic: final or frozen.)
49
50       -s name=substitution
51                 Include a different file than the one mentioned in the direc‐
52                 tive. If the comment is
53
54                     <!-- include "name" -->
55
56                 the  file substitution is included instead. The option -s may
57                 occur multiple times.
58

OPERANDS

60       The following operand is supported:
61
62       file-or-URL
63                 The name of an HTML or XML file or the URL of one. If absent,
64                 standard input is read instead.
65

DIAGNOSTICS

67       The following exit values are returned:
68
69       0         Successful completion.
70
71       > 0       An  error  occurred  in the parsing of one of the HTML or XML
72                 files.
73

SEE ALSO

75       asc2xml(1), hxnormalize(1), hxnum(1), hxprune(1), hxtoc(1), hxunent(1),
76       xml2asc(1), UTF-8 (RFC 2279)
77

BUGS

79       Assumes UTF-8 as input. Doesn't expand character entities. Instead pipe
80       the input through hxunent(1) and asc2xml(1) to convert it to UTF-8.
81
82
83
845.x                               21 Nov 2008                        HXINCL(1)
Impressum