1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id='mkintex1'>
<refmeta>
<refentrytitle>mkintex</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>mkintex</refname>
<refpurpose>index preprocessor for the
<refentrytitle>InTeX</refentrytitle><manvolnum>5</manvolnum>
<refentrytitle>LaTeX</refentrytitle><manvolnum>1</manvolnum>
package</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>mkintex</command>
<arg choice='opt'><replaceable>options</replaceable></arg>
<arg choice='plain'><replaceable><InTeX-index></replaceable></arg>
<arg choice='opt' rep='repeat'><replaceable>InTeX-index</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'><title>DESCRIPTION</title>
<para>The <citerefentry><refentrytitle>InTeX</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> package adds functionality
to LaTeX that eases typesetting and indexing of phrases, acronyms,
and proper names in a consistent manner throughout documents of
arbitrary length.</para>
<para><citerefentry><refentrytitle>mkintex</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> is a preprocessor that
interprets index entries specified in .itx files and generates
appropriate entries for LaTeX and
<citerefentry><refentrytitle>makeindex</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>.</para>
</refsect1>
<refsect1 id='options'><title>OPTIONS</title>
<variablelist remap='TP'>
<varlistentry>
<term><option>--version</option></term>
<listitem>
<para>show program's version number and exit</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h, --help</option></term>
<listitem>
<para>show this help message and exit</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-D, --debug</option></term>
<listitem>
<para>whether or not to output debug information</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V, --verbose</option></term>
<listitem>
<para>whether or not to output verbose information</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-I, --only-build-index</option></term>
<listitem>
<para>only build the internal model of the index</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-O <</option><emphasis remap='I'>file</emphasis><emphasis remap='P->B'>>, --ito-file=<</emphasis><emphasis remap='I'>file</emphasis><emphasis remap='P->B'>></emphasis></term>
<listitem>
<para>output the new internal InTeX information to <<emphasis remap='I'>file</emphasis>> (default: none)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o <</option><emphasis remap='I'>file</emphasis><emphasis remap='P->B'>>, --index-file=<</emphasis><emphasis remap='I'>file</emphasis><emphasis remap='P->B'>></emphasis></term>
<listitem>
<para>output the new indexing information to <<emphasis remap='I'>file</emphasis>> (default: none)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-a <</option><emphasis remap='I'>file</emphasis><emphasis remap='P->B'>>, --acrodef-output=<</emphasis><emphasis remap='I'>file</emphasis><emphasis remap='P->B'>></emphasis></term>
<listitem>
<para>output acronym definitions to <<emphasis remap='I'>file</emphasis>> (default: none)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p <</option><emphasis remap='I'>file</emphasis><emphasis remap='P->B'>>, --persondef-output=<</emphasis><emphasis remap='I'>file</emphasis><emphasis remap='P->B'>></emphasis></term>
<listitem>
<para>output (person) name definitions to <<emphasis remap='I'>file</emphasis>> (default: none)</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='examples'><title>EXAMPLES</title>
<para>Let us assume that you have already written a
<citerefentry><refentrytitle>latex</refentrytitle><manvolnum>1</manvolnum></citerefentry>
document, named <<emphasis
remap='I'>document_name</emphasis>>.tex, that uses the
<citerefentry><refentrytitle>InTeX</refentrytitle><manvolnum>5</manvolnum></citerefentry>
package. Furthermore, we assume that you have defined a set of
concepts, acronyms, and proper nouns for indexing in a file named
<<emphasis remap='I'>document_name</emphasis>>.itx. Then, to
run this program the standard way, first process the document with
<citerefentry><refentrytitle>latex</refentrytitle><manvolnum>1</manvolnum></citerefentry>
(or
<citerefentry><refentrytitle>pdflatex</refentrytitle><manvolnum>1</manvolnum></citerefentry>)
by issuing the command</para>
<para>latex <<emphasis remap='I'>document_name</emphasis>></para>
<para>This will process the document once and generate both a DVI
file (<<emphasis remap='I'>document_name</emphasis>>.dvi)---or
a PDF file (<<emphasis
remap='I'>document_name</emphasis>>.pdf)---and an auxiliary file
(<<emphasis remap='I'>document_name</emphasis>>.aux).
</para>
<para>Next, run the
<citerefentry><refentrytitle>mkintex</refentrytitle><manvolnum>1</manvolnum></citerefentry>
program</para>
<para>mkintex <<emphasis remap='I'>document_name</emphasis>> --index-file=<<emphasis remap='I'>document_name</emphasis>>.rix</para>
<para>that will use as input both <<emphasis
remap='I'>document_name</emphasis>>.aux and <<emphasis
remap='I'>document_name</emphasis>>.itx to produce two new output
files. The first file is <<emphasis
remap='I'>document_name</emphasis>>.ito, which will be used by
<citerefentry><refentrytitle>latex</refentrytitle><manvolnum>1</manvolnum></citerefentry>
in following compilations of <<emphasis
remap='I'>document_name</emphasis>>.tex, and <<emphasis
remap='I'>document_name</emphasis>>.rix, which will be used by
<citerefentry><refentrytitle>makeindex</refentrytitle><manvolnum>1</manvolnum></citerefentry>
to produce a proper index for LaTeX to typeset:</para>
<para>makeindex -o intex.rid intex.rix</para>
<para>After that, we have to run
<citerefentry><refentrytitle>latex</refentrytitle><manvolnum>1</manvolnum></citerefentry>
again to generate a version of the document with the defined
concepts, acronyms, and proper names properly typeset and
indexed:</para>
<para>latex <<emphasis
remap='I'>document_name</emphasis>></para>
<para>Please note that in the examples above, <<emphasis
remap='I'>document_name</emphasis>> is the name of the main LaTeX
document, without the .tex ending.</para>
<para>For more information and examples of how to use the
<refentrytitle>InTeX</refentrytitle><manvolnum>5</manvolnum>
<refentrytitle>LaTeX</refentrytitle><manvolnum>1</manvolnum>
package, please see the file intex.pdf.
</para>
</refsect1>
<refsect1 id='authors'><title>AUTHORS</title>
<para>
<contrib>Original author:</contrib>
<author>
<firstname>Martin</firstname>
<othername>Thorsen</othername>
<surname>Ranang</surname>
</author>
<email>mtr@ranang.org</email>.
</para>
</refsect1>
<refsect1 id='copying'><title>COPYING</title>
<para>
InTeX is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
</para>
<para>
InTeX is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
</para>
<para>
You should have received a copy of the GNU General Public License
along with InTeX. If not, see <http://www.gnu.org/licenses/>.
</para>
</refsect1>
<refsect1 id='see_also'><title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>intex</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>
<citerefentry><refentrytitle>makeindex</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>
<citerefentry><refentrytitle>latex</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
|