home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_2.iso / files / 721b.lha / Yek_v1.2 / Yek.doc.pp / Yek.doc
Text File  |  1993-01-25  |  3KB  |  120 lines
  1.  
  2.                                     YEK
  3.  
  4.                          a file splitting program
  5.  
  6.  
  7. Yek is a program to split large files into smaller ones. Unlike the
  8. standard UNIX Split, Yek is not limited to textfiles. With Yek you can
  9. split any file into files of arbitrary size.
  10.  
  11.  
  12.  
  13. General usage
  14.  
  15. When you start Yek without arguments, just by typing
  16.  
  17. Yek <return>
  18.  
  19. it will respond with an overview of the arguments and switches it supports,
  20. like this.
  21.  
  22. Usage: Yek [-v(erbose)] [-f <output filename>] [-b <buffersize>]
  23.          [-l <output file length>] <file>
  24.  
  25. The <file> argument is the only argument you HAVE to specify to get Yek
  26. working, the others are optional and have (in my humble opinion) sensible
  27. default values. Now for a description of these arguments.
  28.  
  29.  
  30.    -v    This is the verbose option. Specifying this option will
  31.       cause Yek to print information about the amount of bytes
  32.       it has read while it's working.
  33.  
  34.    -f After this option you should give the output filename.
  35.       The files Yek produces will have the names <file>.000,
  36.       <file>.001, etc. The default for this option is 'YekOut'.
  37.  
  38.    -b Specifying a larger buffersize will greatly increase
  39.       operating speed on some computers (like the Amiga), on
  40.       smaller systems it might be necessary to set it somewhat
  41.       lower than the default 100,000.
  42.  
  43.    -l This is self explanatory. The output file length is the
  44.       exact length the files produced by Yek will have (OK,
  45.       I'll admit, the last file will be shorter in most cases).
  46.       Default is 730,000 to make the files fit on a standard
  47.       double density MSDOS floppy.
  48.  
  49.  
  50. That's all there is to using Yek. Now to get the original file back you can
  51. use the AmigaDos Join command, or, when on a UNIX system, cat. Undoubtedly
  52. there's an MSDOS equivalent of these commands, too.
  53.  
  54.  
  55.  
  56. Example usage of Yek.
  57.  
  58. Suppose you happen to have a nice, long sample called Amazing.iff, which
  59. you want to transfer to another computer using MSDOS floppies. 
  60.  
  61.  ------rw-d     Today   23:23  1691 1730375 Amazing.iff
  62.  
  63. Now type
  64.  
  65. Yek -v -f Amaze -b 500000 Amazing.iff <return>
  66.  
  67. and Yek is on it's way! It will inform you of the progress of the splitting
  68. process by printing the number of bytes it just read.
  69.  
  70. 500000 bytes read
  71. 500000 bytes read
  72. 500000 bytes read
  73. 230375 bytes read
  74. Operation complete.
  75.  
  76.  ------rw-d     Today   23:26   714  730000 Amaze.000
  77.  ------rw-d     Today   23:26   714  730000 Amaze.001
  78.  ------rw-d     Today   23:26   266  270375 Amaze.002
  79.  ------rw-d     Today   23:23  1691 1730375 Amazing.iff
  80.  
  81. Now you can get the old file back by typing
  82.  
  83. Join Amaze.000 Amaze.001 Amaze.002 to Amazing.iff    (on the Amiga)
  84.  
  85. or
  86.  
  87. cat Amaze.000 Amaze.001 Amaze.002 > Amazing.iff      (on UNIX systems)
  88.  
  89.  
  90.  
  91. Program history
  92.  
  93.  0.x  Before written history
  94.  1.0  Cosmetic changes to the source
  95.  1.1  Added default outname
  96.  1.2  First public release
  97.  
  98.  
  99.  
  100. Legal stuff
  101.  
  102. Yek is copyright (c) 1993 by Daniel Kussendrager
  103. Permission is explicitly granted to incorporate Yek in any PD series,
  104. upload it to any Bulletin Board, etc., etc., PROVIDED the files of this
  105. distribution are kept together and are not modified.
  106.  
  107.  
  108.  
  109. Where to reach me?
  110.  
  111. Send comments, suggestions and home-brewn programs to
  112.  
  113. daniel@kapteyn.astro.rug.nl
  114.  
  115. and postcards, money (any currency) or Juice Tigers to
  116.  
  117. Daniel Kussendrager
  118. Ernst Casimirlaan 56
  119. 9717 AX  Groningen
  120. The Netherlands