home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 9 Archive / 09-Archive.zip / zip22.zip / vms / zip_cli.help < prev    next >
Text File  |  1997-10-24  |  19KB  |  606 lines
  1. .!
  2. .!  File:    ZIP_CLI.HELP
  3. .!
  4. .!  Author:    Christian Spieler
  5. .!
  6. .!  Date:    05 Dec 95 (orig. ZIP.RNH, 22 Oct 91)
  7. .!
  8. .!  Description:
  9. .!
  10. .!    TPU-processable source file to produce VMS on-line help for
  11. .!    portable Zip.  Adapted from ZIP.RNH, originally based on
  12. .!    ZIP.MAN (now MANUAL).
  13. .!
  14. .!    To build:
  15. .!        $ EDIT /TPU/NOSECTION/NODISPLAY/COMMAND=CVTHELP.TPU ZIP_CLI.HELP
  16. .!        $ RUNOFF /OUT=ZIP_CLI.HLP ZIP_CLI.RNH
  17. .!        $ LIBR /HELP/INSERT libr ZIP_CLI
  18. .!
  19. .!  Modification history:
  20. .!
  21. .!    01-001        Christian Spieler    05-DEC-1995 02:02
  22. .!        Genesis.
  23. .!    01-002        Christian Spieler    20-JAN-1996 03:09
  24. .!        Modified /LICENSE and /VERBOSE descriptions.
  25. .!    01-003        Christian Spieler    11-FEB-1996 23:09
  26. .!        Added /[NO]EXTRA_FIELDS description.
  27. .!    01-004        Christian Spieler    11-MAR-1996 20:08
  28. .!        Removed /ENCRYPT=VERIFY option.
  29. .!    01-005        Christian Spieler    11-MAY-1996 23:08
  30. .!        Corrected/enhanced info about how to get help on UNIX options.
  31. .!    01-006        Christian Spieler    21-JUL-1997 22:26
  32. .!        Updated for new options of Zip 2.2.
  33. .!    01-006        Christian Spieler    14-OCT-1997 22:04
  34. .!        Cleanups for Zip 2.2 release (no version change).
  35. .!
  36. <INIT>
  37. <MAIN>
  38. ZIP
  39.  
  40. Zip is a compression and file packaging utility for Unix, MSDOS, OS/2, and
  41. VMS.  It is analogous to a combination of tar and compress and is
  42. compatible with PKZIP (Phil Katz ZIP) for MSDOS systems.
  43.  
  44. There is a companion to Zip called UnZip (of course).  Zip and UnZip can
  45. work with files produced by PKZIP under MSDOS, and PKZIP and PKUNZIP can
  46. work with files produced by Zip.
  47.  
  48. Zip 2.2 is compatible with PKZIP 2.04.
  49. Note that PKUNZIP 1.10 cannot extract files produced by PKZIP 2.04
  50. or zip 2.2. You must use PKZIP 2.04g or unzip 5.0p1 (or later versions)
  51. to extract them.
  52.  
  53. For a brief help on Zip and Unzip, run each without specifying any
  54. parameters on the command line. If you want to get the help screen
  55. describing the alternate UNIX style command interface, you must
  56. specify the -h option.
  57.  
  58. Zip puts one or more compressed files into a single "zip file" along with
  59. information about the files, including the name, path if requested, date
  60. and time last modified, protection, and check information to verify the
  61. fidelity of each entry.  Zip can pack an entire directory structure in a
  62. zip file with a single command.  Compression ratios of 2:1 to 3:1 are
  63. common for text files.  Zip has has one compression method (deflation) and
  64. can also store files without compression. It automatically chooses the better
  65. of the two for each file to be compressed.
  66.  
  67. Zip is useful for packaging a set of files to send to someone or for
  68. distribution; for archiving or backing up files; and for saving disk space
  69. by temporarily compressing unused files or directories.
  70.  
  71.  
  72. <FORMAT>
  73. ZIP zipfile [file[,...]] [/qualifiers]
  74.  
  75. .!
  76. <TOPIC>
  77. Parameters
  78.  
  79. <PARAMETER>
  80. zipfile
  81.  
  82. <PTEXT>
  83. File specification for the ZIP archive. Zip will perform the requested action
  84. for every zipfile matching the specification.
  85. The default file specification is SYS$DISK:[].ZIP.
  86.  
  87. Note that self-extracting ZIP files are supported; just specify the .EXE
  88. suffix yourself.
  89. <TXETP>
  90.  
  91. <PARAMETER>
  92. file
  93.  
  94. <PTEXT>
  95. An optional comma-separated list of files to be added or replaced in the
  96. zipfile. For unconditional add / replacement actions, a list must be
  97. specified. For the freshening operation, all archive members are processed
  98. per default; the optional file list restricts processing to the specified
  99. archive members.
  100. Expressions may be used to match multiple members.  For add/update operations,
  101. wildcard expressions are interpreted in  VMS wildcard syntax to match
  102. external files. In contrast, for freshening/deletion operation, wildcard
  103. expressions are interpreted in UNIX compatible syntax to match the
  104. internal names of archive members in the zipfile.
  105. <TXETP>
  106.  
  107. <QUALIFIERS>
  108. <QUALIFIER>
  109. /ADJUST_OFFSETS
  110.  
  111. /ADJUST_OFFSETS
  112.  
  113. Adjust internal offsets of the Zip archive members after some data
  114. (e.g. a SFX executable stub) has been prepended to the archive file.
  115. <QUALIFIER>
  116. /APPEND
  117.  
  118. /APPEND
  119.  
  120. Try to work with the existing Zip archive. This option is ignored when
  121. any existing entry in the Zip archive gets updated or deleted.
  122. Without the /APPEND qualifier, Zip always creates a backup copy when
  123. modifying the archive. This is slower, but prevents corruption of the
  124. old archive in case of a fatal problem (power failures, program crash...).
  125. <QUALIFIER>
  126. /BATCH
  127.  
  128. /BATCH[=listfile]
  129.  
  130. Read list of files to add/update to the Zip archive from the listfile.
  131. The listfile defaults to SYS$INPUT.
  132. <QUALIFIER>
  133. /BEFORE
  134.  
  135. /BEFORE=(VMS time specification)
  136.  
  137. Only handle files that are older than the specified date and time.
  138. The specified time is compared with the files' RMS creation time.
  139. <QUALIFIER>
  140. /COMMENT
  141.  
  142. /COMMENT[=KEYWORD[,KEYWORD]]
  143.  
  144. Add comments to the Zip archive.
  145. <LITERAL>
  146. |  ZIP_FILE  Add/replace the multi-line archive comment. (default)
  147. |  FILES     Add file comment to each updated/added archive member.
  148. <LARETIL>
  149.  
  150. The Zip program prompts for each comment to be added; this requires Zip
  151. to be run in interactive mode.
  152.  
  153. The one-line archive member comments are terminated by typing RETURN.
  154. To skip a file comment, just type RETURN without entering any further
  155. characters.
  156.  
  157. The zip archive comment may be multi-line. The comment is ended by a line
  158. containing just a period, or by supplying a ^Z.
  159. <QUALIFIER>
  160. /DELETE
  161.  
  162. /DELETE
  163.  
  164. Delete entries from zip file.
  165. <QUALIFIER>
  166. /DIRNAMES
  167.  
  168. /DIRNAMES (default)
  169. /NODIRNAMES
  170.  
  171. Store directory entries in the archive.
  172. <QUALIFIER>
  173. /ENCRYPT
  174.  
  175. /ENCRYPT[="password"]
  176.  
  177. Encrypt added and updated archive entries.
  178.  
  179. You may specify the password on the command line, although we do not
  180. recommend it since THIS IS INSECURE. Remember to enclose the password
  181. string with quotes, to prevent automatic conversion to upper case or
  182. misinterpretation of punctuation characters by DCL.
  183.  
  184. When the password was not specified, Zip prompts for it on SYS$COMMAND.
  185. For typing the password, terminal echo is suspended. For added user
  186. security, the password prompt appears twice and the two user inputs are
  187. checked for identity before using the password.
  188. <QUALIFIER>
  189. /EXCLUDE
  190.  
  191. /EXCLUDE=(file[,...])
  192.  
  193. A comma-separated list of files to exclude when deleting, updating or
  194. adding files in the archive.
  195. If multiple files are specified, the list should be included in
  196. parentheses.
  197. <QUALIFIER>
  198. /EXLIST
  199.  
  200. /EXLIST=listfile
  201.  
  202. The files matching the filename patterns listed in "listfile" are
  203. excluded when deleting, updating or adding files in the archive.
  204. The "listfile" is a normal text file with one filename pattern entry per
  205. line. The name pattern entries are recognized exactly as found in
  206. "listfile", including leading, embedding and trailing whitespace or most
  207. control characters (with exception of LineFeed and probably CarriageReturn).
  208. <QUALIFIER>
  209. /EXTRA_FIELDS
  210.  
  211. /EXTRA_FIELDS (default)
  212. /NOEXTRA_FIELDS
  213.  
  214. Allows inclusion of extra file attributes information in the zipfile's
  215. entry headers.
  216. Examples are: the VMS attributes (enabled by the /VMS qualifier), or
  217. additional GMT time stamps. These GMT time stamps are quite useful when
  218. transporting a Zip archive world wide, but they are only recognized
  219. by Info-ZIP's UnZip version 5.20 and later, and take up some additional
  220. space.
  221. When /EXTRA_FIELDS is negated, the /VMS qualifier to request saving of the
  222. VMS RMS file attributes is ignored, too!
  223. <QUALIFIER>
  224. /FRESHEN
  225.  
  226. /FRESHEN
  227.  
  228. Freshen existing zipfile entries; replace if newer.  Does not cause any new
  229. files to be added to the archive.
  230. <QUALIFIER>
  231. /FULL_PATH
  232.  
  233. /FULL_PATH  (default)
  234. /NOFULL_PATH
  235.  
  236. Directs Zip to store the directory part of the file names (relative to
  237. the current working directory) in the Zip archive.
  238. <QUALIFIER>
  239. /HELP
  240.  
  241. /HELP
  242.  
  243. Display Zip's help screen, including the version message.
  244. <QUALIFIER>
  245. /INCLUDE
  246.  
  247. /INCLUDE=(file[,...])
  248.  
  249. A comma-separated list of files to include when deleting, updating or
  250. adding files in the archive.
  251. If multiple files are specified, the list should be included in
  252. parentheses.
  253. <QUALIFIER>
  254. /INLIST
  255.  
  256. /INLIST=listfile
  257.  
  258. The files matching the filename patterns listed in "listfile" are
  259. included when deleting, updating or adding files in the archive.
  260. The "listfile" is a normal text file with one filename pattern entry per
  261. line. The name pattern entries are recognized exactly as found in
  262. "listfile", including leading, embedding and trailing whitespace or most
  263. control characters (with exception of LineFeed and probably CarriageReturn).
  264. <QUALIFIER>
  265. /JUNK
  266.  
  267. /JUNK
  268. /NOJUNK (default)
  269.  
  270. Junk the directory part of the file names for added entries (do not
  271. not save the directory structure). The /JUNK qualifier is an alias for
  272. /NOFULL_PATH.
  273. <QUALIFIER>
  274. /KEEP_VERSION
  275.  
  276. /KEEP_VERSION
  277. /NOKEEP_VERSION (default)
  278.  
  279. Directs Zip to include the version number appendix in the stored file names.
  280. This allows to store multiple version of the same file in a single Zip
  281. archive.
  282.  
  283. The normal behaviour of Zip without /KEEP_VERSION is to use only the most
  284. recent version of a specified file and strip of the version number from
  285. the stored file name. This behaviour ensures better compatibility when
  286. transfering a Zip archive to non VMS systems.
  287. <QUALIFIER>
  288. /LATEST
  289.  
  290. /LATEST
  291.  
  292. The archive's creation and modification time is set to the latest
  293. modification time of all archive members.
  294. <QUALIFIER>
  295. /LEVEL
  296.  
  297. /LEVEL=number
  298.  
  299. Specifies the compression level:
  300. <LITERAL>
  301. |  0      Store
  302. |  1      Fastest compression (Defl:F)
  303. |  ...
  304. |  9      Best compression    (Defl:X)
  305. <LARETIL>
  306.  
  307. The default level is 6.
  308. <QUALIFIER>
  309. /LICENSE
  310.  
  311. /LICENSE
  312.  
  313. Displays the Zip license.
  314. <QUALIFIER>
  315. /MOVE
  316.  
  317. /MOVE
  318.  
  319. Move the specified files into the Zip archive.
  320. Entries which have been added (or freshened) to the zip file get removed from
  321. the file system. If a directory is empty afterwards, it is also removed.
  322. <QUALIFIER>
  323. /PKZIP
  324.  
  325. /PKZIP
  326. /NOPKZIP (default)
  327.  
  328. Create PKZIP compatible archive entries.
  329. The file names are truncated and converted to upper case to match the
  330. MSDOS 8+3 file name syntax. Only the MSDOS compatible attributes are stored;
  331. the file owner's write permission is mapped to the "readonly" attribute.
  332. The archive entry is marked as being made under MSDOS regardless of the true
  333. host system of Zip.
  334. <QUALIFIER>
  335. /QUIET
  336.  
  337. /QUIET
  338.  
  339. Perform operations quietly.
  340. <QUALIFIER>
  341. /RECURSE
  342.  
  343. /RECURSE[=KEYWORD]
  344. /NORECURSE (default)
  345.  
  346. Directs Zip to recurse into subdirectories.
  347. The optional keywords recognized are:
  348. <LITERAL>
  349. |  PATH      take patterns as full path specifiers (-r) (default)
  350. |  FILENAMES start from current dir;
  351. |            only use filename part of file patterns (-R)
  352. <LARETIL>
  353. The new FILENAMES optional keyword modifies the recursion algorithm to
  354. be (almost) compatible to PKZIP's behaviour on subdirectory recursion.
  355.  
  356. On VMS, this behaviour can be alternatively archived by using
  357. the "subdirectory recursing wildcard" [...] in the "include files" parameter
  358. list.
  359. <QUALIFIER>
  360. /SINCE
  361.  
  362. /SINCE=(VMS time specification)
  363.  
  364. Only handle files that are newer than the specified date and time.
  365. The specified time is compared with the files' RMS creation time.
  366. <QUALIFIER>
  367. /STORETYPES
  368.  
  369. /STORETYPES=(.ext1,.ext2,... )
  370.  
  371. For files with the specified extensions, Zip does not try to compress the
  372. data but stores them verbatim.  This speeds up operation on files that
  373. have already been compressed and where a second compression step usually
  374. does not gain much space.
  375. The default list of extensions where compression is suppressed is
  376. (.Z,.zip,.zoo,.arc,.arj).
  377.  
  378. But note: when maximum level of compression is requested (/LEVEL=9), the
  379. STORETYPES heuristic is not used. In this case, Zip tries to compress ALL
  380. files.
  381. <QUALIFIER>
  382. /TEMP_PATH
  383.  
  384. /TEMP_PATH=dirspec
  385.  
  386. Specifies an alternate directory where Zip creates its temporary files.
  387. When this qualifier is not given, Zip attempts to write to the current
  388. working directory.
  389. <QUALIFIER>
  390. /TEST
  391.  
  392. /TEST
  393.  
  394. Test archive integrity.
  395. <QUALIFIER>
  396. /TRANSLATE_EOL
  397.  
  398. /TRANSLATE_EOL[=KEYWORD]
  399.  
  400. Selects conversion of the end-of-line markers in text files.
  401. The optional keywords recognized are:
  402. <LITERAL>
  403. |  LF        convert LF -> CRLF (UNIX to DOS) (default)
  404. |  CRLF      convert CRLF -> LF, strip trailing CTRL-Z's (DOS to UNIX)
  405. <LARETIL>
  406.  
  407. This option should only be used with text files. The second option CRLF
  408. is only useful when a DOS text file has been transfered to a VMS disk
  409. in stream (or stream_lf) format.
  410. <QUALIFIER>
  411. /UNSFX
  412.  
  413. /UNSFX
  414.  
  415. Strip any prepended data from the Zip archive, for example a self-extracting
  416. executable stub.
  417. <QUALIFIER>
  418. /UPDATE
  419.  
  420. /UPDATE
  421.  
  422. Freshen existing archive entries; create new ones if needed.
  423. <QUALIFIER>
  424. /VERBOSE
  425.  
  426. /VERBOSE[=MORE|DEBUG]
  427.  
  428. Switch on verbose messages. This includes diagnostics on discovered
  429. oddities in the zipfile's structure, and a progress indicator during
  430. compression operation.
  431.  
  432. When this qualifier is the only command line argument given, it has a special
  433. meaning. In this case a screen of diagnostic information about the program
  434. version is displayed. This display includes the Zip version number and
  435. release date, and it shows some information to determine when and how
  436. the executable was built and set up. This includes info on the used compiler's
  437. name and version, the date of the build (if available), and some optional
  438. compile time feature flags. Additionally, the contents of the environment
  439. variables (=logical names on VMS) that are read by Zip for runtime
  440. configuration are shown.
  441. This information is especially valuable when reporting problems or bugs.
  442.  
  443. <QUALIFIER>
  444. /VMS
  445.  
  446. /VMS
  447.  
  448. Store VMS file attributes in Zip archive.
  449.  
  450. <TOPIC>
  451. Authors
  452.  
  453. Info-ZIP; currently maintained by Onno van der Linden.  VMS support maintained
  454. by Igor Mandrichenko, Christian Spieler, and Hunter Goatley.  Originally based
  455. on a program by Samuel H. Smith.
  456.  
  457. VMS on-line help ported from Zip's MANUAL by Christian Spieler, using
  458. Hunter Goatley's work for UnZip.
  459.  
  460. <TOPIC>
  461. Exit_Codes
  462.  
  463. On VMS, Zip's UNIX style exit values are mapped into proper
  464. VMS status codes:
  465. <LITERAL>
  466. |   1                                  (success)  normal exit,
  467. |   (0x7fff0000 + 16*Zip_error_level)  warnings
  468. |   (0x7fff0002 + 16*Zip_error_level)  normal errors
  469. |   (0x7fff0004 + 16*Zip_error_level)  fatal errors
  470. <LARETIL>
  471.  
  472. The Zip error level (or exit code) approximates the exit
  473. codes defined by PKWARE and takes on the following values:
  474. <LITERAL>
  475. |  VMS       Zip      Type of error
  476. |  severity  errcode
  477. |    -         0      normal; no errors or warnings detected.
  478. |    F         2      unexpected end of zip file.
  479. |    E         3      a generic error in the  zipfile  format  was
  480. |                     detected.   Processing  may  have  completed
  481. |                     successfully anyway;  some  broken  zipfiles
  482. |                     created by other archivers have simple work-
  483. |                     arounds.
  484. |    F         4      zip was unable to allocate memory for one or
  485. |                     more  buffers during program initialization.
  486. |    F         5      a severe error in  the  zipfile  format  was
  487. |                     detected.   Processing probably failed imme-
  488. |                     diately.
  489. |    E         6      entry too large to be split with zipsplit
  490. |    E         7      invalid comment format
  491. |    F         8      zip -T failed, or out of memory
  492. |    E         9      the user aborted zip prematurely  with  con-
  493. |                     trol-C (or similar)
  494. |    F         10     zip  encountered an error while using a temp
  495. |                     file
  496. |    F         11     read or seek error
  497. |    W         12     zip has nothing to do
  498. |    E         13     missing or empty zip file
  499. |    F         14     error writing to a file
  500. |    F         15     zip was unable to create a file for writing
  501. |    E         16     bad command line parameters
  502. |    E         18     zip could not open a specified file to read
  503. <LARETIL>
  504.  
  505. <TOPIC>
  506. Logical_Names
  507.  
  508. Zip scans its process environment for the logical name ZIP_OPTS, which
  509. can be used to specify a string of default options to modify Zip's
  510. behaviour. For the syntax, see help topic UNIX_Options.
  511. With the exception of "-i" and "-x", all recognized UNIX style options
  512. can be used within the ZIP_OPTS equivalence string.
  513.  
  514. For example, the following will cause Zip to skip directories, include
  515. VMS attribute information perform all operations at quiet-level 1 by default:
  516.  
  517. <LITERAL>
  518. |  $ define ZIP_OPTS "-qDV"
  519. <LARETIL>
  520.  
  521. Note that the quotation marks here are required to preserve lowercase options
  522. (opposite of the command-line behavior).
  523.  
  524. ZIP_OPTS may be defined as a symbol rather than a logical, but if both
  525. are defined, the logical is used.
  526.  
  527. The alternative logical name ZIPOPT (more UNIX-like naming convention)
  528. is recognized as well. If both ZIPOPT and ZIP_OPTS are present (and do
  529. not equate to whitespace only), the content of ZIPOPT takes precedence
  530. and ZIP_OPTS is ignored.
  531.  
  532. <TOPIC>
  533. UNIX_Options
  534.  
  535. The default action of Zip is to add or replace zipfile entries from list, which
  536. can include the special name -@ to read names from SYS$INPUT.  The following
  537. list of options was taken from the on-line help generated when Zip is run
  538. with the -h command-line option:
  539.  
  540. <LITERAL>
  541. |  -A   adjust self-extracting exe
  542. |  -b   use "path" for temp files
  543. |  -c   add one-line comments
  544. |  -d   delete entries in zipfile
  545. |  -D   do not add directory entries
  546. |  -e   encrypt
  547. |  -f   freshen: only changed files
  548. |  -F   fix zipfile (-FF try harder)
  549. |  -g   allow growing existing zipfile (unless updating or deleting)
  550. |  -h   show this help
  551. |  -i   include only names matching the following patterns
  552. |  -i@  include only names matching the patterns listed in "file"
  553. |  -j   junk (don't record) directory names
  554. |  -J   junk (remove) prepended (SFX) stub
  555. |  -k   simulate PKZIP made zipfile
  556. |  -l   translate end-of-lines (LF -> CRLF)
  557. |  -ll  translate end-of-lines (CRLF -> LF)
  558. |  -L   show software license
  559. |  -m   move into zipfile (delete files)
  560. |  -n   don't compress theses suffixes
  561. |  -o   make zipfile as old as latest entry
  562. |  -P   encrypt with specified "password"
  563. |  -q   quiet operation
  564. |  -r   recurse into subdirs, match against specified paths
  565. |  -R   recurse into subdirs of current dir, match filenames only
  566. |  -t   only do files after "mmddyyyy"
  567. |  -tt  only do files before "mmddyyyy"
  568. |  -T   test zip file integrity (calls unzip)
  569. |  -u   update: only changed or new files
  570. |  -v   verbose messages/print version info
  571. |  -V   save VMS file attributes
  572. |  -w   append the VMS version number to name stored in zip file
  573. |  -x   exclude names matching the following patterns
  574. |  -x@  exclude names matching the patterns listed in "file"
  575. |  -X   suppress storing of any extra file attributes
  576. |  -z   add zipfile comment
  577. |  -0   store only
  578. |  -1   compress faster
  579. |  -9   compress better
  580. |  -@   read list of files to process from SYS$INPUT
  581. <LARETIL>
  582.  
  583. Note that uppercase options such as -A, -D, -L, -T and -V must be specified
  584. in quotes.  For example:
  585.  
  586. <LITERAL>
  587. |  $ zip "-VD" -a zipfile
  588. <LARETIL>
  589.  
  590. To negate a default option on the command line, add one or more minus signs
  591. before the option letter, in addition to the leading switch character `-':
  592.  
  593. <LITERAL>
  594. |  $ zip --ql zipfile
  595. <LARETIL>
  596.  
  597. or
  598.  
  599. <LITERAL>
  600. |  $ zip -l-q zipfile
  601. <LARETIL>
  602.  
  603. At present it is not possible to decrement an option below zero--that is,
  604. more than a few minuses have no effect.
  605. ===
  606.