home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / new / disk / moni / zaphod / docs / english / zaphod10englisch.doc next >
Text File  |  1994-06-03  |  15KB  |  375 lines
  1.           Zaphod, a binary editor for AMIGA computers
  2.                           Release 1.0
  3.  
  4.                         Holger Schemel
  5.                   aeglos@valinor.ms.sub.org
  6.  
  7.                          June 3, 1994
  8.  
  9.  
  10. Contents
  11.  
  12. 1. Copyright and all that
  13. 2. About Zaphod
  14. 3. Installation
  15. 4. Starting Zaphod from Workbench and Shell
  16. 5. The usage of the program
  17.    5.1 The main window of Zaphod
  18.        5.1.1 The gadgets
  19.        5.1.2 The edit field
  20.    5.2 The menues
  21.        5.2.1 Project
  22.        5.2.2 Edit
  23.        5.2.3 Settings
  24.        5.2.4 Files
  25. 6. Credits
  26. 7. Bug reports and others
  27.  
  28.  
  29. 1. Copyright and all that
  30.  
  31. Zaphod is copyrighted software (C) 1993-94 by Holger Schemel.
  32.  
  33. The program may be freely distributed with the following restrictions:  The
  34. The archive and all its contents may not be changed, and no  files  may  be 
  35. removed or added to the archive. 
  36. All rights reserved.
  37.  
  38. No guarantee of any kind is given that the programs described in this docu-
  39. ment are 100\% reliable. You are using this material at your own risk.  The 
  40. author can not be made responsible for any damage which is caused by  using 
  41. these programs.
  42.  
  43. This package can be included in public domain collections, including  those 
  44. on CD-ROM. The distribution file may be uploaded to Bulletin Board  Systems 
  45. or FTP servers. None of the program nor parts of it may be included or used 
  46. in commercial programs without a written permission from the author.
  47.  
  48. If you have paid more than $5, it's yout own fault.
  49.  
  50. The usage of this program close by nuclear power  stations,  the  usage  of 
  51. weapons and military equipment and the consumption of radio  active  hazel-
  52. nuts is your own risk!
  53.  
  54. 2. About Zaphod
  55.  
  56. Zaphod is a file editor for binary files in the tradition of  classic  pro-
  57. grams like ``FileZap'' and ``NewZap''. However, it is written to  use  fea-
  58. tures of AmigaOS 2.0 so you need this or a higher version of the Amiga ope-
  59. ration system to use this program. The usage with OS 3.0 or  higher  should
  60. not make any problems.
  61.  
  62. This file editor lets you edit several files at a time. The files you  want 
  63. to edit can be marked with the mouse button while holding the  'shift'  key 
  64. right at the start from Workbench, chosen  from  the  ASL  file  requester, 
  65. chosen by dropping their icons into the window or, if  you  started  Zaphod 
  66. from shell, by specifying the files as parameters after the program name.
  67.  
  68. The program window of Zaphod opens on the  Workbench,  on  a  given  public 
  69. screen or on its own public screen which will then be  named  ZAPHOD.1  (or 
  70. ZAPHOD.x, if you started Zaphod x times with its own screen). If you  star-
  71. ted Zaphod on a public screen, you can drop icons into it by  simply  drop-
  72. ping them on the  application  icon,  which  has  the  name  ZAPPICON.1  or 
  73. ZAPPICON.x. You can get Zaphod's  public  screen  into  the  foreground  by 
  74. double-clicking on its application icon.
  75.  
  76. The whole settings of the program can be given and were saved in the  Tool-
  77. Types in the program icon. If you start it from shell, give the settings as 
  78. program parameters. At the time there is no support for an extra configura-
  79. tion file, so if you want to start it from shell regularly, make  an  alias 
  80. in 's:user-startup' of the form 'alias zaphod zaphod <configuration parame-
  81. ters>'.
  82.  
  83. 3. Installation
  84.  
  85. Just copy the whole drawer at the place you want to have it. It's enough to 
  86. have the files ``Zaphod'' and ``Zaphod.info''.
  87.  
  88. If you  have  installed  AmigaOS 2.1  or  above,  you  can  copy  the  file 
  89. ``zaphod.catalog'' into ``LOCALE:Catalogs/<your language>''. At this  time, 
  90. there is only a catalog for German language.
  91.  
  92. Additionally, there are some extra fonts in the ``Zaphod/fonts'' directory. 
  93. The ``topaz'' variations are non-proportional, the ``tripaint''  fonts  are 
  94. proportional ones. Just try them out (They must be  copied  to  your  local 
  95. ``FONTS:'' directory). These fonts are designed to  be  small  or  thin  or 
  96. both, so you can use them to display more data in the  Zaphod  edit  window 
  97. than with the standard system fonts.
  98.  
  99. 4. Starting Zaphod from Workbench and Shell
  100.  
  101.  
  102. The ToolTypes are the same as the shell parameters, that means if you  have
  103. a ToolType of the form 'TOOLTYPE=PARAMETER', then you can give this exactly 
  104. as a shell parameter (you can use a blank instead of the ``='').
  105. (See the descriptions of the menu 'Settings' for more information.)
  106.  
  107. The ToolTypes are:
  108.  
  109. LEFT:
  110.        Left position the window opens.
  111. TOP:
  112.     Top position the window opens.
  113. LINES:
  114.     The number of lines displayed in the edit window.
  115. COLUMNS:
  116.     The number of longwords (four data bytes) per line in the edit win-
  117.         dow.
  118. TEXTFONTNAME:
  119.     Here you can choose the text font of the Zaphod window. '<default>' 
  120.     uses the system font choosen in your system preferences.
  121. TEXTFONTSIZE:
  122.     Choose the size of the font. {\tt <default>} uses the  system  size
  123.     again.
  124. EDITFONTNAME:
  125.     Here you can choose the edit font, which is used in the edit  field
  126.     of the Zaphod window. '<default>' uses  the  non-proportial  system 
  127.     font again. It is recommended to use one of the fonts shipped  with 
  128.     Zaphod to be able to display more characters than with  the  system 
  129.     fonts. If you don't like them, you can get the font editor FEd from 
  130.     AmigaOS 1.3 and create your own fonts for Zaphod.
  131. EDITFONTNAME:
  132.     The size of the chosen edit font.
  133. PUBSCREEN:
  134.     Here you can specify the name of a public screen  on  which  Zaphod 
  135.     shall open its window on. If you specify 'WBENCH',  the  window  is 
  136.     opened on the Workbench. With 'OWNSCREEN' you can advise Zaphod  to 
  137.     open its own public screen, which is then given the name  ZAPHOD.x, 
  138.     where x is the number of the instance of Zaphod with an own  public 
  139.     screen.
  140. EXPERTMODE:
  141.     This parameter tells Zaphod how often it should ask  for  confirma-
  142.     tion. You should start with 'NORMAL'. If you don't want to see  too 
  143.     many questions ``Do you really want...?'', then choose  'MODERATE'. 
  144.     With 'EXPERT', Zaphod asks no  more  questions;  only  choose  this 
  145.     option if you really know what you're doing.
  146. HEXDESIGN:
  147.     Choose 'UPPER' to have upper case  characters  in  the  hexadecimal 
  148.     edit field and 'LOWER' to have lower case characters.
  149. SIZEGADGET:
  150.     Choose 'RIGHT' to have the wider window border with the size gadget 
  151.     on the right window border and 'BOTTOM' to have it  on  the  bottom 
  152.     border.
  153. LOADMODE:
  154.     You can choose  'INSERT_ONE',  'INSERT_ALL'  or  'APPEND_ALL'.  See 
  155.     'Settings / Files' for a description.
  156. CLIPMODE:
  157.     Choose 'INTERNAL' or 'EXTERNAL' for an internal or  external  clip-
  158.     board handling.
  159. CLIPNR_INTERNAL:
  160.     Choose the clip number used for internal clipboard handling.  Don't 
  161.     choose 0 here, because that's the clip number of the  system  clip-
  162.     board.
  163. CLIPNR_EXTERNAL:
  164.     Choose the clip number used for external clipboard handling. Better 
  165.     don't change it from the default value 0 here, because  that's  the 
  166.     clip number of the system clipboard.
  167. ADDRESSBOX:
  168.     Choose 'YES' or 'NO' to have the addresses field in the    edit window 
  169.     displayed or not.
  170. VIEWMODE:
  171.     Choose 'HEX', 'ASCII' or 'HEX&ASCII' to have the file contents dis-
  172.     played as hexadecimal values, ASCII characters or both.
  173.  
  174. If you start Zaphod from shell, you can specify up to ten files which  will 
  175. then be loaded to the file buffers. If  you  give  a  question  mark  here, 
  176. Zaphod will give you a command pattern known from the system commands.
  177.  
  178. 5. The usage of the program
  179.  
  180. 5.1 The main window of Zaphod
  181.  
  182. After starting Zaphod, you see the main window with the edit field and some
  183. gadgets. If you have already given some file names at the start, the  first 
  184. one will be displayed in the edit window (if it can be opened).
  185.  
  186. The file name of the file that is currently in the edit buffer will be dis-
  187. played in the title of the window.
  188.  
  189. 5.1.1 The gadgets
  190.  
  191. If you want to search for a byte sequence in the file, use the search  gad-
  192. gets below of the edit field. Type the byte sequence into the  string  gad-
  193. get; you can use ASCII characters or  hexadecimal  values  or  both  mixed. 
  194. Hexadecimal values must be two numbers preceeded with a `$' or a  `0x'.  If 
  195. these special characters are part of the search string, just put them  into 
  196. quotation marks.
  197.  
  198. Some examples:
  199. $20$2