'\" -*- coding: us-ascii -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH mkintex 1 "12 March 2013" "intex 1.8.0" ""
.SH NAME
mkintex \- index preprocessor for the InTeX(5) LaTeX(1) package
.SH SYNOPSIS
'nh
.fi
.ad l
\fBmkintex\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
[\fIoptions\fR] \fI<InTeX-index>\fR [\fIInTeX-index\fR]\&...
'in \n(.iu-\nxu
.ad b
'hy
.SH DESCRIPTION
The \fBInTeX\fR(5) 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.
.PP
\fBmkintex\fR(1) is a preprocessor that
interprets index entries specified in .itx files and generates
appropriate entries for LaTeX and
\fBmakeindex\fR(1).
.SH OPTIONS
.TP 
\*(T<\fB\-\-version\fR\*(T>
show program's version number and exit
.TP 
\*(T<\fB\-h, \-\-help\fR\*(T>
show this help message and exit
.TP 
\*(T<\fB\-D, \-\-debug\fR\*(T>
whether or not to output debug information
.TP 
\*(T<\fB\-V, \-\-verbose\fR\*(T>
whether or not to output verbose information
.TP 
\*(T<\fB\-I, \-\-only\-build\-index\fR\*(T>
only build the internal model of the index
.TP 
\*(T<\fB\-O <\fR\*(T>\fIfile\fR\fI>, --ito-file=<\fR\fIfile\fR\fI>\fR
output the new internal InTeX information to <\fIfile\fR> (default: none)
.TP 
\*(T<\fB\-o <\fR\*(T>\fIfile\fR\fI>, --index-file=<\fR\fIfile\fR\fI>\fR
output the new indexing information to <\fIfile\fR> (default: none)
.TP 
\*(T<\fB\-a <\fR\*(T>\fIfile\fR\fI>, --acrodef-output=<\fR\fIfile\fR\fI>\fR
output acronym definitions to <\fIfile\fR> (default: none)
.TP 
\*(T<\fB\-p <\fR\*(T>\fIfile\fR\fI>, --persondef-output=<\fR\fIfile\fR\fI>\fR
output (person) name definitions to <\fIfile\fR> (default: none)
.SH EXAMPLES
Let us assume that you have already written a
\fBlatex\fR(1)
document, named <\fIdocument_name\fR>.tex, that uses the
\fBInTeX\fR(5)
package. Furthermore, we assume that you have defined a set of
concepts, acronyms, and proper nouns for indexing in a file named
<\fIdocument_name\fR>.itx. Then, to
run this program the standard way, first process the document with
\fBlatex\fR(1)
(or
\fBpdflatex\fR(1))
by issuing the command
.PP
latex <\fIdocument_name\fR>
.PP
This will process the document once and generate both a DVI
file (<\fIdocument_name\fR>.dvi)---or
a PDF file (<\fIdocument_name\fR>.pdf)---and an auxiliary file
(<\fIdocument_name\fR>.aux). 
.PP
Next, run the
\fBmkintex\fR(1)
program
.PP
mkintex <\fIdocument_name\fR> --index-file=<\fIdocument_name\fR>.rix
.PP
that will use as input both <\fIdocument_name\fR>.aux and <\fIdocument_name\fR>.itx to produce two new output
files. The first file is <\fIdocument_name\fR>.ito, which will be used by
\fBlatex\fR(1)
in following compilations of <\fIdocument_name\fR>.tex, and <\fIdocument_name\fR>.rix, which will be used by
\fBmakeindex\fR(1)
to produce a proper index for LaTeX to typeset:
.PP
makeindex -o intex.rid intex.rix
.PP
After that, we have to run
\fBlatex\fR(1)
again to generate a version of the document with the defined
concepts, acronyms, and proper names properly typeset and
indexed:
.PP
latex <\fIdocument_name\fR>
.PP
Please note that in the examples above, <\fIdocument_name\fR> is the name of the main LaTeX
document, without the .tex ending.
.PP
For more information and examples of how to use the
\fBInTeX\fR(5)
\fBLaTeX\fR(1)
package, please see the file intex.pdf.
.SH AUTHORS
Original author:
Martin Thorsen Ranang
<\*(T<mtr@ranang.org\*(T>>.
.SH COPYING
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.
.PP
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.
.PP
You should have received a copy of the GNU General Public License
along with InTeX. If not, see <http://www.gnu.org/licenses/>.
.SH "SEE ALSO"
\fBintex\fR(5)
\fBmakeindex\fR(1)
\fBlatex\fR(1)