home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD1.mdf / pascal / utility / beauty / pr_pas / prpas.doc < prev    next >
Text File  |  1992-07-07  |  9KB  |  196 lines
  1.  
  2.  
  3.      PrettyPascal 1.0
  4.  
  5.      Invariant Software
  6.      P.O. Box 10206
  7.      Spokane, WA  99209
  8.      509-327-2154 (Greg)
  9.  
  10.      INTRODUCTION
  11.         PrettyPascal is intended for Pascal programmers to help make program
  12.      files more legible by spacing operators, procedure calls, and control
  13.      guards,    and by reformatting the code to a specified style and
  14.      indentation preference.  PrettyPascal is comprised of the following
  15.      files:
  16.          PRPAS.EXE       Executable file.
  17.          PRPAS.DOC       User manual.
  18.          INVOICE.DOC     Registration. 
  19.          PRPSETUP.DAT    Data file for format parameters.
  20.          READ.ME         Brief description and instructions.
  21.          SAMPLE.PAS      Pascal program file for testing PrettyPascal.
  22.  
  23.         PrettyPascal is distributed as Shareware.  This means that Pretty-
  24.      Pascal is commercial software distributed on a try before you buy basis.
  25.      Try PrettyPascal for a couple of weeks, then if you find it useful, 
  26.      register it.
  27.      
  28.      REGISTRATION and BENEFITS
  29.         All that is required is a one time registration fee of $30.  For 
  30.      your $30, you will receive telephone support, announcements of enhance-
  31.      ments and future versions of PrettyPascal, and any other Shareware
  32.      released by Invariant Software.
  33.  
  34.      INSTALLATION
  35.         To make PrettyPascal the most useful, copy the PRPAS.EXE and 
  36.      PRPSETUP.DAT files to a directory that is pointed to by the PATH
  37.      statement used by your DOS.  This statement is located in your
  38.      AUTOEXEC.BAT.  PrettyPascal requires a PC compatible computer and 360K
  39.      of memory.
  40.      
  41.      USING PrettyPascal
  42.         CALLING from DOS
  43.            syntax:  prpas [drive:][path]filename [*.extension]
  44.  
  45.            Examples:
  46.               prpas file1.pas                {original file overwritten}
  47.               prpas c:\src\file1.pas
  48.               prpas *.pas
  49.               prpas file1.pas *.fmt          {formatted file "file1.fmt"}
  50.               prpas c:\src\*.pas *.fmt
  51.               prpas *.pas *.e
  52.  
  53.            Note: The target file option must be of the form "*.XXX".  If
  54.            the target file option is not exercised the formatted file 
  55.            will overwrite the original file.
  56.  
  57.         RESTRICTIONS
  58.            a.  Program comments are not affected except for positioning
  59.                within procedure blocks.
  60.            b.  All word operators such as 'and', 'div', 'mod', 'or', 'shl',
  61.                'shr' and 'xor' are ignored for spacing.
  62.            c.  There is a size limitation for procedures/functions within
  63.                files which is dependent on the indentation spaces.  For
  64.                example, a 40k byte procedure and an indentation of 5 exceeds
  65.                the  65k limit; however, the same procedure and an indentation
  66.                of 2 is fine.  There is no retriction for the file size.
  67.            d.  Brackets "[ ]" are not recognized as delimiters for the "with"
  68.                statement.
  69.            e.  Case statements which use "otherwise" as the default branch
  70.                may not format correctly in some instances.  Program logic,
  71.                however, is not affected.
  72.            f.  Procedures are indented based on the original position of 
  73.                "begin" and the nearest non space and non tab to the left.
  74.            g.  All files must be ASCII text files, use standard pascal
  75.                syntax, and be error-free compiled files.  Syntax errors may 
  76.                result in a runtime error.
  77.  
  78.         USER INTERFACE
  79.            If valid arguments were given, the initial screen is displayed
  80.         with the default format parameters.  The parameters represent your 
  81.         last use of the program and are saved in PRPSETUP.dat.
  82.            The screen is made up of four sections - indentation spaces, 
  83.         function style selection, control style selection, and character
  84.         spacing.  All possible key actions are detailed in the box at the
  85.         bottom of the screen and in the help screen.  Press <Enter> to move
  86.         from one section to another, press <Esc> to terminate the program,
  87.         press <CTRL-R> to run formatting, and press <?> for the help screen.
  88.  
  89.         Indentation spaces:  Press '1','2','3',... or '9' to change 
  90.         indentation.
  91.  
  92.         Function Style and Control Style:  Use up and down arrows to select
  93.         the desired style.
  94.  
  95.         Spacing:
  96.           A 'space' character is marked with a '^' underneath and
  97.           designates movable characters so that the desired spacing can be
  98.           expressed.  A 'space' character can be moved to the left (if a
  99.           blank space exists to the left) or to the right using the 
  100.           <backspace> and <space bar> respectively.  The cursor is moved
  101.           from one 'space' character to another using arrow keys.
  102.  
  103.           A 'case' character is marked with a '-' underneath and are used
  104.           to designate the capitalization or non-capitalization of reserved
  105.           words.  Type "IF", "if", "If" or "iF" to specify the desired
  106.           captalization.  The following words will be affected throughout
  107.           the file except within comments:
  108.             "absolute","and","array","asm","begin","case","const",
  109.             "contructor","destructor","div","do","downto","else","end",
  110.             "external","file","for","forward","function","goto","if",
  111.             "implementation","in","inline","interface","interrupt","label",
  112.             "mod","nil","not","object","of","or","packed","procedure",
  113.             "program","record","repeat","set","shl","shr","string","then",
  114.             "to","type","unit","until","uses","var","virtual","while",
  115.             "with", and "xor"
  116.            These words represent the Turbo Pascal 6 reserved word list.
  117.  
  118.            A 'parenthesis' character is marked with a '*' underneath and
  119.            are used to specify whether or not you wish to parenthesize
  120.            control guards (i.e. "if x=1 then" or "if (x=1) then").  To
  121.            designate, position the cursor at the 'parenthesis' character 
  122.            and type '(' or ')' to add or delete parentheses.
  123.  
  124.      DISCLAIMER
  125.         Invariant Software disclaims all warranties, expressed or implied,
  126.      relating to this product as to the merchantability and/or fitness for
  127.      a particular purpose.  Invariant Software shall not be liable for 
  128.      any damages whether they be direct, indirect, special, consequential, 
  129.      or incidental arising from a failure of this program to operate in 
  130.      the manner desired by the user.  Invariant Software shall not be 
  131.      liable for any damage to data or property which may be caused directly 
  132.      or indirectly by the use of this program.  THE PERSON USING THIS 
  133.      SOFTWARE ASSUMES ALL RISK AS TO THE QUALITY AND PERFORMANCE OF THIS 
  134.      SOFTWARE.
  135.  
  136.      RESPONSIBILITY of USER
  137.         This software is copyrighted under the U.S. copyright laws.  No 
  138.      person shall knowingly modify or distribute a modified version of this 
  139.      software.
  140.         Further, it is the responsibility of the user to pay for this 
  141.      software if they find it useful, and not to use any longer than a 
  142.      two week evaluation period.
  143.         This software is distributed as Shareware and may be freely 
  144.      distributed among other users within the limits as imposed above.
  145.      You are requested to pass this program out for trial use, and under 
  146.      no circumstances charge a fee other than the cost of a distribution 
  147.      disk.
  148.               
  149.      If you have any questions regarding PrettyPascal, site licenses or if
  150.      you have any suggestions, call 509-327-2154 and ask for Greg.
  151.  
  152.  
  153.  
  154.  
  155.      INVOICE/REGISTRATION for PrettyPascal 1.0
  156.     
  157.      Send to:  Invariant Software        or        Invariant Software                
  158.                P.O. Box 10206                      3117 W. Gordon
  159.                Spokane, WA 99209                   Spokane, WA  99205
  160.                                                    509-327-2154
  161.      
  162.      From:
  163.  
  164.      Name:         _____________________________________________
  165.  
  166.      Address:      _____________________________________________
  167.      City, State
  168.      and Zip Code: _____________________________________________
  169.  
  170.      Phone Number: _____________________________________________
  171.  
  172.      ( if applicatable )
  173.  
  174.      Company:      _____________________________________________
  175.  
  176.      Title:        _____________________________________________
  177.          
  178.          
  179.      Registration and notification of upgrades 
  180.      and other products .........................$30.00 ea.  _______
  181.      
  182.      Washington Residents add 8.0% Sales Tax ($2.40 ea.)...  _______
  183.     
  184.      Total Enclosed .......................................  _______
  185.  
  186.      Terms: Check Drawn on U.S. Bank in U.S. Funds,
  187.      International Bank or Postal Money Order
  188.             
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.