summaryrefslogtreecommitdiff
path: root/Build/source/utils/xindy
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-03-25 21:11:20 +0000
committerKarl Berry <karl@freefriends.org>2017-03-25 21:11:20 +0000
commit42a7b05aa7fc09d856fb502d5ba5b6afdb718f11 (patch)
tree3e00b3bf212ff292ef028f3f5f8bf92dbeb52718 /Build/source/utils/xindy
parent6f92919a9b51cbbfef7ec810de988f492e9ddc78 (diff)
xindy build doc and test file
git-svn-id: svn://tug.org/texlive/trunk@43602 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Build/source/utils/xindy')
-rw-r--r--Build/source/utils/xindy/README-clisp65
-rw-r--r--Build/source/utils/xindy/tests/idxhello.idx2
-rw-r--r--Build/source/utils/xindy/tests/idxhello.tex13
3 files changed, 19 insertions, 61 deletions
diff --git a/Build/source/utils/xindy/README-clisp b/Build/source/utils/xindy/README-clisp
index 10f75b08845..5d9beb44c29 100644
--- a/Build/source/utils/xindy/README-clisp
+++ b/Build/source/utils/xindy/README-clisp
@@ -1,62 +1,5 @@
-Prerequisite for building xindy is the clisp package supporting
-foreign function calls functionality.
+(This file public domain.)
-If your OS distribution already has CLISP installed, xindy will try to
-use it (the configure script searches in PATH to find the `clisp'
-executable, or you can pass the configure option --with-clisp=PATH
-where PATH is an absolute path to the `clisp' executable).
-
-Otherwise, you need to build CLISP from source before building xindy.
-Sources and selected binaries are available by anonymous ftp from
- <ftp://ftp.gnu.org/pub/gnu/clisp/>
-and its mirrors.
-
-Sample steps to build clisp:
-
-=======================================================
-# define this to any directory where clisp should be built, e.g.:
-clisp_builddir=`pwd`/clisp-build-dir
-
-wget http://ftp.gnu.org/pub/gnu/clisp/release/2.43/clisp-2.43.tar.gz
-gzip -dc clisp-2.43.tar.gz | tar xf -
-
-cd clisp-2.43
-./configure $clisp_builddir --ignore-absence-of-libsigsegv
-cd $clisp_builddir
-make
-=======================================================
-
-NOTE: clisp package is only a build-dependency: it is not used by
-xindy at runtime. So clisp could be uninstalled after xindy was built.
-Therefore, running "make install" is not necessary, and you can
-specify --with-clisp=$clisp_builddir/clisp when configuring xindy.
-
-When running `configure' for clisp, the following options should be noted:
-
-=======================================================
- --ignore-absence-of-libsigsegv
-
- You may optionally install libsigsegv to improve clisp's runtime
- behavior. You may get libsigsegv sources from
- http://ftp.gnu.org/pub/gnu/libsigsegv/
-
- If you don't have the libsigsegv library, use the above option to
- let it build without libsigsegv.
-
- --with-libsigsegv-prefix=DIR
- --with-libffcall-prefix=DIR
-
- In case you have installed libffcall or libsigsegv in some
- non-standard locations, use the above options to specify their
- prefix directories (such as /usr/local, /opt or /sw).
-
- --without-readline
-
- It was reported that CLISP fails to build on the MacOS X platform,
- because of the faulty 'readline' package. Use the above option if
- you'll experience problems.
-=======================================================
-
-As noted above, running "make install" for clisp is not necessary, and
-you can specify --with-clisp=$clisp_builddir/clisp when configuring
-xindy.
+GNU clisp (gnu.org/software/clisp) is required by xindy.
+See the end of ../README (that is, Buid/source/utils/README) for
+information on building it.
diff --git a/Build/source/utils/xindy/tests/idxhello.idx b/Build/source/utils/xindy/tests/idxhello.idx
new file mode 100644
index 00000000000..5f3b98d84d0
--- /dev/null
+++ b/Build/source/utils/xindy/tests/idxhello.idx
@@ -0,0 +1,2 @@
+\indexentry{there}{1}
+\indexentry{hello}{1}
diff --git a/Build/source/utils/xindy/tests/idxhello.tex b/Build/source/utils/xindy/tests/idxhello.tex
new file mode 100644
index 00000000000..6c709ae075e
--- /dev/null
+++ b/Build/source/utils/xindy/tests/idxhello.tex
@@ -0,0 +1,13 @@
+% $Id$
+% public domain. minimal index test:
+% latex idxhello && texindy idxhello.idx && cat idxhello.ind # inspect output
+% (or makeindex for that matter.)
+%
+% xindy must be able to find its modules, which in TL means being run
+% out of Master/bin/*.
+%
+\documentclass{article}
+\begin{document}
+\index{xyz}xyz
+\index{abc}abc
+\end{document}