home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / indent-1.9.1-src.tgz / tar.out / fsf / indent / README < prev    next >
Text File  |  1996-09-28  |  5KB  |  146 lines
  1. README for GNU `indent'
  2.  
  3. Read the file NEWS for more information, especially to see what's
  4. different from the last version, and what future versions may do.  If
  5. you are installing indent on VMS, see the file VMS-README.
  6.  
  7.  
  8. SIMPLE INSTALLATION
  9.  
  10.   Once you have unpacked the tar file, simply type "make" in the source
  11.   directory to produce an executable copy of `indent' in that directory.
  12.   If you then type "make install", the program will be installed by
  13.   default as /ade/bin/indent and the on-line help will be
  14.   installed as /ade/info/indent.info (see DOCUMENTATION, below).
  15.  
  16.   It is possible to change these default installation paths.  To change
  17.   the place where `indent' is installed, you may specify the prefix
  18.   directory as an argument to make like so:
  19.  
  20.     make prefix=/usr/gnu
  21.  
  22.   This will install `indent' as /usr/gnu/bin/indent and the info node as
  23.   /usr/gnu/info/indent.info.
  24.  
  25.   To specify separate executable and info directories, specify them
  26.   like this:
  27.  
  28.     make prefix=/doc exec_prefix=/usr
  29.  
  30.   This will install `indent' as /usr/bin/indent and the info node as
  31.   /doc/info/indent.info.
  32.  
  33.  
  34. SEPARATE CONFIGURATION
  35.  
  36.   Like most GNU software, `indent' uses the program `configure' to
  37.   determine certain system-dependent parameters and construct the
  38.   makefile.  In the example above, the master makefile passes its
  39.   arguments (if any) to the configure program, and then calls `make'
  40.   recursively to build `indent'.  Thus the last example is equivalent
  41.   to:
  42.  
  43.     configure --prefix=/doc --exec-prefix=/usr
  44.     make
  45.  
  46.   With `configure', it is also possible to build the program in a
  47.   separate directory from the source by running `configure' in that
  48.   separate directory with the source directory as the "--srcdir"
  49.   argument to `configure'.
  50.   
  51.   For example, if the `indent' source is located in the directory
  52.   /SYSTEM_A/src/indent and you want to build a copy in /SYSTEM_B/test/,
  53.   you can do the following:
  54.     
  55.     cd /SYSTEM_B/test
  56.     /SYSTEM_A/src/indent/configure --srcdir=/SYSTEM_A/src/indent
  57.     make
  58.  
  59.   which will produce the the executable file /SYSTEM_B/test/indent.  For
  60.   more information on `configure', see the included file CONF-README.
  61.  
  62.  
  63. DOCUMENTATION
  64.  
  65.   GNU uses a language called "texinfo" for its documentation which
  66.   produces both an on-line, interactive version and a hardcopy version
  67.   for printing.  The on-line version, `indent.info', is installed along
  68.   with the executable by typing "make install".  Refer to the Texinfo
  69.   manual for more information on this system.
  70.  
  71.   The hardcopy version is produced from the source file `indent.texinfo'
  72.   in as either a DVI or Postscript format file.  To produce the DVI
  73.   version, type:
  74.  
  75.     make indent.dvi
  76.  
  77.   To produce the Postscript version, type:
  78.  
  79.     make indent.ps
  80.  
  81.   Note that you must have the TeX typographical system installed for
  82.   this to work.
  83.  
  84.   While a Unix-style "man" page is also provided in the file
  85.   `indent.1', it was provided by a user and is unsupported.  It
  86.   is likely to be several versions behind the program, and thus there
  87.   is no provision for its installation.
  88.  
  89.  
  90. INDENT BUGS
  91.  
  92.   The "-troff" option is not supported and is strongly deprecated.  A
  93.   good thing for someone to do is to rewrite `indent' to generate TeX
  94.   source as a hardcopy output option, amoung other things.  See the
  95.   `Projects' file for more things to do.
  96.  
  97.  
  98. BUG REPORTS
  99.  
  100.   Please address bug-reports and suggestions or comments to:
  101.  
  102.     bug-gnu-utils@prep.ai.mit.edu
  103.  
  104.   Please include in your subject line the string: "GNU indent";  my
  105.   mail reader looks for this string, so if it doesn't appear, your
  106.   report may be ignored.
  107.  
  108.   How to report bugs:
  109.  
  110.   Please begin your bug report with a concise and factual description
  111.   of the behaviour you consider to be abberant.  If you have narrowed
  112.   the problem down to the use of a particular option, please mention
  113.   that.  In general, also be sure to mention the command line options
  114.   used to invoke indent, as well as the contents of your .indent.pro
  115.   if you are using one.
  116.  
  117.   Then include the *smallest possible* piece of code which generates
  118.   the described symptom.  It is very helpful if you can manage to
  119.   reduce the size of the sample code.
  120.  
  121.   Finally, if you have investigated the problem further, include
  122.   debugger stack traces, modifications, or speculation you have.
  123.  
  124. SENDING CODE
  125.  
  126.   If you send a patch as part of your bug fix, or send me code for new
  127.   features, please send them as diffs.  In particular, send me the
  128.   result of "diff -c <old_file> <new_file>".
  129.  
  130. FUTURE OF INDENT
  131.  
  132.   While there is a long list of features to be added to indent, and
  133.   likely a longer list of undiscovered bugs, I maintain `indent' on a
  134.   volunteer basis.  If you or your company find `indent' useful and
  135.   are interested in supporting it through funding, please send me
  136.   mail.
  137.  
  138.   My consulting practice supports development and maintenance of other
  139.   GNU tools as well.  If you have need of GNU or Unix-based
  140.   consulting, please let me know.
  141.  
  142.   Joseph Arceneaux
  143.   Arceneaux Computer Consulting
  144.   jla@ai.mit.edu
  145.   +1 415 285 9088
  146.