home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1998 #6 / amigamamagazinepolishissue1998.iso / coders / indent / readme < prev    next >
Text File  |  1999-05-29  |  4KB  |  122 lines
  1. README for GNU `indent' version 1.7
  2.  
  3. Read the file RELEASE_NOTES for more information, especially to see what's
  4. different from the last version, and what future versions may do.
  5.  
  6.  
  7. SIMPLE INSTALLATION
  8.  
  9.   Once you have unpacked the tar file, simply type "make" in the source
  10.   directory to produce an executable copy of `indent' in that directory.
  11.   If you then type "make install", the program will be installed by
  12.   default as /usr/local/bin/indent and the on-line help will be
  13.   installed as /usr/local/info/indent.info (see DOCUMENTATION, below).
  14.  
  15.   It is possible to change these default installation paths.  To change
  16.   the place where `indent' is installed, you may specify the prefix
  17.   directory as an argument to make like so:
  18.  
  19.     make prefix=/usr/gnu
  20.  
  21.   This will install `indent' as /usr/gnu/bin/indent and the info node as
  22.   /usr/gnu/info/indent.info.
  23.  
  24.   To specify separate executable and info directories, specify them
  25.   like this:
  26.  
  27.     make prefix=/doc exec_prefix=/usr
  28.  
  29.   This will install `indent' as /usr/bin/indent and the info node as
  30.   /doc/info/indent.info.
  31.  
  32.  
  33. SEPARATE CONFIGURATION
  34.  
  35.   Like most GNU software, `indent' uses the program `configure' to
  36.   determine certain system-dependent parameters and construct the
  37.   makefile.  In the example above, the master makefile passes its
  38.   arguments (if any) to the configure program, and then calls `make'
  39.   recursively to build `indent'.  Thus the last example is equivalent
  40.   to:
  41.  
  42.     configure --prefix=/doc --exec-prefix=/usr
  43.     make
  44.  
  45.   With `configure', it is also possible to build the program in a
  46.   separate directory from the source by running `configure' in that
  47.   separate directory with the source directory as the "--srcdir"
  48.   argument to `configure'.
  49.   
  50.   For example, if the `indent' source is located in the directory
  51.   /SYSTEM_A/src/indent and you want to build a copy in /SYSTEM_B/test/,
  52.   you can do the following:
  53.     
  54.     cd /SYSTEM_B/test
  55.     /SYSTEM_A/src/indent/configure --srcdir=/SYSTEM_A/src/indent
  56.     make
  57.  
  58.   which will produce the the executable file /SYSTEM_B/test/indent.  For
  59.   more information on `configure', see the included file CONF-README.
  60.  
  61.  
  62. DOCUMENTATION
  63.  
  64.   GNU uses a language called "texinfo" for its documentation which
  65.   produces both an on-line, interactive version and a hardcopy version
  66.   for printing.  The on-line version, `indent.info', is installed along
  67.   with the executable by typing "make install".  Refer to the Texinfo
  68.   manual for more information on this system.
  69.  
  70.   The hardcopy version is produced from the source file `indent.texinfo'
  71.   in as either a DVI or Postscript format file.  To produce the DVI
  72.   version, type:
  73.  
  74.     make indent.dvi
  75.  
  76.   To produce the Postscript version, type:
  77.  
  78.     make indent.ps
  79.  
  80.   Note that you must have the TeX typographical system installed for
  81.   this to work.
  82.  
  83.   While a Unix-style "man" page is also provided in the file
  84.   `indent.1', it was provided by a user and is unsupported.  It
  85.   is likely to be several versions behind the program, and thus there
  86.   is no provision for its installation.
  87.  
  88.  
  89. INDENT BUGS
  90.  
  91.   The "-troff" option is not supported and is strongly deprecated.  A
  92.   good thing for someone to do is to rewrite `indent' to generate TeX
  93.   source as a hardcopy output option, amoung other things.  See the
  94.   `Projects' file for more things to do.
  95.  
  96.  
  97. BUG REPORTS
  98.  
  99.   Please address bug-reports and suggestions or comments to:
  100.  
  101.     bug-gnu-utils@prep.ai.mit.edu
  102.  
  103.  
  104. FUTURE OF INDENT
  105.  
  106.   There will probably be at least one more version of `indent' released
  107.   which will do a better job of indenting comments (e.g., do what the
  108.   documentation says it does -- see `RELEASE_NOTES' for more details).
  109.   After that, I am considering C++ support, and perhaps VMS support.
  110.  
  111.   However, the Free Software Foundation is very short of funds, and I
  112.   am now supporting `indent' purely on a volunteer basis, so it is not
  113.   certain whether or not I will continue to do this.  If you or your
  114.   company find `indent' useful and are interested in supporting it,
  115.   through funding, donation of a machine, or taking over its
  116.   maintenance, please send me mail.
  117.  
  118.   Joseph Arceneaux
  119.   Independent Consultant
  120.   jla@ai.mit.edu
  121.   +1 415 285 9088
  122.