man/libzip.man

   1 .TH "LIBZIP" "3" "January 19, 2016" "NiH" "Library Functions Manual"
   2 .nh
   3 .if n .ad l
   4 .SH "NAME"
   5 \fBlibzip\fR
   6 \- library for manipulating zip archives
   7 .SH "LIBRARY"
   8 libzip (-lzip)
   9 .SH "SYNOPSIS"
  10 \fB#include <zip.h>\fR
  11 .SH "DESCRIPTION"
  12 \fBlibzip\fR
  13 is a library for reading, creating, and modifying zip archives.
  14 .PP
  15 The main design criteria for
  16 \fBlibzip\fR
  17 were:
  18 .PD 0
  19 .TP 4n
  20 \fB\(bu\fR
  21 Do not create corrupt files, even in case of errors.
  22 .TP 4n
  23 \fB\(bu\fR
  24 Do not delete data.
  25 .TP 4n
  26 \fB\(bu\fR
  27 Be efficient.
  28 .PD
  29 .PP
  30 For this reason, when modifying zip archives,
  31 \fBlibzip\fR
  32 writes to a temporary file and replaces the original
  33 zip archive atomically.
  34 .PP
  35 Below there are two sections listing functions: one for how to read
  36 from zip archives and one for how to create/modify them.
  37 .SH "READING ZIP ARCHIVES"
  38 .SS "open archive"
  39 zip_open(3)
  40 zip_fdopen(3)
  41 .SS "find files"
  42 zip_name_locate(3)
  43 .SS "read files"
  44 zip_fopen(3)
  45 zip_fopen_encrypted(3)
  46 zip_fopen_index(3)
  47 zip_fopen_index_encrypted(3)
  48 zip_fread(3)
  49 zip_fclose(3)
  50 .SS "close archive"
  51 zip_close(3)
  52 zip_discard(3)
  53 .SS "miscellaneous"
  54 zip_stat(3)
  55 zip_file_get_comment(3)
  56 zip_get_archive_comment(3)
  57 zip_get_archive_flag(3)
  58 zip_get_name(3)
  59 zip_get_num_entries(3)
  60 zip_set_default_password(3)
  61 .SH "CREATING/MODIFYING ZIP ARCHIVES"
  62 .SS "create/open archive"
  63 zip_open(3)
  64 .SS "add/change files and directories"
  65 zip_dir_add(3)
  66 zip_file_add(3)
  67 zip_file_replace(3)
  68 zip_file_set_comment(3)
  69 zip_set_file_compression(3)
  70 zip_source_buffer(3)
  71 zip_source_file(3)
  72 zip_source_filep(3)
  73 zip_source_free(3)
  74 zip_source_function(3)
  75 zip_source_zip(3)
  76 .SS "rename files"
  77 zip_rename(3)
  78 .SS "delete files"
  79 zip_delete(3)
  80 .SS "revert changes"
  81 zip_unchange(3)
  82 zip_unchange_all(3)
  83 zip_unchange_archive(3)
  84 .SS "read/modify extra fields"
  85 zip_file_extra_field_by_id(3)
  86 zip_file_extra_field_delete(3)
  87 zip_file_extra_field_delete_by_id(3)
  88 zip_file_extra_field_get(3)
  89 zip_file_extra_field_set(3)
  90 zip_file_extra_fields_count(3)
  91 zip_file_extra_fields_count_by_id(3)
  92 .SS "close archive"
  93 zip_close(3)
  94 .SS "miscellaneous"
  95 zip_set_archive_comment(3)
  96 zip_set_archive_flag(3)
  97 zip_source(3)
  98 .SH "ERROR HANDLING"
  99 zip_error_to_str(3)
 100 zip_strerror(3)
 101 zip_file_strerror(3)
 102 zip_error_get(3)
 103 zip_error_get_sys_type(3)
 104 zip_errors(3)
 105 .SH "AUTHORS"
 106 Dieter Baron <\fIdillo@nih.at\fR>
 107 and
 108 Thomas Klausner <\fItk@giga.or.at\fR>