1man(1) General Commands Manual man(1)
2
3
4
6 xref - generate cross-references inside and between HTML files
7
9 xref [ -x ] [ -b base ] [ -i index ] [ -- ] [ input [ output ] ]
10
12 The xref command links inline elements to DFN elements with the same
13 content. It adds ID attributes where necessary. If the content of a
14 DFN or other element isn't suitable, the TITLE attribute may be used to
15 provide the term to use for comparisons.
16
17 Here is an example:
18
19 <p>A <dfn>b-box</dfn> is defined to be...
20 <p>For every b there is a <em>b-box</em>...
21
22 The output of xref will be similar to this:
23
24 <p>A <dfn id="b-box">b-box</dfn> is defined to be...
25 <p>For every b there is a <em><a href="#b-box">b-box<a/></em>...
26
27
29 The following options are supported:
30
31 -x Use XML conventions: empty elements are written with a slash
32 at the end: <IMG />
33
34 -b base Sets the prefix for the generated URLs. By default base is
35 empty, which generates URLs like "#b-box" above. If base is
36 set to, e.g., "http://xyz/", the URLs will look like
37 "http://xyz/#b-box".
38
39 -i index Directs xref to read terms from a database file before look‐
40 ing for them in the document and afterwards store the terms
41 that were found in the same file. DFN element in the document
42 ovrride terms found in index. This allows xref to be run
43 multiple times on different files, to make the files refer to
44 each other. It may be necessary to run the commands twice, to
45 resolve all cross-references.
46
48 The following operands are supported:
49
50 input The name of an HTML file. If absent, standard input is read
51 instead. The special name "-" also indicates standard input.
52 The input may be a URL.
53
54 output The file to write to. If absent, standard output is used.
55 This may not be a URL.
56
58 The following exit values are returned:
59
60 0 Successful completion.
61
62 >0 An error occurred in the parsing of the HTML file. toc will
63 try to correct the error and produce output anyway.
64
66 index(1), num(1), toc(1), normalize(1), xml2asc(1) asc2xml(1)
67
69 The error recovery for incorrect HTML is primitive.
70
71 The program generates ID attributes, but doesn't generate <a name=...>
72 tags, so the links only work in browsers that recognize ID attributes.
73
74
75
76 4 Aug 2000 man(1)