Download XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="mkintex1">
  <refmeta>
    <refentrytitle>
      mkintex
    </refentrytitle>
    <manvolnum>
      1
    </manvolnum>
    <refmiscinfo>
      intex 1.8.0
    </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>
Default handler: <!-- 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>
        [email protected]
      </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>

You are viewing proxied material from ftp.icm.edu.pl. The copyright of proxied material belongs to its original authors. Any comments or complaints in relation to proxied material should be directed to the original authors of the content concerned. Please see the disclaimer for more details.