"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/zip_source_begin_write.mdoc" (12 Mar 2019, 3071 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 last Fossies "Diffs" side-by-side code changes report for "zip_source_begin_write.mdoc": 1.3.2_vs_1.4.0.

    1 .\" zip_source_begin_write.mdoc -- prepare zip source for writing
    2 .\" Copyright (C) 2014-2017 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_BEGIN_WRITE 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_source_begin_write ,
   37 .Nm zip_source_begin_write_cloning
   38 .Nd prepare zip source for writing
   39 .Sh LIBRARY
   40 libzip (-lzip)
   41 .Sh SYNOPSIS
   42 .In zip.h
   43 .Ft int
   44 .Fn zip_source_begin_write "zip_source_t *source"
   45 .Ft int
   46 .Fn zip_source_begin_write_cloning "zip_source_t *source" "zip_uint64_t offset"
   47 .Sh DESCRIPTION
   48 The functions
   49 .Fn zip_source_begin_write
   50 and
   51 .Fn zip_source_begin_write_cloning
   52 prepare
   53 .Fa source
   54 for writing.
   55 Usually this involves creating temporary files or allocating buffers.
   56 .Pp
   57 .Fn zip_source_begin_write_cloning
   58 preserves the first
   59 .Ar offset
   60 bytes of the original file.
   61 This is done efficiently, and writes to
   62 .Ar source
   63 won't overwrite the original data until
   64 .Fn zip_commit_write
   65 is called.
   66 .Sh RETURN VALUES
   67 Upon successful completion 0 is returned.
   68 Otherwise, \-1 is returned and the error information in
   69 .Ar source
   70 is set to indicate the error.
   71 .Sh SEE ALSO
   72 .Xr libzip 3 ,
   73 .Xr zip_source 3 ,
   74 .Xr zip_source_commit_write 3 ,
   75 .Xr zip_source_rollback_write 3 ,
   76 .Xr zip_source_seek_write 3 ,
   77 .Xr zip_source_tell_write 3 ,
   78 .Xr zip_source_write 3
   79 .Sh HISTORY
   80 .Fn zip_source_begin_write
   81 was added in libzip 1.0.
   82 .Pp
   83 .Fn zip_source_begin_write_cloning
   84 was added in libzip 1.4.0.
   85 .Sh AUTHORS
   86 .An -nosplit
   87 .An Dieter Baron Aq Mt dillo@nih.at
   88 and
   89 .An Thomas Klausner Aq Mt tk@giga.or.at