Skip to content

Commit 97a6a76

Browse files
authored
Update README.md
1 parent a6a046f commit 97a6a76

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

README.md

+64
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,66 @@
11
# zip-cmd
22
Simple CLI tool for the Haskell [zip](https://hackage.haskell.org/package/zip) library
3+
4+
Run: `./zip-cmd -h`
5+
6+
```
7+
zip-cmd -h
8+
Usage: zip-cmd [COMMAND] [-v|--version]
9+
10+
Available options:
11+
-h,--help Show this help text
12+
-v,--version Show program version.
13+
14+
Available commands:
15+
CreateArchive Create a new archive given its location. This will
16+
silently overwrite the specified file if it already
17+
exists.
18+
WithArchive Work with an existing archive.
19+
DoesEntryExist Check whether the specified entry exists in the
20+
archive.
21+
GetEntry Get contents of a specific archive entry as a strict
22+
ByteString. It's not recommended to use this on big
23+
entries, because it will suck out a lot of memory.
24+
SaveEntry Save a specific archive entry as a file in the file
25+
system.
26+
CheckEntry Calculate CRC32 check sum and compare it with the
27+
value read from the archive. The function returns
28+
True when the check sums are the same—that is, the
29+
data is not corrupted.
30+
UnpackInto Unpack the archive into the specified directory. The
31+
directory will be created if it does not exist.
32+
GetArchiveComment Get the archive comment.
33+
GetArchiveDescription Get the archive description record.
34+
AddEntry Add a new entry to the archive given its contents in
35+
binary form.
36+
LoadEntry Load an entry from a given file.
37+
CopyEntry Copy an entry “as is” from another zip archive.
38+
PackDirRecur Add an directory to the archive. Please note that due
39+
to the design of the library, empty sub-directories
40+
will not be added.
41+
RenameEntry Rename an entry in the archive. If the entry does not
42+
exist, nothing will happen.
43+
DeleteEntry Delete an entry from the archive, if it does not
44+
exist, nothing will happen.
45+
Recompress Change compression method of an entry, if it does not
46+
exist, nothing will happen.
47+
SetEntryComment Set an entry comment, if that entry does not exist,
48+
nothing will happen. Note that if binary
49+
representation of the comment is longer than 65535
50+
bytes, it will be truncated on writing.
51+
DeleteEntryComment Delete an entry's comment, if that entry does not
52+
exist, nothing will happen.
53+
SetModTime Set the last modification date/time. The specified
54+
entry may be missing, in that case the action has no
55+
effect.
56+
AddExtraField Add an extra field. The specified entry may be
57+
missing, in that case this action has no effect.
58+
DeleteExtraField Delete an extra field by its type (tag). The
59+
specified entry may be missing, in that case this
60+
action has no effect.
61+
SetExternalFileAttrs Set external file attributes. This function can be
62+
used to set file permissions.
63+
SetArchiveComment Set the comment of the entire archive.
64+
DeleteArchiveComment Delete the archive's comment if it's present.
65+
RunZipCommandsFromFile Executes zip commands from file.
66+
```

0 commit comments

Comments
 (0)