unzip_cli.help
上传用户:andy_li
上传日期:2007-01-06
资源大小:1019k
文件大小:15k
源码类别:

压缩解压

开发平台:

MultiPlatform

  1. .!
  2. .!  File:       UNZIP_CLI.HELP
  3. .!
  4. .!  Author:     Hunter Goatley
  5. .!
  6. .!  Date:       12 Jul 94 (orig. UNZIP.RNH, 23 Oct 91)
  7. .!
  8. .!  Description:
  9. .!
  10. .!      TPU-processable source file to produce VMS on-line help for
  11. .!      portable UnZip.  Adapted from UNZIP.RNH, originally based on
  12. .!      UNZIP.MAN (now UNZIP.DOC).
  13. .!
  14. .!      To build:
  15. .!          $ EDIT /TPU/NOSECTION/NODISPLAY/COMMAND=CVTHELP.TPU UNZIP_CLI.HELP
  16. .!          $ RUNOFF /OUT=UNZIP.HLP UNZIP_CLI.RNH
  17. .!          $ LIBR /HELP/INSERT libr UNZIP
  18. .!
  19. .!  Modification history:
  20. .!
  21. .!      02-001          Hunter Goatley          12-JUL-1994 16:59
  22. .!              Genesis.
  23. .!      02-002          Cave Newt               14-JUL-1994 11:36
  24. .!              Fixed /*TEXT options and added/removed various options.
  25. .!      02-003          Cave Newt               28-JUL-1994 08:54
  26. .!              Removed semicolons from comments and moved /ZIPINFO.
  27. .!      02-004          Christian Spieler       06-OCT-1995 02:02
  28. .!              Changed to conform to revised .CLD definition.
  29. .!      02-005          Christian Spieler       06-FEB-1996 02:20
  30. .!              Added description of /HELP qualifier.
  31. .!      02-006          Christian Spieler       12-MAY-1996 00:50
  32. .!              Some clarifications/cleanups.
  33. .!      02-007          Christian Spieler       04-MAR-1997 22:25
  34. .!              Added /[NO]CASE_INSENSITIVE to ZipInfo mode;
  35. .!              documented the new /PASSWORD="decryption_key" option.
  36. .!      02-007          Christian Spieler       22-JUL-1997 22:37
  37. .!              Formatting changes (prevent line wraps); added "Exit_Codes"
  38. .!              subtopic (no version number change).
  39. .!
  40. <INIT>
  41. <MAIN>
  42. UNZIP
  43. UnZip is used to extract files compressed and packaged by Zip (see HELP ZIP
  44. for information on ZIP).
  45. For a brief help on Zip and Unzip, run each without specifying any
  46. parameters on the command line (or apply the /HELP qualifier).
  47. To get a brief help sceen about the alternate UNIX style command interface,
  48. run each with the -h option applied.
  49. UNZIP will list, test, or extract from a ZIP archive.  ZIP archives are commonly
  50. found on MS-DOS systems; a VMS version of ZIP can also be found here.
  51. Archive member extraction is implied by the absence of the /SCREEN (-c),
  52. /PIPE (-p), /TEST (-t), /LIST (-l, -v) or /COMMENT (-z) qualifiers (options).
  53. All archive members are processed unless a filespec is provided to
  54. specify a subset of the archive members.
  55. <FORMAT>
  56. UNZIP zipfile [file[,...]] [/qualifiers]
  57. .!
  58. <TOPIC>
  59. Parameters
  60. <PARAMETER>
  61. zipfile
  62. <PTEXT>
  63. File specification for the ZIP archive(s) with optional wildcards. UnZip will
  64. perform actions specified for every zipfile matching the specification.
  65. The default file specification is SYS$DISK:[].ZIP.
  66. Note that self-extracting ZIP files are supported; just specify the .EXE
  67. suffix yourself.
  68. <TXETP>
  69. <PARAMETER>
  70. file
  71. <PTEXT>
  72. An optional comma-separated list of archive members to be processed;
  73. if no list is given, all archive members are processed.  Expressions
  74. may be used to match multiple members.  Expressions should be enclosed
  75. in double-quotes to prevent interpretation by DCL.  Multiple filenames
  76. should be separated by blanks.  Each file specification is similar to
  77. a Unix egrep expression and may contain:
  78. <LITERAL>
  79. |*       matches a sequence of 0 or more characters
  80. |?       matches exactly 1 character
  81. |[...]   matches any single character found inside the brackets;
  82. |        ranges are specified by a beginning character,
  83. |        a hyphen, and an ending character.  If a '!' or '^'
  84. |        immediately follows the left bracket, then any character
  85. |        not in the given range is matched.
  86. <LARETIL>
  87. <TXETP>
  88. <QUALIFIERS>
  89. <QUALIFIER>
  90. /ZIPINFO
  91. /ZIPINFO
  92. Displays information about the Zip archive and the files contained therein.
  93. This function used to be provided by a separate ZipInfo program.
  94. The following qualifiers may be specified with /ZIPINFO:
  95. <LITERAL>
  96. |  /SHORT                 Short UNIX "ls -l" format (default)
  97. |  /MEDIUM                Medium UNIX "ls -l" format
  98. |  /LONG                  Long UNIX "ls -l" format
  99. |  /VERBOSE               Verbose, multi-page format
  100. |  /ONE_LINE              Filenames only, one per line
  101. |  /HEADER                Print header lines
  102. |  /TOTALS                Print totals for files
  103. |  /TIMES                 Print file times in sortable decimal format
  104. |  /[NO]CASE_INSENSITIVE  Match filenames case-insensitively
  105. |  /[NO]PAGE              Page screen output through built-in "more"
  106. <LARETIL>
  107. <QUALIFIER>
  108. /BINARY
  109. /BINARY[=KEYWORD]
  110. /NOBINARY (default)
  111. Selects conversion to VMS "standard" binary file format, which is
  112. "fixed length 512 byte records, no record attributes".
  113. The optional keywords recognized are:
  114. <LITERAL>
  115. |  AUTO     Automatically extracts files marked as "binary" (rather
  116. |           than "text") in standard VMS binary file format. (default)
  117. |  ALL      Extracts all files in standard VMS binary file format.
  118. |  NONE     Same as /NOBINARY.
  119. <LARETIL>
  120. Note that a combination of /BINARY[=AUTO] and /TEXT[=AUTO] is allowed.
  121. (see /TEXT qualifier)
  122. <QUALIFIER>
  123. /BRIEF
  124. /BRIEF (default)
  125. When used with /LIST, specifies that a brief listing of the archive's
  126. contents is to be displayed.  A brief listing shows the length, date,
  127. time, and file name for the files in the archive.
  128. <QUALIFIER>
  129. /CASE_INSENSITIVE
  130. /CASE_INSENSITIVE
  131. /NOCASE_INSENSITIVE (default)
  132. Match filenames case-insensitively.  (Good default option under VMS.)
  133. <QUALIFIER>
  134. /COMMENT
  135. /COMMENT
  136. /NOCOMMENT
  137. Display the archive comment.
  138. <QUALIFIER>
  139. /DIRECTORY
  140. /DIRECTORY=directory-spec
  141. Specifies the output directory where all the extracted files are to be
  142. placed.
  143. <QUALIFIER>
  144. /EXCLUDE
  145. /EXCLUDE=(file[,...])
  146. A comma-separated list of files to exclude when extracting files.
  147. If multiple files are specified, the list should be included in
  148. parentheses.
  149. <QUALIFIER>
  150. /FRESHEN
  151. /FRESHEN
  152. /NOFRESHEN
  153. Freshen existing files; replace if newer.  Does not cause any new files to
  154. be created.
  155. <QUALIFIER>
  156. /FULL
  157. /FULL
  158. When used with /LIST, specifies that a full listing of the archive's
  159. contents is to be displayed.  A full listing shows the length,
  160. compression method, compressed size, compression ratio, date,
  161. time, CRC value, and file name for the files in the archive.
  162. <QUALIFIER>
  163. /HELP
  164. /HELP
  165. Displays a one-page brief help screen and exits quietly.
  166. <QUALIFIER>
  167. /JUNK
  168. /JUNK
  169. /NOJUNK (default)
  170. Junk the stored paths (don't recreated the archive's directory
  171. structure.
  172. <QUALIFIER>
  173. /LIST
  174. /LIST
  175. List the contents of the archive.  /BRIEF and /FULL can be used to
  176. specify the amount of information displayed.  The default is /BRIEF.
  177. <QUALIFIER>
  178. /LOWERCASE
  179. /LOWERCASE
  180. /NOLOWERCASE (default)
  181. Convert filenames from all-uppercase operating systems to lowercase.  This
  182. option has no effect under VMS.
  183. <QUALIFIER>
  184. /OVERWRITE
  185. /OVERWRITE
  186. /NOOVERWRITE
  187. The qualifier /OVERWRITE forces overwriting of existing files when extracting.
  188. The negation /NOOVERWRITE results in never overwriting an existing file.
  189. The default action is to prompt for desired action when about to
  190. overwrite an existing file.
  191. For VMS, "overwriting" results in the creation of a new version of the file,
  192. unless version numbers are stored in the archive and /VERSION is specified.
  193. <QUALIFIER>
  194. /PAGE
  195. /PAGE
  196. /NOPAGE
  197. Feed all screen output through the built-in "more" pager.
  198. <QUALIFIER>
  199. /PASSWORD
  200. /PASSWORD=decryption-password
  201. Specifies a decryption password and prevents UnZip from prompting for
  202. a password in case the specified decryption key was wrong. The supplied
  203. string must be enclosed in double-quotes whenever it contains lowercase
  204. or special characters.
  205. <QUALIFIER>
  206. /PIPE
  207. /PIPE
  208. Extract files to SYS$OUTPUT with no informational messages.
  209. <QUALIFIER>
  210. /QUIET
  211. /QUIET[=SUPER]
  212. Perform operations quietly.  The keyword SUPER can be specified to make
  213. operations even more quiet.
  214. <QUALIFIER>
  215. /RESTORE
  216. /RESTORE
  217. /NORESTORE
  218. Restore file owner and protection settings.
  219. <QUALIFIER>
  220. /SCREEN
  221. /SCREEN
  222. /NOSCREEN
  223. Extracts matching files to SYS$OUTPUT (the terminal).
  224. <QUALIFIER>
  225. /TEST
  226. /TEST
  227. /NOTEST
  228. Test archive files.
  229. <QUALIFIER>
  230. /TEXT
  231. /TEXT[=KEYWORD]
  232. /NOTEXT (default)
  233. Selects conversion to VMS standard text file format.
  234. The optional keywords recognized are:
  235. <LITERAL>
  236. |  AUTO     Automatically extracts files marked as "text" (rather
  237. |           than "binary") in standard VMS text file format. (default)
  238. |  ALL      Extracts all files in standard VMS text file format.
  239. |  NONE     Same as /NOTEXT.
  240. <LARETIL>
  241. A similar functionality is available for binary files, see qualifier /BINARY.
  242. <QUALIFIER>
  243. /UPDATE
  244. /UPDATE
  245. /NOUPDATE
  246. Update existing files; create new ones if needed.
  247. <QUALIFIER>
  248. /VERSION
  249. /VERSION
  250. /NOVERSION (default)
  251. Retain VMS file version numbers.
  252. <TOPIC>
  253. Authors
  254. Info-ZIP; currently maintained by Greg Roelofs.  VMS support maintained
  255. by Igor Mandrichenko, Christian Spieler and Hunter Goatley.  Originally
  256. based on a program by Samuel H. Smith.
  257. VMS on-line help ported from UNZIP.DOC by Hunter Goatley.
  258. <TOPIC>
  259. Exit_Codes
  260. On VMS, UnZip's UNIX style exit values are mapped into proper
  261. VMS status codes:
  262. <LITERAL>
  263. |   1                               (success)  normal exit,
  264. |   (0x7fff0000 + 16*UnZip_errnum)  -W- warnings
  265. |   (0x7fff0002 + 16*UnZip_errnum)  -E- normal errors
  266. |   (0x7fff0004 + 16*UnZip_errnum)  -F- fatal errors
  267. <LARETIL>
  268. The UnZip error level (or exit code) approximates the exit
  269. codes defined by PKWARE and takes on the following values:
  270. <LITERAL>
  271. |  VMS       UnZip    Type of error
  272. |  severity  errcode
  273. |    -         0      normal; no errors or warnings detected.
  274. |
  275. |    W         1      one or more warning errors were encountered,
  276. |                     but processing completed  successfully  any-
  277. |                     way.   This  includes  zipfiles where one or
  278. |                     more files was skipped  due  to  unsupported
  279. |                     compression  method  or  encryption  with an
  280. |                     unknown password.
  281. |
  282. |    E         2      a generic error in the  zipfile  format  was
  283. |                     detected.   Processing  may  have  completed
  284. |                     successfully anyway;  some  broken  zipfiles
  285. |                     created by other archivers have simple work-
  286. |                     arounds.
  287. |
  288. |    F         3      a severe error in  the  zipfile  format  was
  289. |                     detected.   Processing probably failed imme-
  290. |                     diately.
  291. |
  292. |    F         4      unzip was unable to allocate memory for  one
  293. |                     or  more  buffers during program initializa-
  294. |                     tion.
  295. |
  296. |    F         5      unzip  was  unable  to  allocate  memory  or
  297. |                     unable  to  obtain a tty to read the decryp-
  298. |                     tion password(s).
  299. |
  300. |    F         6      unzip was unable to allocate  memory  during
  301. |                     decompression to disk.
  302. |
  303. |    F         7      unzip  was  unable to allocate memory during
  304. |                     in-memory decompression.
  305. |
  306. |    F         8      [currently not used]
  307. |
  308. |    E         9      the specified zipfiles were not found.
  309. |
  310. |    E         10     invalid options were specified on  the  com-
  311. |                     mand line.
  312. |
  313. |    E         11     no matching files were found.
  314. |
  315. |    F         50     the disk is (or was) full during extraction.
  316. |
  317. |    F         51     the end of the ZIP archive  was  encountered
  318. |                     prematurely.
  319. |
  320. |    E         80     the user aborted unzip prematurely with con-
  321. |                     trol-C (or similar)
  322. |
  323. |    E         81     no files were found due to unsupported  com-
  324. |                     pression  methods or unsupported decryption.
  325. |                     (If even one additional file is successfully
  326. |                     processed, however, the exit status is 1.)
  327. |
  328. |    E         82     no  files  were  found due to bad decryption
  329. |                     password(s).  This is also the  exit  status
  330. |                     if  no files were found due to a combination
  331. |                     of unsupported  compression  and  bad  pass-
  332. |                     words.   As in the previous case, however, a
  333. |                     single successful file  will  result  in  an
  334. |                     exit status of 1 instead.)
  335. <LARETIL>
  336. In addition, there is a compilation option to expand upon this behavior:
  337. An executable compiled with the option RETURN_CODES defined displays
  338. a human-readable explanation of what the error status means.
  339. <TOPIC>
  340. UNIX_Options
  341. The default action of UnZip is to extract all zipfile entries.  The following
  342. options and modifiers can be provided:
  343. <LITERAL>
  344. |  -Z   ZipInfo mode
  345. |  -c   extract files to SYS$OUTPUT (terminal)
  346. |  -f   freshen existing files (replace if newer); create none
  347. |  -h   show brief help screen and exit quietly
  348. |  -l   list archive files (short format)
  349. |  -p   extract files to SYS$OUTPUT; no informational messages
  350. |  -t   test archive files
  351. |  -u   update existing files; create new ones if needed
  352. |  -v   list archive files (verbose format)
  353. |  -z   display only the archive comment
  354. |
  355. |MODIFIERS
  356. |  -a   auto-extract only text files in standard VMS text file format
  357. |  -aa  extract all files as text
  358. |  -b   auto-extract only binary files in VMS fixed 512 bytes records
  359. |  -bb  extract all files as binary VMS fixed 512 byte record files
  360. |  -j   junk paths (don't recreate archive's directory structure)
  361. |  -n   never overwrite existing files; don't prompt
  362. |  -o   OK to overwrite files without prompting
  363. |  -q   perform operations quietly (-qq => even quieter)
  364. |  -C   match filenames case-insensitively
  365. |  -L   convert filenames to lowercase if created on MSDOS, VMS, etc.
  366. |  -P<pwd>  supply decryption password on the command line (insecure!)
  367. |  -M   page output through built-in "more" function
  368. |  -V   retain (VMS) file version numbers
  369. |  -X   restore owner/protection info (may require privileges)
  370. <LARETIL>
  371. Note that uppercase options such as -C, -L, -M, -P, -V, -X and -Z must
  372. be specified in quotes.  For example:
  373. <LITERAL>
  374. |  $ unzip "-VX" -a zipfile
  375. <LARETIL>
  376. <TOPIC>
  377. UNZIP_OPTS_Default
  378. UnZip allows to modify its default behaviour by specifying (UNIX style)
  379. option defaults via the UNZIP_OPTS logical name.
  380. For example, the following will cause UnZip to match filenames without regard
  381. to case, restore owner/protection information and perform all operations at
  382. quiet-level 1 by default:
  383. <LITERAL>
  384. |  $ define UNZIP_OPTS "-qCX"
  385. <LARETIL>
  386. Note that the quotation marks here are required to preserve lowercase options
  387. (opposite of the command-line behavior). To negate a default option on the
  388. command line, add one or more minus  signs before the option letter, in
  389. addition to the leading switch character `-':
  390. <LITERAL>
  391. |  $ unzip --ql zipfile
  392. <LARETIL>
  393. or
  394. <LITERAL>
  395. |  $ unzip -l-q zipfile
  396. <LARETIL>
  397. At present it is not possible to decrement an option below zero--that is,
  398. more than a few minuses have no effect.
  399. UNZIP_OPTS may be defined as a symbol rather than a logical, but if both
  400. are defined, the logical is used.