home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / Assembler / dse-src6.dms / in.adf / RESCUE.LZH / Rescue.doc < prev    next >
Encoding:
Text File  |  1993-02-13  |  6.9 KB  |  153 lines
  1.    ***********************************************************************  
  2.   **                                                                     **  
  3.  **                                                                       **
  4. **                             RescueSource                                **
  5. *                       Version 2.32   23-Aug-90                            *
  6. *                        Written by James Tough                             *
  7. **                          for Amiga Format                               **
  8.  **                                                                       **
  9.   **                                                                     ** 
  10.    ***********************************************************************  
  11.  
  12.  
  13.    ************************************************************************
  14.   **                                                                      **
  15.   *                         User Documentation                             *
  16.   **                                                                      **
  17.    ************************************************************************
  18.  
  19.  
  20.             Rescue source, is a utility program to retieve source
  21.          text from the Amiga's memory after a visit from the guru    
  22.          or similar software error, ie when the source text cannot be
  23.          written to disk before a reset. Source files from any pure
  24.          text editor can be rescued in this manner, and includes these
  25.          programs :  Devpac V1 and 2 
  26.                      Argasm
  27.                      Txed
  28.                      Cygnus Ed and Pro
  29.             Rescue source is useful for those persons who do not
  30.          have recoverable ram disks (like myself) with expansion
  31.          memory. I hope it is of some use to someone!!!! Perhaps??
  32.          Maybe?? 
  33.             The author accepts no responsiblity of any damage to
  34.          personal property, or otherwise caused by this program. Use
  35.          it at your own risk! (although I am pretty sure that this
  36.          version is bug free (famous last words!!)). 
  37.  
  38.  
  39.                                  *********
  40.  
  41.  
  42.        To use Rescue source, four varbiables have to be supplied. Firstly
  43.     the <search type>, an ascii pattern to signal the start of the source
  44.     text in memory <start text>, an ascii pattern to signal the end of
  45.     the source <end text>, and finally a filename to output any memory
  46.     contents to <save filename>. 
  47.  
  48.  
  49.       Search Type  -  Specifies the type of search conducted on memory
  50.      -------------
  51.              -1 to use both <start text> and <end text>. This method
  52.           searches through memory for the start text, and finds the
  53.           end of the source by looking for end text.
  54.              -2 to use both <start text> to find the start of the source
  55.           and looks through memory until it comes across an illegal ascii
  56.           character. The ascii range starts at 32 (space) and ends at 255.
  57.           The range also includes 9 (tab), 10(newline) and 13(carrage return)  
  58.              Null string (ie, nothing) defaults to -1  
  59.   
  60.  
  61.        Start Text - Specifies the start pattern to look for.
  62.       ------------
  63.               Generally, the start text is a name or pattern located at
  64.           at the first line. The identifier must not exceed 20 characters.
  65.           NOTE : All text in the identifier is case sensitive.          
  66.  
  67.  
  68.         End Text - Specifies the end pattern to look for.
  69.        ----------
  70.               All as for Start Text. End text should not be given if search
  71.            type -2 is used.
  72.  
  73.  
  74.        Save Filename - Output filename
  75.       ---------------
  76.               The filename should be directed to disk. This ensures that no
  77.             source in memory is overwritten and subsequently lost, as it
  78.             would be if the RamDisk is used. If no filename is given, then
  79.             a default of 'rescue.s' is used.
  80.  
  81.  
  82.    Examples  -  Rescue *-*-*-* ***CodeEnd source, searches for '*-*-*-*'
  83.   ----------    at the start of the source, '***CodeEnd' at the end
  84.                 and outputs the memory to 'source' using search type 1.
  85.      
  86.                 Rescue -1 Enigma end df0:Enigma.s, searches for 'Enigma'
  87.                 'end' at the end, and save the memory to the internal
  88.                 drive.
  89.  
  90.                 Rescue -2 ????? df0:source, searches for '?????', finds
  91.                 the end when an illegal letter is found, and saves the
  92.                 source to 'df0:source'
  93.  
  94.                                  *********
  95.  
  96.         When Rescue source loads, it forces itself to chip memory. This 
  97.      ensures that it does not overwrite any text in fast memory (where
  98.      the text is most likely to be). If there is no fast memory, then
  99.      this does not matter. If fast memory is connected in any form. then
  100.      it will search this first. Fastmemory can be in any form, whether
  101.      it be an A501 (or similar), or larger boards. Chip memory is searched
  102.      last (rescue also handles chip memory larger than 1/2 meg). 
  103.  
  104.         NOTE : Rescue does not find any identifiers within itself.
  105.  
  106.         While looking through memory, it will update where it is currently
  107.      looking every $10000 (65536 decimal) bytes.
  108.  
  109.         On the event of finding any complete source files, the user is
  110.      presented with the source's memory location, and length in hexa-
  111.      decimal, eg
  112.        
  113.            Found at $c26bfe, len $2ef5   Save(S) View(V) Exit(X) - 
  114.  
  115.         The user has three choices, save the source from memory 'S' or 's'
  116.      view four lines 'V' or 'v' (this can be repeated to get a mini listing
  117.      of the source in memory, like the CLI command Type), or exit from search
  118.      'X' or 'x'.
  119.  
  120.         If more than one source file is saved, then a file extension is
  121.      added to the end of the filename to differentiate saved files. The 
  122.      extension is only a '.' and a decimal number that increases after
  123.      each save.
  124.  
  125.         Rescue also captures various DOS errors if there was a save error,
  126.      and explains why. If this is not possible, it then prints the DOS 
  127.      error code in decimal. It is upto the user to find out, although
  128.      most errors can be evened-out by swapping disks, and using a different
  129.      file name. 
  130.  
  131.                                  *********
  132.  
  133.  
  134.         I hope this utility is useful to some one (there should be someone
  135.      out there who likes it!). If there are any bugs, please report them
  136.      to me and I should be able to sort them out. Any ideas on improvments
  137.      too, are greatly appreciated. Finally, if anyone would like the
  138.      technical documentaion and the source code together, then send the
  139.      modest (and it is modest) sum of £2 to - 
  140.  
  141.          Mr J Tough.             (disk generously supplied by me!)
  142.           26 Deeside Gardens,
  143.            Aberdeen,
  144.             Scotland.
  145.              AB1 7PN.      
  146.  
  147.                                  *********
  148.  
  149.                                  Thank You
  150.  
  151.                                  *********
  152.  
  153.