From 38cea21778bb96ee16a74896b779a781229b917b Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 9 May 2011 17:26:48 +0000 Subject: update README and merge/remove other top-level doc to resemble current reality git-svn-id: svn://tug.org/texlive/trunk@22381 c570f23f-e606-0410-a88d-b1316a301751 --- Build/source/texk/makeindexk/ACK | 17 ---- Build/source/texk/makeindexk/CONTRIB | 61 +++++++++---- Build/source/texk/makeindexk/FILES | 38 -------- Build/source/texk/makeindexk/Makefile.am | 5 +- Build/source/texk/makeindexk/Makefile.in | 2 +- Build/source/texk/makeindexk/PORTING | 11 --- Build/source/texk/makeindexk/README | 146 +++---------------------------- 7 files changed, 58 insertions(+), 222 deletions(-) delete mode 100644 Build/source/texk/makeindexk/ACK delete mode 100644 Build/source/texk/makeindexk/FILES delete mode 100644 Build/source/texk/makeindexk/PORTING diff --git a/Build/source/texk/makeindexk/ACK b/Build/source/texk/makeindexk/ACK deleted file mode 100644 index 870339c54bb..00000000000 --- a/Build/source/texk/makeindexk/ACK +++ /dev/null @@ -1,17 +0,0 @@ - Acknowledgements - -The author would like to thank the copyright holders for agreeing to -release MakeIndex to the public domain and for allowing the author to -continue his support for this software. - -The author would also like to express his gratitude to the users of -MakeIndex for reporting bugs, and in many instances, for fixing them. -In particular, thanks must go to the contributors who have made -substantial contributions to the MakeIndex software. Their names are -listed in the CONTRIB file which comes with this release. - - - - Pehong Chen - 11/11/1989 - diff --git a/Build/source/texk/makeindexk/CONTRIB b/Build/source/texk/makeindexk/CONTRIB index a6ff1918ac5..b25a7a3539c 100644 --- a/Build/source/texk/makeindexk/CONTRIB +++ b/Build/source/texk/makeindexk/CONTRIB @@ -1,24 +1,47 @@ Key contributors of this MakeIndex distribution include - Pehong Chen chen@renoir.berkeley.edu - Leslie Lamport lamport@src.dec.com +Pehong Chen +Leslie Lamport and, in reverse alphabetical order by last name, - Klaus Zuenkler kl%falke@ztivax.siemens.com - Martha Wershofen-Mersbach grztex%dbngmd21.bitnet@net.bio.net - Art Werschulz werschulz@cs.columbia.edu - Ed Sznyter ews@pescadero.stanford.edu - Joachim Schrod schrod@iti.informatik.th-darmstadt.de - Rainer Schoepf schoepf@sc.zib-berlin.de - Rick Rodgers rodgers@maxwell.mmwb.ucsf.edu - Sebastian Rahtz spqr@ecs.southampton.ac.uk - Eberhard Mattes mattes@azu.informatik.uni-stuttgart.de - Charles Karney karney%ppc.mfenet@nmfecc.arpa - Mark James mark@bdblues.altair.fr - Anita Hoover anita@brahms.udel.edu - Michael Harrison harrison@berkeley.edu - Baron Grey baron@cs.ucla.edu - Andreas Brosig brosig@gmdzi.gmd.de - Johannes Braams braams@hlsdnl5.bitnet - Nelson Beebe beebe@math.utah.edu +Klaus Zuenkler +Eli Zaretskii +Martha Wershofen-Mersbach +Art Werschulz +Ed Sznyter +Joachim Schrod +Rainer Schoepf +Rick Rodgers +Sebastian Rahtz +Eberhard Mattes +Charles Karney +Akira Kakuto +Mark James +Anita Hoover +Taco Hoekwater +Michael Harrison +Baron Grey +Thomas Esser +Andreas Brosig +Peter Breitenlohner +Johannes Braams +Karl Berry +Nelson Beebe + + + Acknowledgements + +The author would like to thank the copyright holders for agreeing to +release MakeIndex to the public domain and for allowing the author to +continue his support for this software. + +The author would also like to express his gratitude to the users of +MakeIndex for reporting bugs, and in many instances, for fixing them. +In particular, thanks must go to the contributors who have made +substantial contributions to the MakeIndex software. Their names are +listed above. + + Pehong Chen + 11/11/1989 + diff --git a/Build/source/texk/makeindexk/FILES b/Build/source/texk/makeindexk/FILES deleted file mode 100644 index c683e53ee0e..00000000000 --- a/Build/source/texk/makeindexk/FILES +++ /dev/null @@ -1,38 +0,0 @@ - ----- Files sent under Automatic Mail Distribution ----- - - Copyright (C) 1989 by Chen & Harrison International Systems, Inc. - Copyright (C) 1988 by Olivetti Research Center - Copyright (C) 1987 by Regents of the University of California - -If you receive MakeIndex by ftp or from any distribution tape, you can -ignore this file because you should have the complete version. This -file explains what you should receive by mail on a file by file basis. -There is a shell script that will send the files listed below to you -automatically. This facility is intended for people with no access to -other distribution channels. - -What follows is a subset of the current MakeIndex distribution. It -contains the following files for important info about MakeIndex: - -FILES README CONTRIB ACK COPYING PORTING - -This distribution includes the file test.tex, which is a documentation -written by Leslie Lamport on the use of MakeIndex with LaTeX. Nelson -Beebe added index terms to the document, so that you can try out -MakeIndex with the test.idx file generated by running LaTeX on -test.tex. Also included is makeindex.l, which is a UNIX man page on -the general use of MakeIndex. - -You should also receice the following files, which comprise the full -MakeIndex source directory. - - Makefile.kcc Makefile.vms mkind.c scanid.h - Makefile.msc VMSmake.com mkind.h scanst.c -LOG Makefile.pcc genind.c qsort.c scanst.h -Makefile Makefile.unx genind.h scanid.c sortid.c - -Altogether, you should receive 26 messages, each containing one file, -from this automatic mail distribution of MakeIndex. - - Pehong Chen - 10/11/1989 diff --git a/Build/source/texk/makeindexk/Makefile.am b/Build/source/texk/makeindexk/Makefile.am index c20b110de79..077e9706434 100644 --- a/Build/source/texk/makeindexk/Makefile.am +++ b/Build/source/texk/makeindexk/Makefile.am @@ -1,6 +1,6 @@ ## Makefile.am for the TeX Live subdirectory texk/makeindexk/ ## -## Copyright (C) 2009, 2010 Peter Breitenlohner +## Copyright (C) 2009, 2010, 2011 Peter Breitenlohner ## You may freely use, modify and/or distribute this file. ## ACLOCAL_AMFLAGS = -I ../../m4 @@ -36,5 +36,4 @@ LDADD = $(KPATHSEA_LIBS) dist_man1_MANS = makeindex.1 mkindex.1 -EXTRA_DIST = ACK CONTRIB FILES NOTES PORTING - +EXTRA_DIST = CONTRIB NOTES diff --git a/Build/source/texk/makeindexk/Makefile.in b/Build/source/texk/makeindexk/Makefile.in index ff1aaa445df..cbbc70ddd5d 100644 --- a/Build/source/texk/makeindexk/Makefile.in +++ b/Build/source/texk/makeindexk/Makefile.in @@ -272,7 +272,7 @@ makeindex_SOURCES = \ LDADD = $(KPATHSEA_LIBS) dist_man1_MANS = makeindex.1 mkindex.1 -EXTRA_DIST = ACK CONTRIB FILES NOTES PORTING +EXTRA_DIST = CONTRIB NOTES all: c-auto.h $(MAKE) $(AM_MAKEFLAGS) all-am diff --git a/Build/source/texk/makeindexk/PORTING b/Build/source/texk/makeindexk/PORTING deleted file mode 100644 index 2f6daaf653e..00000000000 --- a/Build/source/texk/makeindexk/PORTING +++ /dev/null @@ -1,11 +0,0 @@ - ----- MakeIndex Porting Note ----- - -You are welcome and encouraged to port MakeIndex to any system not -support under the current distribution. The standard way of doing -that is by adding patches with enclosed #ifdef ... #endif pairs. You -can invent your own variables with the OS_ prefix attached in the -front. Please report your port back to me, so that I can make it -available to other people. - - Pehong Chen - 11/11/1989 diff --git a/Build/source/texk/makeindexk/README b/Build/source/texk/makeindexk/README index 0ae677040f8..3fea6973a9f 100644 --- a/Build/source/texk/makeindexk/README +++ b/Build/source/texk/makeindexk/README @@ -1,5 +1,5 @@ ------------------------------------------------------------------------------ - MakeIndex General Release Information + MakeIndexk General Release Information Copyright (C) 1989 by Chen & Harrison International Systems, Inc. Copyright (C) 1988 by Olivetti Research Center @@ -7,49 +7,24 @@ Author: Pehong Chen -MakeIndex is a general purpose index processor. This release contains -a FILES file, this README file, a CONTRIB file, an ACK file, a COPYING -notice, a brief PORTING instruction, a doc directory, a paper -directory, a src directory, a lib directory, and a test directory. +MakeIndex is a general purpose index processor written for use with +(La)TeX. ------------------------------------------------------------------------------- -Everyone should read COPYING before installing or distributing MakeIndex. +makeindex is currently maintained in TeX Live and many more people have +contributed changes. This incarnation uses the kpathsea library. +Please send bug reports to tex-k@tug.org. ------------------------------------------------------------------------------- -The CONTRIB file lists the names of people who have contributed to -to this release. +Documentation is in the TeX Live directory texmf-dist/doc/support/makeindex +and texmf/doc/man/man1/{make,mk}index.1. ------------------------------------------------------------------------------- -The ACK file contains the author's acknowledgements. +Basic index styles are in texmf-dist/makeindex/base. ------------------------------------------------------------------------------ -FILES is a note to people receiving MakeIndex from the automatic mail -distribution, which is done by the shell script "auto". - ------------------------------------------------------------------------------- -PORTING contains some information for people interested in porting -MakeIndex to systems not supported under the current distribution. +Everyone should read COPYING before installing or distributing MakeIndex. ------------------------------------------------------------------------------ -The doc directory contains - -deblank.awk AWK script used in the Makefile steps - -makeindex.hlp ASCII version of makeindex.l - -makeindex.info an Emacs (TOPS-20 and GNU) INFO node produced - automatically from makeindex.vms by vmshelp2 - (available from Utah) - -makeindex.l a UNIX man page - -makeindex.ps PostScript translation of makeindex.l - -makeindex.tex documentation for the use under LaTeX - by Leslie Lamport - -makeindex.vms VAX/VMS equivalent of makeindex.l suitable - for inclusion in a local help library +The CONTRIB file lists the names of people who have contributed to +to this release, and the original author's acknowledgements. ------------------------------------------------------------------------------ For a detailed discussion on the design of MakeIndex, please read @@ -58,103 +33,8 @@ For a detailed discussion on the design of MakeIndex, please read Tech. Report No. 87/347, Computer Science Division, University of California, Berkeley, March 1987. -A version of this report is included in the paper directory. A -somewhat condensed version entitled +A somewhat condensed version entitled ``Index Preparation and Processing'' appears in Software: Practice and Experience, 18(9):897-915, September 1988. - ------------------------------------------------------------------------------- - -The src directory contains the C source of MakeIndex. This current -version is known to compile and run on UNIX (BSD and System V, cc and -gcc), VAX/VMS (VMS cc), TOPS-20 (kcc-20 and pcc-20), and IBM PC DOS -(Microsoft C Version 5.0, Turbo C Version 2.0), Atari ST, Siemens -BS2000 (CCD-2000), and IBM MVS/XA (IBM-C370). Consult the files -README and LOG in the src directory for further details. - -Type make to compile under BSD UNIX. Makefiles or command scripts for -the other operating systems are included as well. Implementations of -Make for them are available as part of the Utah DVI driver -distribution (send e-mail to beebe@math.utah.edu). - -Early porting work was carried out by Charles Karney -(karney%ppc.mfenet@nmfecc.arpa) at Princeton University and David J. -Buerger (dbeurger%scu.bitnet@jade.berkeley.edu) at University of Santa -Clara. These efforts were independent of the port to PC DOS, TOPS-20, -VAX VMS, and the draft-ANSI C environment for version 2.3 carried out -by Nelson H.F. Beebe (beebe@math.utah.edu). That port is described -in the file LOG in the src directory. - ------------------------------------------------------------------------------- -The lib directory contains the file idxmac.tex, which is an excerpt of -LaTeX's macros for indexing. This file can be included in plain TeX -documents to generate the .idx file. Similarly, the file -idxmac-amstex.tex can be used with AmSTeX. Some hacking may be -necessary to incorporate it with other dialects. Some people have -complained not having the LaTeX sty file mentioned in -doc/makeindex.tex in their library, so a copy of makeidx.sty and -makeidx.doc is also included in the lib directory. - -The file showidx.sty provides a LaTeX document style option that -records index references on each page in marginal notes; this -facilitates checking that important phrases have been indexed, without -the need to continually consult the index. - ------------------------------------------------------------------------------- -The test directory contains several sets of test files: - -b209*.idx Miscellaneous tests that uncovered bugs at - makeindex version 2.09 which were fixed for - version 2.10. - -book.idx Raw index generated from ``The Technology War'', - David Brandin and Michael Harrison, - John Wiley and Sons, New York, 1988. - -tort.idx a host of odd raw index entries - -test.tex, test.idx a version of doc/makeindex.tex (due to Leslie - Lamport) that incorporates index entries - (prepared by Nelson Beebe). - This can be used both to test MakeIndex, as well as to - illustrate the production of an index for new users. - Read src/README for more info. - -ok-*.inx, ok-*.ilg Correct output for files without the ok- prefix. - -Makefile UNIX makefile to run regression tests on - ../src/makeindex - -vmsdiff.com VAX VMS command file to run differences; its - definition of the symbol MAKEINDEX must be - adapted for each site, since VAX VMS foreign - command symbols require an absolute file - directory name. - ------------------------------------------------------------------------------- -The troff directory contains - -troff.ist a sample style file -ixmac defines macros to be used for indexing under troff -sample.txt a sample troff document with embedded index commands -sample.idx raw index file -sample.ind the pre-formatted index file -makeind a shell script that creates the raw index file (.idx), - invokes makeindex which creates the final index file - (.ind). Note that - makeind sample.txt - will create sample.idx, sample.ilg, and sample.ind. - ------------------------------------------------------------------------------- - Pehong Chen - 11-Nov-1989 - - Nelson H.F. Beebe - 28-Jan-1988, 05-Jul-1991 - - Joachim Schrod - 21-Jun-1990 - ------------------------------------------------------------------------------- -- cgit v1.2.3