source: pst/typesetting/xindy.xml@ fb19657a

10.0 10.1 11.0 9.0 9.1 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since fb19657a was fb19657a, checked in by Ken Moffat <ken@…>, 2 years ago

tags

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22041 af4574ff-66df-0310-9fd7-8a98e5e911e0

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