home *** CD-ROM | disk | FTP | other *** search
/ Oakland CPM Archive / oakcpm.iso / cpm / dskutl / patch18a.lbr / PATCH.DQC / PATCH.DOC
Encoding:
Text File  |  1985-05-13  |  14.9 KB  |  331 lines

  1. ************************************************************************
  2. *                                       *
  3. *            PATCH 1.8 DOCUMENTATION                *
  4. *                                       *
  5. ************************************************************************
  6.  
  7.       PATCH.COM is copyrighted by Bill Rink, San Jose, Ca.
  8. TURBO PASCAL is copyrighted by Borland International, Scotts Valley, Ca.
  9.  
  10.    Note: This was compiled with a Z80 version TURBO PASCAL compiler.
  11.  
  12.       ** TERMINAL INSTALLATION PROGRAM NOW INCLUDED **
  13.  
  14.          (SEE BELOW FOR INSTALLATION INSTRUCTIONS)
  15.  
  16. ------------------------------------------------------------------------
  17.             Record of Revisions
  18. ------------------------------------------------------------------------
  19. Release date May 5, 1985 PATCH 1.8
  20. 1. Fixed a bug in the directory procedure. Also, scans all users files
  21.    in sequence.
  22. 2. Added a CP/M status routine to display various parameters about your
  23.    system.
  24. 3. Changed DISPLAY of ASCII files routine so that it is not necessary to
  25.    have a DELINE function in your terminal, also updates screen more
  26.    quickly.
  27.  
  28.  
  29. Release date January 20, 1985 PATCH 1.7 (not released due to DIR bug)
  30. 1. Put the cursor key variable in 1st page of program space so that it
  31.    can be modified for terminal installation.  (See install procedure.)
  32.  
  33.  
  34. Release date December 27, 1984 PATCH 1.6
  35. 1. Fixed bug that limited maximum user number to 9.
  36. 2. You can now search while viewing ASCII files in the alternate DISPLAY
  37.    mode.
  38. 3. When changing DISPLAY modes, the file pointer is decremented so that
  39.    you will reference the same records after the change in mode.
  40. 4. Slight modifications to DOC file to clarify the install procedures.
  41.    12/20/84 Robert Flagg 72466,2332 (for KayPro SIG, Compuserve PCS25)
  42.    KayPro Sig Version includes Kim Levitt's terminal definition file
  43.    (renamed PAT15.DTA) from his LIFE.LBR 11/25/84 courtesy Kim Levitt.
  44.  
  45.  
  46. Release date December 1, 1984 PATCH 1.5
  47. 1. Added the capability to read and write system tracks. Actually any
  48.    track/record on the disk can be modified.
  49. 2. Added an overlay feature to allow the overlaying of a file to any
  50.    track/record on the disk.  The routine performs a two record copy
  51.    at a time and so it is quite slow, but effective.
  52. 3. Corrected some documentation errors in the DOC file.
  53.  
  54.  
  55. Not Released Patch 1.4
  56.  
  57.  
  58. Release Date November 13, 1984 Patch 1.3
  59.  
  60.     I received a phone call from Irv Hoff telling me that
  61.     people were having difficulty running the .COM file,
  62.     most likely because of TPA size differences. Well, as
  63.     it turned out that was the problem. Evidently when
  64.     TURBO PASCAL compiles a program, it records the top
  65.     of the TPA in the file so that upon loading the .COM
  66.     file into memory it sets the program variable space
  67.     at the top of memory. Well, if your running ZCPR3 or
  68.     have a large BIOS, then most likely PATCH was
  69.     stepping all over your CCP and causing untold
  70.     problems. This new version was compiled for a TPA
  71.     size of 48k, top of TPA set to BF00. Thanks to Irv
  72.     Hoff for pointing it out!
  73.  
  74.  
  75. Release Date October 31, 1984 Patch 1.2
  76. 1. Fixed search function to stop after wrapping around to beginning of
  77.    search.
  78. 2. Added tabbing to ASCII display mode (tab size=8).
  79. 3. Quicker disk operations during searches.
  80. 4. Default disk changed when reference is made to a disk in File Name.
  81. 5. Added a WILDCARD to the search routine
  82.  
  83.  
  84. Release Date October 21, 1984 Patch 1.1
  85. 1. Changed Search function to disregard upper/lower case distinction by
  86.    by using a toggle.
  87. 2. Search now begins at current record and wraps around.
  88. 3. Now able to select disks other than default.
  89. 4. Added Display mode that prints ASCII files out in line format for
  90.    better readability.
  91.  
  92.  
  93. First Release Date October 15, 1984 Patch 1.0
  94.  
  95.  
  96. ------------------------------------------------------------------------
  97. PATCH 1.7      (c) Copyright Bill Rink;  1984
  98. ------------------------------------------------------------------------
  99.  
  100. This software is made available to the public domain and may be freely
  101. distributed.  It is not to be sold or used for commercial use under any
  102. circumstances, without the express consent of the author.  I may be con-
  103. tacted by addressing your correspondence to:
  104.  
  105.             William Rink
  106.             PO Box 21447
  107.             San Jose, Ca
  108.             95151-1447
  109.  
  110. ........................................................................
  111.  
  112. PATCH is a file/memory editor that allows for easy access of either in-
  113. dividual records within a file, pages within memory, or individual
  114. records on the disk.  PATCH can operate in one of two modes; accessing
  115. 128 byte records from within the selected file, or 256 byte pages of
  116. processor memory (up to 64k).  Regardless of which mode you are in,
  117. there are 256 bytes of information displayed on the screen.  PATCH works
  118. like a full screen editor when changing hex data.  In addition, it has
  119. search capabilities on any combination of either HEX, DECIMAL, or ASCII
  120. fields that are separated by commas.
  121.  
  122. PATCH is based upon the concept of EDFILE, a program which I have used
  123. extensively and enjoyed tremendously.  My desire was to make an enhanced
  124. version that would be easy to use and more versatile.
  125.  
  126.        ****************  INSTALLATION  *********************
  127.  
  128. To install this program, simply execute the PATCHINS.COM program and re-
  129. pond to the prompts.  You MUST have the following files on the same
  130. drive/user area in order to successfully install the program:
  131.  
  132.          1. PATCH.COM
  133.          2. PATCHINS.DTA
  134.          3. PATCHINS.MSG
  135.          4. PATCHINS.COM
  136.  
  137. Please read the INSTALL.DOC file for detail information on how to prop-
  138. erly install PATCH.COM.
  139.  
  140. Make certain that you have the proper information available for answer-
  141. ing the terminal control questions before proceeding with a MANUAL in-
  142. stallation.  By the way, I have noticed that in some cases TURBO PASCAL
  143. actually uses the opposite control characters for REVERSE VIDEO. If your
  144. start-up screen does not have a REVERSE VIDEO boarder around the main
  145. menu, try reversing the definitions for START HIGHLIGHTING and END HIGH-
  146. LIGHTING.
  147.  
  148. CURSOR KEY DEFINITION
  149.  
  150. If you would like to customize the cursor movement commands to match
  151. those of your terminal, simply use PATCH to modify the following loca-
  152. tions.    Modify PATCH.COM, not the memory image, as you will experience
  153. problems in trying to modify run-time code on the fly that is referen-
  154. cing these locations each time you enter a key during an edit session.
  155. Values in parenthesis are the current defaults.
  156.  
  157. UP Cursor     0132 hex (10)        Left Cursor  (02)     0138 hex
  158. Down Cursor     0135 hex (0E)        Right Cursor (06)     013B hex
  159.  
  160. You will notice that there are lables to the left of each of these lo-
  161. cations to confirm the data byte being changed.  Sorry, ONLY a single
  162. byte is available for defining the cursor keys as I only read a single
  163. character from the keyboard each time to determine if it is data or a
  164. cursor key.
  165.  
  166. START-UP SCREEN
  167.  
  168. When PATCH is first started it displays a menu of available options.
  169. You'll notice that at this time you can select which disk and user area
  170. is to be used for making changes.  The disk can also be changed once you
  171. are working with disk files by indicating the disk with the file name.
  172.  
  173. You can then choose from viewing/editing records from either a particu-
  174. lar file, disk tracks, or pages from within memory.  Depending on which
  175. mode you enter, you will then have a selection of commands available to
  176. use.
  177.  
  178. COMMANDS
  179.  
  180. You will then be shown a list of commands to use for operating in that
  181. mode.  The command set is more complete when editing files due to the
  182. nature of operation.
  183.  
  184. 'Display'  This will change the display mode for looking at a file.
  185.        If you are looking at a file in the hex/ASCII mode, entering
  186.        a "D" will toggle you into a ASCII line mode in which each
  187.        line is strictly ASCII and is terminated by a CR,LF.  Any
  188.        non-printable characters will be shown as a reverse video
  189.        field to indicate them as such.  Tabs are converted, using
  190.        a tab size of 8.  Binary files that end in .COM are illegal
  191.        to display and you will not be allowed to use this mode.
  192.  
  193. 'Record'   FILE MODE-Enter the record number within the file that you
  194.        wish to access.  This is a DECIMAL record number. The EOF
  195.        record is shown next to the file name.
  196.  
  197.        TRACK MODE-You will be asked for the track number and the
  198.        record number. Again these are DECIMAL numbers. The number
  199.        of sectors per track are shown at the top of the screen.
  200.        You will be prompted for either PHYSICAL or LOGICAL record
  201.        numbers, depending on which mode you are in.
  202.  
  203. 'Base'       Allows changing the BASE address used as a reference while
  204.        in a file. The default is 100H.  This is useful when view-
  205.        ing image files of the operating system.  The BASE can be
  206.        changed from anywhere within a file.  The screen that you
  207.        are currently viewing will then be updated.    The BASE can
  208.        be set when you are viewing system tracks to reflect the ac-
  209.        tual memory locations that the operating system would reside
  210.        in.    If you are outside the system tracks, the address refer-
  211.        ences lose their meaning.  BASE is not allowed when viewing
  212.        memory locations.
  213.  
  214. 'Search'   Will prompt you for a search key to be used for scanning re-
  215.        cords or memory.  You may search for any combination of char-
  216.        acter types (hex, decimal, or ASCII).  To denote different
  217.        types, use a prefix before the field.  Use quotes (") at the
  218.        beginning of any ASCII field, a decimal point (.) at the be-
  219.        ginning of a decimal field, and a H at the start of a hex
  220.        field.  If you leave the prefix out, it will be assumed to be
  221.        hex.  Separate each field with a comma.
  222.  
  223.        e.g. "This is ASCII,.1234,0FE1," etc.
  224.  
  225.        Will search for an ASCII string followed by a decimal, hex
  226.        and ASCII field.
  227.  
  228.        When a string is found, it will be reverse highlighted to
  229.        denote it from the rest.
  230.  
  231.        Wildcards are permitted by using an 'X' for a don't care.
  232.        This must be a separate field, delimited by a comma and there
  233.        may be as many X's in the string as you desire.  For example,
  234.        entering a "Bo,X,"t,X  for a search string would locate a
  235.        match for BOATING, BOOTS, or BOTTOM.  Exercise caution, be-
  236.        cause whenever the wildcard(s) are present, any "X" in an
  237.        ASCII string will act as if it were a wild card too.  For ex-
  238.        ample, searching with a string of  "XRAY,X  will locate XRAYS
  239.        as well as GRAYS.
  240.  
  241.        Searches are done on an entire 256 byte buffer and so there
  242.        are times when the target string will cross the boundary be-
  243.        tween two buffers.  When this happens you will be notified
  244.        and the tail end of the string will be highlighted.    Just go
  245.        back one record to access the beginning of the target string.
  246.        (Sometimes more characters are highlighted than necessary
  247.        when a boundary is crossed, do not be concerned..)
  248.  
  249.        You can terminate the search at any time by hitting any char-
  250.        acter on the keyboard.  This is useful if you are searching a
  251.        long file and realize that you entered the wrong key. The re-
  252.        sponse will always be KEY NOT FOUND and you will be returned
  253.        to the record from which the search began.
  254.  
  255. 'Ucase'    When highlighted, it means that when searching for an ASCII
  256.        match, the case of the key and the string matched against
  257.        will NOT matter.  Both the search string and the characters
  258.        searched will be converted to UPPER case for determining a
  259.        match.  If not highlighted, case does matter.  This feature
  260.        can be toggled by entering an "U" command.  If you perform a
  261.        search on a hex, decimal, or ASCII and numerical combination,
  262.        Ucase will toggle to the OFF state i.e., all searches will
  263.        be exact matches if mixed or numeric.
  264.  
  265. 'Cont'       Continues the search for the last string found.
  266.  
  267. 'Address'  Allows a HEX address to be entered for positioning from
  268.        within the file or memory.  This option is not valid when
  269.        in TRACK mode.
  270.  
  271. 'Edit'       Will place the cursor at the top left corner or at the
  272.        begining of the string that was found with a 'Search'.
  273.        Commands will be displayed to indicate how you may move
  274.        the cursor from within the display.    There are two sets
  275.        of commands available, the standard WordStar format and
  276.        one for those who like to use thier right hand.  If you
  277.        have cursor keypad that outputs E2,E4,E6, and E8, then it
  278.        will work.  (You can use PATCH to change these for your
  279.        particular keypad, just search for them)
  280.  
  281.        To change from the HEX field to the ASCII field, or visa
  282.        versa, enter a ^F.  To quit editing, enter a ^Q.  You will
  283.        then be asked if you wish to WRITE the record or ABORT the
  284.        edit.  Hitting ANY character other than a "W" will abort
  285.        the update.    You will notice that the screen is then re-
  286.        freshed with the current record.  On an EDIT update PATCH
  287.        will write the record and then read it back, displaying the
  288.        changed data on the screen.    If you ABORT, PATCH will read
  289.        the unmodified records and redisplay them.
  290.  
  291. 'Page'       Paging is accomplished by either entering a + or -, or hit-
  292.        ting a RETURN for paging forward.  In TRACK mode, PATCH will
  293.        take you from track to track as you exceed the number of
  294.        records on a track.
  295.  
  296. 'Overlay'  This feature is available when you are in FILE mode only.  By
  297.        selecting it you are asked how many records you would like to
  298.        copy from the file.    Next you are asked if those records
  299.        should be PHYSICAL or LOGICAL.  If you are copying into sys-
  300.        tem tracks you should use PHYSICAL, into another file use
  301.        LOGICAL.  Next you are asked for the destination track and
  302.        record.  Upon completion of this entry you will be told what
  303.        it is about to do.  If you like the parameters, just enter a
  304.        'Y'.  Now PATCH will read two records and copy them to the
  305.        destination, one at a time.    It seems slow, but reliable and
  306.        required little structural changes in the software.
  307.  
  308. 'Log_Sec'  The default mode for accessing TRACKS is in the PHYSICAL
  309.        record mode i.e., each record accessed is physically located
  310.        after the preceeding one.  The system tracks are written this
  311.        way to make booting the operating system simpler.  Once the
  312.        BIOS is in control, all disk accesses are done using LOGICAL
  313.        records and so PATCH will use the disk skewing table in the
  314.        BIOS to compute the PHYSICAL record needed to gain access to
  315.        the desired LOGICAL record.    This mode can be toggled.  When
  316.        in LOG_REC mode you will see both record numbers displayed at
  317.        the top of the screen.
  318.  
  319. To use this program, it is necessary that your terminal have the follow-
  320. ing following screen commands available:
  321.  
  322.         Cursor Addressing
  323.         Reverse Video
  324.         Clear Line
  325.         Clear Screen
  326.  
  327. I think you will find this a powerful PATCH utility and I hope you find
  328. it useful.  Enjoy!
  329.                     Bill Rink  San Jose, California
  330.  
  331.