home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 2: PC / frozenfish_august_1995.bin / bbs / d07xx / d0759.lha / AZap / AZapEnglish.doc < prev    next >
Text File  |  1992-11-06  |  13KB  |  331 lines
  1.  
  2.                   AZap - User's Manual
  3.  
  4.  
  5.  
  6.  
  7.  
  8.   1. Foreword
  9.  
  10.       This manual describes release 1.00 of the utility AZap. This program
  11.   is (c)1992 by Denis  GOUNELLE,  any  commercial  usage  or  selling  without
  12.   author's written authorization is  strictly  forbidden.  You  can  copy  and
  13.   spread this program at the following conditions:
  14.  
  15.     - all the files must be provided
  16.     - none of the file must have been modified
  17.     - you don't charge more than $6 for copy fee
  18.  
  19.       In spite of several tests, no warranty is made that there's no error
  20.   in AZap. YOU USE THIS PROGRAM AT YOUR OWN RISKS.  In    no  event  will  I  be
  21.   liable for any damage, direct or indirect, resulting of the use of AZap.
  22.  
  23.   2. Introduction
  24.  
  25.       AZap is a "new generation" binary editor able to edit files,  memory
  26.   or devices like hard disks. It can open several windows at  the  same  time,
  27.   and while this program cannot be considered as a tool to help you to recover
  28.   a disk, it has a lot of useful functions  (print  bloc,  fill  bloc,  search
  29.   string, etc...).
  30.  
  31.                     CAUTION:
  32.  
  33.       It is absolutly forbidden to use this program  to  modify  a
  34.       copyright notice, or any other illegal usage.  Unexperienced
  35.       users should be aware that this program  may    destroy  their
  36.       programs, or cause severe data loss. 
  37.  
  38.       Suggestions and/or criticisms will be always welcome. Don't hesitate
  39.   to write me at the following address:
  40.  
  41.                    M. GOUNELLE Denis
  42.                     Boite 71
  43.                   6, rue des cailloux
  44.                  92110 CLICHY - FRANCE
  45.  
  46.       This program requires "reqtools.library" v2.0c to run, so  you  must
  47.   copy    it  in    your  "LIBS:"  directory  before.  The  "reqtools.library"  is
  48.   (c)1990-1991 by Nico FRANCOIS.
  49.       Thanks to Pierre ARDICHVILI and Jean-Yves PROUX for beta-testing and
  50.   suggestions.
  51.  
  52.   3. Running AZap from CLI
  53.  
  54.       This program detach itself from CLI window. It accepts the following
  55.   arguments:
  56.  
  57.       WBENCH
  58.       Use Workbench screen instead of custom screen.
  59.  
  60.       LACE
  61.       Use an interlaced custom screen. This option is ignored  if  the
  62.       WBENCH option is specified too.
  63.  
  64.       FONT name
  65.       Use the specified font instead of internal 6x9 font. "name" must
  66.       be given as <font name><Y size>, like "courier9". AZap will  use
  67.       this font only if it isn't proportionnal and  if  it  isn't  too
  68.       large to display a 512 bytes block.
  69.  
  70.       MEMORY
  71.       Open a window to edit memory.
  72.  
  73.       DEVICE name
  74.       Open a window to edit specified device. Don't forget  the  colon
  75.       (":") at the end of the name.
  76.  
  77.   Any other argument is supposed to be the name of a file  to  edit.  You  can
  78.   specify as many names as you want, but only the first eight will be used. Of
  79.   course, you can mix file names, MEMORY  and  DEVICE  options.  Last,    if  no
  80.   argument is specified, a file requester appears so you can select  the  file
  81.   to edit.
  82.  
  83.   4. Running AZap from
  84.  
  85.       You can specify the following options in the "TOOL  TYPES"  of  AZap
  86.   icon:
  87.  
  88.       OPTIONS=WBENCH or OPTIONS=LACE
  89.       See above the description of WBENCH and LACE options.
  90.  
  91.       FONT=name
  92.       See above the description of FONT option.
  93.  
  94.   A file requester will appear, so you can select the file to edit.
  95.  
  96.   5. The edit window
  97.  
  98.       The  left  part  of  the  display  shows  the  block     contents   in
  99.   hexadecimal, by sets of 4 bytes. The right part shows the  same  information
  100.   but as characters.  Bytes  corresponding  to    non-printable  characters  are
  101.   replaced by a point (".").
  102.       At  the  bottom  right  of  the   window   are   displayed   several
  103.   informations: the block address (relative to beginning, in hex), the  offset
  104.   in the block (in hex), the block number (relative to beginnin, in  decimal),
  105.   and the block type. This last information is not significant unless you edit
  106.   a DOS device. When block contents has been modified but not written, a  star
  107.   ("*") is displayed at the right of the first line. When  block  checksum  is
  108.   valid, a "V" character is displayed at the right of the  second  line  (this
  109.   information is not significant unless you edit a DOS device).
  110.  
  111.       When the window is opened, the first    block  is  displayed  and  the
  112.   cursor is on the first  character  of  the  right  part.  The  corresponding
  113.   position in the left part is showed by a display in a different  color.  You
  114.   can move the cursor whith the arrow  keys.  To  switch  between  a  part  to
  115.   another (left to right or right to left) just press the tabulation key.  You
  116.   can also move anywhere you want using the mouse. To modify data,  just  type
  117.   in the new datas over the old ones. In the left part, only "0" to  "9",  "a"
  118.   to "f" and "A" to "F" characters are allowed. AZap keep in mind the 32  last
  119.   changes: as long as you have not moved to another bloc you  can  undo  these
  120.   changes with the escape key. The following keys are also accepted:
  121.  
  122.       ctrl-up      go to first block
  123.       ctrl-down      go to last block
  124.       ctrl-left      go to previous block
  125.       ctrl-right      do to next block
  126.       shift-up      go to first line
  127.       shift-down      go to last line
  128.       shift-left      go to first byte of the line
  129.       shift-right      go to last byte of the line
  130.  
  131.       The buttons at the bottom of the window allow (from left  to  right)
  132.   to go to the first block, to go to the previous block, to write the changes,
  133.   to go to the next block, to go to the last block,  and  to  go  to  a  given
  134.   address. In this last case, a  requester  appears,  so  you  can  enter  the
  135.   address to go. Use the following syntax:
  136.  
  137.       nbr      jump at address 'nbr'
  138.       ºnbr      jump at block 'nbr'
  139.       @nbr      jump at address found by reading the long word at address
  140.           'nbr' (when editing memory only)
  141.       #nbr      jump to the memory area number 'nbr' (when editing memory
  142.           only)
  143.  
  144.   The address may be an expression, whose syntax is described below. Be  aware
  145.   that if you move to another block without writing the changes  made  to  the
  146.   current block, all changes will be lost !
  147.  
  148.       To close the edit window, just click on the  close  gadget.  If  the
  149.   block has been modified but not saved, you will be asked  for  confirmation.
  150.   The program stops when the last edit window is closed.
  151.  
  152.   6. The "Project" menu
  153.  
  154.       Open file...
  155.       Opens a new window to edit a file. A file requester will appear,
  156.       so you can select the file to edit.
  157.  
  158.       Open memory
  159.       Opens a new window to edit memory.
  160.  
  161.       Open device
  162.       Use the sub-menu items to select the device to edit. AZap  opens
  163.       a new window to edit this device.
  164.  
  165.       Palette...
  166.       A palette requester appears, so you can modify screen's  colors.
  167.  
  168.       Save prefs
  169.       Save configuration: screen's colors and font. The options of the
  170.       current  window  are    also  saved  as   default   options.   The
  171.       configuration file is "S:AZap.config".
  172.  
  173.       About...
  174.       Displays informations about the program. Press any key or  click
  175.       in the window to make it go away.
  176.  
  177.       Quit
  178.       Ends program execution. You will be asked for confirmation.
  179.  
  180.   7. The "Edit" menu
  181.  
  182.       Help...
  183.       Displays cursor keys usage with CTRL and SHIFT.
  184.  
  185.       Undo all
  186.       Read current block to undo all changes not saved yet.
  187.  
  188.       Jump back
  189.       Each time you move to  another  block  with  the  "go  to  first
  190.       block", "go to last block" or "GOTO" buttons, the  old  position
  191.       is kept in memory. This command allows  to  jump  back  to  this
  192.       position. The old position  is  also    kept  when  you  use  this
  193.       command, so you can easely toggle between two blocks.
  194.  
  195.       Next block
  196.       When editing a DOS device, this command allows you to go  either
  197.       to the first data block (if the current block is a file  header)
  198.       or to the next block (if the current block is a data block of  a
  199.       OFS disk).
  200.  
  201.       Parent block
  202.       When editing a DOS device and the current block is a file header
  203.       or a directory, this command allows  you  to    go  the  directory
  204.       block corresponding to the parent  directory    of  this  file    or
  205.       directory.
  206.  
  207.       Root block
  208.       When editing a DOS device, this command allows you to go to  the
  209.       root block of this device.
  210.  
  211.       When you use one of these three commands, the old position  is  kept
  212.       in memory for the "Jump back" command.
  213.  
  214.       Fill block...
  215.       Sets all bytes of  the  current  block  to  the  same  value.  A
  216.       requester appears so you can enter a value: either 'c'  to  fill
  217.       with the "c" character or a number (ASCII code of the  character
  218.       to use, prefixed by "0x" for an hexadecimal value).
  219.  
  220.   8. The "Tools" menu
  221.  
  222.       Infos
  223.       Displays  some   informations   about   the    file/memory/device
  224.       currently edited.
  225.  
  226.       Search...
  227.       Searchs for a string or a hexadecimal value. A requester appears
  228.       so you can enter the value to  search  :  either  a  hexadecimal
  229.       value (prefixed by "0x", take care to enter an  even  number  of
  230.       digits) or a character string (ASCII search). To search a string
  231.       beginning with "0x", put all the string between double quotes.
  232.  
  233.       Search text... Searchs for a string of  printable  characters.  This
  234.       may be useful, for exemple, to locate a text area.  A  requester
  235.       appears so you can enter the minimal length  to  search  for.  A
  236.       value lower than 4 is generally not very interesting.
  237.  
  238.       Search next
  239.       Continue last search starting from current position.
  240.  
  241.       For all searchs, AZap move to the position  where  an  occurence    is
  242.       found, or the screen flashes.  The  previous  position  is  kept    in
  243.       memory for the "Jump back" function. You can  abort  a  search,  and
  244.       AZap will find a string laid on two consecutives blocks.
  245.  
  246.       Print...
  247.       Prints the current block. A requester appears so you can specify
  248.       another output file that "PRT:" (the printer).
  249.  
  250.       Convert
  251.       A new window is opened, with four gadgets  that  enable  you    to
  252.       make convertions between binary, decimal, hexadecimal and ASCII.
  253.       Any value entered, either an expression  for    "BIN",  "DEC"  and
  254.       "HEX" gadgets, or  a  character  string  for  "ASC"  gadget,  is
  255.       converted in the other units.  You  don't  have  to  close  this
  256.       window to continue editing.
  257.  
  258.   9. The "Options" menu
  259.  
  260.       Checksum
  261.       Specifies when AZap must update block checksum (used  only  when
  262.       editing a DOS device). Choices are : "always" (update for  *ALL*
  263.       blocks), "Ask if" (you will be asked for), "Boot  blocks"  (only
  264.       for 0 and 1 blocks) and "Automatic" (only if checksum was  valid
  265.       when reading block).
  266.  
  267.       Auto save
  268.       AZap will automatically save any modified block as soon  as  you
  269.       will ask to move to another block.
  270.  
  271.       Read only
  272.       You won't be allowed to modified data.
  273.  
  274.       lwr = UPR
  275.       Specifies if lower case and upper  case  characters  are  to    be
  276.       distinguished when making an ASCII search.
  277.  
  278.       Backup copy
  279.       Specifies if AZap must make a backup copy of    edited    files.    If
  280.       selected, at the next write attempt a requester will    appear    so
  281.       you can enter the name of the copy to  create.  AZap    will  then
  282.       make a copy of the file before recording  your  changes.  If    an
  283.       error occurs during the copy, the requester will  come  back    so
  284.       you can specify another name.  If  you  click  on  the  "Cancel"
  285.       gadget, no copy will be made but your changes will  be  recorded
  286.       anyway.
  287.  
  288.   10. Expressions syntax
  289.  
  290.       AZap is able to compute integer expressions. Default base is decimal
  291.   for addresses ("GOTO" gadget) or the  base  corresponding  to  the  selected
  292.   gadget in the convertion window. Base may be specified  with    "%"  (binary),
  293.   "#" (decimal), and "$" or "0x" (hexa) before  any  number.  Valid  operators
  294.   are :
  295.  
  296.       +      addition
  297.       -      subtraction
  298.       |      logical "or"
  299.       &      logical "and"
  300.       *      multiplication
  301.       /      integral division
  302.       %      reminder of integral division
  303.       <      shift left
  304.       >      shift right
  305.  
  306.   By default, "*", "/", "%", "<" and ">" operators have  higher  priority  but
  307.   you may use parenthesis. If there is a syntax error in  an  expression,  its
  308.   result will be set to -1.
  309.  
  310.   11. Important notes
  311.  
  312.       When starting to run, AZap read the ExecBase structure to  know  you
  313.   memory configuration. Only memory areas defined is memory  management  lists
  314.   may be edited. Except when searching, these areas are considered as adjacent
  315.   and AZap will move automatically  from  an  area  to    another.  The  "Infos"
  316.   command of the "Tools" menu displays the addresses of all areas. Reading and
  317.   writing memory is done after having disabled task  switching,  in  order  to
  318.   avoid conflicts.
  319.  
  320.       AZap can recognize the type of the device you edit. Some  operations
  321.   ("next block", "parent block" and "root block") are disabled on non AmigaDOS
  322.   devices, but don't forget to check the "Checksum" option. AZap  knows  about
  323.   OFS (Old File System) and FFS  (Fast  File  System)  and  handle  both  file
  324.   systems.
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.