home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 287.lha / FedUp_v2.1 / fedup.doc < prev    next >
Encoding:
Text File  |  1989-09-13  |  6.4 KB  |  183 lines
  1.   ==========================================================================
  2.                     
  3.                                 FedUp V1.0   
  4.   
  5.                        File-Editor Utility Program
  6.  
  7.                        
  8.                             Documentation file    
  9.  
  10.   ==========================================================================
  11.      
  12.  
  13.                                   NOTE
  14.         
  15.      This documentation is for FEDUP V1.0 only. Refer to HISTORY.TXT for 
  16.      the latest changes. Topics marked *(n)* are changed/improved in later 
  17.      versions: refer to #n in HISTORY.TXT.
  18.  
  19.  
  20.  
  21.                                 ABSTRACT 
  22.      
  23.      
  24.      FedUp is a random access, byte oriented file-editor who gives you 
  25.      the option to view or edit any file (eg. binary or ASCII) using 
  26.      either ASCII- or hexadecimal notation. FedUp addresses a file in a 
  27.      random fashion (where each 'record' is 256 bytes long); access to a 
  28.      given location appears instantly. Although any filetype is supported, 
  29.      because of FedUp's nature, operation is best suited on binary files.
  30.      Operation on pure ASCII files will be better off with a proper editor 
  31.      (eg. MicroEMACS (the best editor ever written)).  
  32.      
  33.      
  34.      
  35.      
  36.      
  37.                                 STARTUP     
  38.      
  39.  
  40.      FedUp may be initiated from CLI or from workbench. Once FedUp has 
  41.      started, you will be prompted for a file to open. Type the name 
  42.      of an existing file and press <CR> or click on the OK gadget. 
  43.      If you click on the CANCEL gadget, FedUp will terminate itself; 
  44.      FedUp operates ONLY on existing files.
  45.      
  46.      If you start up FedUp from CLI, you may pass a filename as an 
  47.      argument, thus
  48.      
  49.              1> FedUp fubar  
  50.      
  51.      is perfectly acceptable. 
  52.  
  53.      
  54.           
  55.      
  56.                                 MOVEMENT
  57.      
  58.      
  59.      You are now in position to view or edit the given file. As mentioned, 
  60.      FedUp deals with blocks (records) of data; each block is 256 bytes 
  61.      long. *(6)* Block positioning is supported either via menuitems (MOVE) 
  62.      or the cursor keys:      
  63.  
  64.               First record      [CURSOR-UP]    or [SHIFT]+[CURSOR-LEFT]
  65.                 Last record       [CURSOR-DOWN]  or [SHIFT]+[CURSOR-RIGHT]
  66.                 Next record       [CURSOR-RIGHT] 
  67.                 Previous record   [CURSOR-LEFT]
  68.            
  69.      You may also skip directly to a known record by selecting GOTO in the 
  70.      MOVE menu. 
  71.  
  72.      
  73.      
  74.                                  EDIT
  75.           
  76.      
  77.      If you want to edit something in a record, you can select the 
  78.      appropriate menuitem under the EDIT menu: 
  79.      
  80.              ASCII edit  
  81.                 HEX edit    
  82.      
  83.      If you select ASCII edit, the cursor will be placed in the ASCII 
  84.      field. Here, you may use the full keyboard (ALT characters is 
  85.      supported). Positioning is of course supported via the cursor keys. 
  86.      If you press [SHIFT] + one of the cursor keys, the cursor will be 
  87.      placed at the extreme border respectively. Alternatively, you may use 
  88.      the mouse to move or select. 
  89.      Selecting HEX edit allows you to edit in hex (really?), giving  
  90.      you access to the full range of character values (0-255). 
  91.      If you press [BACKSPACE], your entries will be SUBSTITUTED with the 
  92.      original values; they will not be deleted in the conventional fashion. 
  93.      For example, if you have made a lot of corrections, and you realize 
  94.      that this was a bloody stupid thing to do, just move the cursor to the 
  95.      last character and press [BACKSPACE]. The original values will then 
  96.      reappear. *(4)*. 
  97.  
  98.      Note: Some files may not always even with 256 bytes in length; the last
  99.      block may therefore be shorter than 256 bytes. FedUp pads the remaining 
  100.      bytes with '#' characters. Access within this field is not allowed. 
  101.      
  102.      Once you are satisfyed with your corrections, press [CR] or [ESC] and 
  103.      select WRITE under the EDIT menu to save the updates. 
  104.      Note that if you move to another record, your corrections will be lost 
  105.      unless you have saved them *(2)*.
  106.      
  107.      If, for some reason, you want to restore the LAST (important) edited 
  108.      record, select UNDO from the menu. The original record will then 
  109.      assume reappearance. 
  110.      
  111.      
  112.      
  113.      
  114.                         MISCELLANEOUS FUNCTIONS  
  115.      
  116.  
  117.      Under the MISC menu, you have several misc'ed functions: 
  118.      
  119.              SEARCH *(9)* *(10)* *(11)* 
  120.                 PRINT
  121.                 127
  122.                 AUTOSAVE *(2)* 
  123.                 PROMPTS  *(3)*     
  124.  
  125.  
  126.      SEARCH gives you the the possibility to search for a given string
  127.      in the active file. Only string search is supported *(9)*. Once 
  128.      selected, a requester will appear prompting you for a key. Type 
  129.      the key and press <CR> (or click on the OK gadget). If a match 
  130.      occurs, FedUp automaticly moves to the record where the matched 
  131.      string is located *(11)*. 
  132.      The search is started from the current record + 1 (eg. next record). 
  133.      You may terminate the search by pressing the [ESC] key. 
  134.      
  135.  
  136.      PRINT prints a screencopy of the current record to printer or to 
  137.      a file. If you want to send the output to a file, delete the 
  138.      PRT: option in the requester and type the name of the file. 
  139.      If not, just click on the OK gadget. You may terminate the print 
  140.      by pressing the [ESC] key.
  141.      
  142.      
  143.      127 gives you the option to specify if you want ALT characters 
  144.      accessible or not. The default is 256 characters (full range). 
  145.      Characters with values below 32 (CTRL) are always printed as a 
  146.      dot. Note that the ALT characters may produce some strange effects 
  147.      if printed out on printer (or to a file for that matter). If you want 
  148.      to print a record, select 127 characters. 
  149.      
  150.      
  151.      
  152.      
  153.                                 PROJECT 
  154.  
  155.       
  156.      The project menu has 2 options: 
  157.              
  158.              OPEN
  159.                 EXIT
  160.      
  161.      which is rather self-explanatory- OPEN opens a new file while 
  162.      EXIT shuts FedUp down. 
  163.      
  164.      
  165.      
  166.      
  167.                            GENERAL INFORMATION
  168.  
  169.      
  170.      If an error occurs during a read or a write operation, a requester 
  171.      will pop up facing you with 2 options: OK or CANCEL. If you activate 
  172.      the OK gadget, FedUp will terminate itself. If you simply want to 
  173.      ignore the error, select CANCEL. 
  174.  
  175.  
  176.      Martin Lindemann
  177.      Linneaveien 13 B
  178.      1450  NESODDTANGEN
  179.      Norway
  180.      +47 02 911268
  181.  
  182.  
  183.