"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_source_buffer_fragment.mdoc" (24 Jan 2020, 3681 Bytes) of package /linux/misc/libzip-1.6.0.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 "zip_source_buffer_fragment.mdoc": 1.5.2_vs_1.6.0.

    1 .\" zip_source_buffer_fragment.mdoc -- create zip data source from multiple buffers
    2 .\" Copyright (C) 2004-2019 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 December 18, 2017
   33 .Dt ZIP_SOURCE_BUFFER_FRAGMENT 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_source_buffer_fragment ,
   37 .Nm zip_source_buffer_fragment_create
   38 .Nd create zip data source from multiple buffer
   39 .Sh LIBRARY
   40 libzip (-lzip)
   41 .Sh SYNOPSIS
   42 .In zip.h
   43 .Ft zip_source_t *
   44 .Fn zip_source_buffer_fragment "zip_t *archive" "zip_buffer_fragment_t *fragments" "zip_uint64_t nfragments" "int freep"
   45 .Ft zip_source_t *
   46 .Fn zip_source_buffer_fragment_create "zip_buffer_fragment_t *fragments" "zip_uint64_t nfragments" "int freep" "zip_error_t *error"
   47 .Sh DESCRIPTION
   48 The functions
   49 .Fn zip_source_buffer_fragment
   50 and
   51 .Fn zip_source_buffer_fragment_create
   52 create a zip source from the data in
   53 .Ar fragments .
   54 .Ar nfragments
   55 specifies the number of fragments.
   56 If
   57 .Ar freep
   58 is non-zero, the data will be freed when it is no longer needed.
   59 .Bd -literal
   60 struct zip_stat {
   61     zip_uint8_t *data;    /* pointer to the actual data */
   62     zip_uint64_t length;  /* length of this fragment */
   63 };
   64 .Ed
   65 .Pp
   66 The data
   67 .Ar fragments
   68 point to must remain valid for the lifetime of the created source.
   69 .Ar fragments
   70 itself can be discarded once the source is created.
   71 .Pp
   72 The source can be used to open a zip archive from.
   73 .Sh RETURN VALUES
   74 Upon successful completion, the created source is returned.
   75 Otherwise,
   76 .Dv NULL
   77 is returned and the error code in
   78 .Ar archive
   79 or
   80 .Ar error
   81 is set to indicate the error.
   82 .Sh ERRORS
   83 .Fn zip_source_buffer
   84 and
   85 .Fn zip_source_buffer_create
   86 fail if:
   87 .Bl -tag -width Er
   88 .It Bq Er ZIP_ER_INVAL
   89 .Ar nfragments
   90 is greater than zero and
   91 .Ar fragments
   92 is
   93 .Dv NULL .
   94 .It Bq Er ZIP_ER_MEMORY
   95 Required memory could not be allocated.
   96 .El
   97 .Sh SEE ALSO
   98 .Xr libzip 3 ,
   99 .Xr zip_file_add 3 ,
  100 .Xr zip_file_replace 3 ,
  101 .Xr zip_open_from_source 3 ,
  102 .Xr zip_source 3
  103 .Sh HISTORY
  104 .Fn zip_source_buffer_fragment
  105 and
  106 .Fn zip_source_buffer_fragment_create
  107 were added in libzip 1.4.0.
  108 .Sh AUTHORS
  109 .An -nosplit
  110 .An Dieter Baron Aq Mt dillo@nih.at
  111 and
  112 .An Thomas Klausner Aq Mt tk@giga.or.at