home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / new / util / cli / sploin / sploin.doc < prev    next >
Text File  |  1994-03-22  |  18KB  |  435 lines

  1.  
  2.     History
  3.     -------
  4.  
  5.  
  6.     -------------------
  7.     ««« Sploin 1.70 »»»
  8.     -------------------
  9.     - Yves Perrenoud --
  10.     - 22.03.1994 ------
  11.     -------------------
  12.  
  13.  
  14. ------------------------------------------------------------------------------
  15. -  V1.0  :  Base version, which only lets you extract and not really split,  -
  16. -           no bugs found.                                                   -
  17. ------------------------------------------------------------------------------
  18. -  V1.1  :  Added the option to split the file in x parts of a size          -
  19. -           specified by the user, or in a specified number of parts.        -
  20. ------------------------------------------------------------------------------
  21. -  V1.2  :  Added multi file join.                                           -
  22. ------------------------------------------------------------------------------
  23. -  V1.3  :  Added an option which tells Sploin to use an input file          -
  24. -           containing the names of files to join together. Removed a few    -
  25. -           little bugs.                                                     -
  26. ------------------------------------------------------------------------------
  27. -  V1.4  :  Wildcards are now supported. You can specify an destination dir. -
  28. -           when splitting in several parts.                                 -
  29. ------------------------------------------------------------------------------
  30. -  V1.45 :  Fixed an ugly bug which didn't accept subdirectories in the      -
  31. -           original path when using the -d option.                          -
  32. ------------------------------------------------------------------------------
  33. -  V1.5  :  Changed the program so it would no longer use the arp library    -
  34. -           for pattern matching and for break detection, but DICE routines  -
  35. -           instead. Also changed everything to Ansi-C (increased the binary -
  36. -           by 6k). Removed stupid options. Found bugs in the removed        -
  37. -           options (Hey hey!)                                               -
  38. ------------------------------------------------------------------------------
  39. -  V1.6  :  Added an option to reconstruct a previously split file.          -
  40. -           Corrected a bug in the input file option. Can now be compiled    -
  41. -           under UNIX.                                                      -
  42. ------------------------------------------------------------------------------
  43. -  V1.61 :  Fixed an Enforcer hit!                                           -
  44. ------------------------------------------------------------------------------
  45. -  V1.62 :  Changed the spliting size character from "$" to "=". The dollar  -
  46. -           sign is used by UNIX for specifying things like the last word    -
  47. -           on the previous line ("!$"). Due to this, on UNIX the program    -
  48. -           wouldn't split big files in smaller files of a specified size;   -
  49. -           which is my main use of the program.                             -
  50. ------------------------------------------------------------------------------
  51. -  V1.65 :  Removed a bug which didn't set the right protections on the      -
  52. -           created files under UNIX. Added VAX/VMS compatibility, but       -
  53. -           without wildcard support (until I find out how it works).        -
  54. ------------------------------------------------------------------------------
  55. -  V1.70 :  Added the "-m{l|h}" feature to greatly ease the transport on     -
  56. -           MS-DOS format disks by setting default sizes and truncating      -
  57. -           filenames to 8.3 chars when using the multiple file split/join   -
  58. -           options. Added the ']' in StripPath for VMS support.             -
  59. ------------------------------------------------------------------------------
  60.  
  61.  
  62.  
  63.  
  64.                              Sploin Version 1.70
  65.                           Written by Yves Perrenoud
  66.                             Copyright (c) 1991-94
  67.                             All Rights Reserved.
  68.  
  69.  
  70.  
  71.  
  72.     Disclaimer :
  73.     ------------
  74.  
  75.     I am NOT responsible for anything this program does; you are using it
  76.     enterily at your own risk.
  77.  
  78.     This program is freely distributable for non-commercial use, provided a
  79.     small credit note or a thank-you is included in the readme file.
  80.     
  81.     The source file is not to be modified without the permission of the
  82.     author. It is only distributed so the program can be compiled on the
  83.     UNIX and VMS operating systems.
  84.  
  85.     Description :
  86.     -------------
  87.  
  88.     This program lets you split a file in several different ways or join
  89.     several files together.
  90.  
  91.     So here is a descripiton of the spliting facility :
  92.  
  93.     - You can extract a specified amount of bytes anywhere in a file and
  94.       optionaly save what rests.
  95.     
  96.     - Split a file in two parts and only specify the size of the first
  97.       chunk.
  98.     
  99.     - Extract a certain amount of bytes from the beginning of the file.
  100.     
  101.     - Split a file in a certain amount of parts or in chunks of a specified
  102.       size. The resulting files will have the "_n" extension added to the
  103.       original name.
  104.  
  105.     - Optionnaly follow MS-DOS 8.3 characters limitation when splitting in
  106.       multiple parts (giving the most appropriate name possible) and set the
  107.       size of a chunk according to the density of the disk (DD or HD).
  108.  
  109.     And here is a description of the joining facility :
  110.  
  111.     - You can join several files together, just like the command "join". Of
  112.       course wildcards are supported (except on VMS).
  113.  
  114.     - Use an input file to specify the files to join together. This lets
  115.       you join an ilimited number of files together, or use the output of
  116.       another program to prepare a list of files (i.e. list, ARexx, etc..).
  117.  
  118.     - You can reconstruct a file which was previously split with Sploin.
  119.       Let me get this clearer: you have FTPed a big archive (2.5Mb), and
  120.       you want to bring it back to your Amiga at home. Well you split the
  121.       file in chunks of 700'000 bytes, transfer them to disk, and then
  122.       when you get home, you reconstruct the archive with Sploin using the
  123.       "-g" option.
  124.  
  125.     - When reconstructing ("-g"), automatically detects if the multiple files
  126.       are in normal format or in the MS-DOS 8.3 chars one.
  127.  
  128.     Detailled description :
  129.     -----------------------
  130.     
  131.     The command is invoked as follows :
  132.     
  133.         Sploin <Mainfile> {<FileN>} [<options>]
  134.     
  135.     <Mainfile>, is the file you will be spliting or the joined file. The
  136.     fact it must be the first filename on the command line is quite obvious
  137.     when you use the split option, but when joining this can be at first a
  138.     bit confusing; it's just a question of habit.
  139.  
  140.     {<FileN>}, are either the files you are going to join, in which case
  141.     you are only limited by the length of the command line, or the
  142.     resulting files from the split. Wildcards are supported (except on
  143.     VMS).
  144.  
  145.     [<options>], here is a list of them :
  146.  
  147.     
  148.         The mode you are going to use :
  149.  
  150.             -j      : join mode (default).
  151.             -sN     : split mode.
  152.  
  153.         The actual options :
  154.  
  155.             -b      : buffer size.
  156.             -o      : offset (split only).
  157.             -n      : size to split in bytes (split only).
  158.             -r      : save rest (split only).
  159.             -i      : input file.
  160.             -g      : reconstruct mode, opposite of -sN (join only).
  161.             -d      : destination directory (split only).
  162.             -m{l|h} : truncate to 8.3 chars MS-DOS format and sets a chunk
  163.                       size suitable for DD (l) or HD (h).
  164.  
  165.  
  166.  
  167.  
  168.     Spliting files :
  169.     ----------------
  170.     
  171.     Buffering :
  172.     
  173.     With "-b" followed by a value in bytes, you will set the buffer to the
  174.     desired size. The default size is 50'000 bytes.
  175.     
  176.     Exctracting :
  177.     
  178.     "-n" : specifies the amount of bytes to exctract.
  179.     "-o" : is the offset at which the program should start exctracting.
  180.     "-r" : is an option which will save what is rest of the file after the
  181.            exctraction.
  182.  
  183.     So lets say you want to strip the first 2000 bytes of a file called
  184.     "Filename" into a destination file calle