Name
WinZip can encrypt files while you create new Zip files (.zip or.zipx) and it can also add encryption to data in existing Zip files. Encrypt while creating Zip files. WinZip in the Default view: Click the Encrypt toggle in the Actions pane; If you have not already done so, click the Options button that now displays in the Actions pane to set. A zip file takes one or more files and folders on your computer, joins them into one file for convenience sake and compresses them to save storage space. Modern operating systems, including Microsoft Windows and Apple macOS, have built-in support for zip files, so you can open them and create them without any special tools. WinZip is the world's #1 choice when working with large files – zip, unzip, protect, share and more. Zip and unzip files instantly; Protect files with banking-level AES encryption; Share directly to iCloud Drive, Dropbox, Google Drive and ZipShare, from within WinZip; Download Trial It's free, go for it Buy Now Starts at. With WinZip for Mac 2.0 or later, you can right-click (or press CTRL and click) your saved RAR files and use the Context Menu to unzip them. Click on Services at the bottom of the Context menu, then choose Unzip.
ZIP files can contain multiple files of different types. Common files that can be included in a ZIP archive include PDFs, images, videos, and Microsoft Office documents including Microsoft Word, Microsoft Excel, and Microsoft PowerPoint (.DOCX,.XLSX,.PPTX file formats).
zip - package and compress (archive) files
Synopsis
zip [-aABcdDeEfFghjklLmoqrRSTuvVwXyz!@$] [--longoption ...] [-b path] [-n suffixes] [-t date] [-tt date][zipfile [file ...]] [-xi list]
zipcloak (see separate man page)
zipnote (see separate man page)
zipsplit (see separate man page)
Note: Command line processing in zip has been changed to support long options and handle all options and arguments more consistently. Some oldcommand lines that depend on command line inconsistencies may no longer work.
Description
zip is a compression and file packaging utility for Unix, VMS, MSDOS, OS/2, Windows 9x/NT/XP, Minix, Atari, Macintosh, Amiga, and Acorn RISC OS. Itis analogous to a combination of the Unix commands tar(1) and compress(1) and is compatible with PKZIP (Phil Katz's ZIP for MSDOS systems).
A companion program (unzip(1L)) unpacks zip archives. The zip and unzip(1L) programs can work with archives produced by PKZIP(supporting most PKZIP features up to PKZIP version 4.6), and PKZIP and PKUNZIP can work with archives produced by zip (with some exceptions, notablystreamed archives, but recent changes in the zip file standard may facilitate better compatibility). zip version 3.0 is compatible with PKZIP 2.04 andalso supports the Zip64 extensions of PKZIP 4.5 which allow archives as well as files to exceed the previous 2 GB limit (4 GB in some cases). zip alsonow supports bzip2 compression if the bzip2 library is included when zip is compiled. Note that PKUNZIP 1.10 cannot extract files producedby PKZIP 2.04 or zip 3.0. You must use PKUNZIP 2.04g or unzip 5.0p1 (or later versions) to extract them.
See the EXAMPLES section at the bottom of this page for examples of some typical uses of zip.
Large Archives and Zip64.zip automatically uses the Zip64 extensions when files larger than 4 GB are added to an archive, an archivecontaining Zip64 entries is updated (if the resulting archive still needs Zip64), the size of the archive will exceed 4 GB, or when the number of entries inthe archive will exceed about 64K. Zip64 is also used for archives streamed from standard input as the size of such archives are not known in advance, but theoption -fz- can be used to force zip to create PKZIP 2 compatible archives (as long as Zip64 extensions are not needed). You must use a PKZIP 4.5compatible unzip, such as unzip 6.0 or later, to extract files using the Zip64 extensions.
In addition, streamed archives, entries encrypted with standard encryption, or split archives created with the pause option may not be compatible with PKZIPas data descriptors are used and PKZIP at the time of this writing does not support data descriptors (but recent changes in the PKWare published zip standardnow include some support for the data descriptor format zip uses).
Mac OS X. Though previous Mac versions had their own zip port, zip supports Mac OS X as part of the Unix port and most Unix featuresapply. References to 'MacOS' below generally refer to MacOS versions older than OS X. Support for some Mac OS features in the Unix Mac OS X port, such asresource forks, is expected in the next zip release.
For a brief help on zip and unzip, run each without specifying any parameters on the command line.
Use
The program is useful for packaging a set of files for distribution; for archiving files; and for saving disk space by temporarily compressing unused filesor directories.
The zip program puts one or more compressed files into a single zip archive, along with information about the files (name, path, date, time oflast modification, protection, and check information to verify file integrity). An entire directory structure can be packed into a zip archive with asingle command. Compression ratios of 2:1 to 3:1 are common for text files. zip has one compression method (deflation) and can also store files withoutcompression. (If bzip2 support is added, zip can also compress using bzip2 compression, but such entries require a reasonably modern unzipto decompress. When bzip2 compression is selected, it replaces deflation as the default method.) zip automatically chooses the better of the two(deflation or store or, if bzip2 is selected, bzip2 or store) for each file to be compressed.
Command format. The basic command format is
So if before the zip command is executed foo.zip has:
-@ file lists. If a file list is specified as -@ [Not on MacOS], zip takes the list of input files from standard input instead of fromthe command line. For example,
Under Unix, this option can be used to powerful effect in conjunction with the find (1) command. For example, to archive all the C source files inthe current directory and its subdirectories:
Streaming input and output.zip will also accept a single dash ('-') as the zip file name, in which case it will write the zip file tostandard output, allowing the output to be piped to another program. For example:
zip also accepts a single dash ('-') as the name of a file to be compressed, in which case it will read the file from standard input, allowing zip totake input from another program. For example:
If Zip64 support for large files and archives is enabled and zip is used as a filter, zip creates a Zip64 archive that requires a PKZIP 4.5 orlater compatible unzip to read it. This is to avoid amgibuities in the zip file structure as defined in the current zip standard (PKWARE AppNote) where thedecision to use Zip64 needs to be made before data is written for the entry, but for a stream the size of the data is not known at that point. If the data isknown to be smaller than 4 GB, the option -fz- can be used to prevent use of Zip64, but zip will exit with an error if Zip64 was in fact needed.zip 3 and unzip 6 and later can read archives with Zip64 entries. Also, zip removes the Zip64 extensions if not needed when archiveentries are copied (see the -U (--copy) option).
When directing the output to another file, note that all options should be before the redirection including -x. For example:
If the name of the zip archive does not contain an extension, the extension .zip is added. If the name already contains an extension otherthan .zip, the existing extension is kept unchanged. However, split archives (archives split over multiple files) require the .zip extension onthe last split.
Scanning and reading files. When zip starts, it scans for files to process (if needed). If this scan takes longer than about 5 seconds,zip will display a 'Scanning files' message and start displaying progress dots every 2 seconds or every so many entries processed, whichever takeslonger. If there is more than 2 seconds between dots it could indicate that finding each file is taking time and could mean a slow network connection forexample. (Actually the initial file scan is a two-step process where the directory scan is followed by a sort and these two steps are separated with a space inthe dots. If updating an existing archive, a space also appears between the existing file scan and the new file scan.) The scanning files dots are notcontrolled by the -ds dot size option, but the dots are turned off by the -q quiet option. The -sf show files option can be used to scanfor files and get the list of files scanned without actually processing them.
If zip is not able to read a file, it issues a warning but continues. See the -MM option below for more on how zip handles patternsthat are not matched and files that are not readable. If some files were skipped, a warning is issued at the end of the zip operation noting how many fileswere read and how many skipped.
Command modes.zip now supports two distinct types of command modes, external and internal. The external modes (add,update, and freshen) read files from the file system (as well as from an existing archive) while the internal modes (delete and copy) operateexclusively on entries in an existing archive.
Also see -DF for creating difference archives.
See each option description below for details and the EXAMPLES section below for examples.
Split archives.zip version 3.0 and later can create split archives. A split archive is a standard zip archive split over multiplefiles. (Note that split archives are not just archives split in to pieces, as the offsets of entries are now based on the start of each split. Concatenatingthe pieces together will invalidate these offsets, but unzip can usually deal with it. zip will usually refuse to process such a spliced archiveunless the -FF fix option is used to fix the offsets.)
One use of split archives is storing a large archive on multiple removable media. For a split archive with 20 split files the files are typically named(replace ARCHIVE with the name of your archive) ARCHIVE.z01, ARCHIVE.z02, ..., ARCHIVE.z19, ARCHIVE.zip. Note that the last file is the .zip file. Incontrast, spanned archives are the original multi-disk archive generally requiring floppy disks and using volume labels to store disk numbers.zip supports split archives but not spanned archives, though a procedure exists for converting split archives of the right size to spanned archives. Thereverse is also true, where each file of a spanned archive can be copied in order to files with the above names to create a split archive.
Use -s to set the split size and create a split archive. The size is given as a number followed optionally by one of k (kB), m (MB), g (GB), or t(TB) (the default is m). The -sp option can be used to pause zip between splits to allow changing removable media, for example, but read thedescriptions and warnings for both -s and -sp below.
Though zip does not update split archives, zip provides the new option -O (--output-file or --out) to allow splitarchives to be updated and saved in a new archive. For example,
Unicode. Though the zip standard requires storing paths in an archive using a specific character set, in practice zips have stored paths in archivesin whatever the local character set is. This creates problems when an archive is created or updated on a system using one character set and then extracted onanother system using a different character set. When compiled with Unicode support enabled on platforms that support wide characters, zip now stores, inaddition to the standard local path for backward compatibility, the UTF-8 translation of the path. This provides a common universal character set for storingpaths that allows these paths to be fully extracted on other systems that support Unicode and to match as close as possible on systems that don't.
On Win32 systems where paths are internally stored as Unicode but represented in the local character set, it's possible that some paths will be skippedduring a local character set directory scan. zip with Unicode support now can read and store these paths. Note that Win 9x systems and FAT file systemsdon't fully support Unicode.
Be aware that console windows on Win32 and Unix, for example, sometimes don't accurately show all characters due to how each operating system switches incharacter sets for display. However, directory navigation tools should show the correct paths if the needed fonts are loaded.
Command line format. This version of zip has updated command line processing and support for long options.
Short options take the form
Long options take the form
Long option names can be shortened to the shortest unique abbreviation. See the option descriptions below for which support long options. To avoidconfusion, avoid abbreviating a negatable option with an embedded dash ('-') at the dash if you plan to negate it (the parser would consider a trailing dash,such as for the option --some-option using --some- as the option, as part of the name rather than a negating dash). This may be changed to forcethe last dash in --some- to be negating in the future.
Options
The archive bit is set by the operating system when a file is modified and, if used with -AC, -AS can provide an incremental backupcapability. However, other applications can modify the archive bit and it may not be a reliable indicator of which files have changed since the last archiveoperation. Alternative ways to create incremental backups are using -t to use file dates, though this won't catch old files copied to directories beingarchived, and -DF to create a differential archive.
[TANDEM] set Edit/Enscribe formatting options with n defined as
zip -b /tmp stuff *
- will remove the entry foo/tom/junk, all of the files that start with foo/harry/, and all of the files that end with .o (in any path).Note that shell pathname expansion has been inhibited with backslashes, so that zip can see the asterisks, enabling zip to match on the contentsof the zip archive instead of the contents of the current directory. (The backslashes are not used on MSDOS-based platforms.) Can also use quotes toescape the asterisks as in
zip -d foo foo/tom/junk 'foo/harry/*' '*.o'
Not escaping the asterisks on a system where the shell expands wildcards could result in the asterisks being converted to a list of files in the currentdirectory and that list used to delete entries from the archive.Under MSDOS, -d is case sensitive when it matches names in the zip archive. This requires that file names be entered in upper case if theywere zipped by PKZIP on an MSDOS system. (We considered making this case insensitive on systems where paths were case insensitive, but it is possible thearchive came from a system where case does matter and the archive could include both Bar and bar as separate files in the archive.) But see thenew option -ic to ignore case in the archive.
This option does not control the dots from the 'Scanning files' message as zip scans for input files. The dot size for that is fixed at 2 seconds ora fixed number of entries, whichever is longer.
ZIPOPT='-D'; export ZIPOPT
(The variable ZIPOPT can be used for any option, including -i and -x using a new option format detailed below, and can include severaloptions.) The option -D is a shorthand for -x '*/' but the latter previously could not be set as default in the ZIPOPT environment variable asthe contents of ZIPOPT gets inserted near the beginning of the command line and the file list had to end at the end of the line.This version of zip does allow -x and -i options in ZIPOPT if the form
-x file file ... @
is used, where the @ (an argument that is just @) terminates the list.
zip -r foofull .
- -F
- --fix
- -FF
- --fixfix
- Fix the zip archive. The -F option can be used if some portions of the archive are missing, but requires a reasonably intact centraldirectory. The input archive is scanned as usual, but zip will ignore some problems. The resulting archive should be valid, but any inconsistent entrieswill be left out. When doubled as in -FF, the archive is scanned from the beginning and zip scans for special signatures to identify the limits between thearchive members. The single -F is more reliable if the archive is not too much damaged, so try this option first.
- --filesync
- Synchronize the contents of an archive with the files on the OS. Normally when an archive is updated, new files are added and changed files are updated butfiles that no longer exist on the OS are not deleted from the archive. This option enables a new mode that checks entries in the archive against the filesystem. If the file time and file size of the entry matches that of the OS file, the entry is copied from the old archive instead of being read from the filesystem and compressed. If the OS file has changed, the entry is read and compressed as usual. If the entry in the archive does not match a file on the OS, theentry is deleted. Enabling this option should create archives that are the same as new archives, but since existing entries are copied instead of compressed,updating an existing archive with -FS can be much faster than creating a new archive. Also consider using -u for updating an archive. For this option to work, the archive should be updated from the same directory it was created in so the relative paths match. If few files are being copiedfrom the old archive, it may be faster to create a new archive instead.
- -g
- --grow
- Grow (append to) the specified zip archive, instead of creating a new one. If this operation fails, zip attempts to restore the archive to itsoriginal state. If the restoration fails, the archive might become corrupted. This option is ignored when there's no existing archive or when at least onearchive member must be updated or deleted. -h
- --help
- Display the zip help information (this also appears if zip is run with no arguments).
- -h2
- --more-help
- Display extended help including more on command line format, pattern matching, and more obscure options.
- -i files
- --include files
- Include only the specified files, as in:
- PKZIP does not allow recursion in directories other than the current one.) The backslash avoids the shell filename substitution, so that the name matchingis performed by zip at all directory levels. [This is for Unix and other systems where escapes the next character. For other systems where the shelldoes not process * do not use and the above is
- or
- is used.] Note that currently the trailing / is needed for directories (as in
- (no space between option and value) or
- -I
- --no-image [Acorn RISC OS] Don't scan through Image files. When used, zip will not consider Image files (eg. DOS partitions or Spark archives when SparkFS isloaded) as directories but will store them as single files.
- -ic
- --ignore-case
- [VMS, WIN32] Ignore case when matching archive entries. This option is only available on systems where the case of files is ignored. On systems withcase-insensitive file systems, case is normally ignored when matching files on the file system but is not ignored for -f (freshen), -d (delete), -U (copy), andsimilar modes when matching against archive entries (currently -f ignores case on VMS) because archive entries can be from systems where case does matter andnames that are the same except for case can exist in an archive. The -ic option makes all matching case insensitive. This can result in multiple archiveentries matching a command line pattern.
- -j
- --junk-paths
- Store just the name of a saved file (junk the path), and do not store directory names. By default, zip will store the full path (relative to thecurrent directory).
- -jj
- --absolute-path
- [MacOS] record Fullpath (+ Volname). The complete path including volume will be stored. By default the relative path will be stored.
- -J
- --junk-sfx
- Strip any prepended data (e.g. a SFX stub) from the archive.
- -k
- --DOS-names
- Attempt to convert the names and paths to conform to MSDOS, store only the MSDOS attribute (just the user write attribute from Unix), and mark the entry asmade under MSDOS (even though it was not); for compatibility with PKUNZIP under MSDOS which cannot handle certain names such as those with two dots.
- -l
- --to-crlf
- Translate the Unix end-of-line character LF into the MSDOS convention CR LF. This option should not be used on binary files. This option can be used on Unixif the zip file is intended for PKUNZIP under MSDOS. If the input files already contain CR LF, this option adds an extra CR. This is to ensure that unzip-a on Unix will get back an exact copy of the original file, to undo the effect of zip -l. See -ll for how binary files are handled.
- -la
- --log-append
- Append to existing logfile. Default is to overwrite.
- -lf logfilepath
- --logfile-path logfilepath
- Open a logfile at the given path. By default any existing file at that location is overwritten, but the -la option will result in an existing filebeing opened and the new log information appended to any existing information. Only warnings and errors are written to the log unless the -li option isalso given, then all information messages are also written to the log.
- -li
- --log-info
- Include information messages, such as file names being zipped, in the log. The default is to only include the command line, any warnings and errors, and thefinal status.
- -ll
- --from-crlf
- Translate the MSDOS end-of-line CR LF into Unix LF. This option should not be used on binary files. This option can be used on MSDOS if the zip file isintended for unzip under Unix. If the file is converted and the file is later determined to be binary a warning is issued and the file is probably corrupted.In this release if -ll detects binary in the first buffer read from a file, zip now issues a warning and skips line end conversion on the file.This check seems to catch all binary files tested, but the original check remains and if a converted file is later determined to be binary that warning isstill issued. A new algorithm is now being used for binary detection that should allow line end conversion of text files in UTF-8 and similarencodings.
- -L
- --license
- Display the zip license.
- -m
- --move
- Move the specified files into the zip archive; actually, this deletes the target directories/files after making the specified zip archive. Ifa directory becomes empty after removal of the files, the directory is also removed. No deletions are done until zip has created the archive withouterror. This is useful for conserving disk space, but is potentially dangerous so it is recommended to use it in combination with -T to test the archivebefore removing all input files.
- -MM
- --must-match
- All input patterns must match at least one file and all input files found must be readable. Normally when an input pattern does not match a file the 'namenot matched' warning is issued and when an input file has been found but later is missing or not readable a missing or not readable warning is issued. Ineither case zip continues creating the archive, with missing or unreadable new files being skipped and files already in the archive remaining unchanged.After the archive is created, if any files were not readable zip returns the OPEN error code (18 on most systems) instead of the normal success return(0 on most systems). With -MM set, zip exits as soon as an input pattern is not matched (whenever the 'name not matched' warning would be issued)or when an input file is not readable. In either case zip exits with an OPEN error and no archive is created.
- This option is useful when a known list of files is to be zipped so any missing or unreadable files will result in an error. It is less useful when usedwith wildcards, but zip will still exit with an error if any input pattern doesn't match at least one file and if any matched files are unreadable. Ifyou want to create the archive anyway and only need to know if files were skipped, don't use -MM and just check the return code. Also -lf couldbe useful.
- -n suffixes
- --suffixes suffixes
- Do not attempt to compress files named with the given suffixes. Such files are simply stored (0% compression) in the output zip file, so thatzip doesn't waste its time trying to compress them. The suffixes are separated by either colons or semicolons. For example:
- -O output-file
- --output-file output-file Process the archive changes as usual, but instead of updating the existing archive, output the new archive to output-file. Useful for updating an archivewithout changing the existing archive and the input archive must be a different file than the output archive.
- bit 1: Add headers for all files
- bit 2: Don't wait for interactive key press on exit
- -r
- --recurse-paths
- Travel the directory structure recursively; for example:
- -R
- --recurse-patterns
- Travel the directory structure recursively starting at the current directory; for example:
- Patterns are relative file paths as they appear in the archive, or will after zipping, and can have optional wildcards in them. For example, given thecurrent directory is foo and under it are directories foo1 and foo2 and in foo1 is the file bar.c,
- -s splitsize
- --split-size splitsize Enable creating a split archive and set the split size. A split archive is an archive that could be split over many files. As the archive is created, if thesize of the archive reaches the specified split size, that split is closed and the next split opened. In general all splits but the last will be the split sizeand the last will be whatever is left. If the entire archive is smaller than the split size a single-file archive is created.
- Also see -U (--copy) for more on using copy mode.
- -sb
- --split-bell
- If splitting and using split pause mode, ring the bell when zip pauses for each split destination.
- -sc
- --show-command
- Show the command line starting zip as processed and exit. The new command parser permutes the arguments, putting all options and any valuesassociated with them before any non-option arguments. This allows an option to appear anywhere in the command line as long as any values that go with theoption go with it. This option displays the command line as zip sees it, including any arguments from the environment such as from the ZIPOPTvariable. Where allowed, options later in the command line can override options earlier in the command line.
- -sf
- --show-files
- Show the files that would be operated on, then exit. For instance, if creating a new archive, this will list the files that would be added. If the option isnegated, -sf-, output only to an open log file. Screen display is not recommended for large lists.
- -so
- --show-options
- Show all available options supported by zip as compiled on the current system. As this command reads the option table, it should include all options.Each line includes the short option (if defined), the long option (if defined), the format of any value that goes with the option, if the option can benegated, and a small description. The value format can be no value, required value, optional value, single character value, number value, or a list of values.The output of this option is not intended to show how to use any option but only show what options are available.
- -sp
- --split-pause If splitting is enabled with -s, enable split pause mode. This creates split archives as -s does, but stream writing is used so each split canbe closed as soon as it is written and zip will pause between each split to allow changing split destination or media.
- -su
- --show-unicode
- As -sf, but also show Unicode version of the path if exists.
- -sU
- --show-just-unicode
- As -sf, but only show Unicode version of the path if exists, otherwise show the standard version of the path.
- -sv
- --split-verbose
- Enable various verbose messages while splitting, showing how the splitting is being done.
- -S
- --system-hidden
- [MSDOS, OS/2, WIN32 and ATARI] Include system and hidden files.
- [MacOS] Includes finder invisible files, which are ignored otherwise.
- -t mmddyyyy
- --from-date mmddyyyy
- Do not operate on files modified prior to the specified date, where mm is the month (00-12), dd is the day of the month (01-31), andyyyy is the year. The ISO 8601 date format yyyy-mm-dd is also accepted. For example:
- -u
- --update
- Replace (update) an existing entry in the zip archive only if it has been modified more recently than the version already in the zip archive.For example:
- -U
- --copy-entries
- Copy entries from one archive to another. Requires the --out option to specify a different output file than the input archive. Copy mode is thereverse of -d delete. When delete is being used with --out, the selected entries are deleted from the archive and all other entries are copied tothe new archive, while copy mode selects the files to include in the new archive. Unlike -u update, input patterns on the command line are matchedagainst archive entries only and not the file system files. For instance,
- This is useful for changing split size for instance. Encrypting and decrypting entries is not yet supported using copy mode. Use zipcloak forthat.
- -UN v
- --unicode v Determine what zip should do with Unicode file names. zip 3.0, in addition to the standard file path, now includes the UTF-8 translation ofthe path if the entry path is not entirely 7-bit ASCII. When an entry is missing the Unicode path, zip reverts back to the standard file path. Theproblem with using the standard path is this path is in the local character set of the zip that created the entry, which may contain characters that are notvalid in the character set being used by the unzip. When zip is reading an archive, if an entry also has a Unicode path, zip now defaults tousing the Unicode path to recreate the standard path using the current local character set.
- as in
- forces zip to store UTF-8 as native in the archive. Note that storing UTF-8 directly is the default on Unix systems that support it. This optioncould be useful on Windows systems where the escaped path is too large to be a valid path and the UTF-8 version of the path is smaller, but native UTF-8 is notbackward compatible on Windows systems.
- -v
- --verbose
- Verbose mode or print diagnostic version info. Normally, when applied to real operations, this option enables the display of a progress indicator during compression (see -dd for more on dots) andrequests verbose diagnostic info about zipfile structure oddities.
- -V
- --VMS-portable
- [VMS] Save VMS file attributes. (Files are truncated at EOF.) When a -V archive is unpacked on a non-VMS system, some file types (notably Stream_LF textfiles and pure binary files like fixed-512) should be extracted intact. Indexed files and file types with embedded record sizes (notably variable-length recordtypes) will probably be seen as corrupt elsewhere.
- -VV
- --VMS-specific
- [VMS] Save VMS file attributes, and all allocated blocks in a file, including any data beyond EOF. Useful for moving ill-formed files among VMS systems.When a -VV archive is unpacked on a non-VMS system, almost all files will appear corrupt.
- -w
- --VMS-versions
- [VMS] Append the version number of the files to the name, including multiple versions of files. Default is to use only the most recent version of aspecified file.
- -ww
- --VMS-dot-versions
- [VMS] Append the version number of the files to the name, including multiple versions of files, using the .nnn format. Default is to use only the mostrecent version of a specified file.
- -ws
- --wild-stop-dirs
- Wildcards match only at a directory level. Normally zip handles paths as strings and given the paths
- and
- If there is no space between -x and the pattern, just one value is assumed (no list):
- See -i for more on include and exclude.
- -X
- --no-extra Do not save extra file attributes (Extended Attributes on OS/2, uid/gid and file times on Unix). The zip format uses extra fields to include additionalinformation for each entry. Some extra fields are specific to particular systems while others are applicable to all systems. Normally when zip readsentries from an existing archive, it reads the extra fields it knows, strips the rest, and adds the extra fields applicable to that system. With -X,zip strips all old fields and only includes the Unicode and Zip64 extra fields (currently these two extra fields cannot be disabled).
- -y
- --symlinks
- For UNIX and VMS (V8.3 and later), store symbolic links as such in the zip archive, instead of compressing and storing the file referred to by thelink. This can avoid multiple copies of files being included in the archive as zip recurses the directory trees and accesses files directly and bylinks.
- -z
- --archive-comment
- Prompt for a multi-line comment for the entire zip archive. The comment is ended by a line containing just a period, or an end of file condition (^Don Unix, ^Z on MSDOS, OS/2, and VMS). The comment can be taken from a file:
- -Z cm
- --compression-method cm Set the default compression method. Currently the main methods supported by zip are store and deflate. Compression method can be setto:
- zip stuff .* * Even this will not include any subdirectories from the current directory.
- zip -r foo foo creates the archive foo.zip, containing all the files and directories in the directory foo that is contained within the current directory.
- zip -j foo foo/*
- If you are short on disk space, you might not have enough room to hold both the original directory and the corresponding compressed zip archive. Inthis case, you can create the archive in steps using the -m option. If foo contains the subdirectories tom, dick, and harry,you can:
- zip -rm foo foo/tom
zip -rm foo foo/dick
zip -rm foo foo/harry where the first command creates foo.zip, and the next two add to it. At the completion of each zip command, the last created archive isdeleted, making room for the next zip command to function. - zip -s 2g -r split.zip foo creates a split archive of the directory foo with splits no bigger than 2 GB each. If foo contained 5 GB of contents and the contents were stored in thesplit archive without compression (to make this example simple), this would create three splits, split.z01 at 2 GB, split.z02 at 2 GB, and split.zip at alittle over 1 GB.
- zip inarchive.zip foo.c bar.c --out outarchive.zip
- reads archive inarchive.zip, even if split, adds the files foo.c and bar.c, and writes the resulting archive to outarchive.zip.If inarchive.zip is split then outarchive.zip defaults to the same split size. Be aware that outarchive.zip and any split files that arecreated with it are always overwritten without warning. This may be changed in the future.
The format is TTThhDDD, where TTT is the time zone such as MET, hh is the difference between GMT and local time such as -1 above, and DDD is the time zonewhen daylight savings time is in effect. Leave off the DDD if there is no daylight savings time. For the US Eastern time zone EST5EDT.
If the archive is too damaged or the end has been truncated, you must use -FF. This is a change from zip 2.32, where the -F option isable to read a truncated archive. The -F option now more reliably fixes archives with minor damage and the -FF option is needed to fix archiveswhere -F might have been sufficient before.
Neither option will recover archives that have been incorrectly transferred in ascii mode instead of binary. After the repair, the -t option ofunzip may show that some files have a bad CRC. Such files cannot be recovered; you can remove them from the archive using the -d option ofzip.
Note that -FF may have trouble fixing archives that include an embedded zip archive that was stored (without compression) in the archive and,depending on the damage, it may find the entries in the embedded archive rather than the archive itself. Try -F first as it does not have this problem.
The format of the fix commands have changed. For example, to fix the damaged archive foo.zip,
zip -F foo --out foofix
zip -FF foo --out foofixfix
and compare the resulting archive to the archive created by -F. The -FF option may create an inconsistent archive. Depending on what isdamaged, you can then use the -F option to fix that archive.A split archive with missing split files can be fixed using -F if you have the last split of the archive (the .zip file). If this file ismissing, you must use -FF to fix the archive, which will prompt you for the splits you have.
Currently the fix options can't recover entries that have a bad checksum or are otherwise damaged.
-FI--fifo
[Unix] Normally zip skips reading any FIFOs (named pipes) encountered, as zip can hang if the FIFO is not being fed. This option tellszip to read the contents of any FIFO it finds.
-FS
Note that the timezone environment variable TZ should be set according to the local timezone in order for this option to work correctly. A change intimezone since the original archive was created could result in no times matching and recompression of all files.
This option deletes files from the archive. If you need to preserve the original archive, make a copy of the archive first or use the --out option tooutput the updated archive to a new file. Even though it may be slower, creating a new archive with a new archive name is safer, avoids mismatches betweenarchive and OS paths, and is preferred.
-?
zip -r foo . -i *.c
zip -r foo . -i *.c
zip -r foo . -i 'dir/*'
zip -r foo . -i dir/
to include directory dir).The long option form of the first example is
zip -r foo . --include *.c
and does the same thing as the short option form.Though the command syntax used to require -i at the end of the command line, this version actually allows -i (or --include) anywhere.The list of files terminates at the next argument starting with -, the end of the command line, or the list terminator @ (an argument that isjust @). So the above can be given as
zip -i *.c @ -r foo .
zip --include=*.c -r foo .
as additional examples. The single value forms are not recommended because they can be confusing and, in particular, the -ifile format can causeproblems if the first letter of file combines with i to form a two-letter option starting with i. Use -sc to see how your commandline will be parsed.Also possible:
zip -r foo . -i@include.lst
which will only include the files in the current directory and its subdirectories that match the patterns in the file include.lst.Files to -i and -x are patterns matching internal archive paths. See -R for more on patterns.
For example, if you have SparkFS loaded, zipping a Spark archive will result in a zipfile containing a directory (and its content) while using the 'I'option will result in a zipfile containing a Spark archive. Obviously this second case will also be obtained (without the 'I' option) if SparkFS isn'tloaded.
zip -rn .Z:.zip:.tiff:.gif:.snd foo foo
- zip archive to the latest (oldest) 'last modified' time found among the entries in the zip archive. Thiscan be used without any other operations, if desired. For example:zip -o foo
will change the last modified time of foo.zip to the latest time of the entries in foo.zip.
This option can be used to create updated split archives. It can also be used with -U to copy entries from an existing archive to a new archive. Seethe EXAMPLES section below.
Another use is converting zip files from one split size to another. For instance, to convert an archive with 700 MB CD splits to one with 2 GB DVDsplits, can use:
zip -s 2g cd-split.zip --out dvd-split.zip
zip -r foo.zip foo
- , since the recursion does not use the shell's file-name substitution mechanism. If you wish to include only a specific subset of the files indirectory foo and its subdirectories, use the -i option to specify the pattern of files to be included. You should not use -r with thename '.*', since that matches '..' which will attempt to zip up the parent directory (probably not what was intended).
Multiple source directories are allowed as in
zip -r foo foo1 foo2
which first zips up foo1 and then foo2, going down each directory.Note that while wildcards to -r are typically resolved while recursing down directories in the file system, any -R, -x, and -iwildcards are applied to internal archive pathnames once the directories are scanned. To have wildcards apply to files in subdirectories when recursing on Unixand similar systems where the shell does wildcard substitution, either escape all wildcards or put all arguments with wildcards in quotes. This lets zipsee the wildcards and match files in subdirectories using them as it recurses.
zip -R foo '*.c'
zip -R foo/*
Split archives are stored in numbered files. For example, if the output archive is named archive and three splits are required, the resulting archivewill be in the three files archive.z01, archive.z02, and archive.zip. Do not change the numbering of these files or the archive will notbe readable as these are used to determine the order the splits are read.
Split size is a number optionally followed by a multiplier. Currently the number must be an integer. The multiplier can currently be one of k(kilobytes), m (megabytes), g (gigabytes), or t (terabytes). As 64k is the minimum split size, numbers without multipliers default tomegabytes. For example, to create a split archive called foo with the contents of the bar directory with splits of 670 MB that might be usefulfor burning on CDs, the command:
zip -s 670m -r foo bar
could be used.Currently the old splits of a split archive are not excluded from a new archive, but they can be specifically excluded. If possible, keep the input andoutput archives out of the path being zipped when creating split archives.
Using -s without -sp as above creates all the splits where foo is being written, in this case the current directory. This split modeupdates the splits as the archive is being created, requiring all splits to remain writable, but creates split archives that are readable by any unzip thatsupports split archives. See -sp below for enabling split pause mode which allows splits to be written directly to removable media.
The option -sv can be used to enable verbose splitting and provide details of how the splitting is being done. The -sb option can be used toring the bell when zip pauses for the next split destination.
Split archives cannot be updated, but see the -O (--out) option for how a split archive can be updated as it is copied to a new archive. Asplit archive can also be converted into a single-file archive using a split size of 0 or negating the -s option:
zip -s 0 split.zip --out single.zip
Though this split mode allows writing splits directly to removable media, it uses stream archive format that may not be readable by some unzips. Beforerelying on splits created with -sp, test a split archive with the unzip you will be using.
To convert a stream split archive (created with -sp) to a standard archive see the --out option.
zip -rt 12071991 infamy foo
zip -rt 1991-12-07 infamy foo
- -T option is used. On Unix, to use a copy of unzip in the current directoryinstead of the standard system unzip, could use:zip archive file1 file2 -T -TT './unzip -tqq'
In cmd, {} is replaced by the name of the temporary archive, otherwise the name of the archive is appended to the end of the command. The return code ischecked for success (0 on Unix).
zip -u stuff *
will add any new files in the current directory, and update any files which have been modified since the zip archive stuff.zip was lastcreated/modified (note that zip will not try to pack stuff.zip into itself when you do this).Note that the -u option with no input file arguments acts like the -f (freshen) option.
zip inarchive '*.c' --copy --out outarchive
copies entries with names ending in .c from inarchive to outarchive. The wildcard must be escaped on some systems to prevent the shellfrom substituting names of files from the file system which may have no relevance to the entries in the archive.If no input files appear on the command line and --out is used, copy mode is assumed:
zip inarchive --out outarchive
This option can be used to determine what zip should do with this path if there is a mismatch between the stored standard path and the stored UTF-8path (which can happen if the standard path was updated). In all cases, if there is a mismatch it is assumed that the standard path is more current andzip uses that. Values for v are
q - quit if paths do not match
w - warn, continue with standard path
i - ignore, continue with standard path
n - no Unicode, do not use Unicode paths
The default is to warn and continue.Characters that are not valid in the current character set are escaped as #Uxxxx and #Lxxxxxx, where x is an ASCII character for a hex digit.The first is used if a 16-bit character number is sufficient to represent the Unicode character and the second if the character needs more than 16 bits torepresent it's Unicode character code. Setting -UN to
e - escape
zip archive dir -r -UN=UTF8
However, when -v is the only command line argument a diagnostic screen is printed instead. This should now work even if stdout is redirected to afile, allowing easy saving of the information for sending with bug reports to Info-ZIP. The version screen provides the help screen header with program name,version, and release date, some pointers to the Info-ZIP home and distribution sites, and shows information about the target environment (compiler type andversion, OS version, compilation date and the enabled optional features used to create the zip executable).
/foo/bar/dir/file1.c
/foo/bar/file2.c
zip -r foo foo --exclude @exclude.lst
zip -r foo foo -x*.o
Negating this option, -X-, includes all the default extra fields, but also copies over any unrecognized extra fields.
zip -z foo < foowhat
store - Setting the compression method to store forces zip to store entries with no compression. This is generally faster thancompressing entries, but results in no space savings. This is the same as using -0 (compression level zero).
deflate - This is the default method for zip. If zip determines that storing is better than deflation, the entry will be storedinstead.
bzip2 - If bzip2 support is compiled in, this compression method also becomes available. Only some modern unzips currently support thebzip2 compression method, so test the unzip you will be using before relying on archives using this method (compression method 12).
For example, to add bar.c to archive foo using bzip2 compression:
zip -Z bzip2 foo bar.c
Because of the way the shell on Unix does filename substitution, files starting with '.' are not included; to include these as well:
To zip up an entire directory, the command:
You may want to make a zip archive that contains the files in foo, without recording the directory name, foo. You can use the -joption to leave off the paths, as in:
Use -s to set the split size and create a split archive. The size is given as a number followed optionally by one of k (kB), m (MB), g (GB), or t(TB). The command
The -sp option can be used to pause zip between splits to allow changing removable media, for example, but read the descriptions and warningsfor both -s and -sp below.
Though zip does not update split archives, zip provides the new option -O (--output-file) to allow split archives to be updatedand saved in a new archive. For example,
Pattern Matching
This section applies only to Unix. Watch this space for details on MSDOS and VMS operation. However, the special wildcard characters * and []below apply to at least MSDOS also.
The Unix shells (sh, csh, bash, and others) normally do filename substitution (also called 'globbing') on command arguments. Generallythe special characters are:
?match any single character
*
match any number of characters (including none)
[]
match any character in the range indicated within the brackets (example: [a-f], [0-9]). This form of wildcard matching allows a user to specify a list ofcharacters between square brackets and if any of the characters match the expression matches. For example:
zip archive '*.[hc]'
would archive all files in the current directory that end in .h or .c.Ranges of characters are supported:
zip archive '[a-f]*'
would add to the archive all files starting with 'a' through 'f'.Negation is also supported, where any character in that position not in the list matches. Negation is supported by adding ! or ^ to thebeginning of the list:
zip archive '*.[!o]'
matches files that don't end in '.o'.On WIN32, [] matching needs to be turned on with the -RE option to avoid the confusion that names with [ or ] have caused.
When these characters are encountered (without being escaped with a backslash or quotes), the shell will look for files relative to the current path thatmatch the pattern, and replace the argument with a list of the names that matched.The zip program can do the same matching on names that are in the zip archive being modified or, in the case of the -x (exclude) or-i (include) options, on the list of files to be operated on, by using backslashes or quotes to tell the shell not to do the name expansion. In general,when zip encounters a name in the list of files to do, it first looks for the name in the file system. If it finds it, it then adds it to the list offiles to do. If it does not find it, it looks for the name in the zip archive being modified (if it exists), using the pattern matching charactersdescribed above, if present. For each match, it will add that name to the list of files to be processed, unless this name matches one given with the -xoption, or does not match any name given with the -i option.
The pattern matching includes the path, and so patterns like *.o match names that end in '.o', no matter what the path prefix is. Note that the backslashmust precede every special character (i.e. ?*[]), or the entire argument must be enclosed in double quotes (').
In general, use backslashes or double quotes for paths that have wildcards to make zip do the pattern matching for file paths, and always for pathsand strings that have spaces or wildcards for -i, -x, -R, -d, and -U and anywhere zip needs to process thewildcards.
Environment
The following environment variables are read and used by zip as described.
- zip handles some of the conversion internally. When using Kermit to transfer zip files fromVMS to MSDOS, type 'set file type block' on VMS. When transfering from MSDOS to VMS, type 'set file type fixed' on VMS. In both cases, type 'set file typebinary' on MSDOS.
Under some older VMS versions, zip may hang for file specifications that use DECnet syntax foo::*.*.
On OS/2, zip cannot match some names, such as those including an exclamation mark or a hash sign. This is a bug in OS/2 itself: the 32-bit DosFindFirst/Nextdon't find such names. Other programs such as GNU tar are also affected by this bug.
Under OS/2, the amount of Extended Attributes displayed by DIR is (for compatibility) the amount returned by the 16-bit version of DosQueryPathInfo().Otherwise OS/2 1.3 and 2.0 would report different EA sizes when DIRing a file. However, the structure layout returned by the 32-bit DosQueryPathInfo() is a bitdifferent, it uses extra padding bytes and link pointers (it's a linked list) to have all fields on 4-byte boundaries for portability to future RISC OS/2versions. Therefore the value reported by zip (which uses this 32-bit-mode size) differs from that reported by DIR. zip stores the 32-bit formatfor portability, even the 16-bit MS-C-compiled version running on OS/2 1.3, so even this one shows the 32-bit-mode size.
Authors
Copyright © 1997-2008 Info-ZIP.
Currently distributed under the Info-ZIP license.
Copyright © 1990-1997 Mark Adler, Richard B. Wales, Jean-loup Gailly, Onno van der Linden, Kai Uwe Rommel, Igor Mandrichenko, John Bush and Paul Kienitz.
Original copyright:
Permission is granted to any individual or institution to use, copy, or redistribute this software so long as all of the original files are included, thatit is not sold for profit, and that this copyright notice is retained.
LIKE ANYTHING ELSE THAT'S FREE, ZIP AND ITS ASSOCIATED UTILITIES ARE PROVIDED AS IS AND COME WITH NO WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED. INNO EVENT WILL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES RESULTING FROM THE USE OF THIS SOFTWARE.
Please send bug reports and comments using the web page at: www.info-zip.org. For bug reports, please include the version of zip (see zip-h), the make options used to compile it (see zip -v), the machine and operating system in use, and as much additional information aspossible.
Acknowledgements
Thanks to R. P. Byrne for his Shrink.Pas program, which inspired this project, and from which the shrink algorithm was stolen; to Phil Katz forplacing in the public domain the zip file format, compression format, and .ZIP filename extension, and for accepting minor changes to the file format;to Steve Burg for clarifications on the deflate format; to Haruhiko Okumura and Leonid Broukhis for providing some useful ideas for the compression algorithm;to Keith Petersen, Rich Wales, Hunter Goatley and Mark Adler for providing a mailing list and ftp site for the Info-ZIP group to use; and mostimportantly, to the Info-ZIP group itself (listed in the file infozip.who) without whose tireless testing and bug-fixing efforts a portable zipwould not have been possible. Finally we should thank (blame) the first Info-ZIP moderator, David Kirschbaum, for getting us into this mess in the first place.The manual page was rewritten for Unix by R. P. C. Rodgers and updated by E. Gordon for zip 3.0.