home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / fileutil / filez15.arj / FILEZ.DOC next >
Encoding:
Text File  |  1991-12-30  |  12.0 KB  |  316 lines
  1.  
  2.  
  3. ********************************************************************************
  4. 08:58:29  12/30/91                                                     Page 1   
  5.                      T O O L Z   D O C U M E N T A T I O N                      
  6.                                    F I L E Z                                    
  7. ********************************************************************************
  8.  
  9.  
  10. o MODULE NAME
  11.  
  12.    FILEZ
  13.  
  14. o LIBRARY NAME
  15.  
  16.    TOOLZ
  17.  
  18. o TYPE
  19.  
  20.    PROGRAM
  21.  
  22. o QUICK DESCRIPTION
  23.  
  24.    Binary file examination and modification.
  25.  
  26. o ARGUMENT DESCRIPTION
  27.  
  28.    filez <filename> [opt]
  29.       Options:
  30.       /m    monochrome
  31.       /v    video direct (MSDOS only)
  32.  
  33. o NARRATIVE DESCRIPTION
  34.  
  35.  
  36.    This utility can modify any byte of a file, copy portions of the file
  37.    to other files, dump the file (in print image) in entirety or one
  38.    record at a time.  Examination (in REVIEW mode) and editing (in EDIT
  39.    mode) is done in either hex or ASCII.  There are two modes, REVIEW and
  40.    EDIT, under which files are manipulated.  The name of the file to be
  41.    edited must be supplied on the command line.
  42.  
  43.    The /m (monochrome) startup option specifies that color should not be
  44.    used in displays (assuming that color is supported).  The MSDOS
  45.    version also allows direct display video writes with the /v option,
  46.    which will produce faster display updates but disallow Windows
  47.    compatibility.
  48.  
  49.       COMMANDS IN REVIEW MODE
  50.  
  51.          Q     Quit filez
  52.                Also:  ESC
  53.          A     Find the record for the specified address offset
  54.          B     Set to first record (Beginning) of file
  55.                Also:  HOME
  56.          C     Toggle Ignore Search Case (string mode search)
  57.          D     Dump the file to a print image file
  58.          E     Enter the EDIT mode at the current record
  59.  
  60.  
  61. ********************************************************************************
  62.               T O O L Z   M o d u l e   D o c u m e n t a t i o n               
  63. ********************************************************************************
  64.  
  65.  
  66. ********************************************************************************
  67. 08:58:29  12/30/91                                                     Page 2   
  68.                      T O O L Z   D O C U M E N T A T I O N                      
  69.                                    F I L E Z                                    
  70. ********************************************************************************
  71.  
  72.  
  73.          F     Specify a new file to edit without exiting filez
  74.          H     Set Record size (maximum 256)
  75.          I     Insert copyfile into current file at section beginning
  76.          J     Translate one string to another
  77.          K     Translate one pattern to another
  78.          M     Move (copy) a marked section of the file to copyfile
  79.                (must be 'O'pened first)
  80.          N     Set the current record number
  81.          O     Specify output file (copyfile)
  82.          P     Dump the current record to print image
  83.          R     Search/translate for the next occurance
  84.          S     Search for a string from the current record
  85.          T     Search for a pattern of bytes from the current record
  86.          U     Pad the copyfile with a specified character
  87.          V     Delete the currently marked section from the file
  88.          W     Write the current record to the file
  89.          X     Extend the file with a specified character
  90.          Z     Set to last record (end) of file
  91.                Also:  END
  92.          DOWN  Next record
  93.                Also:  Down-Arrow, +
  94.          UP    Previous record
  95.                Also:  Up-Arrow, -
  96.          ?     Display review mode help
  97.                Also:  F1
  98.  
  99.       COMMANDS IN EDIT MODE
  100.  
  101.          UP          Move cursor up one line (keyboard up arrow)
  102.                      Also:  Control-E, Control-I
  103.          DOWN        Move cursor down one line (keyboard down arrow)
  104.                      Also:  Control-X, Control-K
  105.          LEFT        Move cursor left one character (keyboard left arrow)
  106.                      Also:  Control-S, Control-J
  107.                      (Unix note:  do not use Control-S if software
  108.                      handshaking is enabled)
  109.          RIGHT       Move cursor right one character (keyboard right arrow)
  110.                      Control-D, Control-L
  111.          Control-B   Mark beginning of section at cursor
  112.          Control-Z   Mark end of section
  113.          ENTER       Toggle hex/ASCII mode
  114.          ESC         Exit editing mode
  115.          F1          Display edit mode help
  116.                      Also:  Control-H
  117.  
  118.    The REVIEW mode is entered by default when FILEZ is started.  Commands
  119.    for this mode are accepted at the filez> prompt.  Error messages are
  120.    always displayed on the bottom line of the screen.  Either a '?' or
  121.    F1 key may be pressed to see the help screen for the REVIEW mode.
  122.  
  123.  
  124. ********************************************************************************
  125.               T O O L Z   M o d u l e   D o c u m e n t a t i o n               
  126. ********************************************************************************
  127.  
  128.  
  129. ********************************************************************************
  130. 08:58:29  12/30/91                                                     Page 3   
  131.                      T O O L Z   D O C U M E N T A T I O N                      
  132.                                    F I L E Z                                    
  133. ********************************************************************************
  134.  
  135.  
  136.  
  137.    For some commands, more than one key may be effective.  This may be
  138.    useful on some terminals that do not have function keys or have
  139.    function keys not properly described in terminfo.
  140.  
  141.    A search pattern may be specified in hex or ASCII (not
  142.    simultaneously), and the search for the pattern will commence from
  143.    the beginning of the currently displayed record.  While a search is
  144.    in progress, it may be aborted by pressing any key in the MSDOS
  145.    version, or by pressing Control-\ in the UNIX version.
  146.  
  147.    If 'P' (print) is specified, a dump in print image of the current
  148.    record is sent to a file that can be printed upon exit from FILEZ. If
  149.    'D' (dump) is specified, all records are dumped to the print image
  150.    file.
  151.  
  152.    In the EDIT mode, the cursor may be positioned in the hex or ASCII
  153.    region and the bytes to be modified may be specified in hex or ASCII,
  154.    respectively.  In order to move portions of the file to a copyfile,
  155.    the copyfile name must first be specified and opened.  Be sure to
  156.    mark the beginning and end of the section to be moved.   The copyfile
  157.    is closed automatically upon exit from filez, or when a new copyfile
  158.    is specified.  Data file can be composed using this feature, and the
  159.    'U' pad feature appends any character you specify to the end of the
  160.    copy file.  Copyfiles are always opened in the append mode so that
  161.    copyfiles from previous FILEZ sessions can be appended to.
  162.  
  163.    Hex editing is the default upon entering edit mode.  The ENTER key
  164.    toggles between hex and Ascii editing.  The byte under edit will be
  165.    displayed with the foreground and background reveresed.  If editing
  166.    in hex, the corresponding byte under edit in the Ascii display will
  167.    be emphasized.
  168.  
  169.    The record size is 256 by default, but this value may be changed to
  170.    any value between 1 and 256 using the 'H' command from the review
  171.    mode.
  172.  
  173.    A configuration file is optional and can be used to modify screen
  174.    colors.  The configuration file must be named FILEZ.CFG and may be
  175.    located anywhere in the search path.  It is a text file containing
  176.    one or more of the following records:
  177.  
  178.       WINDOW,DISPLAY,<foreground>,<background>
  179.       WINDOW,ADDRESS,<foreground>,<background>
  180.       WINDOW,HEX,<foreground>,<background>
  181.       WINDOW,ASCII,<foreground>,<background>
  182.       WINDOW,HELP,<foreground>,<background>
  183.       WINDOW,STATUS,<foreground>,<background>
  184.       WINDOW,PROMPT,<foreground>,<background>
  185.  
  186.  
  187. ********************************************************************************
  188.               T O O L Z   M o d u l e   D o c u m e n t a t i o n               
  189. ********************************************************************************
  190.  
  191.  
  192. ********************************************************************************
  193. 08:58:29  12/30/91                                                     Page 4   
  194.                      T O O L Z   D O C U M E N T A T I O N                      
  195.                                    F I L E Z                                    
  196. ********************************************************************************
  197.  
  198.  
  199.          foreground/background are reversed in the PROMPT window
  200.       WINDOW,ERROR,<foreground>,<background>
  201.  
  202.    Valid foreground and background colors are:
  203.  
  204.       BLACK
  205.       RED
  206.       GREEN
  207.       YELLOW
  208.       BLUE
  209.       MAGENTA
  210.       CYAN
  211.       WHITE
  212.  
  213.    Empty lines and lines beginning with the '#' character are
  214.    ignored.  The screen color specification are ignored in monochrome
  215.    mode.
  216.  
  217. o COMMENTS
  218.  
  219.    This program is based on EFILE, published by Software Toolz in
  220.    1986.  FILEZ, however, is substantially rewritten and based on
  221.    Curses.
  222.  
  223. o RETURNS
  224.  
  225.    Nothing
  226.  
  227. o APPLICATIONS
  228.  
  229.    FILE
  230.  
  231. o PLATFORMS
  232.  
  233.    MSDOS-S
  234.    UNIX
  235.  
  236. o AUTHOR
  237.  
  238.    Todd Merriman
  239.  
  240. o REVISIONS
  241.  
  242.    11/29/91
  243.    Rewrite and implement under Curses.
  244.    12/16/91
  245.    Binary search pattern would fail when searching with a byte with
  246.    bit 7 set.
  247.    12/23/91
  248.  
  249.  
  250. ********************************************************************************
  251.               T O O L Z   M o d u l e   D o c u m e n t a t i o n               
  252. ********************************************************************************
  253.  
  254.  
  255. ********************************************************************************
  256. 08:58:29  12/30/91                                                     Page 5   
  257.                      T O O L Z   D O C U M E N T A T I O N                      
  258.                                    F I L E Z                                    
  259. ********************************************************************************
  260.  
  261.  
  262.    Added pattern translate
  263.  
  264. o FIXES
  265.  
  266.    12/26/91
  267.    Corrected documentation concerning the names of windows to be
  268.    specified in the Configuration File.
  269.  
  270. o NOTICE
  271.  
  272.    FILEZ is Copyright 1991 Software Toolz, Inc. - Atlanta, Georgia
  273.  
  274.    All rights reserved worldwide.  You are granted a limted license to
  275.    use this program, copy it, and distribute it provided that:  (1) no
  276.    fee may be charged for such copying and distribution, and (2) this
  277.    program may only be distributed in its original unmodified state.
  278.    This program may not be distributed with other programs for which a
  279.    fee is charged except by permission of Software Toolz, Inc.
  280.  
  281.    This program may be registered from Software Toolz for $19.95
  282.    plus shipping and handling.  Visa and MasterCard are accepted.
  283.    Registration entitles you to the latest update on magnetic
  284.    media and a printed user manual.  You are urged to register
  285.    this software if you find it to be of use to you.
  286.  
  287.    You are invited to evaluate DOCZ(tm), the code documentation
  288.    automation facility for MSDOS and UNIX.  DOCZ works with all computer
  289.    languages, and it builds reference manuals and on-line documentation
  290.    for software modules with documentation imbedded in the source code.
  291.    Call or write Software Toolz for the FREE MSDOS demo version.
  292.  
  293.    Software Toolz, Inc.
  294.    8030 Pooles Mill Dr.
  295.    Ball Ground, GA 30107-9610
  296.    (800) 869-3878, (404) 889-8264
  297.    Area Code 404 will be changed to 706 on 3 May 1992
  298.    Internet:  software%toolz.uucp@mathcs.emory.edu
  299.  
  300. o INTRODUCTION DATE
  301.  
  302.    07/29/91
  303.  
  304. o LAST FILE UPDATE
  305.  
  306.    12/30/91 08:57:47 -- filez.c
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313. ********************************************************************************
  314.               T O O L Z   M o d u l e   D o c u m e n t a t i o n               
  315. ********************************************************************************
  316.