home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 1 / ARM_CLUB_CD.iso / contents / apps / files / k / split1 / ReadMe < prev    next >
Encoding:
Text File  |  1994-09-28  |  4.0 KB  |  128 lines
  1. ==========================
  2. =    Split V1.00         =
  3. =                        =
  4. = (C) George Taylor 1994 =
  5. ==========================
  6.  
  7. What is it?
  8. ===========
  9. 'Split' is a command line utility which splits files into many peices.
  10.  
  11. Unlike other split utilities though there is no corresponding join utility,
  12. the resulting split files are 'self-joining' - a bit like self extracting
  13. archives.
  14.  
  15.  
  16.  
  17.  
  18. Copyright and disclaimer
  19. ========================
  20. This software is provided in good faith but there is no warranty.
  21.  
  22. The author cannot accept any liability for any loss or damage resulting from
  23. the use in any way of this software.
  24.  
  25. This software is FREEWARE. You may give copies to others provided they are
  26. unmodified and this document (with intact copyright notice) is included.
  27.  
  28. The self-joining code created with split file is PUBLIC DOMAIN, it therefore
  29. does not effect any software licence which comes with software which you
  30. split using 'Split. You do not need to supply any copyright notice or
  31. this document with the self-joining code.
  32.  
  33.  
  34. How to split files
  35. ==================
  36. Use,
  37.  Split <options>
  38. where options are:
  39.  
  40.  -f <filename>        Specify input file. This option must be present.
  41.  
  42.  -n <name>        Name of output file which is to be created when
  43.                 split pieces are joined together. This must not contain
  44.                 any path or directory components and is truncated
  45.                 to 19 characters. If this option is not present then
  46.                 the leaf name of <filename> is used.
  47.  
  48.  -o <output path>    Output files to a particular path, otherwise
  49.              the current directory is used. (Use dir. or path:
  50.              for example).
  51.  
  52.  -s <split size>    Size in K to split. The default is 128K.
  53.  
  54. For example:
  55.  split -f inputfile -n BigFile -o mydir. -s 50
  56.  
  57. This will create files !BigFile, 01BigFile, 02BigFile etc. If the files already
  58. exist they are overwritten.
  59.  
  60. The files xxBigFile can be recognised by the presence of GSTSPLIT in the
  61. first 8 bytes.
  62.  
  63. The number is placed before the file name to ensure that there are no problems
  64. with long names being truncated.
  65.  
  66. Note the resulting binary !BigFile is incapable of joining any files
  67. other than the ones generated at the same time !BigFile was generated.
  68.  
  69. The !BigFile is public domain and you can give it away with your data files.
  70.  
  71. How to join files
  72. =================
  73.  1    Ensure all the split files are in the same directory. It does not
  74.      matter what the files are called or if there are other files in the
  75.      same directory (including other split files). The filetypes don't
  76.      matter either.
  77.  
  78.  2    Double-click on the !BigFile file. All the parts of the original file
  79.      will be joined together.
  80.           
  81.  3    An error will be given if any parts can not be found or if the
  82.      output file alreay exists. Note that files which do not have
  83.      read access are skipped.
  84.  
  85.  4    Assuming all was successful the original date-stamp and
  86.      file type of BigFile are restored.
  87.      
  88.  5    Finally assuming no errors the extracting program and data
  89.      files are all deleted (if they are not locked).
  90.  
  91. The joining program will start itself up in a taskwindow and multi-task
  92. if it can. No window is opened on screen though.
  93.  
  94.      
  95. Memory
  96. ======
  97. The joining process uses very little memory and will work within a
  98. 64K wimpslot (most of this space is used for file buffering).
  99.  
  100.  
  101. Reliability
  102. ===========
  103. CRC checks are calculated as follows:
  104. Splitting:
  105.     (a)       calculate CRC of input file
  106.     (b)       rewind input file
  107.     (c)       split input file
  108.     (d)       calculate CRC of join program
  109. Joining:
  110.     (a)       calculate CRC of join program
  111.     (b)       join files together
  112.     (c)       rewind output file
  113.     (d)       calculate CRC of output file
  114.     (e)       report warning if either CRC is incorrect
  115.  
  116. This way errors in (i) the source disk, (ii) the transfer of files (eg ftp),
  117. (iii) splitting, (iv) joining (v), writing final file  will be discovered.
  118.  
  119. SWI OS_CRC is used to create CRC values.
  120.  
  121.  
  122. RISC-OS
  123. =======
  124. Split and the joining system have only been tested on RISC-OS 3.10. Later
  125. versions of RISC-OS will be fine, earlier versions I have not tested.
  126.  
  127. The Shared C Library is required by both split and the joining system.
  128.