man/zip_source.mdoc

   1 .\" zip_source.mdoc -- description of zip data source
   2 .\" Copyright (C) 2014-2016 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 October 24, 2015
  33 .Dt ZIP_SOURCE 3
  34 .Os
  35 .Sh NAME
  36 .Nm zip_source
  37 .Nd zip data source structure
  38 .Sh LIBRARY
  39 libzip (-lzip)
  40 .Sh SYNOPSIS
  41 .In zip.h
  42 .Vt zip_source_t *zs ;
  43 .Sh DESCRIPTION
  44 A
  45 .Vt struct zip_source
  46 is a data source used by
  47 .Xr libzip 3
  48 for adding or replacing file contents for a file in a zip archive.
  49 If the source supports seeking, it can also be used to open zip archives from.
  50 It is created by calling one of
  51 .Xr zip_source_buffer 3 ,
  52 .Xr zip_source_buffer_create 3 ,
  53 .Xr zip_source_file 3 ,
  54 .Xr zip_source_file_create 3 ,
  55 .Xr zip_source_filep 3 ,
  56 .Xr zip_source_filep_create 3 ,
  57 .Xr zip_source_function 3 ,
  58 .Xr zip_source_function_create 3 ,
  59 or
  60 .Xr zip_source_zip 3 .
  61 .Vt zip_source_t
  62 is reference counted, and created with a reference count of 1.
  63 .Xr zip_open_from_source 3 ,
  64 .Xr zip_file_add 3 ,
  65 and
  66 .Xr zip_file_replace 3
  67 will decrement the reference count of the
  68 .Vt zip_source_t
  69 when they are done using it, so
  70 .Xr zip_source_free 3
  71 only needs to be called when these functions return an error.
  72 Use
  73 .Xr zip_source_keep 3
  74 to increase the reference count, for example if you need the source after
  75 .Xr zip_close 3 .
  76 .Sh SEE ALSO
  77 .Xr libzip 3 ,
  78 .Xr zip_source_buffer 3 ,
  79 .Xr zip_source_file 3 ,
  80 .Xr zip_source_filep 3 ,
  81 .Xr zip_source_free 3 ,
  82 .Xr zip_source_function 3 ,
  83 .Xr zip_source_zip 3
  84 .Sh AUTHORS
  85 .An -nosplit
  86 .An Dieter Baron Aq Mt dillo@nih.at
  87 and
  88 .An Thomas Klausner Aq Mt tk@giga.or.at