home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 9 Archive / 09-Archive.zip / unzip52.zip / vms / unzip_cli.help < prev    next >
Text File  |  1996-02-07  |  10KB  |  379 lines
  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. .!        $ REN UNZIP_CLI.RNH UNZIP.RNH
  17. .!        $ RUNOFF UNZIP.RNH
  18. .!        $ LIBR /HELP/INSERT libr UNZIP
  19. .!
  20. .!  Modification history:
  21. .!
  22. .!    02-001        Hunter Goatley        12-JUL-1994 16:59
  23. .!        Genesis.
  24. .!    02-002        Cave Newt        14-JUL-1994 11:36
  25. .!        Fixed /*TEXT options and added/removed various options.
  26. .!    02-003        Cave Newt        28-JUL-1994 08:54
  27. .!        Removed semicolons from comments and moved /ZIPINFO.
  28. .!    02-004        Christian Spieler    06-OCT-1995 02:02
  29. .!        Changed to conform to revised .CLD definition.
  30. .!    02-005        Christian Spieler    06-FEB-1996 02:20
  31. .!        Added description of /HELP qualifier.
  32. .!
  33. <INIT>
  34. <MAIN>
  35. UNZIP
  36.  
  37. UnZip is used to extract files compressed and packaged by Zip (see HELP ZIP
  38. for information on ZIP).
  39.  
  40. For a brief help on Zip and Unzip, run each without specifying any
  41. parameters on the command line (or apply the /HELP qualifier).
  42.  
  43. UNZIP will list, test, or extract from a ZIP archive.  ZIP archives are commonly
  44. found on MS-DOS systems; a VMS version of ZIP can also be found here.
  45.  
  46. Archive member extraction is implied by the absence of the -c, -p, -t, -l, -v or
  47. -z options.  All archive members are processed unless a filespec is provided to
  48. specify a subset of the archive members.
  49. <FORMAT>
  50. UNZIP zipfile [file[,...]] [/qualifiers]
  51.  
  52. .!
  53. <TOPIC>
  54. Parameters
  55.  
  56. <PARAMETER>
  57. zipfile
  58.  
  59. <PTEXT>
  60. File specification for the ZIP archive(s) with optional wildcards. UnZip will
  61. perform actions specified for every zipfile matching the specification.
  62. The default file specification is SYS$DISK:[].ZIP.
  63.  
  64. Note that self-extracting ZIP files are supported; just specify the .EXE
  65. suffix yourself.
  66. <TXETP>
  67.  
  68. <PARAMETER>
  69. file
  70.  
  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.  
  79. <LITERAL>
  80. |*       matches a sequence of 0 or more characters
  81. |?       matches exactly 1 character
  82. |[...]   matches any single character found inside the brackets;
  83. |        ranges are specified by a beginning character,
  84. |        a hyphen, and an ending character.  If a '!' or '^'
  85. |        immediately follows the left bracket, then any character
  86. |        not in the given range is matched.
  87. <LARETIL>
  88. <TXETP>
  89.  
  90. <QUALIFIERS>
  91. <QUALIFIER>
  92. /ZIPINFO
  93.  
  94. /ZIPINFO
  95.  
  96. Displays information about the Zip archive and the files contained therein.
  97. This function used to be provided by a separate ZipInfo program.
  98.  
  99. The following qualifiers may be specified with /ZIPINFO:
  100.  
  101. <LITERAL>
  102. |  /SHORT     Short UNIX "ls -l" format (default)
  103. |  /MEDIUM    Medium UNIX "ls -l" format
  104. |  /LONG      Long UNIX "ls -l" format
  105. |  /ONE_LINE  Filenames only, one per line
  106. |  /VERBOSE   Verbose, multi-page format
  107. |  /HEADER    Print header lines
  108. |  /TOTALS    Print totals for files
  109. |  /TIMES     Print file times in sortable decimal format
  110. |  /[NO]PAGE  Page screen output through built-in "more"
  111. <LARETIL>
  112. <QUALIFIER>
  113. /BINARY
  114.  
  115. /BINARY[=KEYWORD]
  116. /NOBINARY (default)
  117.  
  118. Selects conversion to VMS "standard" binary file format, which is
  119. "fixed length 512 byte records, no record attributes".
  120. The optional keywords recognized are:
  121. <LITERAL>
  122. |  AUTO      Automatically extracts files marked as "binary" (rather than
  123. |            "text") in in standard VMS binary file format. (default)
  124. |  ALL       Extracts all files in standard VMS binary file format.
  125. |  NONE      Same as /NOBINARY.
  126. <LARETIL>
  127.  
  128. Note that a combination of /BINARY[=AUTO] and /TEXT[=AUTO] is allowed.
  129. (see /TEXT qualifier)
  130. <QUALIFIER>
  131. /BRIEF
  132.  
  133. /BRIEF (default)
  134.  
  135. When used with /LIST, specifies that a brief listing of the archive's
  136. contents is to be displayed.  A brief listing shows the length, date,
  137. time, and file name for the files in the archive.
  138. <QUALIFIER>
  139. /CASE_INSENSITIVE
  140.  
  141. /CASE_INSENSITIVE
  142. /NOCASE_INSENSITIVE (default)
  143.  
  144. Match filenames case-insensitively.  (Good default option under VMS.)
  145. <QUALIFIER>
  146. /COMMENT
  147.  
  148. /COMMENT
  149. /NOCOMMENT
  150.  
  151. Display the archive comment.
  152. <QUALIFIER>
  153. /DIRECTORY
  154.  
  155. /DIRECTORY=directory-spec
  156.  
  157. Specifies the output directory where all the extracted files are to be
  158. placed.
  159. <QUALIFIER>
  160. /EXCLUDE
  161.  
  162. /EXCLUDE=(file[,...])
  163.  
  164. A comma-separated list of files to exclude when extracting files.
  165. If multiple files are specified, the list should be included in
  166. parentheses.
  167.  
  168. <QUALIFIER>
  169. /FRESHEN
  170.  
  171. /FRESHEN
  172. /NOFRESHEN
  173.  
  174. Freshen existing files; replace if newer.  Does not cause any new files to
  175. be created.
  176. <QUALIFIER>
  177. /FULL
  178.  
  179. /FULL
  180.  
  181. When used with /LIST, specifies that a full listing of the archive's
  182. contents is to be displayed.  A full listing shows the length,
  183. compression method, compressed size, compression ratio, date,
  184. time, CRC value, and file name for the files in the archive.
  185. <QUALIFIER>
  186. /HELP
  187.  
  188. /HELP
  189.  
  190. Displays a one-page brief help screen and exits quietly.
  191. <QUALIFIER>
  192. /JUNK
  193.  
  194. /JUNK
  195. /NOJUNK (default)
  196.  
  197. Junk the stored paths (don't recreated the archive's directory
  198. structure.
  199. <QUALIFIER>
  200. /LIST
  201.  
  202. /LIST
  203.  
  204. List the contents of the archive.  /BRIEF and /FULL can be used to
  205. specify the amount of information displayed.  The default is /BRIEF.
  206. <QUALIFIER>
  207. /LOWERCASE
  208.  
  209. /LOWERCASE
  210. /NOLOWERCASE (default)
  211.  
  212. Convert filenames from all-uppercase operating systems to lowercase.  This
  213. option has no effect under VMS.
  214. <QUALIFIER>
  215. /OVERWRITE
  216.  
  217. /OVERWRITE
  218. /NOOVERWRITE
  219.  
  220. The qualifier /OVERWRITE forces overwriting of existing files when extracting.
  221. The negation /NOOVERWRITE results in never overwriting an existing file.
  222. The default action is to prompt for desired action when about to
  223. overwrite an existing file.
  224.  
  225. For VMS, "overwriting" results in the creation of a new version of the file,
  226. unless version numbers are stored in the archive and /VERSION is specified.
  227. <QUALIFIER>
  228. /PAGE
  229.  
  230. /PAGE
  231. /NOPAGE
  232.  
  233. Feed all screen output through the built-in "more" pager.
  234. <QUALIFIER>
  235. /PIPE
  236.  
  237. /PIPE
  238.  
  239. Extract files to SYS$OUTPUT with no informational messages.
  240. <QUALIFIER>
  241. /QUIET
  242.  
  243. /QUIET[=SUPER]
  244.  
  245. Perform operations quietly.  The keyword SUPER can be specified to make
  246. operations even more quiet.
  247. <QUALIFIER>
  248. /RESTORE
  249.  
  250. /RESTORE
  251. /NORESTORE
  252.  
  253. Restore file owner and protection settings.
  254. <QUALIFIER>
  255. /SCREEN
  256.  
  257. /SCREEN
  258. /NOSCREEN
  259.  
  260. Extracts matching files to SYS$OUTPUT (the terminal).
  261. <QUALIFIER>
  262. /TEST
  263.  
  264. /TEST
  265. /NOTEST
  266.  
  267. Test archive files.
  268. <QUALIFIER>
  269. /TEXT
  270.  
  271. /TEXT[=KEYWORD]
  272. /NOTEXT (default)
  273.  
  274. Selects conversion to VMS standard text file format.
  275. The optional keywords recognized are:
  276. <LITERAL>
  277. |  AUTO      Automatically extracts files marked as "text" (rather than
  278.              "binary") in in standard VMS text file format. (default)
  279. |  ALL       Extracts all files in standard VMS text file format.
  280. |  NONE      Same as /NOTEXT.
  281. <LARETIL>
  282.  
  283. A similar functionality is available for binary files, see qualifier /BINARY.
  284. <QUALIFIER>
  285. /UPDATE
  286.  
  287. /UPDATE
  288. /NOUPDATE
  289.  
  290. Update existing files; create new ones if needed.
  291. <QUALIFIER>
  292. /VERSION
  293.  
  294. /VERSION
  295. /NOVERSION (default)
  296.  
  297. Retain VMS file version numbers.
  298.  
  299. <TOPIC>
  300. Authors
  301.  
  302. Info-ZIP; currently maintained by Greg Roelofs.  VMS support maintained
  303. by Igor Mandrichenko and Hunter Goatley.  Originally based on a program
  304. by Samuel H. Smith.
  305.  
  306. VMS on-line help ported from UNZIP.DOC by Hunter Goatley.
  307.  
  308. <TOPIC>
  309. UNIX_Options
  310.  
  311. The default action of UnZip is to extract all zipfile entries.  The following
  312. options and modifiers can be provided:
  313.  
  314. <LITERAL>
  315. |   -Z   ZipInfo mode
  316. |   -c   extract files to SYS$OUTPUT (terminal)
  317. |   -f   freshen existing files (replace if newer); create none
  318. |   -h   show brief help screen and exit quietly
  319. |   -l   list archive files (short format)
  320. |   -p   extract files to SYS$OUTPUT; no informational messages
  321. |   -t   test archive files
  322. |   -u   update existing files; create new ones if needed
  323. |   -v   list archive files (verbose format)
  324. |   -z   display only the archive comment
  325. |
  326. | MODIFIERS
  327. |   -a   auto-extract only text files in standard VMS text file format
  328. |   -aa  extract all files as text
  329. |   -b   auto-extract only binary files in VMS fixed 512 record file format
  330. |   -bb  extract all files as binary in VMS fixed 512 byte record format
  331. |   -j   junk paths (don't recreate archive's directory structure)
  332. |   -n   never overwrite existing files; don't prompt
  333. |   -o   OK to overwrite files without prompting
  334. |   -q   perform operations quietly (-qq => even quieter)
  335. |   -C   match filenames case-insensitively
  336. |   -L   convert filenames to lowercase if created under MS-DOS, VMS, etc.
  337. |   -M   page output through built-in "more" function
  338. |   -V   retain (VMS) file version numbers
  339. |   -X   restore owner/protection info (may require privileges)
  340. <LARETIL>
  341.  
  342. Note that uppercase options such as -C, -L, -M, -V, -X and -Z must be specified
  343. in quotes.  For example:
  344.  
  345. <LITERAL>
  346. |  $ unzip "-VX" -a zipfile
  347. <LARETIL>
  348.  
  349. .![this should probably be a separate section]:
  350. In addition, default options may be specified via the UNZIP_OPTS logical.
  351. For example, the following will cause UnZip to match filenames without regard
  352. to case, restore owner/protection information and perform all operations at
  353. quiet-level 1 by default:
  354.  
  355. <LITERAL>
  356. |  $ define UNZIP_OPTS "-qCX"
  357. <LARETIL>
  358.  
  359. Note that the quotation marks here are required to preserve lowercase options
  360. (opposite of the command-line behavior). To negate a default option on the
  361. command line, add one or more minus  signs before the option letter, in
  362. addition to the leading switch character `-':
  363.  
  364. <LITERAL>
  365. |  $ unzip --ql zipfile
  366. <LARETIL>
  367.  
  368. or
  369.  
  370. <LITERAL>
  371. |  $ unzip -l-q zipfile
  372. <LARETIL>
  373.  
  374. At present it is not possible to decrement an option below zero--that is,
  375. more than a few minuses have no effect.
  376.  
  377. UNZIP_OPTS may be defined as a symbol rather than a logical, but if both
  378. are defined, the logical is used.
  379.