summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVladimir Volovich <vvv@vsu.ru>2008-03-24 13:21:35 +0000
committerVladimir Volovich <vvv@vsu.ru>2008-03-24 13:21:35 +0000
commit193506fd0f79556aa4d778bf0abcba6b75a5f4ea (patch)
treec7cca31daf238c60718fce30bcd5c099657533c5
parent7b9d9abb23b1362aa8337675cab7be3893145b1c (diff)
add a README-clisp file with some instructions on how to build clisp for xindy
git-svn-id: svn://tug.org/texlive/trunk@7120 c570f23f-e606-0410-a88d-b1316a301751
-rw-r--r--Build/source/utils/xindy/README-clisp87
1 files changed, 87 insertions, 0 deletions
diff --git a/Build/source/utils/xindy/README-clisp b/Build/source/utils/xindy/README-clisp
new file mode 100644
index 00000000000..d4200c3d2d6
--- /dev/null
+++ b/Build/source/utils/xindy/README-clisp
@@ -0,0 +1,87 @@
+Prerequisite for building xindy is the clisp package supporting
+foreign function calls functionality.
+
+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 --with-dynamic-ffi --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.
+
+Xindy requires a clisp built with Foreign Function Interface support.
+If you are using clisp 2.44 or newer, note the following (taken from
+the NEWS file from clisp sources):
+
+* CLISP does not come with GNU libffcall anymore.
+ This is now a separate package and should be installed separately.
+ Pass --with-libffcall-prefix to the top-level configure if it is not
+ installed in a standard place.
+ Option --with-dynamic-ffi is now replaced with --with-ffcall.
+
+So you would need to install libffcall separately, before installing clisp,
+and change --with-dynamic-ffi to --with-ffcall in the xindy configure call.
+You can download libffcall sources from
+http://www.haible.de/bruno/packages-ffcall-README.html
+or from http://packages.debian.org/sid/libffcall1
+(containing some improvements from Debian).
+Again, this is needed only for clisp 2.44 and newer.
+
+When running `configure' for clisp, the following options should be noted:
+
+=======================================================
+ --with-dynamic-ffi (for clisp 2.43 and older), or
+ --with-ffcall (for clisp 2.44 and newer)
+
+ This enables the Foreign Function Interface in clisp.
+ But strictly speaking, it is not necessary to use either of these
+ options, because the default is to support Foreign Function
+ Interface when available.
+
+ --ignore-absence-of-libsigsegv
+
+ You may optionally install libsigsegv to improve clisp's runtime
+ behavios in case of clisp. If you don't have the libsigsegv
+ library, use the above option to let it build without libsigsegv.
+
+ You may get libsigsegv sources from http://ftp.gnu.org/pub/gnu/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.