home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 9 Archive / 09-Archive.zip / unzip540.zip / vms / unzip_def.rnh < prev    next >
Text File  |  1997-09-01  |  12KB  |  279 lines
  1. .!
  2. .!  File:       UNZIP_DEF.RNH
  3. .!
  4. .!  Author:     Hunter Goatley
  5. .!
  6. .!  Date:       October 23, 1991
  7. .!
  8. .!  Description:
  9. .!
  10. .!      RUNOFF source file for VMS on-line help for portable UnZip.
  11. .!      Adapted from UNZIP.MAN (now UNZIP.DOC).
  12. .!
  13. .!      To build:       $ REN UNZIP_DEF.RNH UNZIP.RNH
  14. .!                      $ RUNOFF UNZIP.RNH
  15. .!                      $ LIBR/HELP/INSERT libr UNZIP
  16. .!
  17. .!  Modification history:
  18. .!
  19. .!      01-001          Hunter Goatley          23-OCT-1991 09:21
  20. .!              Genesis.
  21. .!      01-002          Cave Newt               16-MAR-1992 22:37
  22. .!              Updated for UnZip 4.2.
  23. .!      01-003          Igor Mandrichenko       23-MAY-1992 22:14
  24. .!              Added -X option to command syntax.
  25. .!      01-004          Cave Newt               24-MAY-1992 13:30
  26. .!              Added UNZIP_OPTS environment variable help.
  27. .!      01-005          Igor Mandrichenko       14-DEC-1993 18:55
  28. .!              Modified for UnZip V5.1
  29. .!      01-006          Cave Newt               21-DEC-1993 12:38
  30. .!              Added -x option and cleaned up.
  31. .!      01-007          Cave Newt               14-JUL-1994 09:45
  32. .!              Added -Z, -C and -L options, removed -U, minor clean-up.
  33. .!      01-008          Cave Newt               28-JUL-1994 08:57
  34. .!              Removed semi-colons from comments.
  35. .!      02-001          Christian Spieler       09-DEC-1995 02:25
  36. .!              Modified for UnZip 5.2.
  37. .!      02-002          Christian Spieler       06-FEB-1996 02:25
  38. .!              Added -h "help" option.
  39. .!      02-003          Christian Spieler       04-MAR-1997 20:25
  40. .!              Added -P "command line password" option.
  41. .!      02-004          Christian Spieler       26-JUL-1997 00:05
  42. .!              Added Exit_Codes subtopic, explaining UnZip's VMS return codes.
  43. .!
  44. .noflags
  45. .lm4 .rm72
  46. .indent -4
  47. 1 UNZIP
  48. .br
  49. UnZip is used to extract files compressed and packaged by Zip (see HELP ZIP
  50. for information on ZIP).
  51. .sk
  52. For a brief help on Zip and Unzip, run each without specifying any
  53. parameters on the command line, or specify the -h flag (but not in UnZip's
  54. Zipinfo mode).
  55. .sk
  56. UNZIP will list, test, or extract from a ZIP archive.  ZIP archives are commonly
  57. found on MS-DOS systems; a VMS version of ZIP can also be found here.
  58. .sk
  59. Archive member extraction is implied by the absence of the -c, -p, -t, -l, -v or
  60. -z options.  All archive members are processed unless a filespec is provided to
  61. specify a subset of the archive members.
  62. Format:
  63. .sk;.lm+1;.literal
  64. UNZIP [-cfhlptuvxz[ajnoqCLMVX]] file[.zip] [list] [-x xlist] [-d out_dir]
  65. .end literal;.lm-1
  66. .!------------------------------------------------------------------------------
  67. .indent -4
  68. 2 Parameters
  69. .sk;.indent -4
  70. file[.zip]
  71. .sk
  72. File specification for the ZIP archive(s) with optional wildcards. UnZip will
  73. perform actions specified for every zipfile matching the specification.
  74. Default file specification is SYS$DISK:[].ZIP.
  75. Note that self-extracting ZIP files are supported; just specify the .EXE
  76. suffix yourself.
  77. .sk;.indent -4
  78. [list]
  79. .sk
  80. An optional list of archive members to be processed; if no list is given, all
  81. archive members are processed.  Expressions may be
  82. used to match multiple members.  Expressions should be enclosed in double-quotes
  83. to prevent interpretation by DCL.  Multiple filenames should be separated by
  84. blanks.  Each file specification is similar to a Unix egrep expression and may
  85. contain:
  86. .sk
  87. .literal
  88.      *       matches a sequence of 0 or more characters
  89.      ?       matches exactly 1 character
  90.      [...]   matches any single character found inside the brackets;
  91.              ranges are specified by a beginning character,
  92.              a hyphen, and an ending character.  If a '!' or '^'
  93.              immediately follows the left bracket, then any character
  94.              not in the given range is matched.
  95. .end literal
  96. .sk
  97. .sk;.indent -4
  98. [-x xlist]
  99. .sk
  100. An optional list of archive members to be excluded from processing.  The xlist
  101. overrides any files included in the normal list.
  102. .sk;.indent -4
  103. [-d out_dir]
  104. .sk
  105. Optional directory specification to be used as target root directory
  106. for files to be extracted.  Directory should be specified in "[.foo]"
  107. format rather than "foo.dir" or "foo/" format.
  108. .!------------------------------------------------------------------------------
  109. .indent -4
  110. 2 Options
  111. .br
  112. The default action of UnZip is to extract all zipfile entries.  The following
  113. options and modifiers can be provided:
  114. .sk;.literal
  115.    -Z   ZipInfo mode
  116.    -c   extract files to SYS$OUTPUT (terminal)
  117.    -f   freshen existing files (replace if newer); create none
  118.    -h   show brief help screen and exit quietly
  119.    -l   list archive files (short format)
  120.    -p   extract files to SYS$OUTPUT; no informational messages
  121.    -t   test archive files
  122.    -u   update existing files; create new ones if needed
  123.    -v   list archive files (verbose format)
  124.    -z   display only the archive comment
  125. .end literal;.sk;.literal
  126.  MODIFIERS
  127.    -a   extract text files in standard VMS text file format
  128.    -aa  extract all files as text
  129.    -b   auto-extract only binary files in VMS fixed 512-byte record format
  130.    -bb  extract all files as binary in VMS fixed 512-byte record format
  131.    -j   junk paths (don't recreate archive's directory structure)
  132.    -n   never overwrite existing files; don't prompt
  133.    -o   OK to overwrite files without prompting
  134.    -q   perform operations quietly (-qq => even quieter)
  135.    -C   match filenames case-insensitively
  136.    -L   convert filenames to lowercase if created under DOS, VMS, etc.
  137.    -M   feed screen output through built-in "more" pager
  138.    -P<password> supply decryption password on the command line (insecure!)
  139.    -V   retain (VMS) file version numbers
  140.    -X   restore owner/protection info (may require privileges)
  141. .end literal;.sk
  142. Note that uppercase options (-C, -L, -M, -P, -V and -X) must be specified
  143. in quotes. For example:
  144. .sk;.literal
  145.     unzip "-VX" -a zipfile
  146. .end literal;.sk
  147. The output conversion options -b and -a may be combined to perform
  148. binary conversions on binary files and text conversion on text files.
  149. But note: For compatibility with implementation on other systems, -b cancels
  150. any -a option; to get the intended result, -a must be specified AFTER -b.
  151. And, in combination, "text" recognition takes precedence; this means
  152. that -bb has the same effect as -b, and -aa overrides binary conversion
  153. for ALL files.
  154. .sk
  155. Please note that using the "-P<password>" option is higly insecure, the
  156. plaintext password may be seen by others. For this reason (and because of
  157. lack of space), the "-P<password>" option is not advertised on UnZip's
  158. online help screen.
  159. .!------------------------------------------------------------------------------
  160. .indent -4
  161. 2 Exit_Codes
  162. .br
  163. On VMS, UnZip's UNIX style exit values are mapped into proper
  164. VMS status codes:
  165. .sk;.literal
  166.    1                               (success)  normal exit,
  167.    (0x7fff0000 + 16*UnZip_errnum)  -W- warnings
  168.    (0x7fff0002 + 16*UnZip_errnum)  -E- normal errors
  169.    (0x7fff0004 + 16*UnZip_errnum)  -F- fatal errors
  170. .end literal;.sk
  171. The UnZip error level (or exit code) approximates the exit
  172. codes defined by PKWARE and takes on the following values:
  173. .sk;.literal
  174.   VMS       UnZip    Type of error
  175.   severity  errcode
  176.     -         0      normal; no errors or warnings detected.
  177.  
  178.     W         1      one or more warning errors were encountered,
  179.                      but processing completed  successfully  any-
  180.                      way.   This  includes  zipfiles where one or
  181.                      more files was skipped  due  to  unsupported
  182.                      compression  method  or  encryption  with an
  183.                      unknown password.
  184.  
  185.     E         2      a generic error in the  zipfile  format  was
  186.                      detected.   Processing  may  have  completed
  187.                      successfully anyway;  some  broken  zipfiles
  188.                      created by other archivers have simple work-
  189.                      arounds.
  190.  
  191.     F         3      a severe error in  the  zipfile  format  was
  192.                      detected.   Processing probably failed imme-
  193.                      diately.
  194.  
  195.     F         4      unzip was unable to allocate memory for  one
  196.                      or  more  buffers during program initializa-
  197.                      tion.
  198.  
  199.     F         5      unzip  was  unable  to  allocate  memory  or
  200.                      unable  to  obtain a tty to read the decryp-
  201.                      tion password(s).
  202.  
  203.     F         6      unzip was unable to allocate  memory  during
  204.                      decompression to disk.
  205.  
  206.     F         7      unzip  was  unable to allocate memory during
  207.                      in-memory decompression.
  208.  
  209.     F         8      [currently not used]
  210.  
  211.     E         9      the specified zipfiles were not found.
  212.  
  213.     E         10     invalid options were specified on  the  com-
  214.                      mand line.
  215.  
  216.     E         11     no matching files were found.
  217.  
  218.     F         50     the disk is (or was) full during extraction.
  219.  
  220.     F         51     the end of the ZIP archive  was  encountered
  221.                      prematurely.
  222.  
  223.     E         80     the user aborted unzip prematurely with con-
  224.                      trol-C (or similar)
  225.  
  226.     E         81     no files were found due to unsupported  com-
  227.                      pression  methods or unsupported decryption.
  228.                      (If even one additional file is successfully
  229.                      processed, however, the exit status is 1.)
  230.  
  231.     E         82     no  files  were  found due to bad decryption
  232.                      password(s).  This is also the  exit  status
  233.                      if  no files were found due to a combination
  234.                      of unsupported  compression  and  bad  pass-
  235.                      words.   As in the previous case, however, a
  236.                      single successful file  will  result  in  an
  237.                      exit status of 1 instead.)
  238. .end literal;.sk
  239. In addition, there is a compilation option to expand upon this behavior:
  240. An executable compiled with the option RETURN_CODES defined displays
  241. a human-readable explanation of what the error status means.
  242. .!------------------------------------------------------------------------------
  243. .indent -4
  244. 2 Logical_Names
  245. .br
  246. UnZip allows to modify its default behaviour by specifying option defaults
  247. via the UNZIP_OPTS logical name.
  248. For example, the following will cause UnZip to restore owner/protection
  249. information and perform all operations at quiet-level 1 by default:
  250. .sk;.literal
  251.     define UNZIP_OPTS "-qX"
  252. .end literal;.sk
  253. Note that the quotation marks here are required to preserve lowercase options
  254. (opposite of the command-line behavior).
  255. To negate a default option on the command line, add one or more minus
  256. signs before the option letter, in addition to the leading switch character
  257. `-':
  258. .sk;.literal
  259.     unzip --ql zipfile
  260. .end literal
  261. or
  262. .literal
  263.     unzip -l-q zipfile
  264. .end literal;.sk
  265. At present it is not possible to decrement an option below zero--that is,
  266. more than a few minuses have no effect.
  267. .sk
  268. UNZIP_OPTS may be defined as a symbol rather than a logical name, but if
  269. both are defined, the logical name takes precedence.
  270. .!-----------------------------------------------------------------------------
  271. .indent -4
  272. 2 Authors
  273. .br
  274. Info-ZIP; currently maintained by Greg Roelofs.  VMS support maintained
  275. by Christian Spieler and Hunter Goatley.  Originally based on a program
  276. by Samuel H. Smith.
  277. .sk
  278. VMS on-line help ported from UNZIP.DOC by Hunter Goatley.
  279.