home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2002 #3 / Amiga Plus CD - 2002 - No. 03.iso / AmigaPlus / Tools / Development / envCPP31 / c++ / tools / gnu-indent / docs / README < prev    next >
Encoding:
Text File  |  2002-01-01  |  3.2 KB  |  93 lines
  1. README for GNU `indent' 2.2.6.
  2.  
  3.   GNU indent changes the appearance of a C program by inserting or
  4.   deleting whitespace according to a plethora of options.  Some
  5.   canned styles of formatting are supported as well.  GNU indent is
  6.   a descendant of BSD indent.  This file is part of the GNU indent
  7.   distribution.
  8.  
  9.   GNU indent does NOT work for C++, if it does for you then you're
  10.   just lucky.  Don't ask for support for C++.
  11.  
  12.   Read the file NEWS for more information, especially to see what's
  13.   different from the last version, and what future versions may do.
  14.  
  15.   To install indent, please read the file INSTALL included with the
  16.   distribution. If you are installing indent on VMS, see the file
  17.   README.VMS.
  18.  
  19.   For license and copying information, see the file COPYING.
  20.  
  21. DOCUMENTATION
  22.  
  23.   For complete documentation on the Web, please visit:
  24.  
  25.      http://www.xs4all.nl/~carlo17/indent/
  26.  
  27.   GNU uses a language called "texinfo" for its documentation source
  28.   which produces both an on-line, interactive version and a hardcopy
  29.   version for printing.  An HTML version is now produced as well.
  30.  
  31.   The on-line versions, `indent.info' and `indent.1', are installed
  32.   along with the executable by typing "make install".
  33.   Refer to the Texinfo manual for more information on the `info' system.
  34.  
  35.   The hardcopy version is produced from the source file `indent.texinfo'
  36.   in as either a DVI or Postscript format file.  To produce the DVI
  37.   version, download the file `texinfo.tex' from http://texinfo.org/ into
  38.   the top directory, and type:
  39.  
  40.     make indent.dvi
  41.  
  42.   To produce the Postscript version, type:
  43.  
  44.     make indent.ps
  45.  
  46.   Note that you must have the TeX typographical system installed for
  47.   this to work.
  48.  
  49.   The HTML version is included along with the distribution, and
  50.   consists of the files:
  51.  
  52.      indent.html  indent_foot.html  indent_toc.html
  53.  
  54.   which must be installed in the same directory.  These files can also
  55.   be accessed at the URL http://www.xs4all.nl/~carlo17/indent/indent.html
  56.  
  57.   To create the HTML version from the texinfo version, type:
  58.  
  59.      texi2html indent.texinfo
  60.  
  61. BUG REPORTS
  62.  
  63.   Please address bug-reports and suggestions or comments to:
  64.  
  65.     indent@alinoe.com
  66.  
  67.   How to report bugs:
  68.  
  69.   Please begin your bug report with a concise and factual description
  70.   of the behaviour you consider to be abberant.  If you have narrowed
  71.   the problem down to the use of a particular option, please mention
  72.   that.  In general, also be sure to mention the command line options
  73.   used to invoke indent, as well as the contents of your .indent.pro
  74.   if you are using one.
  75.  
  76.   Then include the *smallest possible* piece of code which generates
  77.   the described symptom.  It is very helpful if you can manage to
  78.   reduce the size of the sample code.
  79.  
  80.   Finally, if you have investigated the problem further, include
  81.   debugger stack traces, modifications, or speculation you have.
  82.  
  83. SENDING CODE
  84.  
  85.   If you send a patch as part of your bug fix, or send me code for new
  86.   features, please send them as diffs.  In particular, send me the
  87.   result of "diff -c <old_file> <new_file>".
  88.  
  89.   Because of the regression testing I require of indent, it is
  90.   extremely unlikely that your code will be installed into indent
  91.   "as-is";  however it may still be helpful, and will likely have
  92.   solved your particular problem.
  93.