summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-03-28 00:35:49 +0000
committerKarl Berry <karl@freefriends.org>2009-03-28 00:35:49 +0000
commit26ed61774040442728cbee707dc6e492b5085674 (patch)
tree85c365b3b8cc847e68a312c73b9f8cc1ca083916 /Master/texmf-dist/doc
parent87a534fcd4ae6214e3b7f9f91977abfee4582fcf (diff)
splitindex is back, will fix man page tomorrow (25mar09)
git-svn-id: svn://tug.org/texlive/trunk@12544 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/splitindex/README67
-rw-r--r--Master/texmf-dist/doc/latex/splitindex/install.txt223
-rw-r--r--Master/texmf-dist/doc/latex/splitindex/splitidx.pdfbin0 -> 243672 bytes
-rw-r--r--Master/texmf-dist/doc/latex/splitindex/splitindex.164
4 files changed, 354 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/splitindex/README b/Master/texmf-dist/doc/latex/splitindex/README
new file mode 100644
index 00000000000..8b531b75d6b
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/splitindex/README
@@ -0,0 +1,67 @@
+Welcome to SplitIndex, the TeX index splitter. SplitIndex creates
+multiple index files from one raw index. See manifest.txt if you want
+to know the files SplitIndex exists of.
+
+There are a lot of alternatives in using SplitIndex, because I wanted
+solutions at every platform. Not all of the programs are distributed
+in binary form. But splitindex.tex will work at every platform. And you
+need only TeX (even not LaTeX) to run it.
+
+Currently I support binaries for the following platforms:
+
+ Linux ELF i386, OpenBSD 3.0 i386, CygWIN Windows 32 Bit i386
+
+If you need support, you can write me a mail. Use
+
+ To: splitindex <komascript(at)gmx.info>
+ Subject: SPLITINDEX: <YourProblem>
+
+And replace <YourProblem> by a short (at least 60 chars) description
+of your problem.
+
+See file install.txt for a description how to install this
+distribution and how to get the manual, which describes how to use
+SplitIndex.
+
+LEGALESE:
+---------
+
+This work may be distributed and/or modified under the conditions of
+the LaTeX Project Public License, version 1.3c of the license.
+The latest version of this license is in
+ http://www.latex-project.org/lppl.txt
+and version 1.3c or later is part of all distributions of LaTeX
+version 2005/12/01 or later and of this work.
+
+This work has the LPPL maintenance status "author-maintained".
+
+The Current Maintainer and author of this work is Markus Kohm.
+
+The list of all files belongig to the SplitIndex bundle is given in
+in the file `manifest.txt'. Files generated by means of unpacking the
+distribution (using, for example, the docstrip program) or by means
+of compiling them from a source file, for example, from splitindex.c
+or splitindex.java may be distributed at the distributor's discretion.
+However if they are distributed then a copy of the SplitIndex bundle
+must be distributed together with them.
+
+The list of derived (unpacked or compiled) files belongig to the
+distribution and covered by LPPL is defined by the unpacking scripts
+(with extension .ins) and the installation script (with name
+install.sh) which are part of the distribution.
+
+Two often ignorred clauses from LPPL 1.3c you should not ignore:
+----------------------------------------------------------------
+
+2. You may distribute a complete, unmodified copy of the Work as you
+ received it. Distribution of only part of the Work is considered
+ modification of the Work, and no right to distribute such a Derived
+ Work may be assumed under the terms of this clause.
+3. You may distribute a Compiled Work that has been generated from a
+ complete, unmodified copy of the Work as distributed under Clause 2
+ above, as long as that Compiled Work is distributed in such a way that
+ the recipients may install the Compiled Work on their system exactly
+ as it would have been installed if they generated a Compiled Work
+ directly from the Work.
+
+Enjoy, Markus.
diff --git a/Master/texmf-dist/doc/latex/splitindex/install.txt b/Master/texmf-dist/doc/latex/splitindex/install.txt
new file mode 100644
index 00000000000..353a37af06a
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/splitindex/install.txt
@@ -0,0 +1,223 @@
+ SplitIndex Installation Guide
+
+ 2009-03-18
+
+
+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
+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.
+
+But you may also try the following step by step installation:
+
+HOW TO INSTALL SplitIndex FROM A TDS-ARCHIVE
+============================================
+
+Some distributors may use a SplitIndex TDS-archive for distributing
+SplitIndex. SplitIndex TDS-archive may be installed very easily.
+The SplitIndex TDS-archive has following contents:
+
+ +- doc/
+ | +- latex/
+ | +- splitindex/
+ | +- install.txt
+ | +- README
+ | +- splitidx.pdf
+ | +- splitindex.1
+ +- tex/
+ | +- latex/
+ | +- splitindex/
+ | +- splitidx.sty
+ | +- splitindex.tex
+ +- scripts/
+ | +- splitindex/
+ | +- perl/
+ | +- splitindex.pl
+ +- source/
+ +- latex/
+ +- splitindex/
+ +- install.sh
+ +- install.txt
+ +- manifest.txt
+ +- README
+ +- splitidx.dtx
+ +- splitidx.ins
+ +- splitindex.1
+ +- splitindex.c
+ +- splitindex.class
+ +- splitindex.exe
+ +- splitindex.java
+ +- splitindex-Linux-i386
+ +- splitindex-OpenBSD-i386
+ +- splitindex.pl
+ +- splitindex.tex
+
+If you don't have such an archive, continue reading at 1st step of ``HOW TO
+GENERATE THE splitidx PACKAGE''. If you have such an archive - we will use
+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
+ shell:
+
+ kpsexpand \$TEXMFLOCAL
+
+ to use the local texmf tree or:
+
+ kpsexpand \$HOMETEXMF
+
+ to use your private texmf tree. Following uses ``<TEXMF>'' to
+ be a synonym for the texmf tree you want to use.
+
+B) Extract splitindex.tds.zip at <TEXMF> with all the subdirectories of
+ the splitindex.tds.zip but without generating additional
+ subdirectories, e.g., using:
+
+ cd <TEXMF>
+ unzip splitindex.tds.zip
+
+ or any other zip extraction programm.
+
+C) Continue with 5th to 9th step of ``HOW TO INSTALL THE BINARIES''.
+
+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.
+
+E) Read ``HOW TO TEST YOUR INSTALLATION'' at the end of this
+ documentation.
+
+
+HOW TO GENERATE THE splitidx PACKAGE
+====================================
+
+You need this only, if you don't have a SplitIndex TDS-archive, but want
+to install SplitIndex from a basic SplitIndex distribution. If you have
+already done the SplitIndex TDS-archive installation discribed above, you
+should skip this section.
+
+1st) Process splitidx.ins with TeX or LaTeX, e.g. using the following
+ input at a command shell (e.g. bash or command.com):
+
+ latex splitidx.ins
+
+ Maybe you'll be asked, if you want to overwrite existing files.
+ 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
+ shell:
+
+ kpsexpand \$TEXMFLOCAL
+
+ to use the local texmf tree or:
+
+ kpsexpand \$HOMETEXMF
+
+ to use your private texmf tree. Following uses ``<TEXMF>'' to
+ be a synonym for the texmf tree you want to use.
+
+3rd) Create folder <TEXMF>/tex/latex/splitindex (at Windows:
+ <TEXMF>\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
+ base, e.g. texhash or mktexlsr if you are using teTeX/TeX Live.
+
+
+HOW TO INSTALL THE BINARIES
+===========================
+
+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 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
+
+6th) Copy splitindex.java to the binary search path of SUN JAVA
+ 1.4.1.
+
+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).
+
+9th) Copy splitindex.tex to the same location you've copied
+ splitidx.sty to and do 4th step again.
+
+
+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:
+
+ latex splitidx.dtx
+ latex splitidx.dtx
+ mkindex splitidx
+ latex splitidx.dtx
+
+ or (if you do not have the mkindex script):
+
+ latex splitidx.dtx
+ latex splitidx.dtx
+ makeindex -s gind.ist splitidx
+ makeindex -s gglo.ist -o splitidx.gls splitidx.glo
+ latex splitidx.dtx
+
+ You may print the resulting splitidx.dvi. If you prefere PDF
+ files, use pdflatex instead of latex.
+
+11th) read the manual you produced at 10th 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.
+
+\documentclass{article} % We use \Class{article} class ...
+\usepackage{splitidx} % ... and the \Package{splitidx} package
+\makeindex % And we want index generation
+\usepackage{hyperref}
+% We define 4 indices:
+\newindex[General Index]{idx} % Name and shortcut of the 1st index
+\newindex[Index of Animals]{ani} % ... 2nd index
+\newindex[Index of Fruits]{fru} % ... 3rd index
+\newindex[Index of Vegetables]{veg} % ... \dots\ 4th index
+
+\begin{document}
+Apples\sindex[fru]{apple} % an entry to fru index
+and oranges\sindex[fru]{orange} % an entry to fru index
+are fruits\sindex{fruits}. % an implicite entry to idx index
+Tomatos\sindex[veg]{tomato} % an entry to veg index
+are vegetables\index{vegetables}. % an implicite entry to idx index
+Cats\sindex[ani]{cat} % an entry to ani index
+are animals\sindex[idx]{animals}. % an explicite entry to idx index
+
+\twocolumn[%
+ \section*{Indices}%
+ \markboth{Indices}{Indices}%
+]
+\printsubindex* % print all indices
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/splitindex/splitidx.pdf b/Master/texmf-dist/doc/latex/splitindex/splitidx.pdf
new file mode 100644
index 00000000000..85509454bac
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/splitindex/splitidx.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/splitindex/splitindex.1 b/Master/texmf-dist/doc/latex/splitindex/splitindex.1
new file mode 100644
index 00000000000..98188409f60
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/splitindex/splitindex.1
@@ -0,0 +1,64 @@
+.TH SPLITINDEX "1" "November 2002" "splitindex 0.2a" "User Commands"
+.SH NAME
+splitindex \- manual page for splitindex 0.2a
+.SH SYNOPSIS
+.B splitindex.pl
+[\fIOPTION\fR]... \fIRAWINDEXFILE \fR[\fIMAKEINDEXOPTION\fR]...
+.PP
+.B splitindex
+[\fIOPTION\fR]... \fIRAWINDEXFILE \fR[\fIMAKEINDEXOPTION\fR]...
+.PP
+.B java splitindex
+[\fIOPTION\fR]... \fIRAWINDEXFILE \fR[\fIMAKEINDEXOPTION\fR]...
+.PP
+.B tex splitindex
+.SH DESCRIPTION
+splitindex 0.2a
+Copyright (c) 2002 Markus Kohm <kohm@gmx.de>
+.PP
+Split a single raw index file into multiple raw index files.
+.PP
+Example: splitindex.pl foo.idx.
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help and terminate
+.TP
+\fB\-m\fR, \fB\-\-makeindex\fR PROGNAME
+call PROGNAME instead of default `makeindex'.
+.TP
+\fB\-i\fR, \fB\-\-identify\fR EXPRESSION
+use regular EXPRESSION to match entries
+(see also option \fB\-\-resultis\fR and \fB\-\-suffixis\fR).
+Default is `^(\e\eindexentry)\e[([^]]*)\e](.*)$'.
+.TP
+\fB\-r\fR, \fB\-\-resultis\fR PATTERN
+create line to be written from PATTERN after matching
+lines (see also option \fB\-\-identify\fR).
+Default is `$1$3'.
+.TP
+\fB\-s\fR, \fB\-\-suffixis\fR PATTERN
+create suffix to be used from PATTERN after matching
+lines (see also option \fB\-\-identify\fR).
+Default is `-$2'.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+be more verbose
+(can be used multiple to increase verbosity)
+.TP
+\fB\-\-version\fR
+show version and terminate
+.SH COPYRIGHT
+Copyright \(co 2002 Markus Kohm <kohm@gmx.de>
+.SH "SEE ALSO"
+The full documentation for
+.B splitindex
+is maintained as a LaTeX manual. If the
+.B texdoc
+and
+.B splitindex
+programs are properly installed at your site, the command
+.IP
+.B texdoc splitidx
+.PP
+should give you access to the complete manual.