"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/libzip.mdoc" (12 Mar 2019, 4975 Bytes) of package /linux/misc/libzip-1.5.2.tar.xz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "libzip.mdoc": 1.5.1_vs_1.5.2.

    1 .\" libzip.mdoc -- general overview of available functions
    2 .\" Copyright (C) 2005-2018 Dieter Baron and Thomas Klausner
    3 .\"
    4 .\" This file is part of libzip, a library to manipulate ZIP archives.
    5 .\" The authors can be contacted at <libzip@nih.at>
    6 .\"
    7 .\" Redistribution and use in source and binary forms, with or without
    8 .\" modification, are permitted provided that the following conditions
    9 .\" are met:
   10 .\" 1. Redistributions of source code must retain the above copyright
   11 .\"    notice, this list of conditions and the following disclaimer.
   12 .\" 2. Redistributions in binary form must reproduce the above copyright
   13 .\"    notice, this list of conditions and the following disclaimer in
   14 .\"    the documentation and/or other materials provided with the
   15 .\"    distribution.
   16 .\" 3. The names of the authors may not be used to endorse or promote
   17 .\"    products derived from this software without specific prior
   18 .\"    written permission.
   19 .\"
   20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
   21 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   22 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
   24 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
   26 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   27 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
   28 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
   29 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
   30 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   31 .\"
   32 .Dd September 29, 2018
   33 .Dt LIBZIP 3
   34 .Os
   35 .Sh NAME
   36 .Nm libzip
   37 .Nd library for manipulating zip archives
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Sh DESCRIPTION
   43 .Nm
   44 is a library for reading, creating, and modifying zip archives.
   45 .Pp
   46 The main design criteria for
   47 .Nm
   48 were:
   49 .Bl -bullet -compact
   50 .It
   51 Do not create corrupt files, even in case of errors.
   52 .It
   53 Do not delete data.
   54 .It
   55 Be efficient.
   56 .El
   57 .Pp
   58 For this reason, when modifying zip archives,
   59 .Nm
   60 writes to a temporary file and replaces the original
   61 zip archive atomically.
   62 .Pp
   63 Below there are two sections listing functions: one for how to read
   64 from zip archives and one for how to create/modify them.
   65 .Sh READING ZIP ARCHIVES
   66 .Ss open archive
   67 .Bl -bullet -compact
   68 .It
   69 .Xr zip_open 3
   70 .It
   71 .Xr zip_fdopen 3
   72 .El
   73 .Ss find files
   74 .Bl -bullet -compact
   75 .It
   76 .Xr zip_name_locate 3
   77 .El
   78 .Ss read files
   79 .Bl -bullet -compact
   80 .It
   81 .Xr zip_fopen 3
   82 .It
   83 .Xr zip_fopen_encrypted 3
   84 .It
   85 .Xr zip_fopen_index 3
   86 .It
   87 .Xr zip_fopen_index_encrypted 3
   88 .It
   89 .Xr zip_fread 3
   90 .It
   91 .Xr zip_fseek 3
   92 (uncompressed files only)
   93 .It
   94 .Xr zip_ftell 3
   95 (uncompressed files only)
   96 .It
   97 .Xr zip_fclose 3
   98 .El
   99 .Ss close archive
  100 .Bl -bullet -compact
  101 .It
  102 .Xr zip_close 3
  103 .El
  104 .Ss miscellaneous
  105 .Bl -bullet -compact
  106 .It
  107 .Xr zip_stat 3
  108 .It
  109 .Xr zip_file_get_comment 3
  110 .It
  111 .Xr zip_file_get_external_attributes 3
  112 .It
  113 .Xr zip_get_archive_comment 3
  114 .It
  115 .Xr zip_get_archive_flag 3
  116 .It
  117 .Xr zip_get_name 3
  118 .It
  119 .Xr zip_get_num_entries 3
  120 .It
  121 .Xr zip_set_default_password 3
  122 .El
  123 .Sh CREATING/MODIFYING ZIP ARCHIVES
  124 .Ss create/open archive
  125 .Bl -bullet -compact
  126 .It
  127 .Xr zip_open 3
  128 .El
  129 .Ss add/change files and directories
  130 .Bl -bullet -compact
  131 .It
  132 .Xr zip_dir_add 3
  133 .It
  134 .Xr zip_file_add 3
  135 .It
  136 .Xr zip_file_replace 3
  137 .It
  138 .Xr zip_file_set_comment 3
  139 .It
  140 .Xr zip_file_set_external_attributes 3
  141 .It
  142 .Xr zip_file_set_encryption 3
  143 .It
  144 .Xr zip_file_set_mtime 3
  145 .It
  146 .Xr zip_set_file_compression 3
  147 .It
  148 .Xr zip_source_buffer 3
  149 .It
  150 .Xr zip_source_file 3
  151 .It
  152 .Xr zip_source_filep 3
  153 .It
  154 .Xr zip_source_free 3
  155 .It
  156 .Xr zip_source_function 3
  157 .It
  158 .Xr zip_source_zip 3
  159 .El
  160 .Ss rename files
  161 .Bl -bullet -compact
  162 .It
  163 .Xr zip_rename 3
  164 .El
  165 .Ss delete files
  166 .Bl -bullet -compact
  167 .It
  168 .Xr zip_delete 3
  169 .El
  170 .Ss revert changes
  171 .Bl -bullet -compact
  172 .It
  173 .Xr zip_unchange 3
  174 .It
  175 .Xr zip_unchange_all 3
  176 .It
  177 .Xr zip_unchange_archive 3
  178 .El
  179 .Ss read/modify extra fields
  180 .Bl -bullet -compact
  181 .It
  182 .Xr zip_file_extra_field_by_id 3
  183 .It
  184 .Xr zip_file_extra_field_delete 3
  185 .It
  186 .Xr zip_file_extra_field_delete_by_id 3
  187 .It
  188 .Xr zip_file_extra_field_get 3
  189 .It
  190 .Xr zip_file_extra_field_set 3
  191 .It
  192 .Xr zip_file_extra_fields_count 3
  193 .It
  194 .Xr zip_file_extra_fields_count_by_id 3
  195 .El
  196 .Ss close archive (writing)
  197 .Bl -bullet -compact
  198 .It
  199 .Xr zip_close 3
  200 .It
  201 .Xr zip_discard 3
  202 .El
  203 .Ss miscellaneous (writing)
  204 .Bl -bullet -compact
  205 .It
  206 .Xr zip_libzip_version 3
  207 .It
  208 .Xr zip_register_progress_callback_with_state 3
  209 .It
  210 .Xr zip_set_archive_comment 3
  211 .It
  212 .Xr zip_set_archive_flag 3
  213 .It
  214 .Xr zip_source 3
  215 .El
  216 .Sh ERROR HANDLING
  217 .Bl -bullet -compact
  218 .It
  219 .Xr zip_error_strerror 3
  220 .It
  221 .Xr zip_strerror 3
  222 .It
  223 .Xr zip_file_strerror 3
  224 .It
  225 .Xr zip_get_error 3
  226 .It
  227 .Xr zip_error_init_with_code 3
  228 .It
  229 .Xr zip_error_system_type 3
  230 .It
  231 .Xr zip_errors 3
  232 .El
  233 .Sh AUTHORS
  234 .An -nosplit
  235 .An Dieter Baron Aq Mt dillo@nih.at
  236 and
  237 .An Thomas Klausner Aq Mt tk@giga.or.at