home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / database / dfixup36.zip / DFIXUP.TXT < prev    next >
Text File  |  1988-05-25  |  13KB  |  331 lines

  1.  
  2.  
  3.  
  4. dFIXUP 3.6_________________________________________________________ May 25, 1988
  5.  
  6.  
  7.             NAME:     DFIXUP.EXE
  8.             
  9.             PURPOSE:  Processes standard dBASE1-type program files,
  10.                       and writes properly indented output files. In
  11.                       addition,  dFIXUP   detects  and  reports  on
  12.                       programming mistakes,  and displays some file
  13.                       statistics.
  14.             
  15.             SYNTAX:   DFIXUP [filespec1 ... filespecN]
  16.             
  17.                       filespec can be one of the following:
  18.             
  19.                            The name  of a  .PRG file, with optional
  20.                            .PRG extension.
  21.                            
  22.                            The name  of a  .CLP file  (used by  the
  23.                            Clipper2 compiler),  with optional  .CLP
  24.                            extension.  All   .CLP  files   must  be
  25.                            prefixed   with   an   '@',   which   is
  26.                            consistent with  the syntax  used by the
  27.                            Clipper compiler. .CLP files contain the
  28.                            names of  files  to  be  processed,  one
  29.                            filename per  line, with  optional  .PRG
  30.                            file extension.
  31.                            
  32.                       The dFIXUP  command line  supports both  path
  33.                       names and wildcards.
  34.                       
  35.                       If  no  command  line  arguments  are  given,
  36.                       dFIXUP will  prompt you  for an input file to
  37.                       be processed.
  38.                       
  39.                       For files  not prefixed  with an  '@', dFIXUP
  40.                       will  automatically   assume  a   .PRG   file
  41.                       extension. For  all files  prefixed  with  an
  42.                       '@', a .CLP extension is assumed. If you have
  43.                       a file  (either  .CLP  or  .PRG)  without  an
  44.                       extension, you  can process it by including a
  45.                       period after  the filename,  e.g. in  essence
  46.                       saying that the file extension is blank.
  47.                       
  48.                       
  49.             USAGE:    dFIXUP will  write all  .PRG files  specified
  50.                       into files  with the  same basename, but with
  51.                       an .OUT extension. The following are examples
  52.                       of some input file names, and their resulting
  53.                       output file names:
  54.             
  55.                            PAYROLL        PAYROLL.OUT
  56.                            SAMPLE.PRG     SAMPLE.OUT
  57.                            C:\DBASE\TEST  C:\DBASE\TEST.OUT
  58.             ____________________
  59.             1    dBASE is a registered trademark of Ashton-Tate
  60.             2    Clipper is a registered trademark of Nantucket
  61.  
  62.  
  63.  
  64. User's Guide ____________________________________________________________ Page 1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. dFIXUP 3.6_________________________________________________________ May 25, 1988
  71.  
  72.  
  73.             
  74.                       All  specified  files  will  be  indented  as
  75.                       required, and comments will not be removed.
  76.             
  77.                       If you do not specify one or more files to be
  78.                       processed on  the command  line, dFIXUP  will
  79.                       ask you for the name of a single .PRG file to
  80.                       be processed.  In this interactive mode, both
  81.                       path names  and  .CLP  files  are  supported,
  82.                       while wildcards are not.
  83.             
  84.                       In addition  to the input file name, you will
  85.                       also be  asked to  supply an output file name
  86.                       (which must be different from the input file;
  87.                       if this  is not the case, the input file will
  88.                       be destroyed),  as well  as whether to indent
  89.                       the file  and whether  or not  to remove  all
  90.                       comment lines.
  91.             
  92.                       If you  press ENTER  without  a  filename  in
  93.                       response to  the output  file prompt,  dFIXUP
  94.                       will assume  the basename  of the  input file
  95.                       with an .OUT extension.
  96.             
  97.                       If  you   answer  'N'  to  the  prompt  about
  98.                       indenting, dFIXUP will remove all indentation
  99.                       from the  output file  specified. This can be
  100.                       useful after  development  is  complete,  and
  101.                       disk space is tight.
  102.             
  103.                       If  you   answer  'Y'  to  the  prompt  about
  104.                       indenting, or  if you  process files from the
  105.                       command line, dFIXUP will prefix each line of
  106.                       your program  with three spaces each for each
  107.                       level  of   indentation.  This  is  also  the
  108.                       default if  you press  ENTER in  response  to
  109.                       this prompt.
  110.             
  111.                       If  you   answer  'Y'  to  the  prompt  about
  112.                       removing comments,  dFIXUP  will  remove  all
  113.                       lines that start with a single asterisk ('*')
  114.                       or the  keyword NOTE.  dFIXUP will not remove
  115.                       comment lines  starting with  two  ampersands
  116.                       ('&'). Pressing  ENTER in  response  to  this
  117.                       prompt is equivalent to pressing 'N'.
  118.             
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130. User's Guide ____________________________________________________________ Page 2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. dFIXUP 3.6_________________________________________________________ May 25, 1988
  137.  
  138.  
  139.             ERRORS:   dFIXUP will  detect the  following  kinds  of
  140.                       errors:
  141.             
  142.                       Mismatched statements:
  143.             
  144.                            IF - ELSE - ENDIF
  145.                            DO WHILE - ENDDO
  146.                            DO CASE - CASE - OTHERWISE - ENDCASE
  147.                            FOR - NEXT
  148.                            
  149.                            Example:
  150.                            
  151.                                 DO WHILE .T.
  152.                                    DO MAINMENU
  153.                                 ENDIF
  154.                            
  155.                       Unbalanced statements:
  156.                       
  157.                            IF - ENDIF
  158.                            DO WHILE - ENDDO
  159.                            DO CASE - ENDCASE
  160.                            FOR - NEXT
  161.                            
  162.                            Example:
  163.                            
  164.                                 IF AT(ANSWER,'YyNn') > 0
  165.                                    IF UPPER(ANSWER) = 'Y'
  166.                                       ...
  167.                                    ELSE
  168.                                       ...
  169.                                    ENDIF
  170.                                    ...
  171.                                    ...
  172.                                 
  173.                                 <EOF>
  174.                       
  175.                       Extra statements:
  176.                       
  177.                            ELSE
  178.                            OTHERWISE
  179.                            
  180.                            Example:
  181.                                 
  182.                                 IF upper(STATE) = 'CA'
  183.                                    ...
  184.                                 ELSE
  185.                                    ...
  186.                                 ELSE
  187.                                    ...
  188.                                 ENDIF
  189.                       
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196. User's Guide ____________________________________________________________ Page 3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. dFIXUP 3.6_________________________________________________________ May 25, 1988
  203.  
  204.  
  205.                       If any errors are found during the processing
  206.                       of a  file,  dFIXUP  will  display  the  file
  207.                       statistics, and  then wait  until you press a
  208.                       key.
  209.                                 
  210.             EXAMPLE:  Command line use of dFIXUP:
  211.                       
  212.                            DFIXUP PAYROLL.PRG
  213.                            DFIXUP AR*.PRG AP*.PRG
  214.                            DFIXUP @GL.CLP
  215.                            DFIXUP *.PRG
  216.                            
  217.                       Interactive use of dFIXUP:
  218.                            
  219.                            DFIXUP
  220.                                 
  221.             BATCH FILES:
  222.                       dFIXUP will  set the  DOS  ERRORLEVEL  if  it
  223.                       terminates with  an  error  condition.  These
  224.                       errors and the corresponding exit codes are:
  225.             
  226.                       Couldn't open input file                1
  227.                       Couldn't open output file               2
  228.                       Error writing output file               3
  229.                       dFIXUP aborted by user                  6
  230.                       Couldn't install interrupt handler      7
  231.                       Couldn't allocate memory for file list  8
  232.                       Couldn't open .CLP file                 9
  233.             
  234.             
  235.                       dFIXUP will try to diagnose and explain these
  236.                       errors if possible.
  237.             
  238.                       You can  test against these exit code using a
  239.                       IF   ERRORLEVEL   <n>   statement   in   your
  240.                       batchfiles.
  241.             
  242.             SPECS:    dFIXUP  has  the  following  limitations  and
  243.                       requirements:
  244.             
  245.                       DOS version:             MS/PC-DOS 2.0 or
  246.                                                higher
  247.                       Program file length:     Unlimited
  248.                       Indentation levels:      64 levels
  249.                       Files per run:           256 files
  250.                       File path length:        40 characters
  251.                       Memory requirements:     28KB plus up to 41
  252.                                                bytes for each file
  253.                                                processed.
  254.                       Program line length:     254 characters, as
  255.                                                in dBASE III
  256.                       File size:               17009 bytes
  257.                       File date & time:        5-25-88, 8:00pm
  258.                       
  259.  
  260.  
  261.  
  262. User's Guide ____________________________________________________________ Page 4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. dFIXUP 3.6_________________________________________________________ May 25, 1988
  269.  
  270.  
  271.                       If the file you receive is different in size,
  272.                       or has a different date stamp, do not use the
  273.                       program. It may be a Trojan Horse or infected
  274.                       with a Virus.
  275.                       
  276.                       dFIXUP was  implemented  using  Microsoft  C3
  277.                       Version 5.0,  using the  standard  C  runtime
  278.                       library.
  279.             
  280.             COMMENTS: dFIXUP 3.6 is exactly the same as dFIXUP 3.5,
  281.                       with the  exception that  3.6 has a graphical
  282.                       progress display.
  283.             
  284.                       All comments,  suggestions and contributions,
  285.                       if any,  should be  directed to the program's
  286.                       author:
  287.             
  288.                            Vertical Solutions
  289.                            Attn: Torsten Hoff
  290.                            1925 Century Park East, Suite 1150
  291.                            Los Angeles, CA  90067
  292.                            
  293.                       The author hereby grants a limited license to
  294.                       copy  and   distribute  dFIXUP  to  all  non-
  295.                       commercial   users    under   the   following
  296.                       conditions:
  297.             
  298.                            dFIXUP must be distributed in unmodified
  299.                            form,    including    the    README.1ST,
  300.                            DFIXUP.EXE, DFIXUP.TXT,  and  DFIXUP.PRN
  301.                            files.
  302.                            
  303.                            No fee  may be  charged by  anyone for a
  304.                            copy of dFIXUP.
  305.                            
  306.                            dFIXUP may not be distributed as part of
  307.                            any commercial product.
  308.                            
  309.                       The  author  considers  this  product  to  be
  310.                       shareware.   Any    contributions   will   be
  311.                       appreciated.
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.             ____________________
  324.             3    Microsoft C is a registered trademark of Microsoft
  325.  
  326.  
  327.  
  328. User's Guide ____________________________________________________________ Page 5
  329.  
  330.  
  331.