Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libzip (3)

Name

libzip - library for manipulating zip archives

Synopsis

#include <zip.h>

Description

LIBZIP(3)                BSD Library Functions Manual                LIBZIP(3)

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:
     o   Do not create corrupt files, even in case of errors.
     o   Do not delete data.
     o   Be efficient.

     For this reason, when modifying zip archives, libzip writes to a tempo-
     rary 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.

READING ZIP ARCHIVES
   open archive
     o   zip_open(3)
     o   zip_fdopen(3)

   find files
     o   zip_name_locate(3)

   read files
     o   zip_fopen(3)
     o   zip_fopen_encrypted(3)
     o   zip_fopen_index(3)
     o   zip_fopen_index_encrypted(3)
     o   zip_fread(3)
     o   zip_fseek(3) (uncompressed files only)
     o   zip_ftell(3) (uncompressed files only)
     o   zip_fclose(3)

   close archive
     o   zip_close(3)

   miscellaneous
     o   zip_stat(3)
     o   zip_compression_method_supported(3)
     o   zip_encryption_method_supported(3)
     o   zip_file_get_comment(3)
     o   zip_file_get_external_attributes(3)
     o   zip_get_archive_comment(3)
     o   zip_get_archive_flag(3)
     o   zip_get_name(3)
     o   zip_get_num_entries(3)
     o   zip_set_default_password(3)

CREATING/MODIFYING ZIP ARCHIVES
   create/open archive
     o   zip_open(3)

   add/change files and directories
     o   zip_dir_add(3)
     o   zip_file_add(3)
     o   zip_file_replace(3)
     o   zip_file_set_comment(3)
     o   zip_file_set_dostime(3)
     o   zip_file_set_external_attributes(3)
     o   zip_file_set_encryption(3)
     o   zip_file_set_mtime(3)
     o   zip_set_file_compression(3)
     o   zip_source_buffer(3)
     o   zip_source_file(3)
     o   zip_source_filep(3)
     o   zip_source_free(3)
     o   zip_source_function(3)
     o   zip_source_zip(3)

   rename files
     o   zip_rename(3)

   delete files
     o   zip_delete(3)

   revert changes
     o   zip_unchange(3)
     o   zip_unchange_all(3)
     o   zip_unchange_archive(3)

   read/modify extra fields
     o   zip_file_extra_field_by_id(3)
     o   zip_file_extra_field_delete(3)
     o   zip_file_extra_field_delete_by_id(3)
     o   zip_file_extra_field_get(3)
     o   zip_file_extra_field_set(3)
     o   zip_file_extra_fields_count(3)
     o   zip_file_extra_fields_count_by_id(3)

   close archive (writing)
     o   zip_close(3)
     o   zip_discard(3)

   miscellaneous (writing)
     o   zip_file_attributes_init(3)
     o   zip_libzip_version(3)
     o   zip_register_progress_callback_with_state(3)
     o   zip_set_archive_comment(3)
     o   zip_set_archive_flag(3)
     o   zip_source(3)

ERROR HANDLING
     o   zip_error_strerror(3)
     o   zip_strerror(3)
     o   zip_file_strerror(3)
     o   zip_get_error(3)
     o   zip_error_init_with_code(3)
     o   zip_error_system_type(3)
     o   zip_errors(3)

AUTHORS
     Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>



ATTRIBUTES
     See attributes(7) for descriptions of the following attributes:





     +---------------+------------------+
     |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
     +---------------+------------------+
     |Availability   | compress/libzip  |
     +---------------+------------------+
     |Stability      | Volatile         |
     +---------------+------------------+

NOTES
     Source code for open source software components in Oracle Solaris can be
     found at https://www.oracle.com/downloads/opensource/solaris-source-code-
     downloads.html.

     This software was built from source available at https://github.com/ora-
     cle/solaris-userland.  The original community source was downloaded from
     https://libzip.org/download/libzip-1.7.3.tar.gz.

     Further information about this software can be found on the open source
     community website at https://libzip.org/.

BSD                             April 17, 2020                             BSD