source: pst/typesetting/xindy.xml@ 4c24eb0

10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 4c24eb0 was 4c24eb0, checked in by Pierre Labastie <pieere@…>, 8 months ago

Remove period at the end of short descriptions.
In the process, some attributes in single quotes have been changed to double
quotes, and a few attribute lists have been written on one line instead of
several lines.

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

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