home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR2 / DBGEDIT1.ZIP / DBGEDIT1.DOC next >
Text File  |  1993-12-21  |  11KB  |  287 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                  DEBUG Script File Editor - Shareware v1.0, 12/19/93
  11.                   Copyright 1993 by Richard Lauhead and Ed Johnson
  12.                                  All Rights Reserved
  13.  
  14.           =================================================================
  15.  
  16.                                      The Purpose
  17.                                      ===========
  18.  
  19.           This little utility has one sole purpose in life: to make it
  20.           easier to enter DEBUG scripts from printed listings.
  21.  
  22.                                        Credits
  23.                                        =======
  24.  
  25.           Original program idea, QBasic version (unreleased) and
  26.           documentation by Ed Johnson.
  27.  
  28.           Conversion to C++, enhancement ideas, and endless testing by
  29.           Richard Lauhead.
  30.  
  31.                                   Shareware Notice
  32.                                   ================
  33.  
  34.           This utility is being distributed as shareware. You are
  35.           encouraged to share this utility with others. If you find it
  36.           useful after a reasonable evaluation period (not to exceed
  37.           entering 3 scripts) you must pay for it. Registration is only
  38.           $10. This program is not restricted in any way and will not "nag"
  39.           you to register. The only reminder will be displayed as part of
  40.           the version number on the screen. We trust that your conscience 
  41.           will be your guide. Upon receipt of your registration, we will
  42.           send you a note of thanks for your contribution. You will also be
  43.           notified of any and all future upgrades. See the end of this file
  44.           for registration information.
  45.  
  46.                                    The Inspiration
  47.                                    ===============
  48.  
  49.           Not being a touch typist, I always found it difficult to type in
  50.           DEBUG scripts from magazine articles because I was always
  51.           switching between the alpha keys and the numeric keypad. I work
  52.           for a restaurant and part of my job is to handle the programming
  53.           of our cash registers. Some of that programming involves entering
  54.           hexadecimal numbers. The numeric keys on the registers are
  55.           similar to the keypad on a PC but have a double-zero key in the
  56.           place of the period. To enter a hexadecimal letter (A-F) on the
  57.           registers, you have to hit the double-zero key followed by a
  58.           number from 1-6. The double-zero key acts as a shift key and will
  59.           treat the next key hit as a hexadecimal letter (00-1=A, 00-2=B,
  60.           and so on). Once you get used to it, it's a pretty quick way to
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.           enter the data. I decided to mimic this type of data entry for
  68.           creating DEBUG scripts. My first thought was to simply use the
  69.           numeric keypad and enter the data into a text editor and then use
  70.           the search and replace feature to convert the text into the
  71.           proper format. My script looked something like this:
  72.  
  73.           N SCRIPT.COM
  74.           .5+100+.5.2+66+00+00+00+00+00+0.4
  75.           .5+108+0.1+43+44+44+20+2.4+20+73
  76.           ...
  77.           ...
  78.           RCX
  79.           00.62
  80.           W
  81.           Q
  82.  
  83.           This looks pretty cryptic, but actually worked quite well. The
  84.           only problem was trying to proof it as I went along. I then used
  85.           search and replace to convert ".1" to "A", ".2" to "B", etc. The
  86.           "+" was used to mark a space character. My converted script
  87.           looked like this:
  88.  
  89.           N SCRIPT.COM
  90.           E 100 EB 66 00 00 00 00 00 0D
  91.           E 108 0A 43 44 44 20 2D 20 73
  92.           ...
  93.           ...
  94.           RCX
  95.           00F2
  96.           W
  97.           Q
  98.  
  99.           I could enter the bulk of the script without moving my hand from
  100.           the numeric keypad. I decided that a QBASIC program could be
  101.           written to eliminate even more key presses. The original QBASIC
  102.           program worked OK, but I wanted the program to be a bit easier to
  103.           distribute and available to everyone who has a use for it. Since
  104.           everyone doesn't use MS DOS, I needed to get it converted to a
  105.           language that could be compiled. Thanks to the efforts of Richard
  106.           Lauhead, the end result is this program.
  107.  
  108.                                      The Details
  109.                                      ===========
  110.  
  111.           The file is distributed as a self-extracting archive. If you are
  112.           reading this, you have already unpacked the file. Just type
  113.           "DBGEDIT1" (no quotes) to run the program.
  114.  
  115.           Once running, the program will prompt you for the output file
  116.           name of the script file you want to create. If a file already
  117.           exists with that name you will be asked if you want to load the
  118.           file for editing or if you want to overwrite it and create a new
  119.           script file. Any valid DOS file name will work, but don't use a
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.           COM extension! Normally a SCR extension is used for DEBUG
  127.           scripts.
  128.  
  129.           Based on your input file name, the program will start to generate
  130.           the DEBUG script using the name you entered with a COM extension
  131.           as the DEBUG file name. It also displays the DEBUG "E" command
  132.           and the starting address. You won't have to key those in. As you
  133.           enter the hexadecimal numbers, your script will be formatted
  134.           automatically by placing a space between each byte entered.
  135.  
  136.           -/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/-/
  137.  
  138.                The following keys are active for keying in the script:
  139.  
  140.                                       0-9, A-F
  141.                                       ========
  142.  
  143.           Used for hexadecimal entry (lower case letters will be converted
  144.           to upper case automatically).
  145.  
  146.                                      . (period)
  147.                                      ==========
  148.  
  149.           Will display the word "SHIFT" to the right of the output file
  150.           name. When this is displayed, hitting the numbers 1-6 will result
  151.           in the letters A-F being entered respectively. If you prefer, you
  152.           can use the "normal" A-F keys to enter those letters as well.
  153.  
  154.                               (enter) and (down-arrow)
  155.                               ========================
  156.  
  157.           Will move to the next line of the DEBUG script. Note that the
  158.           program keeps track of the byte count per line as you enter the
  159.           script. If you try to enter more than 8 bytes on a line, you'll
  160.           get one of those annoying beeps to let you know (8 bytes per line
  161.           is a limit set by DEBUG so we don't allow more than that to be
  162.           entered on a line). Hit enter or down-arrow to move to the next
  163.           line. If you have previously used up-arrow to edit a line, any
  164.           bytes entered in the next line will be displayed so you can edit
  165.           those or skip past them.
  166.  
  167.                                      (up-arrow)
  168.                                      ==========
  169.  
  170.           Will move you to the previous line for making corrections. This
  171.           is limited in that you have to backspace to the point of
  172.           correction and re-type the rest of the line.
  173.  
  174.                                      (backspace)
  175.                                      ===========
  176.  
  177.           A destructive backspace that allows you to fix typos on the
  178.           current line.
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.                                           Q
  186.                                           =
  187.  
  188.           Will exit data entry mode, complete the script, and prompt you to
  189.           create the COM file if you wish. You will also be prompted to
  190.           save the script file at this point. After getting through the
  191.           prompts, the program will exit to DOS.
  192.  
  193.           If you don't want to use this program to compile the scripts, you
  194.           can still use DEBUG outside of this program as you would for any
  195.           other script file. Just type: 
  196.  
  197.                           DEBUG <script.scr 
  198.  
  199.           where script.scr is the name of your script file (if the script
  200.           is not in your path or the current directory, you'll have to
  201.           include the entire path in your script filename).
  202.  
  203.           =================================================================
  204.  
  205.           Richard and I are proud of our little program. This turned out to
  206.           be a bigger project than either of us bargained for, but we both
  207.           love to "tinker" and are very sensitive to the functionality of
  208.           anything that someone else might use. If you have any suggestions
  209.           for improvements, please pass them along to us.
  210.  
  211.           Send any inquiries to:
  212.  
  213.           Ed Johnson              or              Richard Lauhead
  214.           399 Lexington Pkwy S                    3985 Clover Av
  215.           St Paul, MN 55105-2926                  St Paul, MN 55127-7015
  216.  
  217.           We can both be reached via modem as well:
  218.  
  219.           Internet addresses:
  220.           ed.johnson@giz.com
  221.           richard.lauhead@giz.com
  222.  
  223.           The Gizmode Databank (8/N/1, up to 14.4K) (612)644-4041:
  224.           Ed Johnson
  225.           Richard Lauhead
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.           *****************************************************************
  233.  
  234.                               Registration Information
  235.  
  236.                      DEBUG SCRIPT FILE EDITOR v1.0 REGISTRATION
  237.                      ==========================================
  238.  
  239.           Name ___________________________________________________________
  240.  
  241.  
  242.           Address ________________________________________________________
  243.  
  244.  
  245.                   ________________________________________________________
  246.  
  247.  
  248.                   ________________________________________________________
  249.  
  250.  
  251.           Phone ____________________  Internet mail address ______________
  252.                                              
  253.  
  254.           All prices are in US Funds - we can't accept credit cards or
  255.           Purchase Orders
  256.  
  257.           ___ Registration(s) of DEBUG SCRIPT FILE EDITOR - $10.00ea _____
  258.  
  259.           ___ Upgrade(s)                                  - $ 2.00ea _____
  260.  
  261.               (Indicate disk size __3.5"  __5.25")             Total _____ 
  262.  
  263.           Where did you find our program? ________________________________
  264.  
  265.           Type of PC Used _________________________  DOS Version _________
  266.  
  267.           General Hardware Setup _________________________________________
  268.  
  269.           Comments and Suggestions _______________________________________
  270.  
  271.           ________________________________________________________________
  272.  
  273.           ________________________________________________________________
  274.  
  275.           ________________________________________________________________
  276.  
  277.           ________________________________________________________________
  278.  
  279.  
  280.  
  281.           Make Check or Money Order payable to:    Ed Johnson
  282.                                                    399 Lexington Pkwy S
  283.                                                    St Paul, MN 55105-2926
  284.  
  285.           ****************************************************************
  286.  
  287.