home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / HEDITOR.ZIP / HEDITOR.DOC next >
Text File  |  1990-07-27  |  13KB  |  314 lines
  1.  
  2.  
  3.  
  4.  
  5.               ╔═════════════════════════════════════╗
  6.               ║ HEXADECIMAL EDITOR by Thuan-Tit Ewe ║
  7.               ╚═════════════════════════════════════╝
  8.  
  9.  
  10.                 Copyright (C) 1990 by Thuan-Tit Ewe.
  11.               Please read the copyright notice below.
  12.  
  13.  
  14.  
  15. ┌────────────────────────────────────────────────────────────────────┐
  16. │ Introduction                                                       │
  17. └────────────────────────────────────────────────────────────────────┘
  18. Heditor is a manual,  interactive binary file  editor that lets you  edit
  19. both hex and in ASCII.  It was written to  fill the need for  hexadecimal
  20. editors that will work only with disk sectors but not files.
  21.  
  22.  
  23. ┌────────────────────────────────────────────────────────────────────┐
  24. │Operation of Hexeditor                                              │
  25. └────────────────────────────────────────────────────────────────────┘
  26.   F1    Help key
  27.   F2    Brings out pull down menu
  28.   F9    Switches between files
  29.   Tab   Switches back and forth between hex and ASCII
  30.   Ctrl-Left &
  31.   Ctrl-Right Moves the page up or down with skip increments.
  32.   Esc   Returns to DOS prompt or exit
  33.  
  34.  
  35. ┌────────────────────────────────────────────────────────────────────┐
  36. │ Menu options                                                       │
  37. └────────────────────────────────────────────────────────────────────┘
  38.   File
  39.   Option
  40.   Setup
  41.   Structures
  42.   Help
  43.  
  44. These are the 5 main pull down  menus. The operation of these menus  will
  45. be describe later.
  46.  
  47.   File option:
  48.     Open, Chain, Switch, close, lseek, write, shell, eXit.
  49.  
  50.     Open: Use this  option to open  files to edit.  The opened file  will
  51. replace the current opened file which  is closed. To open a file  without
  52. closing  the  current  file,  use the chaining command below.
  53.  
  54.     Chain:  Opens  another file without closing the current file. You can
  55. then flip back and forth with the  F9 key. Heditor supports a total of  8
  56. opened files or available file handles which ever is less.
  57.  
  58.     Switch: You can also use this option to switch between files.
  59.  
  60.     Close: Close current  file. If you  have opened  only one file,  this
  61. option is null.
  62.  
  63.     lseek: Seek to different position in the file.
  64.  
  65.     Write:  Write the current block in to file. Remember heditor does not
  66. automatically  write the edited file. You this option when you  are happy
  67. with the edit and before  moving to the next  block or page. If you  exit
  68. heditor, you WILL loose your changes.
  69.  
  70.     Shell:  Shell   commands  from   the heditor.  This program uses  the
  71. swapping mechanism to swap itself out  of memory before execution of  the
  72. shell. The swap drive is either  the current drive or the path  specified
  73. in the "TMP" environment variable.
  74.  
  75.     Exit: You this option to exit  the current session of heditor or  use
  76. the <ESC> key whichever is more convenient.
  77.  
  78.  
  79.   Option:
  80.     String: Displays and allows you to edit with the line editor a string
  81. terminated with null.
  82.  
  83.     Short: Displays and allows you to edit the next 2 bytes as short.
  84.  
  85.     Long: Displays and allows you to edit the next 4 bytes as long.
  86.  
  87.     Open Struct File: A structure file can be set up to  instruct heditor
  88. to display certain fields in  structure. Currently the heditor will  only
  89. break up field from the top of the block. The cursor position is ignored.
  90. You the skip to the position you want to break using Crtl-left  and Crtl-
  91. Right along with the skip increments.
  92.  
  93. Some field are not displayed properly and currently does not allow you to
  94. edit the fields directly.  Future releases may fix  this. Tell me if  you
  95. really, really want this feature.
  96.  
  97.     String search:  Search  for string  in  the  file. To  specify  ascii
  98. character, use  quotes in  order  as not  to  confuse the  simple  minded
  99. parser. For example,  to search  for "Hello",  type in  exactly with  the
  100. quotes, "Hello".  If you want to search for "Hello" followed with a null,
  101. enter this:
  102.  
  103. "Hello", 0
  104.  
  105. The search mechanism will search from the beginning of the current block.
  106. To continue searching, page to the next block and search,   otherwise the
  107. search would have found the current one. Will be fixed in later versions.
  108.  
  109.     Browse file: The option allows you to use the integrated file browser
  110. to browse text  files. The  browser will browse  both UNIX  and DOS  text
  111. files correctly. The browser allows you to browse more than one  file and
  112. flip between  them for  you to  compare files.  See Appendix  B for  more
  113. details.
  114.  
  115.     Ascii table: A simple minded ascii  table along with hex, octal,  and
  116. mnemonics and the characters itself.
  117.  
  118.     Calculator: See appendix for calculator operation.
  119.  
  120.   Setup: Skip: This  is the  skip value whenever   you  use crtl-left  or
  121. crtl-right. It is set by default to 24, which is a line, so when you type
  122. crtl-left if moves the block  one line up and  likewise one line down  if
  123. you type crtl-right.
  124.  
  125.   Structures: If  you  have  entered  a  structure  file.  The  names  of
  126. structures will  appear in  this menu  and you  can select  to break  the
  127. current page into whatever  structure you want.  Use "sample.str" to  see
  128. how a structure  file is written.  There are  also several constructs  in
  129. sample.str that may not look like C. Those are constructs to help heditor
  130. break the structure and  format the print.  Most of those constructs  are
  131. parsed but not honored. Future versions may correct this.
  132.  
  133.   Help: This  option  gives you  the  version  number of  heditor  you're
  134. running  and  also  licensing  information  regarding  the  use  of  this
  135. software.
  136.  
  137.  
  138. ┌────────────────────────────────────────────────────────────────────┐
  139. │ Working with the line editor in heditor                            │
  140. └────────────────────────────────────────────────────────────────────┘
  141.   The build line editor  comes up every time  you are prompted an  option
  142. that requires  you to  type. More  often than  not, a  default string  is
  143. already sitting there, if you do not want the string, type any  key other
  144. than the usual editing key and the default string is discarded.
  145.  
  146.   Insert, left and right arrow keys work as you would expect them  to and
  147. crtl-left and crtl-right will skip  recognizable words. If you're at  the
  148. end of the line, the display will horizontal scroll as you time.
  149.  
  150.   The default is  setup as  non insert  mode and  you can  shift it  into
  151. insert mode by pressing the Ins key.
  152.  
  153.   Press enter when you're  though editing or Esc  if you want to  discard
  154. the operation.
  155.  
  156.  
  157. ┌────────────────────────────────────────────────────────────────────┐
  158. │ Working with a mouse                                               │
  159. └────────────────────────────────────────────────────────────────────┘
  160.   You can use the  pull down menus  with a mouse.  The mouse driver  must
  161. first be installed. To  invoke menus. Move mouse  cursor to the top  line
  162. and press the left mouse button. You can now hold down the button to view
  163. all option menus and select operation.
  164.  
  165.   Since the mouse  support is  only partial, certain  operations may  not
  166. work with the mouse. Future releases may fix this.
  167.  
  168.  
  169. ┌────────────────────────────────────────────────────────────────────┐
  170. │ Appendix A                                                         │
  171. └────────────────────────────────────────────────────────────────────┘
  172. Calculator: Pop up calculator for heditor.
  173.  
  174. Usuall programmers' calculator with
  175.   o       Base conversion to and from hex, oct, dec and binary
  176.   o       Constant calculation
  177.   o       Memory
  178.   o       Shift operations
  179.   o       Logical functions like and, or, xor, neg
  180.   o       Shift operations for shifting right and left
  181.  
  182. Keys:
  183.   Alt-H Converts current value into hex
  184.   Alt-O Converts current value into oct
  185.   Alt-B Converts current value into binary
  186.   Alt-D Converts current value into decimal
  187.   Alt-F To set number of decimal place. See note.
  188.  
  189.   m     Store current value in memory
  190.   r     Recall value from memory
  191.  
  192.   0-9.  decimal numbers
  193.   -+/*  Mathematical operations
  194.   ^|&~  Logical operations
  195.   <>    Shift operations. Will shift right or left according to the
  196.         arrow.
  197.   <Esc> Gets out of calculator
  198.   <Backspc> Deletes the previous digit
  199.  
  200. Note:
  201.   To set the number of decimal places, first enter Alt-F followed by
  202. a number. For example, <Alt-F> <2>  will set the number of decimal  place
  203. to 2.
  204.  
  205. Limitations:
  206.   All operations are done either in double or long, which means this will
  207. be a limiting factor to the calculator.
  208.  
  209.  
  210. ┌────────────────────────────────────────────────────────────────────┐
  211. │ Appendix B                                                         │
  212. └────────────────────────────────────────────────────────────────────┘
  213.   The file browser is a mini environment for browsing of text  and binary
  214. files. In the browser this keys are activated:
  215.  
  216.   F2            Flips the browser from text->binary->hex->text....
  217.   F3            Cycle through files
  218.   UP            Scroll up one line
  219.   DOWN          Scroll down one line
  220.   Crtl-left     Scroll left
  221.   Crtl-right    Scroll right
  222.   Esc           Returns to the hexeditor
  223.  
  224.   The cursor is sitting on a command interpreter that lets you search for
  225. strings. To search for "hello" for example just enter:
  226.  
  227.   "hello" <ENTER>
  228.  
  229.   This will search for the first occurrence of "hello"
  230.  
  231.   You can also browse another file while browsing the current one and you
  232. do this by type
  233.  
  234.   f <filename>
  235.  
  236.   on the command line.
  237.  
  238.   To return to the hex editor, press the <Esc> key.
  239.  
  240.  
  241. ┌────────────────────────────────────────────────────────────────────┐
  242. │ Appendix C                                                         │
  243. └────────────────────────────────────────────────────────────────────┘
  244.   Incompatibilities:
  245.     If you're using nnansi.sys, "cls" (clear screen) first before
  246.     executing heditor. Heditor does NOT use BIOS for screen access
  247.     therefore bypassing nnansi. Future revisions will correct this.
  248.  
  249.   Problems:
  250.     If you have any questions or comments drop a line to,
  251.  
  252.       Thuan-Tit Ewe
  253.       P.O. Box 1016
  254.       Capitola 95010
  255.  
  256.  
  257. ┌────────────────────────────────────────────────────────────────────┐
  258. │ Appendix D                                                         │
  259. └────────────────────────────────────────────────────────────────────┘
  260. Files:
  261.  
  262. SAMPLE.STR          Sample struct file.
  263. HEDITOR.DOC         This document
  264.  
  265. In previous version
  266. SCAL.MAP            Map file for calculator
  267.                     Current versions has this file inlined in the
  268.                     binary.
  269.  
  270. In DOS version
  271. HEDITOR.EXE         The real mode editor
  272.  
  273. In OS/2 version
  274. HEDITORP.EXE        Both protected and real mode versions of the
  275.                     editor are combined into a same executable.
  276.  
  277.  
  278. ╔════════════════════════════════════════════════════════════════════╗
  279. ║ Technical data                                                     ║
  280. ╚════════════════════════════════════════════════════════════════════╝
  281.    C  source   compiled  with   Microsoft  C  v5.10 and assembler  source
  282. assembled with Microsoft Assembler v5.10.
  283.  
  284.    The  editor  has been successfully  ported with  all it's grandeur  to
  285. OS/2,  Microport   UNIX  System  V Release 3.0 and  Release 2.0 and  UNIX
  286. System V Release 3.2.
  287.  
  288.  
  289. ╔════════════════════════════════════════════════════════════════════╗
  290. ║ Copyright                                                          ║
  291. ╚════════════════════════════════════════════════════════════════════╝
  292. Thuan-Tit Ewe and CompuTech Software Systems disclaims all  warranties as
  293. to  this  software,  whether   express  or  implied,  including   without
  294. limitation to any  implied warranties of  merchantability, fitness for  a
  295. particular purpose, functionality or data integrity or protection.
  296.  
  297. This  software   has  NOT   been and WILL NOT  be released to the  public
  298. domain.
  299.  
  300. You're  authorized   to  make   copies  and   use this software only  for
  301. noncommercial  purposes   and provided  that no fee  is charged for  use,
  302. copying or distribution, nor the program modified in any way.
  303.  
  304.  
  305.       ▄▄██▀▀▀▀██▄▄
  306.    ▄█▀▀  ▄▄▄▄▄   ▀▀█▄
  307.   ██   ███▀▀▀▀██▄   ██
  308.  ██   ███      ▀▀    ██
  309.  ██   ███            ██
  310.  ▀█▄  ▀██▄    ▄██   ▄█▀
  311.   ▀█▄  ▀▀█████▀▀   ▄█▀        This software is Copyright 1988-1990
  312.     ▀▀█▄▄▄    ▄▄▄█▀▀          Thuan-Tit Ewe
  313.         ▀▀▀▀▀▀▀▀
  314.