Core/Dep: Added libzip which IS needed by G3D
Fixes compile on Windows and Linux (if you didn't have libzip installed for some reason). --HG-- branch : trunk
This commit is contained in:
@@ -0,0 +1,124 @@
|
||||
.\" $NiH: zip_add.mdoc,v 1.9 2005/06/09 21:14:54 wiz Exp $
|
||||
.\"
|
||||
.\" zip_add.mdoc -- add files to zip archive
|
||||
.\" Copyright (C) 2004, 2005, 2006 Dieter Baron and Thomas Klausner
|
||||
.\"
|
||||
.\" This file is part of libzip, a library to manipulate ZIP archives.
|
||||
.\" The authors can be contacted at <[email protected]>
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in
|
||||
.\" the documentation and/or other materials provided with the
|
||||
.\" distribution.
|
||||
.\" 3. The names of the authors may not be used to endorse or promote
|
||||
.\" products derived from this software without specific prior
|
||||
.\" written permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
|
||||
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
|
||||
.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
|
||||
.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
||||
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
|
||||
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
.\"
|
||||
.Dd April 9, 2006
|
||||
.Dt ZIP_ADD 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm zip_add ,
|
||||
.Nm zip_replace
|
||||
.Nd add file to zip archive or replace file in zip archive
|
||||
.Sh LIBRARY
|
||||
libzip (-lzip)
|
||||
.Sh SYNOPSIS
|
||||
.In zip.h
|
||||
.Ft int
|
||||
.Fn zip_add "struct zip *archive" "const char *name" \
|
||||
"struct zip_source *source"
|
||||
.Ft int
|
||||
.Fn zip_replace "struct zip *archive" "int index" \
|
||||
"struct zip_source *source"
|
||||
.Sh DESCRIPTION
|
||||
The function
|
||||
.Fn zip_add
|
||||
adds a file to a zip archive, while
|
||||
.Fn zip_replace
|
||||
replaces an existing file in a zip archive.
|
||||
The argument
|
||||
.Ar archive
|
||||
specifies the zip archive to which the file should be added.
|
||||
.Ar name
|
||||
is the file's name in the zip archive (for
|
||||
.Fn zip_add ) ,
|
||||
while
|
||||
.Ar index
|
||||
specifies which file should be replaced (for
|
||||
.Fn zip_replace ) .
|
||||
The data is obtained from the
|
||||
.Ar source
|
||||
argument.
|
||||
See the
|
||||
.Fn zip_source_*
|
||||
functions cited in
|
||||
.Sx SEE ALSO .
|
||||
.Sh RETURN VALUES
|
||||
Upon successful completion, the index of the new file in the archive
|
||||
is returned.
|
||||
Otherwise, \-1 is returned and the error code in
|
||||
.Ar archive
|
||||
is set to indicate the error.
|
||||
.Sh EXAMPLES
|
||||
.Bd -literal -offset indent
|
||||
struct zip_source *s;
|
||||
|
||||
if ((s=zip_source_buffer(archive, buffer, len)) == NULL ||
|
||||
zip_add(archive, name, s) \*[Lt] 0) {
|
||||
zip_source_free(s);
|
||||
printf("error adding file: %s\n", zip_strerror(archive));
|
||||
}
|
||||
.Ed
|
||||
.Sh ERRORS
|
||||
.Fn zip_add
|
||||
and
|
||||
.Fn zip_replace
|
||||
fail if:
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er ZIP_ER_EXISTS
|
||||
There is already a file called
|
||||
.Ar name
|
||||
in the archive.
|
||||
(Only applies to
|
||||
.Fn zip_add ) .
|
||||
.It Bq Er ZIP_ER_INVAL
|
||||
.Ar source
|
||||
or
|
||||
.Ar name
|
||||
are
|
||||
.Dv NULL ,
|
||||
or
|
||||
.Ar index
|
||||
is invalid.
|
||||
.It Bq Er ZIP_ER_MEMORY
|
||||
Required memory could not be allocated.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr libzip 3 ,
|
||||
.Xr zip_source_file 3 ,
|
||||
.Xr zip_source_filep 3 ,
|
||||
.Xr zip_source_function 3 ,
|
||||
.Xr zip_source_zip 3
|
||||
.Sh AUTHORS
|
||||
.An -nosplit
|
||||
.An Dieter Baron Aq [email protected]
|
||||
and
|
||||
.An Thomas Klausner Aq [email protected]
|
||||
Reference in New Issue
Block a user