home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / prgramer / rexx / rdebug / readme.os2 < prev    next >
Encoding:
Text File  |  1993-04-03  |  12.1 KB  |  294 lines
  1.  
  2.  
  3.  
  4.  
  5.      rDEBUG Version 2.1 Distribution Notes
  6.  
  7.      March, 1993 Revision
  8.  
  9.                              WHAT IS rDEBUG
  10.  
  11.      rDEBUG is an Intergrate Development Environment for
  12.      OS/2 REXX language procedures and KEDIT macros.  This
  13.      is a source level debugger using all common features of
  14.      an IDE such as:  built-in editor, breakpoints,
  15.      watchpoints, stepping single lines or stepping over
  16.      procedures, selective tracing, logging, restart
  17.      capabilities, pulldown menus, context help, a profiler
  18.      and a demo program.  The system features fault tolerant
  19.      coding to maintain a debugging session in spite of most
  20.      coding errors. rDEBUG is ideal for checking VISUAL REXX
  21.      procedures. rDEBUG is a number of REXX macros that
  22.      requires Mansfield Software Group's KEDIT for this version
  23.      but will support the EPM for version 2.2.
  24.  
  25.      Support is available for Canada and the USA, initially,
  26.      by the CANADA REMOTE SYSTEMS BBS and will be extended to
  27.      COMPUSERVE if warranted.  Other countries will be serviced
  28.      by mail.
  29.  
  30.      rDEBUG IS NOT FREE SOFTWARE, but rather, user-supported
  31.      "Shareware". rDEBUG may registered for $99 for a single
  32.      user or $399 for a multiple-user site.  Shipping and
  33.      handling is $2.50 for Canada and the USA or $3.00 for
  34.      other countries.  Please indicate whether uyou wish
  35.      3.5" or 5.25" format disks.
  36.  
  37.      More details are provided later in this documentation
  38.      file.
  39.  
  40.      While on the topic of printers if you wish to print from
  41.      within rDEBUG please change line 2 of rDEBUG.KEX as shown there.
  42.  
  43.  
  44.                           HARDWARE REQUIREMENTS
  45.  
  46.      rDEBUG will run on three systems, OS/2, DOS AND VM/CMS with
  47.      265K of hard disk space an additional 251 is required for
  48.      KEDIT.  This disk contains only the OS/2 version.  With
  49.      registration you can generate a system for any or all of
  50.      OS/2, DOS and VM/CMS (VM/CMS has to be tested yet). rDEBUG
  51.      can be run from a floppy and works on everything from a
  52.      notebook XT under DOS 3.3 and a 80386/sx 25mhz under DOS 5.0
  53.      and OS/2 version 2.0.
  54.  
  55.                           SOFTWARE REQUIREMENTS
  56.  
  57.      You must have installed IBM's REXX 2.0 with OS/2 version
  58.      2.0.  Also, you must have installed Mansfield Software
  59.      Group's KEDIT for OS/2 version 5.0+ in the root directory of
  60.      the drive that contains rDEBUG directory or in a directory
  61.      in the PATH.  KEDIT (includes a version for DOS as well as
  62.      for OS/2) can be bought from me at a big discount (approxi-
  63.      mately $125.00) or directly from Mansfield Software Group,
  64.      P.O.  Box 532, Storrs, CT, 06268 (203) 429-8404.
  65.  
  66.  
  67.  
  68.  
  69.  
  70.                INSTALLATION of rDEBUG for OS/2 version 2.0
  71.  
  72.      rDEBUG can work in any directory, however, the current
  73.      directory must be on the same drive that contains an rDEBUG
  74.      directory.
  75.  
  76.      1) click on OS/2 Full Screen prompt
  77.      2) place rDEBUG disk in your floppy drive
  78.      3) type A: and press <ENTER>, if you use drive "A", or
  79.      4) type B: and press <ENTER>, if you use drive "B"
  80.      5) if only rDEBUG.zip exists,
  81.         type: "c:"
  82.         type: "md \temp"       (may already exist, ignore error message)
  83.         type: "cd \temp"
  84.         type: "PKUNZIP a:\rDEBUG" or as in 3 & 4
  85.         type: "PKUNZIP b:\rDEBUG" to uncompress it.
  86.      6) type: "INSTALL target_drive"  (defaults: INSTALL C:) and press <ENTER>
  87.      7) follow instructions displayed on screen to complete installation.
  88.      8) be sure KEDIT.EXE is installed in root directory or in a directory
  89.         in the path defined in \rdebug\rdebug.cmd.
  90.      9) type: "rDEBUG" to run a demonstration procedure that shows what rDEBUG
  91.         can do.
  92.     10) type: "rDEBUG profile" to run a debugging session on an actual procedure.
  93.     11) to run rDEBUG on Visual REXX procedures you must install VREXX as shown
  94.         in the VREXX.ZIP which is available on most BBS's (or if you have registered
  95.         included with rDEBUG distribution disk).
  96.  
  97.  
  98.                      HOW TO RUN rDEBUG FROM DESKTOP
  99.  
  100.      1) double click/1 on rDEBUG folder
  101.      2) Run DEMO by clicking on DEMO
  102.      3) Run TESTPROF by clicking on TESTPROF
  103.      4) Run your program when \rDEBUG is on drive C by clicking on rDEBUG
  104.         and supplying your program name when prompted
  105.      5) Run your program when \rDEBUG is on drive D by clicking on D:\rDEBUG
  106.         icon and supplying your program name when prompted
  107.  
  108.                           rDEBUG DEMO COVERAGE
  109.  
  110.      If you type rDEBUG in the OS/2 commandline a simple
  111.      demonstration procedure will run and stop at various points
  112.      to execute and explain some of rDEBUG's features namely:
  113.        Breakpoints:            BREAK 2 5-7      ( set b/p's at lines 2 5 6 7)
  114.        Assignments:            abc = 1
  115.        Show variables:         SAY abc def dbp
  116.        GO COMMAND:             GO 3
  117.        WATCH COMMAND:          watch abc (def>12)
  118.        STEP PROCEDURE COMMAND: GO 0   or F10
  119.        PROFILER TOOL COMMAND:  PROFILER
  120.        EXIT COMMAND:           EXIT
  121.  
  122.  
  123.  
  124.  
  125.  
  126.   FILES USED BY rDEBUG:  (* marks files that can be deleted after demo)
  127.  
  128.      CHORES.CMD    * test file used by profile.cmd
  129.      CHORES2.CMD   * test file used by profile.cmd
  130.      DEBUGRUN.KEX    main routine od rDEBUG
  131.      DEMO.CMD      * demo test file
  132.      INSTALL.CMD   * installation procedure for rDEBUG
  133.      PROFILE.CMD   * sample procedure for logging on
  134.      RCASE.KEX       macro to standardize the case of REXX procedures
  135.      RDBCMDS.KEX     macro to call rDEBUG commands
  136.      RDBEND.KEX      wrap up macro for rDEBUG
  137.      RDBHELP.HLP     online help system file
  138.      RDBHELP.KEX     macro to deliver online help
  139.      RDBINIT.KEX     initialization macro to set up screens, etc
  140.      RDBIO.OS        special routines to handle REXX SAY and PULL commands
  141.      RDBMENU.KEX     macro to handle all menus
  142.      RDBMISC.KEX     macro to supply various miscellaneous function
  143.      RDBMSG.KEX      macro to handle most messages to tester
  144.      RDBPROF.KEX     macro to maintain the procedure's profile
  145.      RDBTASK.KEX     macro to handle rDEBUG commands from the menus
  146.      RDBUI.KEX       macro to provide the user interface
  147.      RDBUIEXT.OS2    definitions of keys for os/2
  148.      RDBVARS.KEX     macro to store and pass startup variables between macros
  149.      RDDEMO.CMD    * procedure to initialize a demonstarion of rDEBUG
  150.      RDDEMO.KEX    * macro to handle a DEMO of rDEBUG
  151.      RDDEMO.INC    * file used by RDDEMO.KEX
  152.      RDEBUG.CMD      procedure to start a rDEBUG session on REXX procedure
  153.      RDEBUG.CTL    * control file used by INSTALL.CMD
  154.      RDEBUG.HLP      rDEBUG help manual
  155.      RDEBUG.KEX      macro to start a rDEBUG session on REXX macro
  156.      RDPROFIL.KEX    macro to setup all rDEBUG sessions
  157.      RDXGEN.KEX      macro to tailor DEBUGRUN.KEX or setup a system
  158.      RDXMIMIC.KEX    macro to modify certain REXX statements
  159.      RDXWRAP.KEX     macro to wrap up rDEBUG.KEX
  160.      README.OS2      this file
  161.      RHYPERTX.KEX    macro to handle hypertext functions
  162.      RMATCH.KEX      macro to verify the proper pairing of delimiters
  163.      RPP.KEX         macro to indent REXX code in a structured fashion
  164.      RSTRUC.KEX      macro to show only lines that contain REXX key words
  165.      RSYNMSG.KEX     macro to handle error message for rSYNTAX.kex
  166.      RSYNTAX.KEX     macro to check for proper syntax of all REXX statements
  167.      RXREF.KEX       macro to generate a cross  reference map of all variables
  168.      TELL.CMD        procedure to call TELL macro
  169.      TELL.KEX        macro to show information on invoking a procedure
  170.      TRACESW.CMD   * procedure to call rXREF macro
  171.      TRACESW.KEX   * macro to initialize control variables
  172.  
  173.  
  174.                         UPDATE INFORMATION
  175.  
  176.      If you're already a registered user of rDEBUG and you want
  177.      an update of the latest version, we'll be happy to oblige.
  178.      Please see order form below.  Or, you can leave a message
  179.      for Gil Gagnon on Canada Remote Systems (416) 798-7730 or
  180.      798-7731 (Gil.Gagnon@canrem on Internet).
  181.  
  182.      Your support of this product makes continued development
  183.      possible.  We schedule our development work by the response
  184.      we receive from a product.  By registering, you're letting
  185.      us know that this product is important to YOU!
  186.  
  187.      We offer several incentives to you for registering.  First
  188.      of all, you receive the most up-to-date copy of the program
  189.      that we have, including comments, embedded test drivers and
  190.      code for DOS in addition to OS2.    You also receive support
  191.      for rDEBUG.  And finally, you will receive several tools not
  192.      included in the evaluation package.  Make no mistake, however,
  193.      this is a fully functional version of rDEBUG and not "crippled"
  194.      in any way.  In the wings: 1) support for IBM's EPM editor;
  195.      2) REXX's TRACE-like output as an option 3) rDEBUG 3.0 for
  196.      DOS  and 4) support for Quercus Personal Rexx for OS/2.
  197.  
  198.      All products and documentation here are Copyright 1992.
  199.  
  200.                      J Gil Gagnon & Associates Inc.
  201.                     814-25 Glenn Hawthorne Boulevard
  202.                       Mississauga, Ontario L5R 3E6
  203.                          Voice:  (416)  568-3105
  204.  
  205.      They may not be sold or licensed without the express
  206.      permission of J Gil Gagnon & Associates Inc.
  207.  
  208.  
  209.                          DISTRIBUTION NOTICE
  210.  
  211.      This is "user-supported" software.  You are hereby granted a
  212.      license by J Gil Gagnon & Associates Inc to distribute this
  213.      evaluation copy of rDEBUG and its documentation, subject to
  214.      the following conditions:
  215.  
  216.      1.   rDEBUG may be distributed freely  without  charge  in
  217.           evaluation form only.
  218.  
  219.      2.   rDEBUG  may not be sold,  licensed,  or a fee charged
  220.           for its use.   If a fee is charged in  connection  with
  221.           rDEBUG, it must cover the cost of copying or dissemi-
  222.           nation  only.   Such charges must be clearly identified
  223.           as such by  the  originating  party.    Under  no  cir-
  224.           cumstances  may  the  purchaser be given the impression
  225.           that he is buying rDEBUG itself.
  226.  
  227.      3.   rDEBUG must be presented as a complete unit,  includ-
  228.           ing  this  documentation.    Neither  rDEBUG  nor its
  229.           documentation may be amended or altered in any way.
  230.  
  231.      4.   By granting you the right to distribute the  evaluation
  232.           form  of rDEBUG,  you do not become the owner of rDEBUG
  233.           in any form.
  234.  
  235.      Any other use,  distribution or representation  of rDEBUG
  236.      is expressly forbidden without the written consent
  237.      of J Gil Gagnon & Associates Inc.
  238.  
  239.  
  240.  
  241.  
  242.  
  243. Mail to:
  244.  
  245.          J Gil Gagnon & Associates Inc
  246.          814-25 Glenn Hawthorne Boulevard
  247.          Mississauga, Ontario L5R 3E6
  248.          Telephone: (416) 568-3105
  249.  
  250.                        O R D E R   F O R M
  251.  
  252.  
  253.                           Name __________________________________
  254.  
  255.                        Company __________________________________
  256.  
  257.                        Street  __________________________________
  258.  
  259.       City, State, Zip/Country __________________________________
  260.  
  261.                                __________________________________
  262.  
  263.  
  264.      Registration Fee for Single-
  265.      System rDEBUG License         $99.00 ...........___________
  266.  
  267.      Registration Fee for Multi-
  268.      System Site License          $299.00 ...........___________
  269.  
  270.      Purchase of KEDIT 5.0 for OS/2
  271.      and DOS                      $125.00 ...........___________
  272.  
  273.      Sub total                                       ___________
  274.  
  275.      Shipping and Handling:
  276.  
  277.         U.S. and Canada:            $2.50
  278.         Other countries:            $3.00 ...........___________
  279.      (We airmail all foreign shipments)
  280.  
  281.      GST 7% of subtotal (for Canadian residents)     ___________
  282.  
  283.      TOTAL...........................................___________
  284.  
  285.      Please indicate payment method:
  286.  
  287.      Check  __  MO ___
  288.  
  289.  
  290.      We normally ship 3.5" 720K diskettes.  Check here if you
  291.      need rDEBUG on 5.25" 360K diskette.................________
  292.  
  293.      Where did you learn of rDEBUG? ____________________________
  294.