CD Actual 13/CDA13.ISO/cdactual/demobin/share/program/Pascal/BEAUTIFY.ZIP/BEAUTIFY.DOC

Text File | 1991-01-01 | 5.2 KB | 201 lines

RESPONSE FILE
A response file contains a list of command line options, each on a seperate
line. This allows to user to reconfigure BEAUTIFY without having to type long
command lines. Anything on a command line except input and output file
specifications can be in a response file. This includes other response file
specifications, identifier file specifications as well as options. Options
must not include the leading flag character (- or /) while file specifications
must.

IDENTIFIER FILE
An identifier file contains identifiers (on seperate lines) that the user
wants treated specially in regard to case.

OPTIONS

-a n
     Sets the column that comments are aligned at.  Any comment
     starting at a column to the right of the comment threshing
     column will be aligned.  Default: 50

-b+, -b-
     Determines whether builtin indentifiers will be handled
     specially.  If so, the file BUILTINS.DAT will be read in and
     whenever an indentifier is found matching (case ignored) an
     identifier in this file, it will be output as it is
     specified in the file.  Default: -b+

-cc n
     Sets the number of spaces that a continued comment is
     indented relative to the first line of the comment.
     Default: 2

-ci n
     Sets the number of spaces that a continued statement is
     indented relative to the first line of the statement.
     Default: 8

-ct n
     Sets the comment threshing column.  Any comments starting to
     the right of this column will be aligned to the column
     specified by -a.  Default: 6

-e n
     Sets the number of spaces to be placed before END statements
     that are not at the start of a line.  Default: 2

-f+, -f-
     Enables/disables the placing of a space between a procedure
     or function name and its parameter list.  Default: -f-

-i n
     Sets the number of spaces by which to indent each level.
     Default: 2

-l n
     Sets the maximum length of output lines.  Default: 125

-m n
     Sets the size (in characters) of the left margin.  This
     number of spaces will be prepended to each line of output.
     Default: 0

-n+, -n-
     Determines if an END statement will cause a new line of
     output to be started.  Also determines if body closer (e.g.
     END, UNTIL) will be unindented with respect to the body.
     Default: -n+

     With -n+ code would look like:

          begin
               repeat
                    foo(x);
               until x > 5
          end;

     With -n- the same code would be:

          begin
               repeat
                    foo(x);
                    until x > 5   end;

-o+, -o-
     Enables/disables the starting of a newline after a case
     constant and the indenting of the statement part of the
     case.  Default: -o-

     With -o+ code would look like:

          case x of
               1:
                    y := 1;
               2:
                    begin
                         foo(x);
                    end;
          end;

     With -o- it would be:

          case x of
               1: y := 1;
               2: begin
                    foo(x);
               end;
          end;

-p+, -p-
     Enables/disables the indenting of all of a procedure or
     function definition, except the header itself.  Default: -p-

-r+, -r-
     Causes reserved words to be output in upper/lower case.
     Default: -r-

-s+, -s-
     Enables/disables simple statements following a THEN, ELSE,
     or DO to be 'snuggled' up to the corresponding THEN, ELSE,
     or DO.  Default: -s-

     With -s+ code would be like:

          if x then foo(x)
          else begin
               foo(y);
          end;

     With -s- it would be:

          if x then
               foo(x)
          else begin
               foo(y);
          end;

-sd+, -sd-
     As with -s- and -s+, but only effects the snuggling up to
     DOs.  Default: -sd-

-si+, -si-
     As with -s- and -s+, but only effects the snuggling up to
     THENs and ELSEs.  Default: -si-

-t n
     Sets the tab width for the input file.  Default: 5

-w+, -w-
     Enables/disables the insertion of a BEGIN-END pair around
     structured statements that are controlled by another
     structured statement.  Default: -w-

     For this example the following input is assumed:

          if v then
               if w then
                    x
               else
                    y
          else
               z;

     With -w+ this would become:

          if v then begin
               if w then
                    x
               else
                    y
          end else
               z;

     With -w- it would be unchanged.

-z+, -z-
     Enables/disables strip blank lines between the
     procedure, function, constructor, or destructor
     and it's body. Default: -z-

     For example:

     procedure MyExitProc;

     var
       I: Integer;

     begin
       { statement... }
     end;

     With -z+ it would be

     procedure MyExitProc;
     var
       I: Integer;
     begin
       { statement... }
     end;

     With -z- it would be unchanged.