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