home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 18 REXX / 18-REXX.zip / rcf2102j.zip / read.me < prev    next >
Text File  |  1999-05-26  |  13KB  |  305 lines
  1.  
  2.                      REXX Code Formatter/2 - READ.ME
  3.                      ---------------------------------
  4.  
  5. Welcome to REXX Code Formatter/2.
  6.  
  7. This file contains information you need to install REXX Code Formatter/2,
  8. and additional information not included in the product documentation.
  9.  
  10. This READ.ME file is divided into the following chapters:
  11.    -  REXX Code Formatter/2 Description 
  12.    -  REXX Code Formatter/2 Registration
  13.    -  Before You Install REXX Code Formatter/2
  14.        -Software Requirements
  15.        -Hardware Requirements
  16.    -  Installing REXX Code Formatter/2
  17.    -  Removing REXX Code Formatter/2
  18.    -  Getting Help
  19.    -  Trademarks
  20.    -  Release History
  21.  
  22.  
  23. REXX Code Formatter/2 Description
  24. -----------------------------------
  25. The REXX Code Formatter/2 (RCF/2) is an OS/2(*) REXX application written 
  26. using VisPro/REXX(**) and VisPro/Reports(**).  It is designed to allow a
  27. REXX programmer to format a program in a particular style, insuring that
  28. the format of each element of the REXX program conforms to that style.
  29.  
  30. NOTES: (1) This program makes use of the RexxUtils functions that come
  31.            with OS/2, and it assumes they have not been removed.
  32.        (2) You do not need to have VisPro/REXX or VisPro/Reports 
  33.            installed on your system to run RCF/2.
  34.  
  35.  
  36. Features of REXX Code Formatter/2
  37. ---------------------------------
  38.  
  39. Using this product, users may, for example:
  40.  
  41.    Define the indentation to be used in general plus the amount for: 
  42.     - Program statements subordinate to DO and SELECT,
  43.     - Statements that begin with THEN/ELSE, and 
  44.     - Continued statements.
  45.    Specify whether:
  46.     - Lines are to be split at semicolons,
  47.     - Redundant spaces are to be removed from program statements,
  48.     - New lines are to start before or after THEN/ELSE keywords, and
  49.     - END statements are to be indented to align with the corresponding 
  50.       DO/SELECT subordinate statements.
  51.    Specify the formatting for:
  52.     - REXX keyword Instructions,
  53.     - REXX keywords besides those that begin a REXX keyword instruction,
  54.     - Variables names,
  55.     - Function names, and
  56.     - Labels.
  57.    Define special formatting for selected function names.
  58.    Check for duplicate labels and insure all labels start on a new line.
  59.    Have RCF/2 create a file of label names as they appear in the program
  60.     so that all references to them in the program (and even other
  61.     programs) will reflect this same format.
  62.    Align full-line, left-hand, and right-hand comments.
  63.    Add "commented line number" to program statements.
  64.    Generate a listing of the formatted program.
  65.  
  66. In addition, while RCF/2 is not a syntax-checker or code debugger, it 
  67. does provide some assistance in program development.  It can, for
  68. example:
  69.  
  70.    Identify DO and SELECT instructions missing a corresponding END clause,
  71.    Create cross-reference information for labels, variables, and function 
  72.     names,
  73.    Flag function names that might be misspelled,
  74.    Flag comments that are started but not closed, and
  75.    Highlight literal strings with a missing quote.
  76.   
  77.  
  78. REXX Code Formatter/2 Registration
  79. ------------------------------------
  80.    This program is SHAREWARE.  The registration fee is $15 U.S. per copy.
  81.  
  82.    To register your copy of REXX Code Formatter/2 and receive your
  83.    Registration Key, order RCF/2 from BMT Micro.
  84.  
  85.    For BMT Micro orders, see the BMTORDER.TXT file which is contained in
  86.    this package, or refer to the "Registration" section found in the
  87.    RCF/2 on-line help facility.
  88.  
  89.  
  90. Before You Install REXX Code Formatter/2
  91. ------------------------------------------
  92.    Software Requirements
  93.    ---------------------
  94.     IBM Operating System/2(*) (OS/2) Warp 3.x. or higher
  95.  
  96.    Hardware Requirements
  97.    ---------------------
  98.     -  A personal computer that runs OS/2 Warp 3.0 or higher
  99.                                                                        
  100.     -  1MB of fixed disk space above that required by OS/2 
  101.  
  102.  
  103. Installing REXX Code Formatter/2
  104. ----------------------------------
  105.  
  106.     If you have received In RCF/2 on a diskette, skip to step 2.
  107.  
  108.     STEP 1: If you have down-loaded or received RCF/2 as a ZIP file,
  109.     you will need to use the PKZIP(r) software by Pkware, Inc. To
  110.     perform this step, do the following:
  111.  
  112.         A. Obtain a copy PKUNZIP.EXE to unpack the file.  This
  113.            program is readily available on most BBS's and FTP's 
  114.            sites.
  115.  
  116.         B. Make the directory containing the RCF2.ZIP file the
  117.            default directory.  At the OS/2 command prompt, enter the
  118.            command:
  119.  
  120.                    PKUNZIP RCF2nnnn.ZIP
  121.  
  122.            Where "nnnn" is a suffix.  (This suffix is associated with
  123.            the release of RCF/2.  The higher suffix being the later
  124.            release of the program.)
  125.  
  126.     STEP 2: If installing from diskette, place the distribution 
  127.     diskette in your diskette drive.
  128.  
  129.     STEP 3: At the OS/2 prompt, enter one of the following:
  130.  
  131.         A. If installing from diskette on drive A, enter:
  132.  
  133.                    A:\INSTALL
  134.  
  135.         B. If installing from diskette on drive B, enter:
  136.  
  137.                    B:\INSTALL
  138.   
  139.         C. If installing from a fixed disk (for example, the
  140.            directory where RCF2nnnn.ZIP has been "unzipped"), 
  141.            enter the full path to the INSTALL.EXE program.
  142.  
  143.            To illustrate, if the RCF/2 package has been placed
  144.            in the "TEMP" directory on the "C:" drive, enter:
  145.  
  146.                    C:\TEMP\INSTALL
  147.  
  148.     STEP 4: Answer the installation program questions.
  149.  
  150.     STEP 5: When complete, an RCF/2 program icon will appear
  151.     on your desktop.  (You may move it to any convenient place.)
  152.     Double-clicking the program icon will start RCF/2.
  153.  
  154.     NOTE: There are two (2) DLL files supplied with this product.
  155.           These two files must be addressable by RCF/2.  Either
  156.           the LIBPATH in the CONFIG.SYS file must specify a "." as
  157.           one of the directories (this usually the first one), or
  158.           the DLL files must moved to a DLL directory that is
  159.           specified by the LIBPATH keyword.
  160.  
  161.     See the RCF/2 help introduction for more information about
  162.     getting started with RCF/2.
  163.  
  164.  
  165. Removing REXX Code Formatter/2
  166. --------------------------------
  167.     To remove the installation of RCF/2, do the following:
  168.  
  169.     STEP 1: Run the RCF/2 installation procedure and select:
  170.  
  171.         Delete the installed product and re-install
  172.  
  173.     STEP 2: After the deletion is complete, exit the install
  174.     procedure without doing the re-install.
  175.  
  176. Getting Help
  177. ------------
  178.  
  179.    Documentation
  180.  
  181.    -   Documentation is provided through the RCF/2 Help facility.
  182.  
  183.        Please review the on-line help "Introduction" for valuable
  184.        information about support, limitations, and future enhancements.
  185.  
  186.    Service and Technical Support
  187.  
  188.    -   Technical support is free to all registered users of RCF/2.
  189.        Questions and problems should be sent via E-mail to
  190.        RKE_Software@ibm.net.
  191.  
  192.    Defect Reporting
  193.  
  194.    -   If you believe that you have found a defect in RCF/2, please 
  195.        report it to RKE Software using the procedure described
  196.        in the on-line help for "Support" which is a sub-chapter of the 
  197.        "Introduction."
  198.  
  199.  
  200. Trademarks
  201. ----------
  202.    (*)   IBM and OS/2 are trademarks of the International Business 
  203.          Machines Corporation.
  204.  
  205.    (**)  VisPro/REXX and VisPro/Reports are trademarks of HockWare, Inc.
  206.  
  207.  
  208. Release History
  209. ---------------
  210.  
  211. Release 1.1.0  Initial release.
  212.  
  213. Release 1.1.1  A maintenance modification release to correct various 
  214.                bugs and problems found in the initial RCF/2 release, 
  215.                primarily caused by the differences between Warp 3 and 4.
  216.                This release includes:
  217.                - Fixes to eliminate loading problems when running under 
  218.                  OS/2 Warp 3 with classical REXX and Warp 4 with Object 
  219.                  REXX. 
  220.                - Correction to incorrect program listing output.
  221.                - Corrections to miscellaneous help panels.
  222.                - Modifications to some notebook pages to accommodate 
  223.                  differences between Warp 3 and Warp 4.
  224.                - Elimination of a bug that could cause two settings 
  225.                  notebooks to be open at the same time.
  226.  
  227. Release 1.1.2  Corrected an error that could prevent an editor from being
  228.                properly configured and invoked.
  229.  
  230. Release 1.2.0  New product release.  This release adds:
  231.                - A cross reference facility for labels, variables, and
  232.                  function names.
  233.                - Optional formatting notes if undefined function names are 
  234.                  found. 
  235.                - The ability to add "Commented line numbers" to statements.
  236.                - Landscape printing formats.
  237.                - Right-hand alignment of full-line comments with extension 
  238.                  and truncation to allow for "boxing" of comments.
  239.                - Specification of file name and directory for generated
  240.                  associated label files.
  241.                - Maintenance of multiple generated associated label 
  242.                  file data in a single file.
  243.                - Separate formatting specification for the standard REXX
  244.                  built-in functions.
  245.                - The specification of the file to be edited as a parameter 
  246.                  at RCF invocation.
  247.                - The extension of the allowable indentation values to be up 
  248.                  to 999.
  249.                - Placement of the print specification in a separate page to
  250.                  facilitate changing of printer specifications.
  251.                - Use of Warp 4 notebook format for configuration settings 
  252.                  when using OS/2 Warp 4.
  253.  
  254. Release 1.2.1  A maintenance release to correct the following:
  255.                - Missing function names in the internal function names 
  256.                  tables.
  257.                - Corrected print menu selection options.
  258.  
  259. Release 1.2.2  A maintenance release to correct the following:
  260.                - A right-hand comment formats incorrectly in some cases 
  261.                  where a left-hand comment also exists.
  262.  
  263. Release 1.2.3  A maintenance release to correct the following:
  264.                - Corrects the activation/deactivation of the Save & Quit 
  265.                  option.
  266.                - Corrects a problem on OS/2 version determination caused by
  267.                  some add-on programs.
  268.  
  269. Release 1.2.4  A maintenance release to correct the following:
  270.                - Corrects a serious error in housekeeping.
  271.  
  272. Release 1.2.5  A maintenance release to add or correct the following:
  273.                - Flagging where a variable is "set" in the symbol 
  274.                  cross-referencing display and list has been added.
  275.                - An error that occurs under certain circumstances during the 
  276.                  formatting of a CALL or SIGNAL has been corrected.
  277.  
  278. Release 1.2.6  A maintenance release to correct the following:
  279.                - A right-hand comment formats incorrectly in some cases when it 
  280.                  cannot begin in the specified left justification column.
  281.  
  282. Release 1.2.7  A maintenance release which provides the following:
  283.                - A stand-alone version of RCF/2 (RCF2SA.EXE) that provides a
  284.                  non-GUI version of the program.
  285.                - Correction and modifications to the Help information.
  286.  
  287. Release 1.2.8  A maintenance and new feature release which provides the 
  288.                following:
  289.                - Adds missing VisPro/REXX(**) functions to the internal tables.
  290.                - Adds a help display to the non-GUI version of RCF/2 when a 
  291.                  question mark is given as a parameter.
  292.                - Corrected multiple errors in the help text.
  293.                - Provides improved label reference file handling.
  294.                - Improves label file referencing to make it easier to 
  295.                  use a single directory for all label files.
  296.                - Adds a new feature that allows performing formatting on 
  297.                  multiple REXX source programs in a directory or VisPro/REXX(**)
  298.                  project.
  299.                - Added help for the new features.
  300.  
  301. Release 1.2.9  A maintenance release to correct the following:
  302.                - Batch processing bypasses some files when using HPFS
  303.                - Label file does not always store the correct source file name
  304.                - Several errors in help text
  305.