home *** CD-ROM | disk | FTP | other *** search
/ HAM Radio 3 / hamradioversion3.0examsandprograms1992.iso / packet / bsq / bsq.doc < prev    next >
Text File  |  1986-06-07  |  3KB  |  64 lines
  1. BSQ.DOC v2.0          2/20/86 W1GOH
  2. BSQ is a program designed to allow transfer of arbitrary binary
  3. files via packet radio.  It converts a binary file to printable
  4. ASCII characters, performing data compression where possible;
  5. the result may be transmitted (in "conversational" mode) and
  6. reconverted (again using BSQ) to binary at the other end.  It may
  7. also be included in packet mail.
  8.  
  9. BSQ is available from the W1GOH BBS both in source and binary form,
  10. versions of the latter running on IBM PCs and other MSDOS machines
  11. as well as CPM-based Z80s.   It is implemented in "vanilla" C, and
  12. should be easily portable to other environments.  Thanks to W0RLI
  13. and KE3Z for the CPM port; for details on the latter, download file
  14. BSQ/BSQCPM.DOC from the W1GOH BBS or other distribution sites.
  15.  
  16. *** NB: Transfer of large files on a busy packet channel is both
  17. *** slow and somewhat antisocial.  Try to confine big transfers
  18. *** to lightly-used times and/or frequencies!
  19.  
  20. USAGE:
  21.   bsq <options> file.ext [outname]
  22.     reads binary file.ext, writes file.bsq (or outname if specified)
  23.   bsq <options> file.bsq [outname]
  24.     reads file.bsq, writes file whose name is same as original
  25.     (or outname, if specified).
  26.  
  27.   BSQ default output is always in the current directory. WARNING: existing 
  28.     files whose name conflicts with the output file name are overwritten.
  29.  
  30.   <options> may include:
  31.    -b   Bootstrap mode.  Does simple bit-stuffing, no data
  32.         compression.  Output file suitable for simple BASIC pgm
  33.         BSQBOOT.BAS.
  34.    -o    Old mode. Used to specify creation of .BSQ files compatible
  35.         with earlier versions of BSQ.
  36.  
  37. You may "bootstrap" BSQ to your machine, over the air, via either
  38. of two ways:
  39.   (1) If you have a C compiler, you may download BSQ/BSQ.C and
  40.      compile it.  Careful... BSQ.C is 23K bytes!
  41.   (2) If you have an MSDOS machine and Microsoft BASIC or equivalent,
  42.      you may download BSQ/BSQBOOT.BAS along with BSQ.BSQ (17K!),
  43.      which must be renamed BSQ.BSQ on your local (MS-DOS) machine.
  44.      BSQBOOT.BAS reads BSQ.BSQ, and writes the executable file
  45.      BSQ.COM.  This process runs VERY slowly (about 10 minutes
  46.      on an IBM PC/XT!).
  47.  
  48. Eventually similar bootstrapping techniques should work with
  49.      other .BSQ files, e.g. BSQCPM.BSQ for CPM-based machines.
  50.  
  51. NOTES:
  52. 1. Each line of a .BSQ file is the same length (72 chars) and consists
  53.    entirely of visible characters.  If your .BSQ file gets mutilated in
  54.    simple ways during packet transfer (eg, by addition of a TNC line like
  55.    "*** CONNECT REQUEST: W1GOH") you may be able to fix it using any text
  56.    editor.  BSQ will warn you if it is suspicious of the input file.
  57. 2. Several incompatible generations of BSQ have already evolved.  Newer
  58.    versions can read & convert old .BSQ files, but old versions may be
  59.    unable to convert new .BSQ files properly.  The -o option is intended
  60.    to force newer BSQ versions to write old-format files; however, use of
  61.    -o involves some inefficiency and loss of certain features.
  62.  
  63. (end)
  64.