home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD2.bin / bbs / util / mayflower.lha / MayFlower / CutFile / CutFile.doc < prev    next >
Text File  |  1994-05-04  |  7KB  |  176 lines
  1.                                                       --- ---
  2.                        CutFile 3.0 (19940305)         (o) (o)
  3.                                                          ^
  4.                        by  Stephen D. Childers        \_____/
  5.  
  6. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  7. Program Description:
  8.  
  9.    1) Program is used to cut very large text files down to bytesize
  10.       editable chunks. This is useful when you have a system with very
  11.       little memory or an editor program that chokes on large files.
  12.  
  13.       When you are finished with editing the cut pieces then use the
  14.       'Join' command to bring them back together again.
  15.  
  16.       NOTE: Use a 'Join' command that will allow the joining of files
  17.             in alphabetical order when using wild characters.
  18.  
  19.    2) Runs only from CLI. Can be made resident.
  20.  
  21.    3) Program (when run from CLI) will interact with the 'c:Why' command
  22.       after program failures; this command may provide a more detailed
  23.       explanation of why the program failed.
  24.  
  25.       The 'Why' command should be used immediately after a program
  26.       failure to extract the last program's result code, because
  27.       that result code is changed upon the execution of the next CLI
  28.       command.
  29.  
  30.    4) Certain error reports will contain the name of the argument, file,
  31.       device, (etc) that is associated with failure when it occurs.
  32.  
  33. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  34. CLI usage:
  35.  
  36.    1> CutFile [!] [in out size]
  37.  
  38.       ! = Show author info
  39.  
  40.     in   = Input file name.
  41.     out  = Output file name.
  42.     size = Size of cut.
  43.   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  44.    1) The program will automatically append an ascending serial number
  45.       to each output file cut.
  46.  
  47.       The Program will look for an "Empty:" device in which to write all
  48.       the output cuts to. This device may be a logical assignment to
  49.       your favourite memory device or the name of a volume for a diskette
  50.       device. Once the logical device "Empty:" becomes full then a
  51.       System Request will notify you that "Empty:" needs attention, at
  52.       which point you may:
  53.  
  54.       A) Copy all of the cuts within "Empty:" to another device,
  55.          and then delete all of the output cuts that are within
  56.          "Empty:".
  57.  
  58.       B) Remove the volume "Empty:" diskette and replace it with
  59.          another "Empty:" volume that is empty.
  60.  
  61.       Once "Empty:" is ready to receive more file cuts then press
  62.       "Continue".
  63.  
  64.    2) Size number may be given in decimal or hex. Limits are 1 through
  65.       4294967295. Hex numbers must be preceded with the 'h' character.
  66.  
  67. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  68. CLI Example #1:
  69.  
  70.    1> CutFile HD0:biggy tiny 50000
  71.  
  72.    Let us say that the size of file "biggy" is 320000 bytes long. A list
  73.    of the output results would provide the following data:
  74.  
  75.    Filename             Size
  76.    --------------       ------
  77.    Empty:tiny.cut1       50000
  78.    ...and so on...       50000
  79.    Empty:tiny.cut6       50000
  80.    Empty:tiny.cut7       20000
  81.  
  82.    When program is finished with cutting the file then use a "Join"
  83.    command in the following manner:
  84.  
  85.       > Join Empty:tiny.cut*  as ElseWhere:Biggy2
  86.    or > Join Empty:tiny.cut#? as ElseWhere:Biggy2
  87.  
  88.  
  89. CLI Example #2:
  90.  
  91.    1> CutFile HD0:Biggest wee 30000
  92.  
  93.    Let us say that the size of file "biggest" is 1270003 bytes long.
  94.    A list (sort) of the output results would provide the following data:
  95.  
  96.    Filename             Size
  97.    --------------       ------
  98.    Empty:wee.cut01       30000
  99.    ...and so on...       30000
  100.    Empty:wee.cut09       30000
  101.    Empty:wee.cut10       30000
  102.    ...and so on...       30000
  103.    Empty:wee.cut42       30000
  104.    Empty:wee.cut43       10003  (last file; the remainder bytes)
  105.  
  106.    As you can see, a ZERO was placed in the correct location within
  107.    the file names. This proper placement of the ZERO will allow a
  108.    'Join' command to place the files in correct sequence when rejoining
  109.    them into one large file again.
  110.  
  111.    The ZERO will be correctly placed within the filename regardless of
  112.    the number of cuts you require (ie 10, 100, 1000, etc ).
  113.  
  114. CLI Example #3:
  115.  
  116.    This last example just ahead should get my point across. Perform the
  117.    following CLI command steps.
  118.  
  119.    STEP 1 = > makedir ram:test
  120.    STEP 2 = > assign Empty: ram:test/
  121.    STEP 3 = > copy CutFile ram:test/CutFile
  122.    STEP 4 = > cd ram:test/
  123.    STEP 5 = > CutFile CutFile many 42
  124.    STEP 6 = > list many* sort
  125.    STEP 7 = > Join many#? as CutFileTwo
  126.    STEP 8 = > CutFileTwo !
  127.  
  128.    Step 5 above will produce over 100 files.
  129.  
  130.    Step 6 above will show that all the ZEROS are in their proper place
  131.    within the output file cuts.
  132.  
  133.    Step 7 above will join all the separate cuts back together again into
  134.    a new program file called CutFileTwo.
  135.  
  136.    Step 8 above will run the CutFileTwo program and perform what the
  137.    option tells it to do. Doing this will prove that all of the cuts
  138.    were rejoined in the proper sequence (alphabetical order).
  139.  
  140. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  141. Version History:
  142.  
  143.    The following information briefly describes changes or improvements
  144.    made to each version, and they will be described in descending order;
  145.    meaning latest version information begins first:
  146.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  147.    Version 3.0 (19940305) -
  148.    1) Changed version numbering format. Program can now be used with the
  149.       "Version" command. Date within parenthesis is shown in a somewhat
  150.       international format as (yyyymmdd).
  151.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  152.    Version 19930730 -
  153.    1) Optimized and refined source code thereby making program smaller.
  154.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  155.    Version 19920115 - The first version.
  156.  
  157. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  158.         _   _   _   _   _   _   _   _   _   _   _   _   _   _   _
  159.        / \ / \ / \ / \ / \ / \ / \ / \ / \ / \ / \ / \ / \ / \ / \
  160.      /X_/\X_/\X_/\X_/\X_/\X_/\X_/\X___X/\_X/\_X/\_X/\_X/\_X/\_X/\_X\
  161.     //                                                             \\
  162.    //     3   The Lord shall cut off all flattering lips, and the   \\
  163.   //   tongue that speaketh proud things:                            \\
  164.  //       4   Who have said, With our tongue will we prevail; our     \\
  165.  X     lips are our own: who is lord over us?                          X
  166.  \\                                                                   //
  167.   \\                       Our Lord's Holy Bible - Psalms 12:3-4     //
  168.    \\                           (King James by the way)             //
  169.     \\ _   _   _   _   _   _   _   ___   _   _   _   _   _   _   _ //
  170.      \X \/X \/X \/X \/X \/X \/X \/X   X\/ X\/ X\/ X\/ X\/ X\/ X\/ X/
  171.        \_/ \_/ \_/ \_/ \_/ \_/ \_/ \_/ \_/ \_/ \_/ \_/ \_/ \_/ \_/
  172.  
  173. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  174.                             End Of Document
  175.  
  176.