From 10e6cd9ce34c0ec20d007ebe6ce8fca9783b7309 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 5 Apr 2013 23:29:43 +0000 Subject: splitindex (5apr13) git-svn-id: svn://tug.org/texlive/trunk@29688 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/splitindex/install.txt | 120 +++++++++++---------- 1 file changed, 63 insertions(+), 57 deletions(-) (limited to 'Master/texmf-dist/doc/latex/splitindex/install.txt') diff --git a/Master/texmf-dist/doc/latex/splitindex/install.txt b/Master/texmf-dist/doc/latex/splitindex/install.txt index 353a37af06a..9fa69851ce9 100644 --- a/Master/texmf-dist/doc/latex/splitindex/install.txt +++ b/Master/texmf-dist/doc/latex/splitindex/install.txt @@ -1,6 +1,6 @@ SplitIndex Installation Guide - 2009-03-18 + 2013-04-04 INTRODUCTION @@ -8,15 +8,12 @@ INTRODUCTION If you know how to install LaTeX packages and how to install binary programs, just do it. If you don't know, read the following. If you -are using Linux-i386 or OpenBSD-i386 or another Unix like environment -with installed Gnu fileutils and installed Gnu-C-Compiler, you may try +are using a system which provides a bash and gnu tools, you may try install.sh for installation. See ./install.sh --help -for more information. If you don't have GCC, Linux-i386 or -OpenBSD-i386 you may also use install.sh, but you have to compile -and link splitindex.c before. See the splitidx manual for this. +for more information. But you may also try the following step by step installation: @@ -29,10 +26,12 @@ The SplitIndex TDS-archive has following contents: +- doc/ | +- latex/ - | +- splitindex/ - | +- install.txt - | +- README - | +- splitidx.pdf + | | +- splitindex/ + | | +- install.txt + | | +- README + | | +- splitidx.pdf + | +- man/ + | +- man1/ | +- splitindex.1 +- tex/ | +- latex/ @@ -41,8 +40,9 @@ The SplitIndex TDS-archive has following contents: | +- splitindex.tex +- scripts/ | +- splitindex/ - | +- perl/ - | +- splitindex.pl + | +- splitindex.pl + | +- splitindex.tlu + | +- splitindex_main.tlu +- source/ +- latex/ +- splitindex/ @@ -54,12 +54,10 @@ The SplitIndex TDS-archive has following contents: +- splitidx.ins +- splitindex.1 +- splitindex.c - +- splitindex.class - +- splitindex.exe +- splitindex.java - +- splitindex-Linux-i386 - +- splitindex-OpenBSD-i386 +- splitindex.pl + +- splitindex.tlu + +- splitindex_main.tlu +- splitindex.tex If you don't have such an archive, continue reading at 1st step of ``HOW TO @@ -68,14 +66,14 @@ the file name ``splitindex.tds.zip'' in the following - you may continue with: A) Have a look where your LaTeX Distribution searchs for files. - With teTeX you can ask kpathsea for this, e.g. using a unix + With TeX Live you can ask kpathsea for this, e.g. using a unix shell: kpsexpand \$TEXMFLOCAL to use the local texmf tree or: - kpsexpand \$HOMETEXMF + kpsexpand \$TEXMFHOME to use your private texmf tree. Following uses ``'' to be a synonym for the texmf tree you want to use. @@ -89,7 +87,7 @@ B) Extract splitindex.tds.zip at with all the subdirectories of or any other zip extraction programm. -C) Continue with 5th to 9th step of ``HOW TO INSTALL THE BINARIES''. +C) Continue with 5th or 6th step at ``HOW TO INSTALL THE EXECUTABLES''. D) Call the program, which is used to update the filename data base, e.g., texhash or mktexlsr if you are using teTeX/TeX Live. @@ -115,14 +113,14 @@ should skip this section. Answer this question with yes. 2nd) Have a look where your LaTeX Distribution searchs for files. - With teTeX you can ask kpathsea for this, e.g. using a unix + With TeX Live you can ask kpathsea for this, e.g. using a unix shell: kpsexpand \$TEXMFLOCAL to use the local texmf tree or: - kpsexpand \$HOMETEXMF + kpsexpand \$TEXMFHOME to use your private texmf tree. Following uses ``'' to be a synonym for the texmf tree you want to use. @@ -131,70 +129,78 @@ should skip this section. \tex\latex\splitindex), if it doesn't exist. Copy splitidx.sty to this folder. -4th) Call the program, which is used to update the filename data +4th) Create folder /scripts/splitindex (at Windows: + \scripts\latex\splitindex), if it doesn't exist. Copy + splitindex.pl, splitindex.tlu and splitindex_main.tlu to this folder. + +5th) Call the program, which is used to update the filename data base, e.g. texhash or mktexlsr if you are using teTeX/TeX Live. -HOW TO INSTALL THE BINARIES -=========================== +HOW TO INSTALL THE EXECUTABLE +============================= + +You need only one of the executables splitindex.pl or splitindex.tlu. +I recommend to use splitindex.pl, but if your system doesn't provide perl +but TeXLua, you may use splitindex.tlu instead. + +To install splitindex.pl or splitindex.tlu on Windows: -You need only one of the binaries splitindex (compiled from splitindex.c), -splitindex.class (compiled from splitindex.java) or splitindex.pl (using a -perl interpreter). Following steps will install all these binaries. -Please do them all, before asking for support. +5th) Rename a copy of runscript.exe into splitindex.exe and copy it + into the binary folder of your TeX installation. You may simply search + for runscript.exe itself to find the binary folder. -5th) Rename the suitable binary (e.g. splitindex-Linux-i386, if you're - using Linux-i386) to splitindex or compile splitindex.c to generate - a binary named splitindex using e.g. - gcc -O3 -Wall -o splitindex splitindex.c - or - gcc -O3 -Wall -DNO_LONGOPT -o splitindex splitindex.c +To install splitindex.pl or splitindex.tlu on Linux, OpenBSD, OS X, +OpenSolaris etc.: -6th) Copy splitindex.java to the binary search path of SUN JAVA - 1.4.1. +6th) Copy splitindex.pl or splitindex.tlu to the binary folder of your TeX + installation and rename it into splitindex. You may simply do a + `which pdflatex' to find the binary folder. Make splitindex executable + for everybody using e.g. `chmod a+x splitindex'. -7th) Copy splitindex.pl and splitindex or splitindex.exe somewhere to - your binary search path (ask environment variable PATH). -8th) Copy the manual page splitindex.1 to your manual seach path. If you are - using Linux or OpenBSD, this may be, e.g., /usr/local/man/man1/ (ask - environment variable MANPATH). +HOW TO GET A REAL BINARY +======================== -9th) Copy splitindex.tex to the same location you've copied - splitidx.sty to and do 4th step again. +If you don't like scripts, you may make a real binary from the C source file +splitindex.c and install that instead of the script. If your getopt library +doesn't support long options, you may define NO_LONGOPT. In this case the code +for long options won't be compiled. I recommend to use either the perl or the +TeXLua script. Nevertheless, you may find binaries in the splitindex +repository at +. HOW TO GENERATE THE MANUAL ========================== -10th) process splitidx.dtx with LaTeX to generate the user manual of - splitidx and SplitIndex, e.g. using the following input at a - command shell: +7th) process splitidx.dtx with LaTeX to generate the user manual of + splitidx and SplitIndex, e.g. using the following input at a + command shell: - latex splitidx.dtx - latex splitidx.dtx + pdflatex splitidx.dtx + pdflatex splitidx.dtx mkindex splitidx - latex splitidx.dtx + pdflatex splitidx.dtx - or (if you do not have the mkindex script): + or (if you do not have the mkindex script): - latex splitidx.dtx - latex splitidx.dtx + pdflatex splitidx.dtx + pdflatex splitidx.dtx makeindex -s gind.ist splitidx makeindex -s gglo.ist -o splitidx.gls splitidx.glo - latex splitidx.dtx + pdflatex splitidx.dtx - You may print the resulting splitidx.dvi. If you prefere PDF - files, use pdflatex instead of latex. + You may print the resulting splitidx.pdf. -11th) read the manual you produced at 10th step. +8th) read the manual you produced at 7th step. HOW TO TEST YOUR INSTALLATION ============================= Use the following LaTeX source to test the installation. See -splitidx.dvi or splitidx.pdf to see how to do this. +splitidx.pdf to learn to know how to do this. \documentclass{article} % We use \Class{article} class ... \usepackage{splitidx} % ... and the \Package{splitidx} package -- cgit v1.2.3