home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fonts 1 / freshfonts1.bin / bbs / programs / amiga / makeindex.lha / makeindex-2.12 / README < prev   
Text File  |  1991-07-08  |  7KB  |  161 lines
  1. ------------------------------------------------------------------------------
  2.         MakeIndex General Release Information
  3.  
  4.     Copyright (C) 1989 by Chen & Harrison International Systems, Inc.
  5.     Copyright (C) 1988 by Olivetti Research Center
  6.     Copyright (C) 1987 by Regents of the University of California
  7.  
  8.             Author: Pehong Chen
  9.  
  10. MakeIndex is a general purpose index processor.  This release contains
  11. a FILES file, this README file, a CONTRIB file, an ACK file, a COPYING
  12. notice, a brief PORTING instruction, a doc directory, a paper
  13. directory, a src directory, a lib directory, and a test directory.
  14.  
  15. ------------------------------------------------------------------------------
  16. Everyone should read COPYING before installing or distributing MakeIndex.
  17.  
  18. ------------------------------------------------------------------------------
  19. The CONTRIB file lists the names of people who have contributed to
  20. to this release.
  21.  
  22. ------------------------------------------------------------------------------
  23. The ACK file contains the author's acknowledgements.
  24.  
  25. ------------------------------------------------------------------------------
  26. FILES is a note to people receiving MakeIndex from the automatic mail
  27. distribution, which is done by the shell script "auto".
  28.  
  29. ------------------------------------------------------------------------------
  30. PORTING contains some information for people interested in porting
  31. MakeIndex to systems not supported under the current distribution.
  32.  
  33. ------------------------------------------------------------------------------
  34. The doc directory contains
  35.  
  36. deblank.awk        AWK script used in the Makefile steps
  37.  
  38. makeindex.hlp        ASCII version of makeindex.l
  39.  
  40. makeindex.info        an Emacs (TOPS-20 and GNU) INFO node produced
  41.             automatically from makeindex.vms by vmshelp2
  42.             (available from Utah)
  43.  
  44. makeindex.l        a UNIX man page
  45.  
  46. makeindex.ps        PostScript translation of makeindex.l
  47.  
  48. makeindex.tex        documentation for the use under    LaTeX
  49.             by Leslie Lamport
  50.  
  51. makeindex.vms        VAX/VMS equivalent of makeindex.l suitable
  52.             for inclusion in a local help library
  53.  
  54. ------------------------------------------------------------------------------
  55. For a detailed discussion on the design of MakeIndex, please read
  56.  
  57.     Pehong Chen and Michael Harrison, ``Automating Index Preparation'',
  58.     Tech. Report No. 87/347, Computer Science Division,
  59.     University of California, Berkeley, March 1987.
  60.  
  61. A version of this report is included in the paper directory.  A
  62. somewhat condensed version entitled
  63.  
  64.     ``Index Preparation and Processing''
  65.  
  66. appears in Software: Practice and Experience, 18(9):897-915, September 1988.
  67.  
  68. ------------------------------------------------------------------------------
  69.  
  70. The src directory contains the C source of MakeIndex.  This current
  71. version is known to compile and run on UNIX (BSD and System V, cc and
  72. gcc), VAX/VMS (VMS cc), TOPS-20 (kcc-20 and pcc-20), and IBM PC DOS
  73. (Microsoft C Version 5.0, Turbo C Version 2.0), Atari ST, Siemens
  74. BS2000 (CCD-2000), and IBM MVS/XA (IBM-C370).  Consult the files
  75. README and LOG in the src directory for further details.
  76.  
  77. Type make to compile under BSD UNIX.  Makefiles or command scripts for
  78. the other operating systems are included as well.  Implementations of
  79. Make for them are available as part of the Utah DVI driver
  80. distribution (send e-mail to beebe@math.utah.edu).
  81.  
  82. Early porting work was carried out by Charles Karney
  83. (karney%ppc.mfenet@nmfecc.arpa) at Princeton University and David J.
  84. Buerger (dbeurger%scu.bitnet@jade.berkeley.edu) at University of Santa
  85. Clara.  These efforts were independent of the port to PC DOS, TOPS-20,
  86. VAX VMS, and the draft-ANSI C environment for version 2.3 carried out
  87. by Nelson H.F. Beebe (beebe@math.utah.edu).  That port is described
  88. in the file LOG in the src directory.
  89.  
  90. ------------------------------------------------------------------------------
  91. The lib directory contains the file idxmac.tex, which is an excerpt of
  92. LaTeX's macros for indexing.  This file can be included in plain TeX
  93. documents to generate the .idx file.  Similarly, the file
  94. idxmac-amstex.tex can be used with AmSTeX.  Some hacking may be
  95. necessary to incorporate it with other dialects.  Some people have
  96. complained not having the LaTeX sty file mentioned in
  97. doc/makeindex.tex in their library, so a copy of makeidx.sty and
  98. makeidx.doc is also included in the lib directory.
  99.  
  100. The file showidx.sty provides a LaTeX document style option that
  101. records index references on each page in marginal notes; this
  102. facilitates checking that important phrases have been indexed, without
  103. the need to continually consult the index.
  104.  
  105. ------------------------------------------------------------------------------
  106. The test directory contains several sets of test files:
  107.  
  108. b209*.idx        Miscellaneous tests that uncovered bugs at
  109.             makeindex version 2.09 which were fixed for
  110.             version 2.10.
  111.  
  112. book.idx        Raw index generated from ``The Technology War'',
  113.             David Brandin and Michael Harrison,
  114.             John Wiley and Sons, New York, 1988.
  115.  
  116. tort.idx        a host of odd raw index entries
  117.  
  118. test.tex, test.idx    a version of doc/makeindex.tex (due to Leslie
  119.             Lamport) that incorporates index entries
  120.             (prepared by Nelson Beebe).
  121.             This can be used both to test MakeIndex, as well as to
  122.             illustrate the production of an index for new users.
  123.             Read src/README for more info.
  124.  
  125. ok-*.inx, ok-*.ilg    Correct output for files without the ok- prefix.
  126.  
  127. Makefile        UNIX makefile to run regression tests on
  128.             ../src/makeindex
  129.  
  130. vmsdiff.com        VAX VMS command file to run differences; its
  131.             definition of the symbol MAKEINDEX must be
  132.             adapted for each site, since VAX VMS foreign
  133.             command symbols require an absolute file
  134.             directory name.
  135.  
  136. ------------------------------------------------------------------------------
  137. The troff directory contains
  138.  
  139. troff.ist        a sample style file
  140. ixmac            defines macros to be used for indexing under troff
  141. sample.txt        a sample troff document with embedded index commands
  142. sample.idx        raw index file
  143. sample.ind        the pre-formatted index file
  144. makeind            a shell script that creates the raw index file (.idx),
  145.             invokes makeindex which creates the final index file
  146.             (.ind).  Note that
  147.                 makeind sample.txt
  148.             will create sample.idx, sample.ilg, and sample.ind.
  149.  
  150. ------------------------------------------------------------------------------
  151.                         Pehong Chen
  152.                         11-Nov-1989
  153.  
  154.                         Nelson H.F. Beebe
  155.                         28-Jan-1988, 05-Jul-1991
  156.  
  157.                         Joachim Schrod
  158.                         21-Jun-1990
  159.  
  160. ------------------------------------------------------------------------------
  161.