"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_source_stat.mdoc" (24 Jan 2020, 4102 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_stat.mdoc": 1.5.2_vs_1.6.0.

    1 .\" zip_source_stat.mdoc -- get information about zip source
    2 .\" Copyright (C) 2014-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_STAT 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_source_stat
   37 .Nd get information about zip_source
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Ft int
   43 .Fn zip_source_stat "zip_source_t *source" "zip_stat_t *sb"
   44 .Sh DESCRIPTION
   45 The
   46 .Fn zip_source_stat
   47 function obtains information about the zip source
   48 .Ar source
   49 .Pp
   50 The
   51 .Ar sb
   52 argument is a pointer to a
   53 .Ft struct zip_source_stat
   54 (shown below), into which information about the zip source is placed.
   55 .Bd -literal
   56 struct zip_source_stat {
   57     zip_uint64_t valid;                 /* which fields have valid values */
   58     const char *name;                   /* name of the file */
   59     zip_uint64_t index;                 /* index within archive */
   60     zip_uint64_t size;                  /* size of file (uncompressed) */
   61     zip_uint64_t comp_size;             /* size of file (compressed) */
   62     time_t mtime;                       /* modification time */
   63     zip_uint32_t crc;                   /* crc of file data */
   64     zip_uint16_t comp_method;           /* compression method used */
   65     zip_uint16_t encryption_method;     /* encryption method used */
   66     zip_uint32_t flags;                 /* reserved for future use */
   67 };
   68 .Ed
   69 The structure pointed to by
   70 .Ar sb
   71 must be initialized with
   72 .Fn zip_stat_init 3
   73 before calling
   74 .Fn zip_source_stat .
   75 .Pp
   76 The
   77 .Ar valid
   78 field of the structure specifies which other fields are valid.
   79 Check if the flag defined by the following defines are in
   80 .Ar valid
   81 before accessing the fields:
   82 .Bl -tag -width ZIP_STAT_ENCRYPTION_METHODXX -compact -offset indent
   83 .It Dv ZIP_STAT_NAME
   84 .Ar name
   85 .It Dv ZIP_STAT_INDEX
   86 .Ar index
   87 .It Dv ZIP_STAT_SIZE
   88 .Ar size
   89 .It Dv ZIP_STAT_COMP_SIZE
   90 .Ar comp_size
   91 .It Dv ZIP_STAT_MTIME
   92 .Ar mtime
   93 .It Dv ZIP_STAT_CRC
   94 .Ar crc
   95 .It Dv ZIP_STAT_COMP_METHOD
   96 .Ar comp_method
   97 .It Dv ZIP_STAT_ENCRYPTION_METHOD
   98 .Ar encryption_method
   99 .It Dv ZIP_STAT_FLAGS
  100 .Ar flags
  101 .El
  102 .Pp
  103 .Em NOTE :
  104 Some fields may only be filled out after all data has been read from
  105 the source, for example the
  106 .Ar crc
  107 or
  108 .Ar size
  109 fields.
  110 .Sh RETURN VALUES
  111 Upon successful completion 0 is returned.
  112 Otherwise, \-1 is returned and the error information in
  113 .Ar source
  114 is set to indicate the error.
  115 .Sh SEE ALSO
  116 .Xr libzip 3 ,
  117 .Xr zip_source 3
  118 .Sh HISTORY
  119 .Fn zip_source_stat
  120 was added in libzip 1.0.
  121 .Sh AUTHORS
  122 .An -nosplit
  123 .An Dieter Baron Aq Mt dillo@nih.at
  124 and
  125 .An Thomas Klausner Aq Mt tk@giga.or.at