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