"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/zip_set_file_compression.mdoc" (12 Mar 2019, 3902 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 latest Fossies "Diffs" side-by-side code changes report for "zip_set_file_compression.mdoc": 1.5.1_vs_1.5.2.

    1 .\" zip_set_file_compression.mdoc -- set compression method and its flags
    2 .\" Copyright (C) 2012-2019 Dieter Baron and Thomas Klausner
    3 .\"
    4 .\" This file is part of libzip, a library to manipulate ZIP files.
    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_SET_FILE_COMPRESSION 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_set_file_compression
   37 .Nd set compression method for file in zip
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Ft int
   43 .Fn zip_set_file_compression "zip_t *archive" "zip_uint64_t index" "zip_int32_t comp" "zip_uint32_t comp_flags"
   44 .Sh DESCRIPTION
   45 The
   46 .Fn zip_set_file_compression
   47 function sets the compression method for the file at position
   48 .Ar index
   49 in the zip archive to
   50 .Ar comp
   51 with the compression method specific
   52 .Ar comp_flags .
   53 The
   54 .Ar comp
   55 is the same as returned by
   56 .Xr zip_stat 3 .
   57 For the
   58 .Ar comp
   59 argument, currently only the following values are supported:
   60 .Bl -tag -width ZIP_CM_DEFLATE_XX
   61 .It Dv ZIP_CM_DEFAULT
   62 default compression; currently the same as
   63 .Dv ZIP_CM_DEFLATE ,
   64 but
   65 .Ar flags
   66 are ignored.
   67 .It Dv ZIP_CM_STORE
   68 Store the file uncompressed.
   69 .It Dv ZIP_CM_BZIP2
   70 Compress the file using the
   71 .Xr bzip2 1
   72 algorithm.
   73 .It Dv ZIP_CM_DEFLATE
   74 Deflate the file with the
   75 .Xr zlib 3
   76 algorithm and default options.
   77 .El
   78 .Pp
   79 .Em NOTE :
   80 Only the deflate and store methods can be assumed to be universally
   81 supported.
   82 .Pp
   83 The
   84 .Ar comp_flags
   85 argument defines the compression level, 1 being fastest compression
   86 and 9 highest.
   87 Allowed values are 0 (which uses the default compression for the
   88 algorithm) and 1-9, other values are undefined.
   89 Further compression method specific flags might be added over time.
   90 .Pp
   91 The current compression method for a file in a zip archive can be
   92 determined using
   93 .Xr zip_stat 3 .
   94 .Sh RETURN VALUES
   95 Upon successful completion 0 is returned.
   96 Otherwise, \-1 is returned and the error information in
   97 .Ar archive
   98 is set to indicate the error.
   99 .Sh ERRORS
  100 .Fn zip_set_file_compression
  101 fails if:
  102 .Bl -tag -width Er
  103 .It Bq Er ZIP_ER_COMPNOTSUPP
  104 Unsupported compression method requested.
  105 .It Bq Er ZIP_ER_INVAL
  106 .Ar index
  107 is not a valid file index in
  108 .Ar archive ,
  109 or the argument combination is invalid.
  110 .It Bq Er ZIP_ER_RDONLY
  111 Read-only zip file, no changes allowed.
  112 .El
  113 .Sh SEE ALSO
  114 .Xr libzip 3 ,
  115 .Xr zip_stat 3
  116 .Sh HISTORY
  117 .Fn zip_set_file_compression
  118 was added in libzip 0.11.
  119 .Sh AUTHORS
  120 .An -nosplit
  121 .An Dieter Baron Aq Mt dillo@nih.at
  122 and
  123 .An Thomas Klausner Aq Mt tk@giga.or.at