home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / Ascii-Ansi / vec3.231.lha / vec3231 / docs / vec.doc < prev   
Encoding:
Text File  |  1993-12-08  |  7.2 KB  |  199 lines
  1. vec                The FIP Manual                  vec
  2.  
  3.     NAME
  4.     vec, vdc - Ville's encoder/decoder
  5.  
  6.     SYNOPSIS
  7.     vec [<options>] [<files>]
  8.     vdc [<options>] [<files>]
  9.  
  10.     DESCRIPTION
  11.     Vec  is  used  to convert binary data into printable ASCII characters
  12.     for transmission  trough  networks.  Vdc decodes files created by vec
  13.     back  into their original form.  Vdc can also decode files encoded by
  14.     uuencode, btoa or fipencode and vec is able to create files which can
  15.     be decoded by uudecode.
  16.  
  17.     The  programs  process files given on command line or if no files are
  18.     given, then the standard input stream is processed.  If several files
  19.     are encoded by one call to vec,  they will be stored in single output
  20.     file,  which  will  then be split by vdc.  By default vec outputs via
  21.     standard output stream and vdc creates files with the original names.
  22.  
  23.     If the given file names contain wildcard patterns, vec and vdc may or
  24.     may not expand them. This is system dependent feature.  Amiga version
  25.     does it under AmigaOS 2.04 or newer.
  26.  
  27.     OPTIONS
  28.     -0  Select  encoding  method 0.  Vec only  -  vdc checks its input to
  29.         determine the right method.
  30.  
  31.     -1  Select encoding method 1. Vec only.
  32.  
  33.     -2  Select encoding method 2. Vec only.
  34.  
  35.     -3  Select encoding method 3. Vec only.
  36.  
  37.     -a  Select ASCII escape encoding method. Vec only.
  38.  
  39.     -A <file_name>
  40.         Append output to named file.
  41.  
  42.     -b <number>
  43.         Select the I/O buffer size in bytes.  Memory usage will be doubly
  44.         affected because there are two buffers.
  45.  
  46.     -d  Decode.  Vec and vdc  are the same executable binary and normally
  47.         the  program  name  is  checked  to  determine which operation is
  48.         desired.  This  option can  be  used to  override  the  automatic
  49.         operation selection.
  50.  
  51.     -D  Select the new work directory.
  52.  
  53.     -e  Encode. See above.
  54.  
  55.     -f  Output full-length lines when using escape encoding methods.  Vec
  56.         only.
  57.  
  58.     -i  Select ISO 8859-1 escape encoding method. Vec only.
  59.  
  60.     -l  Write  those  input lines,  which do not contain encoded data  to
  61.         standard  output.  Decoded  files  will  be  replaced by one line
  62.         indicator,  which contains file  name.  Do not  use  this  option
  63.         together with -p option! Vdc only.
  64. vec                The FIP Manual                  vec
  65.  
  66.     -L  Same as above, but don't write indicator lines.
  67.  
  68.     -N  Do not store or restore file mode flags.
  69.  
  70.     -n <file_name>
  71.         Override the name of encoded file. When the file is decoded, this
  72.         name will be used.  If you are encoding standard input and you do
  73.         not use this option, the name `noname' is used. Vec only.
  74.  
  75.     -o <file_name>
  76.         Output  to named file.  Overwrite existing file.  If used on vdc,
  77.         file  mode flag and file name information will be ignored and all
  78.         encoded files will be concatenated to single file.
  79.  
  80.     -p  Output to standard output. See above. Default for vec.
  81.  
  82.     -q  Quick mode. Checksums are not calculated, stored or checked.
  83.  
  84.     -r  Use CR+LF pairs as newlines. By default only LF is used.
  85.  
  86.     -R  Reset uuencode table after each decoded file. Use this option, if
  87.         your  input  file  consists  of  uuencoded  files  from different
  88.         sources.  If you don't use this option, the table from one source
  89.         may ruin the decoding of following tableless files from different
  90.         source. Table is always reset between different input files.  Vdc
  91.         only.
  92.  
  93.     -s  Silent mode. File names are not displayed.
  94.  
  95.     -t  Output  TABs  literally  when using escape encoding methods.  Vec
  96.         only.
  97.  
  98.     -u  Select uuencode compatible encoding method. Vec only.
  99.  
  100.     -w <number>
  101.         Select  the  width  of  the  output lines.  No effect on uuencode
  102.         method. Vec only.
  103.  
  104.     -x  Select hexdump encoding method. Vec only.
  105.  
  106.     -   Option  delimiter.  All  parameters  after it are considered file
  107.         names. This is how you can specify file names starting with dash.
  108.  
  109.     ENCODING METHODS
  110.     Vec  can  use eight different methods to encode data into ASCII char-
  111.     acters. Vdc can decode all these methods and two extra.
  112.  
  113.     Vec method 0
  114.         Fast  but  inefficient.  Data  will  expand  35%  and output will
  115.         contain only 7 bit ASCII characters: codes 33 and 36 through 99.
  116.  
  117.     Vec method 1
  118.         A bit slower but more compact.  Data will expand 24.6% and output
  119.         will  still contain only 7 bit ASCII characters:  codes 33 and 36
  120.         through 126.
  121.  
  122.     Vec method 2
  123.         Fast.  Requires  8  bit transmission.  Data will expand 15.7% and
  124.         output  will  contain  characters  which have high bit set. Char-
  125.         acters will be  printable in ISO 8859-1 or MS-DOS character sets:
  126.         codes 33, 36 through 126 and 161 through 197.
  127. vec                The FIP Manual                  vec
  128.  
  129.     Vec method 3
  130.         Slower.  Very  compact.  Requires  8 bit transmission.  Data will
  131.         expand only 8% and output will contain characters which have high
  132.         bit  set.  Characters  will  be printable in ISO 8859-1 or MS-DOS
  133.         character sets: codes 33, 36 through 126 and 161 through 251.
  134.  
  135.     Vec method a - ASCII escape method
  136.         Outputs  printable  characters  literally  and  escapes the other
  137.         characters. Medium speed. Very efficient on text files, but quite
  138.         inefficient on binary data.  Output will contain only 7 bit ASCII
  139.         characters.  Data will expand about 66% for random input,  almost
  140.         zero  for average text input.  Text files are readable in encoded
  141.         form.
  142.  
  143.     Vec method i - ISO 8859-1 escape method
  144.         Outputs  printable  characters  literally  and  escapes the other
  145.         characters. Medium speed. Very efficient on text files, but quite
  146.         inefficient on binary data. Output will contain characters, which
  147.         have high bit set.  Characters will be printable in ISO 8859-1 or
  148.         MS-DOS character sets.  Data will expand about 15% for random in-
  149.         put, almost zero for average text input.  Text files are readable
  150.         in encoded form.
  151.  
  152.     Vec method x - hexdump method
  153.         Very slow and very inefficient.  Data will expand 102.5% and out-
  154.         put  will  contain  hexadecimal digits.  Header will contain same
  155.         characters  as  method  0.   Originally  implemented  in  testing
  156.         purposes, but may be useful in some cases.
  157.  
  158.     Uuencode method
  159.         Very  fast and very inefficient.  Data will expand 40% and output
  160.         will contain  only  7 bit ASCII characters:  codes 33 through 96.
  161.         Fully compatible with uuencode and uudecode programs.
  162.  
  163.     Btoa method
  164.         Decode only.  Data will expand 25.8% and code contains only 7 bit
  165.         ASCII characters. Compatible with btoa and atob programs.
  166.  
  167.     Fipencode method
  168.         Decode only. Data will expand 15.8% and code contains 8 bit char-
  169.         acters,  which  are  printable in ISO 8859-1 and MS-DOS character
  170.         sets. Compatible with fipencode and fipdecode programs.
  171.  
  172.     Vec methods use CRC16 checksum. Uuencode has primitive line checksums
  173.     and byte count.  Btoa and fipencode have their own checksums, but vdc
  174.     doesn't support them.
  175.  
  176.     Expansion  percentage  for  vec  methods  is calculated here using 80
  177.     character line width.
  178.  
  179.     VERSION
  180.     This manual is written 8th December 1993 for vec version 3.231.
  181. vec                The FIP Manual                  vec
  182.  
  183.     AUTHOR
  184.     Ville Saari
  185.  
  186.     Address:  Tallbergin puistotie 7 B 21
  187.               00200 Helsinki
  188.               FINLAND
  189.  
  190.     Phone:    +358 0 682 2226
  191.  
  192.     Internet: vsaari@garfield.fipnet.fi
  193.  
  194.     If you find bugs in vec, please let me know.
  195.  
  196.     Vec  is freely distributable,  but if you like it and absolutely want
  197.     to pay me something or give me a yacht or Ferrari or something,  then
  198.     do it.
  199.