libzip
NAME
libzip
—
library for manipulating zip archives
LIBRARY
libzip (-lzip)SYNOPSIS
#include <zip.h>
DESCRIPTION
libzip
is a library for reading, creating, and modifying
zip archives.
The main design criteria for libzip
were:
- Do not create corrupt files, even in case of errors.
- Do not delete data.
- Be efficient.
For this reason, when modifying zip archives,
libzip
writes to a temporary file and replaces the
original zip archive atomically.
Below there are two sections listing functions: one for how to read from zip archives and one for how to create/modify them.
GENERAL NOTES
Unless explicitly documented, functions should not be passedNULL
pointers as arguments.
FILE NAMES
Encoding
Names of files in the host file system are expected in UTF-8 encoding. On Windows, variants for ASCII and UTF-16 are also available.Names of files inside archives are by default expected in UTF-8
encoding. Other encodings can be requested by using the flags
ZIP_FL_ENC_CP437
and
ZIP_FL_ENC_RAW
.
For details see the relevant man pages.
Directory Separator
The zip format requires the use of forward slash (‘/’) as directory separator. Since backslash (‘\’) can be part of a valid file name on Unix systems,libzip
does not
automatically convert them, even on Windows. It is the responsibility of the
programmer to ensure that all directory separators are passed as forward
slashes to libzip
.
THREAD SAFETY
In general, different zip archives opened bylibzip
are
independent of each other and can be used by parallel-running threads without
locking. If you want to use an archive from multiple threads, you have to
synchronize access to it yourself. If you use an archive as a source for
zip_file_add(3) or
zip_file_replace(3), access to
the target archive must be synchronized with access to the source archive as
well.
READING ZIP ARCHIVES
Open Archive
Find Files
Read Files
Close Archive
Miscellaneous
CREATING/MODIFYING ZIP ARCHIVES
Create/Open Archive
Add/Change Files and Directories
- zip_dir_add(3)
- zip_file_add(3)
- zip_file_replace(3)
- zip_file_set_comment(3)
- zip_file_set_dostime(3)
- zip_file_set_external_attributes(3)
- zip_file_set_encryption(3)
- zip_file_set_mtime(3)
- zip_set_file_compression(3)
- zip_source_buffer(3)
- zip_source_file(3)
- zip_source_filep(3)
- zip_source_free(3)
- zip_source_function(3)
- zip_source_layered(3)
- zip_source_zip(3)