Google Git
Sign in
flutter / third_party / libzip / 89d3318c709eb51eddbe93f5131241a46d8b989c / . / man / zip_open.mdoc
blob: 1f1a5560dbd663bb02abcdbbc8f3dab0673ff728 [file] [log] [blame]
Dieter Baronbb1453e2003-10-02 14:20:53 +0000[diff] [blame]1.\" zip_open.mdoc -- open zip archive
Thomas Klausner89d33182009-02-15 00:53:58 +0100[diff] [blame^]2.\" Copyright (C) 2003-2009 Dieter Baron and Thomas Klausner
Dieter Baronbb1453e2003-10-02 14:20:53 +0000[diff] [blame]3.\"
4.\" This file is part of libzip, a library to manipulate ZIP archives.
Dieter Baronb86c4332007-11-07 14:35:13 +0100[diff] [blame]5.\" The authors can be contacted at <libzip@nih.at>
Dieter Baron90288262003-10-01 18:28:10 +0000[diff] [blame]6.\"
Dieter Baronbb1453e2003-10-02 14:20:53 +0000[diff] [blame]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.
Thomas Klausnere9faec42003-10-02 15:52:56 +0000[diff] [blame]19.\"
Dieter Baronbb1453e2003-10-02 14:20:53 +0000[diff] [blame]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.\"
Thomas Klausner89d33182009-02-15 00:53:58 +0100[diff] [blame^]32.Dd February 15, 2009
Dieter Baron90288262003-10-01 18:28:10 +0000[diff] [blame]33.Dt ZIP_OPEN 3
34.Os
35.Sh NAME
36.Nm zip_open
37.Nd open zip archive
38.Sh LIBRARY
Dieter Baronff551f12003-10-03 12:04:09 +0000[diff] [blame]39libzip (-lzip)
Dieter Baron90288262003-10-01 18:28:10 +0000[diff] [blame]40.Sh SYNOPSIS
Thomas Klausner680c87b2003-10-02 15:32:02 +0000[diff] [blame]41.In zip.h
Dieter Baron90288262003-10-01 18:28:10 +0000[diff] [blame]42.Ft struct zip *
Dieter Baron321bc802003-10-06 16:36:54 +0000[diff] [blame]43.Fn zip_open "const char *path" "int flags" "int *errorp"
Dieter Baron90288262003-10-01 18:28:10 +0000[diff] [blame]44.Sh DESCRIPTION
Thomas Klausnere9faec42003-10-02 15:52:56 +0000[diff] [blame]45The zip archive specified by
46.Ar path
47is opened and a pointer to a
Dieter Baron214922d2003-10-02 15:48:47 +0000[diff] [blame]48.Ft struct zip ,
Dieter Baron7c43a822003-10-02 16:00:55 +0000[diff] [blame]49used to manipulate the archive, is returned.
Dieter Barondd9afca2003-10-02 14:13:37 +0000[diff] [blame]50The
51.Fa flags
52are specified by
Thomas Klausner680c87b2003-10-02 15:32:02 +0000[diff] [blame]53.Em or Ns No 'ing
Dieter Barondd9afca2003-10-02 14:13:37 +0000[diff] [blame]54the following values, or 0 for none of them.
55.Bl -tag -offset indent -width ZIP_CHECKCONS
56.It Dv ZIP_CREATE
57Create the archive if it does not exist.
58.It Dv ZIP_EXCL
59Error if archive already exists.
60.It Dv ZIP_CHECKCONS
61Perform additional consistency checks on the archive, and error if
62they fail.
Thomas Klausnerb9148ee2003-12-28 00:51:51 +0000[diff] [blame]63.El
Thomas Klausner81225ec2003-10-06 17:02:07 +0000[diff] [blame]64.Pp
65If an error occurs and
Dieter Baron321bc802003-10-06 16:36:54 +0000[diff] [blame]66.Ar errorp
67is non-NULL, it will be set to the corresponding error code.
Dieter Baron90288262003-10-01 18:28:10 +0000[diff] [blame]68.Sh RETURN VALUES
69Upon successful completion
Dieter Barondd9afca2003-10-02 14:13:37 +0000[diff] [blame]70.Fn zip_open
Dieter Baron90288262003-10-01 18:28:10 +0000[diff] [blame]71returns a
Thomas Klausner680c87b2003-10-02 15:32:02 +0000[diff] [blame]72.Ft struct zip
Dieter Baron90288262003-10-01 18:28:10 +0000[diff] [blame]73pointer.
74Otherwise,
75.Dv NULL
Dieter Baron321bc802003-10-06 16:36:54 +0000[diff] [blame]76is returned and
77.Ar *errorp
Dieter Baron90288262003-10-01 18:28:10 +0000[diff] [blame]78is set to indicate the error.
Dieter Baron214922d2003-10-02 15:48:47 +0000[diff] [blame]79.Sh ERRORS
Dieter Baron99d31972003-10-07 11:54:17 +0000[diff] [blame]80The archive specified by
81.Ar path
82is opened unless:
Dieter Baron214922d2003-10-02 15:48:47 +0000[diff] [blame]83.Bl -tag -width Er
Thomas Klausnerd0147e92004-11-17 21:55:17 +0000[diff] [blame]84.It Bq Er ZIP_ER_EXISTS
Dieter Baron99d31972003-10-07 11:54:17 +0000[diff] [blame]85The file specified by
86.Ar path
87exists and
Dieter Baron68d238c2003-10-03 11:19:03 +0000[diff] [blame]88.Dv ZIP_EXCL
89is set.
Thomas Klausnerd0147e92004-11-17 21:55:17 +0000[diff] [blame]90.It Bq Er ZIP_ER_INCONS
Dieter Baron99d31972003-10-07 11:54:17 +0000[diff] [blame]91Inconsistencies were found in the file specified by
Thomas Klausnercdfa8482003-10-09 13:39:08 +0000[diff] [blame]92.Ar path
93and
Dieter Baron321bc802003-10-06 16:36:54 +0000[diff] [blame]94.Dv ZIP_CHECKCONS
95was specified.
Thomas Klausnerd0147e92004-11-17 21:55:17 +0000[diff] [blame]96.It Bq Er ZIP_ER_INVAL
Thomas Klausnere9faec42003-10-02 15:52:56 +0000[diff] [blame]97The
Dieter Baron214922d2003-10-02 15:48:47 +0000[diff] [blame]98.Ar path
99argument is
100.Dv NULL .
Thomas Klausnerd0147e92004-11-17 21:55:17 +0000[diff] [blame]101.It Bq Er ZIP_ER_MEMORY
Dieter Baron214922d2003-10-02 15:48:47 +0000[diff] [blame]102Required memory could not be allocated.
Thomas Klausnerd0147e92004-11-17 21:55:17 +0000[diff] [blame]103.It Bq Er ZIP_ER_NOENT
Dieter Baron99d31972003-10-07 11:54:17 +0000[diff] [blame]104The file specified by
105.Ar path
106does not exist and
Dieter Baron214922d2003-10-02 15:48:47 +0000[diff] [blame]107.Dv ZIP_CREATE
108is not set.
Thomas Klausnerd0147e92004-11-17 21:55:17 +0000[diff] [blame]109.It Bq Er ZIP_ER_NOZIP
Dieter Baron99d31972003-10-07 11:54:17 +0000[diff] [blame]110The file specified by
111.Ar path
112is not a zip archive.
Thomas Klausnerd0147e92004-11-17 21:55:17 +0000[diff] [blame]113.It Bq Er ZIP_ER_OPEN
Dieter Baron99d31972003-10-07 11:54:17 +0000[diff] [blame]114The file specified by
115.Ar path
116could not be opened.
Thomas Klausnerd0147e92004-11-17 21:55:17 +0000[diff] [blame]117.It Bq Er ZIP_ER_READ
Dieter Baron214922d2003-10-02 15:48:47 +0000[diff] [blame]118A read error occurred; see
119.Va errno
120for details.
Thomas Klausnerd0147e92004-11-17 21:55:17 +0000[diff] [blame]121.It Bq Er ZIP_ER_SEEK
Dieter Baron99d31972003-10-07 11:54:17 +0000[diff] [blame]122The file specified by
123.Ar path
124does not allow seeks.
Dieter Baron214922d2003-10-02 15:48:47 +0000[diff] [blame]125.El
126.Sh SEE ALSO
Thomas Klausnerbec1cfe2005-06-09 18:50:27 +0000[diff] [blame]127.Xr libzip 3 ,
Thomas Klausnerc2995a52003-12-27 22:37:34 +0000[diff] [blame]128.Xr zip_close 3 ,
Thomas Klausner89d33182009-02-15 00:53:58 +0100[diff] [blame^]129.Xr zip_error_to_str 3 ,
130.Xr zip_fdopen 3
Thomas Klausnera456cf52005-06-09 21:13:13 +0000[diff] [blame]131.Sh AUTHORS
132.An -nosplit
133.An Dieter Baron Aq dillo@giga.or.at
Thomas Klausner39b5f9e2005-06-09 21:14:54 +0000[diff] [blame]134and
Thomas Klausnera456cf52005-06-09 21:13:13 +0000[diff] [blame]135.An Thomas Klausner Aq tk@giga.or.at