DataMuseum.dk

top - metrics - download

    Length: 4342 (0x10f6)
    Types: TextFile
    Names: »Lindex.1«

└─⟦52210d11f⟧ Bits:30007239 EUUGD2: TeX 3 1992-12
    └─⟦c319c2751⟧ »unix3.0/TeX3.0.tar.Z« 
        └─⟦036c765ac⟧ 
            └─⟦this⟧ »TeX3.0/Man-pages/other-manuals/Lindex.1« 
└─⟦52210d11f⟧ Bits:30007239 EUUGD2: TeX 3 1992-12
    └─⟦63303ae94⟧ »unix3.14/TeX3.14.tar.Z« 
        └─⟦c58930e5c⟧ 
            └─⟦this⟧ »TeX3.14/Man-pages/other-manuals/Lindex.1« 

TextFile

From trwrb!trwspp!spp3!simpson@ucbvax.Berkeley.EDU Sun Apr 10 22:17:52 1988
From: trwrb!trwspp!spp3!simpson@ucbvax.Berkeley.EDU (Scott Simpson)
Date: 10 Apr 1988 0759-PST (Sunday)
To: mackay@june.cs.washington.edu
Subject: LaTeX index processor on TeX distribution

I have updated the manual page for the LaTeX index processor on the
TeX distribution tape.  Please replace the file index.1 with the file
enclosed.  I just added a paragraph about the comment character.
	Scott

#! /bin/sh
# To extract, remove mail header lines and type "sh filename"
echo x - index.1
sed -e 's/^X//' > index.1 << '!FaR!OuT!'
X.\" $Header: /home/simpson/src/index/RCS/index.1,v 1.3 88/04/10 08:53:54 simpson Exp $
X.if t .ds LX L\v'-.22m'\h'-.1667m'\s-3A\s+3\h'-.125m'\v'.22m'T\h'-.1667m'\v'.22m'E\h'-.125m'\v'-.22m'X
X.if n .ds LX LaTeX
X.TH INDEX 1 TRW
X.UC
X.SH NAME
Xindex \- index processor for converting LaTeX idx files
X.SH ORIGIN
XTRW
X.SH SYNOPSIS
X.B index [ -l ]
X.B [ -f
X.I alphabetizefile
X.B ] [
X.I file...
X.B ]
X.SH DESCRIPTION
X.I Index
Xconverts 
X.I idx 
Xfiles generated by \*(LX into 
X.I theindex 
Xenvironments that can be processed by \*(LX.
XMultiple files may be given.
XIf the file is not found, the extension
X.I idx
Xis appended and the new file is looked for.
XIndex files will be created with the extension
X.I ind.
XIf no files are given, standard input is read and standard output it written.
XSubitems and subsubitems can be generated by separating index entries
Xwith commas.
XFor example, after running your document
Xthrough \*(LX you may obtain an index file 
X.I sample.idx
Xcontaining entries
Xthat look like
X.RS
X.nf
X\eindexentry{Reagan}{32}
X\eindexentry{Reagan}{54}
X\eindexentry{Reagan,republicans}{54}
X\eindexentry{Carter}{60}
X\eindexentry{Reagan,republicans,conventions}{62}
X.fi
X.RE
XAfter running the index file through
X.I index
Xa file
X.I sample.ind 
Xwill be created that will contain
X.RS
X.nf
X\ebegin{theindex}
X\eitem Carter 60
X\eindexspace 
X\eitem Reagan 32, 54
X  \esubitem republicans 54
X    \esubsubitem conventions 62
X\eend{theindex}
X.fi
X.RE
XThe 
X.I indexspace 
Xleaves a little extra vertical space between the entries that start with
Xa new letter.
XIf the 
X.I -l 
Xoption is given, then a large index letter will precede each entry
Xthat starts with a new letter.
X.PP
X.I Index
Xreads the file
X.I .alphabetize
Xin the home directory if it exists
Xto determine how to alphabetize an
X.I idx
Xfile.
XThis file contains rules for skipping control sequences, characters, etc
Xwhen alphabetizing a file.
XThe format of this file is described in
X.IR index (5).
XIf the 
X.I -f 
Xoption is given, then another alphabetization file can be given.
X.PP
XA dash following an entry indicates the beginning of a range. 
XThe range is ended by the occurence of the next equivalent entry.
XFor example, suppose you had a \*(LX file containing
X.RS
X.nf
X\&...and they fought\eindex{fighting-} and wept...
X.fi
X.RE
Xon page 40 and
X.RS
X.nf
X\&...and were still fighting\eindex{fighting} years later...
X.fi
X.RE 
Xon page 42 with no intervening
X.I \eindex
Xcommands.
XThen after running the 
X.I idx
Xfile through 
X.I index,
Xthe line 
X.RS
X.nf
X\eitem fighting 40--42
X.fi
X.RE 
Xwould be contained in the 
X.I ind 
Xfile.
XWhen ranges are given for subitems and subsubitems, only the last
Xcomma separated entry should have a dash suffix.
XDuplicate page numbers are suppressed.
X.PP
XIf you wish to insert a comma into your index entry, you will need to 
Xhide it from the index processor with braces
Xsince only outer level commas are recognized as item delimiters.
XFor example,
X.RS
X.nf
X\eindex{Reagan{,} Ronald}
X.fi
X.RE
Xgenerates the index entry for
X.I Reagan, Ronald.
X.PP
XYou can delete the page numbers by using \*(LX's comment character.  
XFor example,
X.RS
X.nf
X\eindex{Reagan,see also Grenada%}
X.fi
X.RE
Xwill comment out the page numbers.
X.SH FILES
X.nf
X.ta \w'~/.alphabetize  'u
X~/.alphabetize	Default alphabetization file
X.fi
X.SH AUTHOR
XScott Simpson
X.SH SEE ALSO
Xprofile(3), index(5), profile(5)
X.SH BUGS
XRanges may not span roman/arabic boundaries;
Xthat is, you may not start a range in a roman section and
Xend it in an arabic section.  You must
Xend the range in the roman numeral section and restart
Xit in the arabic section.
!FaR!OuT!
exit