home *** CD-ROM | disk | FTP | other *** search
/ Java Programmer's Toolkit / Java Programmer's Toolkit.iso / editors / filez / filez.doc next >
Encoding:
Text File  |  1992-03-07  |  15.6 KB  |  505 lines
  1.  
  2.  
  3. ********************************************************************************
  4. 16:03:08  03/07/92                                                     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.       Non-selection bar commands:
  52.  
  53.          DOWN  Next record
  54.                Also:  Down-Arrow, +
  55.  
  56.          UP    Previous record
  57.                Also:  Up-Arrow, -
  58.  
  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. 16:03:08  03/07/92                                                     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.          ?     Display review mode help
  74.                Also:  F1
  75.  
  76.          Ctrl-W   Repaint the screen
  77.  
  78.          E     Enter edit mode
  79.  
  80.          HOME  Set to first record (Beginning) of file
  81.  
  82.          END   Set to last record (end) of file
  83.  
  84.          ESC   Exit the filez program
  85.  
  86.       Selection bar commands:
  87.  
  88.       File
  89.  
  90.          Exit
  91.  
  92.             Exit the filez program
  93.  
  94.          Help
  95.  
  96.             Display the review mode help screen
  97.  
  98.          ASCII table
  99.  
  100.             Display the on-line ASCII table
  101.  
  102.       Set
  103.  
  104.          Address
  105.  
  106.             Find the record for the specified address offset
  107.  
  108.          Record
  109.  
  110.             Set the current record number
  111.  
  112.          End
  113.  
  114.             Set to last record (end) of file
  115.  
  116.          Beginning
  117.  
  118.             Set to first record (Beginning) of file
  119.  
  120.          Next record
  121.  
  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. 16:03:08  03/07/92                                                     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.             Display next record
  137.  
  138.          Previous record
  139.  
  140.             Display previous record
  141.  
  142.          Search case
  143.  
  144.             Toggle Ignore Search Case (string mode search)
  145.  
  146.          New file
  147.  
  148.             Specify a new file to edit without exiting filez
  149.  
  150.          Record size
  151.  
  152.             Set Record size (maximum 256)
  153.  
  154.          Copyfile name
  155.  
  156.             Specify copyfile name
  157.  
  158.          8-bit characters
  159.  
  160.             Toggle display of 8-bit characters
  161.  
  162.       Search
  163.  
  164.          String
  165.  
  166.             Search for a string from the current record
  167.  
  168.          Pattern
  169.  
  170.             Search for a pattern of bytes from the current record
  171.  
  172.          Next
  173.  
  174.             Search for the next occurance
  175.  
  176.       Translate
  177.  
  178.          String
  179.  
  180.             Translate one string to another
  181.  
  182.          Pattern
  183.  
  184.             Translate one pattern to another
  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. 16:03:08  03/07/92                                                     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.  
  200.          Next
  201.  
  202.             Translate the next occurance
  203.  
  204.       Operate
  205.  
  206.          Copy
  207.  
  208.             Move a marked section of the file to copyfile
  209.             (must be 'O'pened first)
  210.  
  211.          Cut
  212.  
  213.             Delete the currently marked section from the file
  214.  
  215.          Pad copyfile
  216.  
  217.             Pad the copyfile with a specified character
  218.  
  219.          Extend
  220.  
  221.             Extend the file with a specified character
  222.  
  223.          Edit record
  224.  
  225.             Enter the EDIT mode at the current record
  226.  
  227.          Insert file
  228.  
  229.             Insert copyfile into current file at section beginning
  230.  
  231.          Update
  232.  
  233.             Write the current record to the file
  234.  
  235.       Print
  236.  
  237.          Record
  238.  
  239.             Dump the current record to print image
  240.  
  241.          Whole file
  242.  
  243.             Dump the file to a print image file
  244.  
  245.  
  246.       COMMANDS IN EDIT MODE
  247.  
  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. 16:03:08  03/07/92                                                     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.          UP          Move cursor up one line (keyboard up arrow)
  263.                      Also:  Ctrl-E, Ctrl-I
  264.          DOWN        Move cursor down one line (keyboard down arrow)
  265.                      Also:  Ctrl-X, Ctrl-K
  266.          LEFT        Move cursor left one character (keyboard left arrow)
  267.                      Also:  Ctrl-S, Ctrl-J
  268.                      (Unix note:  do not use Ctrl-S if software
  269.                      handshaking is enabled)
  270.          RIGHT       Move cursor right one character (keyboard right arrow)
  271.                      Ctrl-D, Ctrl-L
  272.          Ctrl-B   Mark beginning of section at cursor
  273.          Ctrl-Z   Mark end of section
  274.          ENTER       Toggle hex/ASCII mode
  275.          ESC         Exit editing mode
  276.          F1          Display edit mode help
  277.                      Also:  Ctrl-H
  278.          Ctrl-W   Repaint the screen
  279.  
  280.    The REVIEW mode is entered by default when FILEZ is started.  Commands
  281.    for this mode are accepted at the filez> prompt.  Error messages are
  282.    always displayed on the bottom line of the screen.  Either a '?' or
  283.    F1 key may be pressed to see the help screen for the REVIEW mode.
  284.  
  285.    For some commands, more than one key may be effective.  This may be
  286.    useful on some terminals that do not have function keys or have
  287.    function keys not properly described in terminfo.
  288.  
  289.    A search pattern may be specified in hex or ASCII (not
  290.    simultaneously), and the search for the pattern will commence from
  291.    the beginning of the currently displayed record.  While a search is
  292.    in progress, it may be aborted by pressing any key in the MSDOS
  293.    version, or by pressing Ctrl-\ in the UNIX version.
  294.  
  295.    If Print->Record is specified, a dump in print image of the current
  296.    record is sent to a file that can be printed upon exit from FILEZ. If
  297.    Print->Whole file is specified, all records are dumped to the print image
  298.    file.
  299.  
  300.    In the EDIT mode, the cursor may be positioned in the hex or ASCII
  301.    region and the bytes to be modified may be specified in hex or ASCII,
  302.    respectively.  In order to move portions of the file to a copyfile,
  303.    the copyfile name must first be specified and opened.  Be sure to
  304.    mark the beginning and end of the section to be moved.   The copyfile
  305.    is closed automatically upon exit from filez, or when a new copyfile
  306.    is specified.  Data file can be composed using this feature, and the
  307.    Operate->Pad feature appends any character you specify to the end of the
  308.    copy file.  Copyfiles are always opened in the append mode so that
  309.    copyfiles from previous FILEZ sessions can be appended to.
  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.  
  317.  
  318. ********************************************************************************
  319. 16:03:08  03/07/92                                                     Page 6   
  320.                      T O O L Z   D O C U M E N T A T I O N                      
  321.                                    F I L E Z                                    
  322. ********************************************************************************
  323.  
  324.  
  325.    Hex editing is the default upon entering edit mode.  The ENTER key
  326.    toggles between hex and Ascii editing.  The byte under edit will be
  327.    displayed with the foreground and background reveresed.  If editing
  328.    in hex, the corresponding byte under edit in the Ascii display will
  329.    be emphasized.
  330.  
  331.    The record size is 256 by default, but this value may be changed to
  332.    any value between 1 and 256 using the Set->Record size command from
  333.    the review mode.
  334.  
  335.    A configuration file is optional and can be used to modify screen
  336.    colors.  The configuration file must be named FILEZ.CFG and may be
  337.    located anywhere in the search path.  It is a text file containing
  338.    one or more of the following records:
  339.  
  340.       WINDOW,DISPLAY,<foreground>,<background>
  341.       WINDOW,ADDRESS,<foreground>,<background>
  342.       WINDOW,HEX,<foreground>,<background>
  343.       WINDOW,ASCII,<foreground>,<background>
  344.       WINDOW,HELP,<foreground>,<background>
  345.       WINDOW,STATUS,<foreground>,<background>
  346.       WINDOW,SELECT,<foreground>,<background>
  347.       WINDOW,ERROR,<foreground>,<background>
  348.       WINDOW,TABLE,<foreground>,<background>
  349.       WINDOW,PROMPT,<foreground>,<background>
  350.       WINDOW,MENU,<foreground>,<background>
  351.  
  352.    Valid foreground and background colors are:
  353.  
  354.       BLACK
  355.       RED
  356.       GREEN
  357.       YELLOW
  358.       BLUE
  359.       MAGENTA
  360.       CYAN
  361.       WHITE
  362.  
  363.    Other options are:
  364.  
  365.       OPTION,BITS,8
  366.  
  367.    Empty lines and lines beginning with the '#' character are
  368.    ignored.  The screen color specification are ignored in monochrome
  369.    mode.
  370.  
  371. o COMMENTS
  372.  
  373.    This program is based on EFILE, published by Software Toolz in
  374.  
  375.  
  376. ********************************************************************************
  377.               T O O L Z   M o d u l e   D o c u m e n t a t i o n               
  378. ********************************************************************************
  379.  
  380.  
  381. ********************************************************************************
  382. 16:03:08  03/07/92                                                     Page 7   
  383.                      T O O L Z   D O C U M E N T A T I O N                      
  384.                                    F I L E Z                                    
  385. ********************************************************************************
  386.  
  387.  
  388.    1986.  FILEZ, however, is substantially rewritten and based on
  389.    Curses.
  390.  
  391. o RETURNS
  392.  
  393.    Nothing
  394.  
  395. o APPLICATIONS
  396.  
  397.    FILE
  398.  
  399. o PLATFORMS
  400.  
  401.    MSDOS-S
  402.    UNIX
  403.  
  404. o AUTHOR
  405.  
  406.    Todd Merriman
  407.  
  408. o REVISIONS
  409.  
  410.    11/29/91
  411.    Rewrite and implement under Curses.
  412.    12/16/91
  413.    Binary search pattern would fail when searching with a byte with
  414.    bit 7 set.
  415.    12/23/91
  416.    Added pattern translate
  417.    1/12/92
  418.    Added Cntrl-W repaint command
  419.    1/13/92
  420.    Add ASCII table view
  421.    2/21/92
  422.    Add 8-bit character display to MSDOS version
  423.    2/25/92
  424.    Revise from 1.6 to 1.7.  Add pull-down menus to replace character
  425.    commands.
  426.  
  427. o FIXES
  428.  
  429.    12/26/91
  430.    Corrected documentation concerning the names of windows to be
  431.    specified in the Configuration File.
  432.    1/13/92
  433.    Found problem disallowing color modifications for the the configuration
  434.    file for the HELP window.
  435.    2/15/92
  436.    Inadvertant ESC pressed twice sequentially exited program without
  437.  
  438.  
  439. ********************************************************************************
  440.               T O O L Z   M o d u l e   D o c u m e n t a t i o n               
  441. ********************************************************************************
  442.  
  443.  
  444. ********************************************************************************
  445. 16:03:08  03/07/92                                                     Page 8   
  446.                      T O O L Z   D O C U M E N T A T I O N                      
  447.                                    F I L E Z                                    
  448. ********************************************************************************
  449.  
  450.  
  451.    saving edits.
  452.  
  453. o NOTICE
  454.  
  455.    FILEZ is Copyright 1991 Software Toolz, Inc. - Atlanta, Georgia
  456.  
  457.    All rights reserved worldwide.  You are granted a limted license to
  458.    use this program, copy it, and distribute it provided that:  (1) no
  459.    fee may be charged for such copying and distribution, and (2) this
  460.    program may only be distributed in its original unmodified state.
  461.    This program may not be distributed with other programs for which a
  462.    fee is charged except by permission of Software Toolz, Inc.
  463.  
  464.    This program may be registered from Software Toolz for $19.95
  465.    plus shipping and handling.  Visa and MasterCard are accepted.
  466.    Registration entitles you to the latest update on magnetic
  467.    media and a printed user manual.  You are urged to register
  468.    this software if you find it to be of use to you.
  469.  
  470.    You are invited to evaluate DOCZ(tm), the code documentation
  471.    automation facility for MSDOS and UNIX.  DOCZ works with all computer
  472.    languages, and it builds reference manuals and on-line documentation
  473.    for software modules with documentation imbedded in the source code.
  474.    Call or write Software Toolz for the FREE MSDOS demo version and
  475.    DOCZ brochure.
  476.  
  477.    Software Toolz, Inc.
  478.    8030 Pooles Mill Dr.
  479.    Ball Ground, GA 30107-9610
  480.    (706) 889-8264
  481.    Internet:  software%toolz.uucp@mathcs.emory.edu
  482.  
  483. o INTRODUCTION DATE
  484.  
  485.    07/29/91
  486.  
  487. o LAST FILE UPDATE
  488.  
  489.    03/07/92 16:02:25 -- filez.c
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502. ********************************************************************************
  503.               T O O L Z   M o d u l e   D o c u m e n t a t i o n               
  504. ********************************************************************************
  505.