home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 12 / CD_ASCQ_12_0294.iso / vrac / clnclp.zip / CLEANCL.DOC < prev    next >
Text File  |  1993-11-01  |  11KB  |  298 lines
  1.                    Online User's Guide
  2.  
  3. CONTENTS
  4.  
  5. WHAT IS CleanClipper
  6. CUSTOMER SERVICE
  7. REGISTRATION and BENEFITS
  8. INSTALLING CleanClipper
  9. USING CleanClipper
  10. NOTES ON CleanClipper
  11. DISCLAIMER
  12.  
  13. WHAT IS CleanClipper
  14.  
  15. CleanClipper is a Clipper 5.0+ soure code formatter.  The
  16. program handles such things as indentation, operator spacing,
  17. function statement spacing, control statement spacing, code-
  18. block spacing, comment positioning, parentheses min/max,
  19. reserved word case, and more.  CleanClipper is a great tool for
  20. programmers who have to maintain or review Clipper programs
  21. developed by others.  
  22.  
  23. CUSTOMER SERVICE
  24.  
  25.  Contacting Invariant Software
  26.  
  27.    Address: Invariant Software        Phone: 509-328-9542
  28.             P.O. Box 10206            Email: CIS 73501,1643
  29.             Spokane, WA  99209
  30.  
  31. REGISTRATION and BENEFITS
  32.  
  33. By registering CleanClipper you will receive the latest
  34. version, a printed user's guide, free support, and a free
  35. upgrade.  Please use the file REGISTER.DOC.  Thanks for the
  36. support!
  37.  
  38. INSTALLING CleanClipper
  39.  
  40.  What is Required to Run CleanClipper
  41.  
  42.  CleanClipper 1.0 requires an IBM-compatible computer, a minimum
  43.  of 512k RAM, and MS-DOS 3+.
  44.  
  45.  Installing CleanClipper
  46.  
  47.  To make CleanClipper the most useful, copy the following files
  48.  to a directory that is pointed to by the PATH statement used by
  49.  your DOS.
  50.    CLEANCL.EXE      Executable file.
  51.    CLEANCL.DOC      User's Guide.
  52.    CLEANCL.HLP      Text file for F1 help screens.
  53.  The following files will be created once CleanClipper is run:
  54.    CLEANCL.DAT      File to save default format parameters.
  55.    CLEANCL.RSV      File for reserved word listing.
  56.    REGISTER.DOC     Registration file.
  57.  
  58. USING CleanClipper
  59.  
  60.  Calling from DOS
  61.  
  62.  At the DOS prompt use the following syntax:
  63.    CLEANCL [DRIVE:][PATH][filename1] [filename2]
  64.    where filename1 = source file
  65.          filename2 = target file
  66.  The brackets '[]' designate optional arguments.
  67.  
  68.  Examples:
  69.   cleancl                       { allows configuration changes }
  70.                                 { regardless of the run mode   }
  71.   cleancl file1.prg             { formats one file in current  }
  72.                                 { directory                    }
  73.   cleancl c:\src\file1.prg      { formats one file in given    }
  74.                                 { path                         }
  75.   cleancl *.prg                 { formats all files with an    }
  76.                                 { extension of 'prg'           }
  77.   cleancl file1.prg file1.fmt   { formats one file and places  }
  78.                                 { result in file 'file1.fmt'   }
  79.   cleancl r??.prg s??.fmt       { formats number of files and  }
  80.                                 { places results in new files  }
  81.   cleancl c:\src\*.prg *.fmt
  82.   cleancl src\*.prg *.fmt
  83.   cleancl \src\*.prg *.fmt
  84.   cleancl *.prg *.e
  85.   cleancl r*.* s*.*
  86.   cleancl ?.prg *.fmt
  87.  
  88.  Online Help
  89.  
  90.  HELP is available to you at almost any point in the program.
  91.  If you are uncertain how to continue or just want some
  92.  information, press F1.  In addition, the HELP menu command
  93.  allows you to peruse an online user's guide.
  94.  
  95.  Using the Menu
  96.  
  97.  You have two options to select your choice from a menu.  First,
  98.  you can use the arrow keys to move the cursor to the choice you
  99.  want, then press ENTER.  Secondly, you can simply type the
  100.  first letter of your choice.  It doesn't matter which item the
  101.  cursor is on, and there is no need to press ENTER.  Press F1
  102.  for a description of the menu selection.
  103.  
  104.  Run Command
  105.  
  106.  Use this command to actually run the formatting on the files
  107.  specified in the 'Source' and 'Target' fields.
  108.  
  109.  Edit Command
  110.  
  111.  Use this command to make changes to the format configuration
  112.  parameters, the Source and Target file fields, and the Run
  113.  Mode.
  114.   
  115.   general rules
  116.  
  117.   Space characters are denote by '^' and can be moved with the
  118.   SPACE BAR or BACKSPACE keys.  Format selections, denoted by
  119.   ( ), can be selected with the space bar.  Use the following
  120.   keys to navigate the edit screen:
  121.     TAB : go to the next section.
  122.     SHIFT-TAB : go to the previous section.
  123.     F10 : return to the menu.
  124.  
  125.   source and target file fields
  126.  
  127.   Use this section to specify the source and target files for
  128.   formatting.  The syntax for the two fields are:
  129.     Source : [drive:][path]filename1
  130.     Target : [filename2]
  131.   You may use wildcards in either filename option.  The brackets
  132.   '[]' denote optional input.  If the target file is left blank
  133.   the source file(s) will be overwritten with the formatted
  134.   file.  If the target file already exists it will be replaced
  135.   with the formatted file.  The target file is always placed in
  136.   the same path as the source file path.
  137.  
  138.   procedure style
  139.  
  140.   Use this section to specify the indentation of statements
  141.   within subroutines and functions.
  142.  
  143.   control style
  144.  
  145.   Use this section to specify the indentation of statements
  146.   within the control statements DO WHILE, DO CASE, FOR, and IF.
  147.   For example, the various styles could be, but are not
  148.   limited to:
  149.  
  150.   if x==1          if x==1       if x==1
  151.     x:=0             x:=0            x:=0
  152.   endif              endif         endif
  153.  
  154.   The position of 'x:=0' determines the indentation of state-
  155.   ments within control statements.
  156.  
  157.   procedure/function spacing
  158.  
  159.   Use this section to specify the spacing for procedure or
  160.   function calls and definitions.  The space characters are
  161.   denoted with a '^' and include parentheses and commas.
  162.   Possible styles include:
  163.     function compare(p1, p2)
  164.     function compare( p1,p2 )
  165.     function compare( p1, p2 )
  166.  
  167.   operator spacing
  168.  
  169.   Use this section to specify spacing for assignment, boolean,
  170.   relational, and math operators.  Space characters are denoted
  171.   by a '^'.  The operator spacing is limited to the following:
  172.     assignment : :=, +=, -=, *=, /=, %=, **=, ~=
  173.     boolean    : .and., .or.
  174.     relational : <, >, <=, >=, ==, !=, $
  175.     math       : **, ^, *, /, %, +, -
  176.  
  177.   code block spacing
  178.  
  179.   Use this section to specify the spacing for code blocks.  The
  180.   space characters are denoted with a '^'.  Possible styles
  181.   include:
  182.     { | a, b | a++, a+b }
  183.     { |a,b| a++, a+b }
  184.     {|a,b| a++,a+b}
  185.  
  186.   array initializaion spacing
  187.  
  188.   Use this section to specify the spacing for array intiiali-
  189.   zation statements.  The space characters are denoted with a
  190.   '^'.  Possible styles include:
  191.     arry := {a, b}
  192.     arry := { a,b }
  193.     arry := { a, b }
  194.  
  195.   comment positioning
  196.  
  197.   Use this section to specify the placement of code-line
  198.   comments - comments which come after a line of code (i.e.
  199.   'x=0  // comment').  Lines which begin with a comment will be
  200.   indented appropriately.  You can specify if the comment should
  201.   be placed at certain column, or placed a number of spaces
  202.   after the end of code.
  203.  
  204.   parentheses in expressions
  205.  
  206.   Use this section to specify if you wish to have all assignment
  207.   (:= only) and control expressions (except FOR) altered by min-
  208.   imizing or maximizing the parentheses for binary characters.
  209.   Choose 'no change' if you wish to leave the expression un-
  210.   touched.  Only binary operators and their associated operands
  211.   are considered.  Unary operators are not affected.  Paren-
  212.   theses will be added or deleted in accordance with the follow-
  213.   ing binary operator rules of precedence:
  214.     Operators                              Precedence
  215.     ---------                              ----------
  216.     **, ^                                  First
  217.     *, /, %                                Second
  218.     +, -                                   Third
  219.     <>, !=, #, <, <=, ==, >, >=, $, =      Fourth
  220.     .and.                                  Fifth
  221.     .or.                                   Sixth
  222.     :=, +=, -=, *=, /=, %=, **=, ~=        Seventh
  223.  
  224.   preprocessor directives positioning
  225.  
  226.   Use this section to specify whether you wish to indent prepro-
  227.   cessor directives, or place the directives at the first
  228.   column.
  229.  
  230.   reserved word case
  231.  
  232.   Use this section to specify how reserved words should be
  233.   altered as regards case.  The possible selections are 'no
  234.   change', 'while', 'While', and 'WHILE'.  To add or delete
  235.   reserved words, use a word processor to edit the file CLEANCL.
  236.   RSV.  You may add words at any location as long as each word
  237.   has its own line.  CleanClipper will sort the changed file and
  238.   save the changes in the new CLEANCL.RSV file.  If the file
  239.   CLEANCL.RSV is accidentally deleted, CleanClipper will create
  240.   a new file with a limited number of reserved words.
  241.  
  242.   run mode
  243.  
  244.   Use this section to specify the mode to run CleanClipper.
  245.   'Manual' mode always allows the user to edit the format
  246.   parameters and file fields before running format.  'Auto' mode
  247.   does not allow editing and begins formatting immediately.
  248.   Auto mode is useful if you have already specified the format
  249.   parameters you prefer (the last configuration is always saved
  250.   in CLEANCL.DAT) and know the files you wish to format.  Auto
  251.   mode only works when at least a 'source' file is specified at
  252.   the DOS prompt.  Auto mode, for example, could also be used
  253.   for a batch file which archives program files.
  254.  
  255.  Color Command
  256.  
  257.  Use this command to change the background and/or foreground
  258.  colors of the main screen.  The possible colors for each are
  259.  blue, green, cyan, magenta, brown, black, red, and white.
  260.  Simple select the 'background' or 'foreground' menu command
  261.  and the screen color will change in the above order.
  262.  
  263.  Phone Command
  264.  
  265.  Select this command for information to contact Invariant 
  266.  Software by phone or mail.
  267.  
  268.  Help Command
  269.  
  270.  Select this command for the online user's guide.
  271.  
  272.  Quit Command
  273.  
  274.  Select this command to quit CleanClipper.
  275.  
  276. NOTES ON CleanClipper
  277.  
  278. * All files must be ASCII text files.
  279. * Only code within a function or procedure is affected.
  280. * CleanClipper does recognize the 'REPEAT...UNTIL' control
  281.   statement which many programmers use via preprocessor
  282.   directives.
  283. * Program comments are not affected except for positioning.
  284. * If syntax errors exist in a file, an error message may be
  285.   displayed and the program will be stopped.  Source files
  286.   should be compiled-error-free!
  287.  
  288. DISCLAIMER
  289.  
  290. Invariant Software disclaims all warranties, expressed or
  291. implied, relating to this product as to the merchantability and/
  292. or fitness for a particular purpose.  Invariant Software shall
  293. not be liable for any damages whether they be direct, indirect,
  294. special, consequential, or indirectly by the use of this
  295. program.  THE PERSON USING THIS SOFTWARE ASSUMES ALL RISK AS TO
  296. THE QUALITY AND PERFORMANCE OF THIS SOFTWARE.
  297. ~
  298.