1
.\" zip_set_file_compression.mdoc -- set compression method and its flags
2
.\" Copyright (C) 2012 Dieter Baron and Thomas Klausner
4
.\" This file is part of libzip, a library to manipulate ZIP files.
5
.\" The authors can be contacted at <libzip@nih.at>
7
.\" Redistribution and use in source and binary forms, with or without
8
.\" modification, are permitted provided that the following conditions
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
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.
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.
33
.Dt ZIP_SET_FILE_COMPRESSION 3
36
.Nm zip_set_file_compression
37
.Nd set compression method for file in zip
43
.Fn zip_set_file_compression "struct zip *archive" "zip_uint64_t index" \
44
"zip_int32_t comp" "zip_uint32_t comp_flags"
47
.Fn zip_set_file_compression
48
function sets the compression method for the file at position
52
with the compression method specific
56
is the same as returned by
60
argument, currently only the following values are supported:
61
.Bl -tag -width ZIP_CM_DEFLATE_XX
63
default compression; currently the same as
66
Store the file uncompressed.
68
Deflate the file with the
70
algorithm and default options
75
argument is currently ignored.
76
.\" For the comp_flags argument, the lower 4 bits define the compression
78
.\" 0 is fastest compression, 15 is highest compression
79
.\" .Dv ZIP_COMP_FL_DEFAULT
80
.\" can be used to specify that the default shall be used.
81
.\" Further compression method specific flags will be added over time.
83
The current compression method for a file in a zip archive can be
87
Upon successful completion 0 is returned.
88
Otherwise, \-1 is returned and the error information in
90
is set to indicate the error.
92
.Fn zip_set_file_compression
95
.It Bq Er ZIP_ER_INVAL
97
is not a valid file index in
99
or the argument combination is invalid.
100
.It Bq Er ZIP_ER_COMPNOTSUPP
101
Unsupported compression method requested.
102
.It Bq Er ZIP_ER_RDONLY
103
Read-only zip file, no changes allowed.
110
.An Dieter Baron Aq Mt dillo@nih.at
112
.An Thomas Klausner Aq Mt tk@giga.or.at
added
removed
man/zip_set_file_compression.mdoc
