home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 9 Archive / 09-Archive.zip / zip21.zip / vms / zip_cli.help < prev    next >
Text File  |  1996-04-14  |  14KB  |  477 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 ZIP.DOC).
  13. .!
  14. .!    To build:
  15. .!        $ EDIT /TPU/NOSECTION/NODISPLAY/COMMAND=CVTHELP.TPU ZIP_CLI.HELP
  16. .!        $ RUNOFF /OUT=ZIP.HLP ZIP_CLI.RNH
  17. .!        $ LIBR /HELP/INSERT libr ZIP
  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. .!
  30. <INIT>
  31. <MAIN>
  32. ZIP
  33.  
  34. Zip is a compression and file packaging utility for Unix, MSDOS, OS/2, and
  35. VMS.  It is analogous to a combination of tar and compress and is
  36. compatible with PKZIP (Phil Katz ZIP) for MSDOS systems.
  37.  
  38. There is a companion to Zip called UnZip (of course).  Zip and UnZip can
  39. work with files produced by PKZIP under MSDOS, and PKZIP and PKUNZIP can
  40. work with files produced by Zip.
  41.  
  42. Zip 2.1 is compatible with PKZIP 2.04.
  43. Note that PKUNZIP 1.10 cannot extract files produced by PKZIP 2.04
  44. or zip 2.1. You must use PKZIP 2.04g or unzip 5.0p1 (or later versions)
  45. to extract them.
  46.  
  47. For a brief help on Zip and Unzip, run each without specifying any
  48. parameters on the command line.
  49.  
  50. Zip puts one or more compressed files into a single "zip file" along with
  51. information about the files, including the name, path if requested, date
  52. and time last modified, protection, and check information to verify the
  53. fidelity of each entry.  Zip can pack an entire directory structure in a
  54. zip file with a single command.  Compression ratios of 2:1 to 3:1 are
  55. common for text files.  Zip has has one compression method (deflation) and
  56. can also store files without compression. It automatically chooses the better
  57. of the two for each file to be compressed.
  58.  
  59. Zip is useful for packaging a set of files to send to someone or for
  60. distribution; for archiving or backing up files; and for saving disk space
  61. by temporarily compressing unused files or directories.
  62.  
  63.  
  64. <FORMAT>
  65. ZIP zipfile [file[,...]] [/qualifiers]
  66.  
  67. .!
  68. <TOPIC>
  69. Parameters
  70.  
  71. <PARAMETER>
  72. zipfile
  73.  
  74. <PTEXT>
  75. File specification for the ZIP archive. Zip will perform the requested action
  76. for every zipfile matching the specification.
  77. The default file specification is SYS$DISK:[].ZIP.
  78.  
  79. Note that self-extracting ZIP files are supported; just specify the .EXE
  80. suffix yourself.
  81. <TXETP>
  82.  
  83. <PARAMETER>
  84. file
  85.  
  86. <PTEXT>
  87. An optional comma-separated list of files to be added or replaced in the
  88. zipfile. For unconditional add / replacement actions, a list must be
  89. specified. For the freshening operation, all archive members are processed
  90. per default; the optional file list restricts processing to the specified
  91. archive members.
  92. Expressions may be used to match multiple members.  For add/update operations,
  93. wildcard expressions are interpreted in  VMS wildcard syntax to match
  94. external files. In contrast, for freshening/deletion operation, wildcard
  95. expressions are interpreted in UNIX compatible syntax to match the
  96. internal names of archive members in the zipfile.
  97. <TXETP>
  98.  
  99. <QUALIFIERS>
  100. <QUALIFIER>
  101. /ADJUST_OFFSETS
  102.  
  103. /ADJUST_OFFSETS
  104.  
  105. Adjust internal offsets of the Zip archive members after some data
  106. (e.g. a SFX executable stub) has been prepended to the archive file.
  107. <QUALIFIER>
  108. /APPEND
  109.  
  110. /APPEND
  111.  
  112. Try to work with the existing Zip archive. Without the /APPEND qualifier,
  113. Zip always creates a backup copy when modifying the archive. This is
  114. slower, but prevents corruption of the old archive in case of a fatal
  115. problem (power failures, program crash...).
  116. <QUALIFIER>
  117. /BATCH
  118.  
  119. /BATCH[=listfile]
  120.  
  121. Read list of files to add/update to the Zip archive from the listfile.
  122. The listfile defaults to SYS$INPUT.
  123. <QUALIFIER>
  124. /COMMENT
  125.  
  126. /COMMENT[=KEYWORD[,KEYWORD]]
  127.  
  128. Add comments to the Zip archive.
  129. <LITERAL>
  130. |  ZIP_FILE  Add or replace the multi line Zip archive comment. (default)
  131. |  FILES     Add a file comment to each updated or added archive member.
  132. <LARETIL>
  133. <QUALIFIER>
  134. /DELETE
  135.  
  136. /DELETE
  137.  
  138. Delete entries from zip file.
  139. <QUALIFIER>
  140. /DIRNAMES
  141.  
  142. /DIRNAMES (default)
  143. /NODIRNAMES
  144.  
  145. Store directory entries in the archive.
  146. <QUALIFIER>
  147. /ENCRYPT
  148.  
  149. /ENCRYPT
  150.  
  151. Encrypt added and updated archive entries.
  152. Zip prompts for a password on SYS$COMMAND. For typing the password, terminal
  153. echo is suspended. For added user security, the password prompt appears twice
  154. and the two user inputs are checked for identity before using the password.
  155. <QUALIFIER>
  156. /EXCLUDE
  157.  
  158. /EXCLUDE=(file[,...])
  159.  
  160. A comma-separated list of files to exclude when deleting, updating or
  161. adding files in the archive.
  162. If multiple files are specified, the list should be included in
  163. parentheses.
  164. <QUALIFIER>
  165. /EXTRA_FIELDS
  166.  
  167. /EXTRA_FIELDS (default)
  168. /NOEXTRA_FIELDS
  169.  
  170. Allows inclusion of extra file attributes information in the zipfile's
  171. entry headers.
  172. Examples are: the VMS attributes (enabled by the /VMS qualifier), or
  173. additional GMT time stamps. These GMT time stamps are quite useful when
  174. transporting a Zip archive world wide, but they are only recognized
  175. by Info-ZIP's UnZip version 5.20 and later, and take up some additional
  176. space.
  177. When /EXTRA_FIELDS is negated, the /VMS qualifier to request saving of the
  178. VMS RMS file attributes is ignored, too!
  179. <QUALIFIER>
  180. /FRESHEN
  181.  
  182. /FRESHEN
  183.  
  184. Freshen existing zipfile entries; replace if newer.  Does not cause any new
  185. files to be added to the archive.
  186. <QUALIFIER>
  187. /FULL_PATH
  188.  
  189. /FULL_PATH  (default)
  190. /NOFULL_PATH
  191.  
  192. Directs Zip to store the directory part of the file names (relative to
  193. the current working directory) in the Zip archive.
  194. <QUALIFIER>
  195. /HELP
  196.  
  197. /HELP
  198.  
  199. Display Zip's help screen, including the version message.
  200. <QUALIFIER>
  201. /INCLUDE
  202.  
  203. /INCLUDE=(file[,...])
  204.  
  205. A comma-separated list of files to include when deleting, updating or
  206. adding files in the archive.
  207. If multiple files are specified, the list should be included in
  208. parentheses.
  209. <QUALIFIER>
  210. /JUNK
  211.  
  212. /JUNK
  213. /NOJUNK (default)
  214.  
  215. Junk the directory part of the file names for added entries (do not
  216. not save the directory structure). The /JUNK qualifier is an alias for
  217. /NOFULL_PATH.
  218. <QUALIFIER>
  219. /KEEP_VERSION
  220.  
  221. /KEEP_VERSION
  222. /NOKEEP_VERSION (default)
  223.  
  224. Directs Zip to include the version number appendix in the stored file names.
  225. This allows to store multiple version of the same file in a single Zip
  226. archive.
  227.  
  228. The normal behaviour of Zip without /KEEP_VERSION is to use only the most
  229. recent version of a specified file and strip of the version number from
  230. the stored file name. This behaviour ensures better compatibility when
  231. transfering a Zip archive to non VMS systems.
  232. <QUALIFIER>
  233. /LATEST
  234.  
  235. /LATEST
  236.  
  237. The archive's creation and modification time is set to the latest
  238. modification time of all archive members.
  239. <QUALIFIER>
  240. /LEVEL
  241.  
  242. /LEVEL=number
  243.  
  244. Specifies the compression level:
  245. <LITERAL>
  246. |  0      Store
  247. |  1      Fastest compression (Defl:F)
  248. |  ...
  249. |  9      Best compression    (Defl:X)
  250. <LARETIL>
  251.  
  252. The default level is 6.
  253. <QUALIFIER>
  254. /LICENSE
  255.  
  256. /LICENSE
  257.  
  258. Displays the Zip license.
  259. <QUALIFIER>
  260. /MOVE
  261.  
  262. /MOVE
  263.  
  264. Move the specified files into the Zip archive.
  265. Entries which have been added (or freshened) to the zip file get removed from
  266. the file system. If a directory is empty afterwards, it is also removed.
  267. <QUALIFIER>
  268. /PKZIP
  269.  
  270. /PKZIP
  271. /NOPKZIP
  272.  
  273. Create PKZIP compatible archive entries.
  274. The file names are truncated and converted to upper case to match the
  275. MSDOS 8+3 file name syntax. Only the MSDOS compatible attributes are stored;
  276. the file owner's write permission is mapped to the "readonly" attribute.
  277. The archive entry is marked as being made under MSDOS regardless of the true
  278. host system of Zip.
  279. <QUALIFIER>
  280. /QUIET
  281.  
  282. /QUIET
  283.  
  284. Perform operations quietly.
  285. <QUALIFIER>
  286. /RECURSE
  287.  
  288. /RECURSE
  289. /NORECURSE
  290.  
  291. Directs Zip to recurse into subdirectories.
  292. On VMS, this behaviour can be alternatively archived by using
  293. the "subdirectory recursing wildcard" [...] in the "include files" parameter
  294. list.
  295. <QUALIFIER>
  296. /SINCE
  297.  
  298. /SINCE=(VMS time specification)
  299.  
  300. Only handle files that are newer than the specified date and time.
  301. <QUALIFIER>
  302. /STORETYPES
  303.  
  304. /STORETYPES=(.ext1,.ext2,... )
  305.  
  306. For files with the specified extensions, Zip does not try to compress the
  307. data but stores them verbatim.  This speeds up operation on files that
  308. have already been compressed and where a second compression step usually
  309. does not gain much space.
  310. The default list of extensions where compression is suppressed is
  311. (.Z,.zip,.zoo,.arc,.arj).
  312.  
  313. But note: when maximum level of compression is requested (/LEVEL=9), the
  314. STORETYPES heuristic is not used. In this case, Zip tries to compress ALL
  315. files.
  316. <QUALIFIER>
  317. /TEMP_PATH
  318.  
  319. /TEMP_PATH=(dirspec)
  320.  
  321. Specifies an alternate directory where Zip creates its temporary files.
  322. When this qualifier is not given, Zip attempts to write to the current
  323. working directory.
  324. <QUALIFIER>
  325. /TEST
  326.  
  327. /TEST
  328.  
  329. Test archive integrity.
  330. <QUALIFIER>
  331. /TRANSLATE_EOL
  332.  
  333. /TRANSLATE_EOL[=KEYWORD]
  334.  
  335. Selects conversion of the end-of-line markers in text files.
  336. The optional keywords recognized are:
  337. <LITERAL>
  338. |  LF        convert LF -> CRLF (UNIX convention to DOS convention) (default)
  339. |  CRLF      convert CRLF -> LF, and strip any trailing CTRL-Z (DOS to UNIX).
  340. <LARETIL>
  341.  
  342. This option should only be used with text files. The second option CRLF
  343. is only useful when a DOS text file has been transfered to a VMS disk
  344. in stream (or stream_lf) format.
  345. <QUALIFIER>
  346. /UNSFX
  347.  
  348. /UNSFX
  349.  
  350. Strip any prepended data from the Zip archive, for example a self-extracting
  351. executable stub.
  352. <QUALIFIER>
  353. /UPDATE
  354.  
  355. /UPDATE
  356.  
  357. Freshen existing archive entries; create new ones if needed.
  358. <QUALIFIER>
  359. /VERBOSE
  360.  
  361. /VERBOSE[=MORE|DEBUG]
  362.  
  363. Switch on verbose messages. This includes diagnostics on discovered
  364. oddities in the zipfile's structure, and a progress indicator during
  365. compression operation.
  366.  
  367. When this qualifier is the only command line argument given, it has a special
  368. meaning. In this case a screen of diagnostic information about the program
  369. version is displayed. This display includes the Zip version number and
  370. release date, and it shows some information to determine when and how
  371. the executable was built and set up. This includes info on the used compiler's
  372. name and version, the date of the build (if available), and some optional
  373. compile time feature flags. Additionally, the contents of the environment
  374. variables (=logical names on VMS) that are read by Zip for runtime
  375. configuration are shown.
  376. This information is especially valuable when reporting problems or bugs.
  377.  
  378. <QUALIFIER>
  379. /VMS
  380.  
  381. /VMS
  382.  
  383. Store VMS file attributes in Zip archive.
  384.  
  385. <TOPIC>
  386. Authors
  387.  
  388. Info-ZIP; currently maintained by Onno van der Linden.  VMS support maintained
  389. by Igor Mandrichenko, Christian Spieler, and Hunter Goatley.  Originally based
  390. on a program by Samuel H. Smith.
  391.  
  392. VMS on-line help ported from ZIP.DOC by Christian Spieler, using
  393. Hunter Goatley's work for UnZip.
  394.  
  395. <TOPIC>
  396. UNIX_Options
  397.  
  398. The default action of Zip is to add or replace zipfile entries from list, which
  399. can include the special name -@ to read names from SYS$INPUT.  The following
  400. list of options was taken from the on-line help generated when Zip is run
  401. without any command-line parameters:
  402.  
  403. <LITERAL>
  404. |  -A   adjust self-extracting exe
  405. |  -b   use "path" for temp files
  406. |  -c   add one-line comments
  407. |  -d   delete entries in zipfile
  408. |  -D   do not add directory entries
  409. |  -e   encrypt
  410. |  -f   freshen: only changed files
  411. |  -F   fix zipfile (-FF try harder)
  412. |  -g   allow growing existing zipfile
  413. |  -h   show this help
  414. |  -i   include only the following names
  415. |  -j   junk (don't record) directory names
  416. |  -J   junk (remove) prepended (SFX) stub
  417. |  -k   simulate PKZIP made zipfile
  418. |  -l   translate end-of-lines (LF -> CRLF)
  419. |  -ll  translate end-of-lines (CRLF -> LF)
  420. |  -L   show software license
  421. |  -m   move into zipfile (delete files)
  422. |  -n   don't compress theses suffixes
  423. |  -o   make zipfile as old as latest entry
  424. |  -q   quiet operation
  425. |  -r   recurse into directories
  426. |  -t   only do files after "mmddyy"
  427. |  -T   test zip file integrity
  428. |  -u   update: only changed or new files
  429. |  -v   verbose messages/print version info
  430. |  -V   save VMS file attributes
  431. |  -w   append the VMS version number to name stored in zip file
  432. |  -x   exclude the names that follow from those operated on
  433. |  -X   suppress storing of any extra file attributes
  434. |  -z   add zipfile comment
  435. |  -0   store only
  436. |  -1   compress faster
  437. |  -9   compress better
  438. <LARETIL>
  439.  
  440. Note that uppercase options such as -A, -D, -L, -T and -V must be specified
  441. in quotes.  For example:
  442.  
  443. <LITERAL>
  444. |  $ zip "-VD" -a zipfile
  445. <LARETIL>
  446.  
  447. .![this should probably be a separate section]:
  448. In addition, default options may be specified via the ZIP_OPTS logical.
  449. For example, the following will cause Zip to skip directories, include
  450. VMS attribute information perform all operations at quiet-level 1 by default:
  451.  
  452. <LITERAL>
  453. |  $ define ZIP_OPTS "-qDV"
  454. <LARETIL>
  455.  
  456. Note that the quotation marks here are required to preserve lowercase options
  457. (opposite of the command-line behavior). To negate a default option on the
  458. command line, add one or more minus  signs before the option letter, in
  459. addition to the leading switch character `-':
  460.  
  461. <LITERAL>
  462. |  $ zip --ql zipfile
  463. <LARETIL>
  464.  
  465. or
  466.  
  467. <LITERAL>
  468. |  $ zip -l-q zipfile
  469. <LARETIL>
  470.  
  471. At present it is not possible to decrement an option below zero--that is,
  472. more than a few minuses have no effect.
  473.  
  474. ZIP_OPTS may be defined as a symbol rather than a logical, but if both
  475. are defined, the logical is used.
  476. ===
  477.