home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / packer / vv097exe / vvuser.asc < prev    next >
Text File  |  1993-01-07  |  6KB  |  143 lines
  1.  
  2. User Guide for VVencode/VVdecode
  3.  
  4. Table  of  Contents
  5.  
  6. 1     Guide  to  using  VVcode ...................... 2
  7.           1.1   VVencode command options .....................: 2
  8.           1.2   VVdecode command options .....................: 3
  9.           1.3   Operating system specific considerations ............... 3
  10.                     1.3.1   MS-DOS ........................... 3
  11.                     1.3.2   OS/2 ............................. 3
  12.                     1.3.3   Unix.............................: 3
  13.                     1.3.4   VAX/VMS .......................... 4
  14.                     1.3.5   VM/CMS ..........................: 4
  15.           1.4   Transferring files between systems ..................: 4
  16.           1.5   Unusual applications of VVcode ...................: 4
  17.  
  18.                           1
  19.  
  20.  
  21. 1   Guide  to  using  VVcode
  22.  
  23.    o  general introduction
  24.  
  25. 1.1   VVencode  command  options
  26.  
  27.    o  described in a generic manner with operating system specifics at the end of the section
  28.     The general syntax of the VVencode command line is:
  29.             vvencode  [options]  input-file  [options]  [output-file]  [options]
  30.     There are two parameters and many optional qualifiers.  The parameters are:
  31.  
  32. input-file
  33. output-file
  34.  
  35.     The command qualifiers modify the behaviour of VVcode and are all optional.  Qualifiers may
  36. appear before, between or after the parameters.  The qualifiers acceptable to VVencode are:
  37.  
  38. debug           Write copious debugging output to the standard error device or to the log file if the
  39.                 +log qualifier was specified.  This qualifier would normally only be used when trying
  40.                 to report a VVencode problem and may indeed have been disabled for the version that
  41.                 you are using.
  42.  
  43. encoding_table file-spec
  44.                 Read the encoding table to be used from the file `file-spec'.  The file must contain
  45.                 the 64 characters to be used by VVencode.  If this qualifier is not specified, the default
  46.                 VVencode encoding table will be used.
  47.  
  48. format file-format
  49.                 Explicitly specify the file format that should be assumed by VVencode when it is reading
  50.                 the input file.  The file-format value must be one of `fixed', `stream' and `variable'.
  51.                 This qualifier would only be used if it was necessary to override the value determined
  52.                 automatically by VVencode.
  53.  
  54. header_filespec file-spec
  55. help            VVencode will display a usage message on the standard error device and exit.
  56.  
  57. log file-spec
  58. mode file-mode
  59.                 Explicitly specify the file mode that should be assumed by VVencode when it is read-
  60.                 ing the input file.  The file-format value must be one of `binary' and `text'.  This
  61.                 qualifier would only be used if it was necessary to override the value determined auto-
  62.                 matically by VVencode.
  63. overwrite
  64. record_length
  65. split_size
  66.  
  67.  
  68. timestamp time
  69. translation_file file-spec
  70.  
  71. 1.2   VVdecode  command  options
  72.  
  73.     The general syntax of the VVdecode command line is:
  74.  
  75.             vvdecode  [options]  input-file  [options]  [output-file]  [options]
  76.  
  77. 1.3   Operating  system  specific  considerations
  78.  
  79. 1.3.1  MS-DOS
  80.  
  81.    o  qualifiers introduced with `/' or `-' and must be separated from each other by whitespace
  82.    o  values separated from qualifier by `=' or `:'
  83.    o  optional values supported
  84.    o  VVcode will act as a filter when `-' is specified as the input or output file
  85.    o  optional file specification for `log' qualifier
  86.    o  examples of VVencode usage
  87.  
  88. 1.3.2  OS/2
  89.  
  90.    o  qualifiers introduced with `/' or `-' and must be separated from each other by whitespace
  91.    o  values separated from qualifier by `=' or `:'
  92.    o  optional values supported
  93.    o  VVcode will act as a filter when `-' is specified as the input or output file
  94.    o  optional file specification for `log' qualifier
  95.    o  GCC 2.1 implementation does not support file timestamping
  96.    o  HPFS file names supported
  97.    o  OS/2 extended attributes not supported yet
  98.    o  examples of VVencode usage
  99.  
  100. 1.3.3  Unix
  101.  
  102.    o  qualifiers introduced with `-' or `+' and must be separated from each other by whitespace
  103.    o  values separated from qualifier by whitespace
  104.    o  optional values not supported
  105.    o  VVcode will act as a filter when `-' is specified as the input or output file
  106.    o  examples of VVencode usage
  107.  
  108.  
  109. 1.3.4  VAX/VMS
  110.  
  111.    o  qualifiers introduced with `/'
  112.    o  values separated from qualifier by `='
  113.    o  standard VMS CLD conventions
  114.    o  optional values supported
  115.    o  VVcode will act as a filter when `-' is specified as the input or output file though meaningless
  116.       on VMS
  117.    o  optional file specification for `log' qualifier
  118.    o  examples of VVencode usage
  119.  
  120. 1.3.5  VM/CMS
  121.  
  122.    o  qualifiers introduced with `(' and must be separated from each other by whitespace
  123.    o  values separated from qualifier by `=' or `:'
  124.    o  command line driven through REXX EXEC
  125.    o  optional values supported
  126.    o  VVcode does not support input or output from/to standard I/O
  127.    o  optional file specification for `log' qualifier
  128.    o  examples of VVencode usage
  129.  
  130. 1.4   Transferring  files  between  systems
  131.  
  132.    o  file type and format
  133.    o  character set
  134.    o  electronic mail
  135.    o  timestamping
  136.  
  137. 1.5   Unusual  applications  of  VVcode
  138.  
  139.    o  character set conversion
  140.    o  file type conversion
  141.    o  VMS file format conversion vs.  CONVERT
  142.  
  143.