source: pst/typesetting/xindy.xml@ 5e61060

10.0 10.1 11.0 7.10 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus nosym perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 5e61060 was 5e61060, checked in by Ken Moffat <ken@…>, 6 years ago

Update texlive to 2016, also update xindy to current source. Various cleanups, in particular the perl modules are now mode 644. Explanations brought into same order as the commands (I hope). Tag asymptote and biber. Any users of asymptote on gcc-6.1 systems should consult the wiki pages for install-tl-unx or asymptote (i.e. if from source) as appropriate. E&OE.

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

  • Property mode set to 100644
File size: 7.4 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 &lfs79_checked;&gcc6_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
110patch -Np1 -i ../xindy-&xindy-version;-upstream_fixes-1.patch &amp;&amp;
111
112./configure --prefix=/opt/texlive/&texlive-year; \
113 --bindir=/opt/texlive/&texlive-year;/bin/$TEXARCH \
114 --datarootdir=/opt/texlive/&texlive-year; \
115 --includedir=/usr/include \
116 --libdir=/opt/texlive/&texlive-year;/texmf-dist \
117 --mandir=/opt/texlive/&texlive-year;/texmf-dist/doc/man &amp;&amp;
118
119make LC_ALL=POSIX</userinput></screen>
120
121 <para>
122 This package does not have a testsuite.
123 </para>
124
125 <para>
126 Now, as the <systemitem class="username">root</systemitem> user:
127 </para>
128
129<screen role="root"><userinput>make install</userinput></screen>
130
131 </sect2>
132
133 <sect2 role="commands">
134 <title>Command Explanations</title>
135
136 <para>
137 <parameter>sed -i "s/ grep -v '^;'/ awk NF/" ...</parameter>: The build
138 sorts files in latin{1..3} encodings to create latin.xdy, and unicode
139 versions of these to create utf8.xdy after using
140 <command>grep -v '^;'</command> to remove blank lines. With
141 <application>grep-2.23</application> any data not in the expected
142 encoding is treated as binary, resulting in a useless file. This
143 command uses an alternative way of removing blank lines.
144 </para>
145
146 <para>
147 <parameter>patch -Np1 -i ../xindy-&xindy-version;-upstream_fixes-1.patch</parameter>:
148 <application>Xindy</application> is now maintained at CTAN. This patch
149 updates the source to match what is used for the &texlive-year; texlive
150 binary version ( but ignoring changes which were only made to allow for
151 spaces in pathnames).
152 </para>
153
154 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
155 href="../../xincludes/tex-prefix.xml"/>
156
157 <para><parameter>--includedir=/usr/include</parameter>:
158 This parameter ensures that the <filename>kpathsea</filename>
159 headers from <xref linkend="texlive"/> will be found.</para>
160
161 <para>
162 <parameter>make LC_ALL=POSIX</parameter>: with the current version of
163 <application>coreutils</application> it is essential to build
164 <application>xindy</application> in the POSIX (or C) locale because in a
165 UTF-8 locale the file <filename>latin.xdy</filename> will contain only a
166 heading and then a line '<literal>Binary file (standard input)
167 matches</literal>' instead of the many lines of
168 <application>lisp</application> merge-rule commands it ought to contain.
169 </para>
170
171 </sect2>
172
173 <sect2 role="content">
174 <title>Contents</title>
175
176 <segmentedlist>
177 <segtitle>Installed Programs</segtitle>
178 <segtitle>Installed Libraries</segtitle>
179 <segtitle>Installed Directory</segtitle>
180
181 <seglistitem>
182 <seg>
183 tex2xindy, texindy, xindy
184 </seg>
185 <seg>
186 None
187 </seg>
188 <seg>
189 /opt/texlive/&texlive-year;/texmf-dist/xindy
190 </seg>
191 </seglistitem>
192 </segmentedlist>
193
194 <variablelist>
195 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
196 <?dbfo list-presentation="list"?>
197 <?dbhtml list-presentation="table"?>
198
199 <varlistentry id="tex2xindy">
200 <term><command>tex2xindy</command></term>
201 <listitem>
202 <para>
203 transforms a LaTeX index file into a xindy raw index file.
204 </para>
205 <indexterm zone="xindy tex2xindy">
206 <primary sortas="b-tex2xindy">tex2xindy</primary>
207 </indexterm>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry id="texindy">
212 <term><command>texindy</command></term>
213 <listitem>
214 <para>
215 is a wrapper for xindy that turns on many LaTeX conventions by default.
216 </para>
217 <indexterm zone="xindy texindy">
218 <primary sortas="b-texindy">texindy</primary>
219 </indexterm>
220 </listitem>
221 </varlistentry>
222
223 <varlistentry id="xindy-prog">
224 <term><command>xindy</command></term>
225 <listitem>
226 <para>
227 creates a sorted and tagged index from a raw LaTeX index.
228 </para>
229 <indexterm zone="xindy xindy">
230 <primary sortas="b-xindy">xindy</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
235 </variablelist>
236
237 </sect2>
238
239</sect1>
Note: See TracBrowser for help on using the repository browser.