[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[347e59c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[75b1a338] | 7 | <!ENTITY xindy-download-http "https://tug.ctan.org/support/xindy/base/xindy-&xindy-version;.tar.gz">
|
---|
[347e59c] | 8 | <!ENTITY xindy-download-ftp " ">
|
---|
| 9 | <!ENTITY xindy-md5sum "221acfeeb0f6f8388f89a59c56491041">
|
---|
| 10 | <!ENTITY xindy-size "506 KB">
|
---|
| 11 | <!ENTITY xindy-buildsize "15 MB">
|
---|
| 12 | <!ENTITY xindy-time "less than 0.1 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="xindy" xreflabel="xindy-&xindy-version;">
|
---|
| 16 | <?dbhtml filename="xindy.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>xindy-&xindy-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="xindy">
|
---|
| 22 | <primary sortas="a-xindy">xindy</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to xindy</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | <!-- LaTeX for the system, but just latex for the command -->
|
---|
| 30 | <application>Xindy</application> is an index processor that can be used
|
---|
| 31 | to generate book-like indexes for arbitrary document-preparation systems.
|
---|
[d28648d] | 32 | This includes systems such as TeX and LaTeX, the roff-family, and
|
---|
[347e59c] | 33 | SGML/XML-based systems (e.g., HTML) that process some kind of text and
|
---|
| 34 | generate indexing information.
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
[1cd77c3] | 37 | &lfs122_checked;
|
---|
[347e59c] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&xindy-download-http;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&xindy-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download MD5 sum: &xindy-md5sum;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download size: &xindy-size;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated disk space required: &xindy-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &xindy-time;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
[5e61060f] | 73 | <bridgehead renderas="sect3">Required Additional Downloads</bridgehead>
|
---|
| 74 | <itemizedlist spacing="compact">
|
---|
| 75 | <listitem>
|
---|
[fa3edfef] | 76 | <para>
|
---|
| 77 | Required patch: <ulink
|
---|
[1715682] | 78 | url="&patch-root;/xindy-&xindy-version;-upstream_fixes-2.patch"/>
|
---|
[fa3edfef] | 79 | </para>
|
---|
[5e61060f] | 80 | </listitem>
|
---|
| 81 | </itemizedlist>
|
---|
| 82 |
|
---|
[347e59c] | 83 | <bridgehead renderas="sect3">Xindy Dependencies</bridgehead>
|
---|
| 84 |
|
---|
| 85 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 86 | <para role="required">
|
---|
[d28648d] | 87 | <xref linkend="clisp"/> and
|
---|
[347e59c] | 88 | <xref linkend="texlive"/>
|
---|
| 89 | </para>
|
---|
| 90 |
|
---|
| 91 | </sect2>
|
---|
| 92 |
|
---|
| 93 | <sect2 role="installation">
|
---|
| 94 | <title>Installation of xindy</title>
|
---|
| 95 |
|
---|
| 96 | <para>
|
---|
| 97 | Install <application>xindy</application> by running the following
|
---|
| 98 | commands:
|
---|
| 99 | </para>
|
---|
| 100 |
|
---|
| 101 | <screen><userinput>export TEXARCH=$(uname -m | sed -e 's/i.86/i386/' -e 's/$/-linux/') &&
|
---|
[5e61060f] | 102 |
|
---|
[5ac40fda] | 103 | sed -i "s/ grep -v '^;'/ awk NF/" make-rules/inputenc/Makefile.in &&
|
---|
[5e61060f] | 104 |
|
---|
[75da3e08] | 105 | sed -i 's%\(indexentry\)%\1\\%' make-rules/inputenc/make-inp-rules.pl &&
|
---|
| 106 |
|
---|
[1715682] | 107 | patch -Np1 -i ../xindy-&xindy-version;-upstream_fixes-2.patch &&
|
---|
[5e61060f] | 108 |
|
---|
[ed3707e] | 109 | ./configure --prefix=$TEXLIVE_PREFIX \
|
---|
| 110 | --bindir=$TEXLIVE_PREFIX/bin/$TEXARCH \
|
---|
| 111 | --datarootdir=$TEXLIVE_PREFIX \
|
---|
| 112 | --includedir=/usr/include \
|
---|
| 113 | --libdir=$TEXLIVE_PREFIX/texmf-dist \
|
---|
| 114 | --mandir=$TEXLIVE_PREFIX/texmf-dist/doc/man &&
|
---|
[5e61060f] | 115 |
|
---|
[068a163] | 116 | make LC_ALL=POSIX</userinput></screen>
|
---|
[347e59c] | 117 |
|
---|
| 118 | <para>
|
---|
[48771ae] | 119 | This package does not have a test suite.
|
---|
[347e59c] | 120 | </para>
|
---|
| 121 |
|
---|
| 122 | <para>
|
---|
| 123 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 124 | </para>
|
---|
| 125 |
|
---|
| 126 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 127 |
|
---|
| 128 | </sect2>
|
---|
| 129 |
|
---|
| 130 | <sect2 role="commands">
|
---|
| 131 | <title>Command Explanations</title>
|
---|
| 132 |
|
---|
[5ac40fda] | 133 | <para>
|
---|
[1a518e97] | 134 | <command>sed -i "s/ grep -v '^;'/ awk NF/" ...</command>: The build
|
---|
[5ac40fda] | 135 | sorts files in latin{1..3} encodings to create latin.xdy, and unicode
|
---|
| 136 | versions of these to create utf8.xdy after using
|
---|
| 137 | <command>grep -v '^;'</command> to remove blank lines. With
|
---|
| 138 | <application>grep-2.23</application> any data not in the expected
|
---|
| 139 | encoding is treated as binary, resulting in a useless file. This
|
---|
| 140 | command uses an alternative way of removing blank lines.
|
---|
| 141 | </para>
|
---|
| 142 |
|
---|
[75da3e08] | 143 | <para>
|
---|
| 144 | <command>sed -i 's%\(indexentry\)%\1\\%' ...</command>: A regexp
|
---|
| 145 | contains <literal>indexentry{</literal> - perl has warned about the
|
---|
| 146 | unescaped left brace for some time and now treats it as illegal.
|
---|
| 147 | Change it to <literal>indexentry\{</literal>, doubling the backslash
|
---|
| 148 | for <command>sed</command>.
|
---|
| 149 | </para>
|
---|
| 150 |
|
---|
[5e61060f] | 151 | <para>
|
---|
[1715682] | 152 | <command>patch -Np1 -i ../xindy-&xindy-version;-upstream_fixes-2.patch</command>:
|
---|
[5e61060f] | 153 | <application>Xindy</application> is now maintained at CTAN. This patch
|
---|
[75da3e08] | 154 | updates the source with some of the changes made there (but ignoring
|
---|
| 155 | changes which were only made to allow for spaces in pathnames and some trivial
|
---|
| 156 | recent changes).
|
---|
[5e61060f] | 157 | </para>
|
---|
| 158 |
|
---|
| 159 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 160 | href="../../xincludes/tex-prefix.xml"/>
|
---|
| 161 |
|
---|
[fa3edfef] | 162 | <para>
|
---|
| 163 | <parameter>--includedir=/usr/include</parameter>:
|
---|
| 164 | This parameter ensures that the <filename>kpathsea</filename>
|
---|
| 165 | headers from <xref linkend="texlive"/> will be found.
|
---|
| 166 | </para>
|
---|
[068a163] | 167 |
|
---|
[2cbfee09] | 168 | <para>
|
---|
[1a518e97] | 169 | <command>make LC_ALL=POSIX</command>: with the current version of
|
---|
[2cbfee09] | 170 | <application>coreutils</application> it is essential to build
|
---|
| 171 | <application>xindy</application> in the POSIX (or C) locale because in a
|
---|
| 172 | UTF-8 locale the file <filename>latin.xdy</filename> will contain only a
|
---|
| 173 | heading and then a line '<literal>Binary file (standard input)
|
---|
| 174 | matches</literal>' instead of the many lines of
|
---|
| 175 | <application>lisp</application> merge-rule commands it ought to contain.
|
---|
| 176 | </para>
|
---|
| 177 |
|
---|
[347e59c] | 178 | </sect2>
|
---|
| 179 |
|
---|
| 180 | <sect2 role="content">
|
---|
| 181 | <title>Contents</title>
|
---|
| 182 |
|
---|
| 183 | <segmentedlist>
|
---|
| 184 | <segtitle>Installed Programs</segtitle>
|
---|
| 185 | <segtitle>Installed Libraries</segtitle>
|
---|
| 186 | <segtitle>Installed Directory</segtitle>
|
---|
| 187 |
|
---|
| 188 | <seglistitem>
|
---|
| 189 | <seg>
|
---|
| 190 | tex2xindy, texindy, xindy
|
---|
| 191 | </seg>
|
---|
| 192 | <seg>
|
---|
| 193 | None
|
---|
| 194 | </seg>
|
---|
| 195 | <seg>
|
---|
[ed3707e] | 196 | $TEXLIVE_PREFIX/texmf-dist/xindy
|
---|
[347e59c] | 197 | </seg>
|
---|
| 198 | </seglistitem>
|
---|
| 199 | </segmentedlist>
|
---|
| 200 |
|
---|
| 201 | <variablelist>
|
---|
| 202 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 203 | <?dbfo list-presentation="list"?>
|
---|
| 204 | <?dbhtml list-presentation="table"?>
|
---|
| 205 |
|
---|
| 206 | <varlistentry id="tex2xindy">
|
---|
| 207 | <term><command>tex2xindy</command></term>
|
---|
| 208 | <listitem>
|
---|
| 209 | <para>
|
---|
[4c24eb0a] | 210 | transforms a LaTeX index file into a xindy raw index file
|
---|
[347e59c] | 211 | </para>
|
---|
| 212 | <indexterm zone="xindy tex2xindy">
|
---|
| 213 | <primary sortas="b-tex2xindy">tex2xindy</primary>
|
---|
| 214 | </indexterm>
|
---|
| 215 | </listitem>
|
---|
| 216 | </varlistentry>
|
---|
| 217 |
|
---|
| 218 | <varlistentry id="texindy">
|
---|
| 219 | <term><command>texindy</command></term>
|
---|
| 220 | <listitem>
|
---|
| 221 | <para>
|
---|
[4c24eb0a] | 222 | is a wrapper for xindy that turns on many LaTeX conventions by default
|
---|
[347e59c] | 223 | </para>
|
---|
| 224 | <indexterm zone="xindy texindy">
|
---|
| 225 | <primary sortas="b-texindy">texindy</primary>
|
---|
| 226 | </indexterm>
|
---|
| 227 | </listitem>
|
---|
| 228 | </varlistentry>
|
---|
| 229 |
|
---|
| 230 | <varlistentry id="xindy-prog">
|
---|
| 231 | <term><command>xindy</command></term>
|
---|
| 232 | <listitem>
|
---|
| 233 | <para>
|
---|
[4c24eb0a] | 234 | creates a sorted and tagged index from a raw LaTeX index
|
---|
[347e59c] | 235 | </para>
|
---|
| 236 | <indexterm zone="xindy xindy">
|
---|
| 237 | <primary sortas="b-xindy">xindy</primary>
|
---|
| 238 | </indexterm>
|
---|
| 239 | </listitem>
|
---|
| 240 | </varlistentry>
|
---|
| 241 |
|
---|
| 242 | </variablelist>
|
---|
| 243 |
|
---|
| 244 | </sect2>
|
---|
| 245 |
|
---|
| 246 | </sect1>
|
---|