Imported Upstream version 1.9.0

[platform/upstream/libzip.git] / man / zip_close.man

diff --git a/man/zip_close.man b/man/zip_close.man
index 0c4ef60..e9936c1 100644 (file)
--- a/man/zip_close.man
+++ b/man/zip_close.man
@@ -1,4 +1,36 @@
-.TH "ZIP_CLOSE" "3" "December 18, 2017" "NiH" "Library Functions Manual"
+.\" Automatically generated from an mdoc input file.  Do not edit.
+.\" zip_close.mdoc -- close zip archive
+.\" Copyright (C) 2003-2022 Dieter Baron and Thomas Klausner
+.\"
+.\" This file is part of libzip, a library to manipulate ZIP archives.
+.\" The authors can be contacted at <libzip@nih.at>
+.\"
+.\" 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.
+.\"
+.TH "ZIP_CLOSE" "3" "April 1, 2022" "NiH" "Library Functions Manual"
 .nh
 .if n .ad l
 .SH "NAME"
@@ -28,14 +60,19 @@ written).
 If successful,
 \fIarchive\fR
 is freed.
-If writing fails,
-\fBzip_close\fR()
-fails;
+Otherwise
 \fIarchive\fR
 is left unchanged and must still be freed.
 .PP
 To close and free a zip archive without saving changes, use
 zip_discard(3).
+.PP
+Progress updates for GUIs can be implemented using
+zip_register_progress_callback_with_state(3).
+Cancelling the write of an archive during
+\fBzip_close\fR
+can be implemented using
+zip_register_cancel_callback_with_state(3).
 .SH "RETURN VALUES"
 Upon successful completion 0 is returned.
 Otherwise, \-1 is returned and the error code in
@@ -90,9 +127,10 @@ for added or replaced files will be passed back.
 .SH "SEE ALSO"
 libzip(3),
 zip_discard(3),
-zip_error_get(3),
 zip_fdopen(3),
+zip_get_error(3),
 zip_open(3),
+zip_register_cancel_callback_with_state(3),
 zip_register_progress_callback_with_state(3),
 zip_strerror(3)
 .SH "HISTORY"
@@ -102,3 +140,11 @@ was added in libzip 0.6.
 Dieter Baron <\fIdillo@nih.at\fR>
 and
 Thomas Klausner <\fItk@giga.or.at\fR>
+.SH "CAVEATS"
+Please note that all indices,
+zip_stat(3)
+information and other data about the archive is invalid after
+\fBzip_close\fR.
+When you open the same file again, it will be a completely new
+\fIzip_t\fR
+structure.