home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / gnu / gptx-0.2 / README < prev    next >
Encoding:
Text File  |  1991-10-10  |  4.0 KB  |  85 lines
  1. README for GNU ptx - last revised 91-10-10.
  2. Copyright (C) 1991 Free Software Foundation, Inc.
  3. See file COPYING for copying conditions.
  4.  
  5.    This is the 0.2 alpha release of `gptx', the GNU version of a
  6. permuted index generator.  This software has the main goal of
  7. providing a `ptx' *almost* compatible replacement, able to handle
  8. small files quickly, while providing a platform for more development.
  9.  
  10.    This version reimplements and extends standard `ptx'.  Among other
  11. things, it can produce a readable "KWIC" (keywords in their context)
  12. without the need of `nroff', there is also an option to produce TeX
  13. compatible output.  This version does not yet handle huge input files,
  14. that is, those files which do not fit in memory all at once.
  15.  
  16.    *Please note* that an overall renaming of all options is
  17. foreseeable.  In fact, GNU ptx specifications are not frozen yet.
  18.  
  19.    There is some documentation in `gptx.texinfo', but no man page.
  20. This software installs as two programs: gptx and ptx, which have
  21. different calling sequences and behaviour; ptx attempts to be
  22. compatible with UNIX ptx.  Calling `gptx +help' or `ptx -h' prints an
  23. option summary.
  24.  
  25.   I tried to follow GNU installation standards.  `gptx' has been
  26. tested on 386/ix, Appolo-3, Iris-4D, Sun-3 and Sparc systems.  Tell me
  27. how it worked on your machine!  To install, please follow these steps:
  28.  
  29. 0.  Only `gptx' will be compiled, and not `ptx', if the standard `ptx'
  30. default Ignore file is not found.  So, if you also want `ptx' and the
  31. Ignore file is not /usr/lib/eign, be careful to define IGNOREFILE to
  32. the location of the Ignore file to use.  You can do this while calling
  33. configure, as explained a little below.
  34.  
  35. 1.  At the top level (the directory this README is in), type
  36. `./configure'.  This shell script attempts to guess correct values for
  37. various system-dependent variables used during compilation, and
  38. creates the files `Makefile', `lib/Makefile', `src/Makefile' and
  39. `doc/Makefile'.  This takes a minute or two.
  40.  
  41.   If you want to compile in a different directory from the one
  42. containing the source code, `cd' to that directory and run `configure'
  43. with the option `+srcdir=DIR', where DIR is the directory that
  44. contains the source code.  The object files and executables will be
  45. put in the current directory.  This option only works with versions of
  46. `make' that support the VPATH variable.  `configure' ignores any other
  47. arguments you give it.
  48.  
  49.   If your system requires unusual options for compilation or linking
  50. that `configure' doesn't know about, you can give `configure' initial
  51. values for variables by setting them in the environment; in
  52. Bourne-compatible shells, you can do that on the command line like
  53. this:
  54.  
  55.     $ CC='gcc -traditional' LIBS=-lposix ./configure
  56.  
  57. 2.  If you want to change the directories where the programs will be
  58. installed, or the optimization options, edit `Makefile' and change
  59. those values.  If you have an unusual system that needs special
  60. compilation options that `configure' doesn't know about, and you
  61. didn't pass them in the environment when running `configure', you
  62. should add them to `Makefile' now.  Alternately, teach `configure' how
  63. to figure out that it is being run on a system where they are needed,
  64. and mail the diffs to the address listed at the end of this file so we
  65. can include them in the next release.
  66.  
  67. 3.  In the top-level directory, type `make'.  You don't need to
  68. otherwise touch the Makefiles in the subdirectories or use them
  69. directly.
  70.  
  71. 4.  If the programs compile successfully, type `make check'.  There
  72. should not be any output from the `diff' program.
  73.  
  74. 5.  If everything went fine so far, type `make install' to install
  75. the programs and their documentation.
  76.  
  77. 6.  After you have installed the programs, you can remove the binaries
  78. from the source directories by typing `make clean'.  Type `make
  79. distclean' if you also want to remove the Makefiles that `configure'
  80. created, for instance if you are going to recompile the utilities next
  81. on another type of machine.
  82.  
  83.   Please mail suggestions and bug reports to Francois Pinard, using
  84. <pinard@iro.umontreal.ca> or <...uunet!iros1!pinard>.
  85.