Skip to content

Commit 13b93e5

Browse files
committed
Add README.md for github.
1 parent e100454 commit 13b93e5

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Synopsis
2+
--------
3+
4+
_sunzip_ is a streaming unzip utility. It will read a .zip file from stdin and
5+
decompress its contents into the current directory. Command line options allow
6+
specifying a different destination directory, overwriting existing files
7+
(normally prevented), and testing the contents of .zip file instead of writing
8+
the decompressed files.
9+
10+
_sunzip_ can decompress methods 0 (stored), 8 (deflated), 9 (Deflate64), 10
11+
(DCL imploded), and 12 (bzip2). _sunzip_ handles Zip64 .zip files. It does not
12+
handle encrypted .zip files.
13+
14+
Motivation
15+
----------
16+
17+
Most unzip utilities require random access to the .zip file, since they first
18+
read the central directory at the end, and then use that to access the entries
19+
in the .zip file. Those utilities cannot accept a .zip file on a pipe. _sunzip_
20+
reads and processes the .zip file contents sequentially. The entry information
21+
in the central directory is applied to the already decompressed files when the
22+
central directory is read.
23+
24+
Installation
25+
------------
26+
27+
Compile and link with zlib, infback9.c and inftree9.c (found in zlib's contrib
28+
directory), blast.c (also in contrib), and libbz2. blast.c from zlib 1.2.9 or
29+
later must be used.
30+
31+
Test
32+
----
33+
34+
`cat any.zip | sunzip`
35+
36+
License
37+
-------
38+
39+
This code is under the zlib license, permitting free commercial use.

0 commit comments

Comments
 (0)