"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/zip_register_progress_callback.mdoc" (12 Mar 2019, 2921 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_register_progress_callback.mdoc": 1.3.2_vs_1.4.0.

    1 .\" zip_register_progress_callback.mdoc -- provide updates during zip_close
    2 .\" Copyright (C) 2016-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_REGISTER_PROGRESS_CALLBACK 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_register_progress_callback
   37 .Nd provide updates during zip_close (obsolete interface)
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Vt typedef void (*zip_progress_callback_t)(double);
   43 .Ft void
   44 .Fn zip_register_progress_callback "zip_t *archive" "zip_progress_callback_t progress_callback"
   45 .Sh DESCRIPTION
   46 The function
   47 .Fn zip_register_progress_callback
   48 is the obsolete version of
   49 .Xr zip_register_progress_callback_with_state 3 .
   50 .Pp
   51 The
   52 .Fn zip_register_progress_callback
   53 function registers a callback function
   54 .Ar progress_callback
   55 for the zip archive
   56 .Ar archive .
   57 This function is called during
   58 .Xr zip_close 3
   59 after every zip archive entry that's completely written to disk.
   60 The value is a
   61 .Vt double
   62 in the range from 0.0 to 1.0.
   63 This can be used to provide progress indicators for user interfaces.
   64 .Sh SEE ALSO
   65 .Xr libzip 3 ,
   66 .Xr zip_close 3
   67 .Sh HISTORY
   68 .Fn zip_register_progress_callback
   69 was added in libzip 1.2.0.
   70 It was deprecated in libzip 1.3.0, use
   71 .Fn zip_register_progress_callback_with_state
   72 instead.
   73 .Sh AUTHORS
   74 .An -nosplit
   75 .An Dieter Baron Aq Mt dillo@nih.at
   76 and
   77 .An Thomas Klausner Aq Mt tk@giga.or.at