"Fossies" - the Fresh Open Source Software Archive

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

    1 .\" zip_source_tell.mdoc -- report current read offset in source
    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_TELL 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_source_tell
   37 .Nd report current read offset in zip source
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Ft zip_int64_t
   43 .Fn zip_source_tell "zip_source_t *source"
   44 .Sh DESCRIPTION
   45 The function
   46 .Fn zip_source_tell
   47 returns the current read offset
   48 for
   49 .Fa source .
   50 The return value can be passed to
   51 .Xr zip_source_seek 3
   52 with
   53 .Ar whence
   54 set to
   55 .Dv SEEK_SET
   56 to return to the same location in the source.
   57 .Sh RETURN VALUES
   58 Upon successful completion the current read offset is returned.
   59 Otherwise, \-1 is returned and the error information in
   60 .Ar source
   61 is set to indicate the error.
   62 .Sh SEE ALSO
   63 .Xr libzip 3 ,
   64 .Xr zip_source 3 ,
   65 .Xr zip_source_read 3 ,
   66 .Xr zip_source_tell_write 3
   67 .Sh HISTORY
   68 .Fn zip_source_tell
   69 was added in libzip 1.0.
   70 .Sh AUTHORS
   71 .An -nosplit
   72 .An Dieter Baron Aq Mt dillo@nih.at
   73 and
   74 .An Thomas Klausner Aq Mt tk@giga.or.at