home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 3 / AACD03.BIN / AACD / Programming / sofa / archive / SmallEiffel.lha / SmallEiffel / man / pretty.txt < prev    next >
Text File  |  1999-06-05  |  3KB  |  71 lines
  1.  
  2.                              The pretty command
  3.                                       
  4.    Usage
  5.    
  6.    pretty [options] <Class_names> ...
  7.    
  8.    Command pretty is the SmallEiffel Pretty Printer for Eiffel source
  9.    files. For all classes given as arguments, pretty looks for the
  10.    corresponding file using the same algorithm as command finder. All the
  11.    corresponding files are reprinted in a pretty way.
  12.    
  13.    For example, if you are allowed to write the corresponding file, you
  14.    can reprints the source file of class HELLO_WORLD using command :
  15.    pretty hello_world
  16.           
  17.    There are four modes of pretty printing -zen, -default, -end and
  18.    -parano mode. Only one mode can be selected and mode -default is the
  19.    default mode.
  20.    
  21.    Options for pretty printing
  22.    
  23.    -zen:
  24.           The less you can print. Pseudo variable Current is never
  25.           printed (unless it is necessary). No end mark comment for
  26.           routines. No end comments for constructs (if, inspect, debug,
  27.           ...). Very compact printing.
  28.    -default:
  29.           the default mode. Don't change printing of pseudo variable
  30.           Current (if Current is in the input, Current is in the output).
  31.           Print end comment of routines. Don't print end comments for
  32.           constructs (if, inspect, debug, ...).
  33.    -end:
  34.           Same printing as previous mode but print ends of all constructs
  35.           (if, inspect, debug, ...).
  36.    -parano:
  37.           Same printing as previous mode but prints Current everywhere
  38.           you can.
  39.    -no_style_warning:
  40.           Suppress output for warning messages related to non respect of
  41.           standard Eiffel style guidelines (for example ItEm will not
  42.           trigger a warning).
  43.    -no_warning:
  44.           Suppress output for all warning messages (error messages are
  45.           still printed).
  46.    -version:
  47.           Show the number of the [1]version of SmallEiffel you're using.
  48.           
  49.    Security and BackUp file
  50.    
  51.    For the security of sources files, a backup file is created before
  52.    writting the new file (system or command pretty may crash during
  53.    printing of the new file). The backup file name is "foo.bak" when
  54.    source file name is "foo.e". Backup file is written in the same
  55.    directory as source file.
  56.    If an old backup file already exists before pretty printing, command
  57.    pretty exit with an error message. To be sure that the pretty printing
  58.    is well done, the output file is parsed again.
  59.    Even if second parsing gives no errors, backup file is NOT removed.
  60.    Thus you can recompile your Eiffel code to check new file before
  61.    removing backup file by yourself.
  62.    
  63.                                    [Line]
  64.    Copyright © Dominique COLNET and Suzanne COLLIN - [2]<colnet@loria.fr>
  65.                   Last update: 05 June 1999, by DC & OZ. 
  66.  
  67. References
  68.  
  69.    1. file://localhost/home/colnet/SmallEiffel/man/man/SmallEiffelFAQ.html#Q02
  70.    2. mailto:colnet@loria.fr
  71.