aboutsummaryrefslogtreecommitdiff
path: root/dep/libzip/man/zip_rename.man
diff options
context:
space:
mode:
Diffstat (limited to 'dep/libzip/man/zip_rename.man')
-rw-r--r--dep/libzip/man/zip_rename.man88
1 files changed, 88 insertions, 0 deletions
diff --git a/dep/libzip/man/zip_rename.man b/dep/libzip/man/zip_rename.man
new file mode 100644
index 00000000000..2f1acd6063a
--- /dev/null
+++ b/dep/libzip/man/zip_rename.man
@@ -0,0 +1,88 @@
+.\" Converted with mdoc2man 0.2
+.\" from NiH: zip_rename.mdoc,v 1.7 2005/06/09 21:13:12 wiz Exp
+.\" $NiH: zip_rename.mdoc,v 1.7 2005/06/09 21:13:12 wiz Exp $
+.\"
+.\" zip_rename.mdoc \-- rename file in zip archive
+.\" Copyright (C) 2003-2008 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_RENAME 3 "July 24, 2008" NiH
+.SH "NAME"
+zip_rename \- rename file in zip archive
+.SH "LIBRARY"
+libzip (-lzip)
+.SH "SYNOPSIS"
+#include <zip.h>
+.PP
+int
+zip_rename(struct zip *archive, int index, const char *name);
+.SH "DESCRIPTION"
+The file at position
+\fBindex\fR
+in the zip archive
+\fBarchive\fR
+is renamed to
+\fBname.\fR
+.SH "RETURN VALUES"
+Upon successful completion 0 is returned.
+Otherwise, \-1 is returned and the error code in
+\fBarchive\fR
+is set to indicate the error.
+.SH "ERRORS"
+zip_rename
+fails if:
+.RS
+.TP 4
+[ZIP_ER_DELETED]
+The file to be renamed has been deleted from the archive.
+.TP 4
+[ZIP_ER_EXISTS]
+There is already a file called
+\fBname\fR
+in the archive.
+.TP 4
+[ZIP_ER_INVAL]
+\fBindex\fR
+is not a valid file index in
+\fBarchive,\fR
+\fBname is\fR
+\fBNULL\fR
+or the empty string.
+Also a file cannot be renamed to a directory or vice versa.
+Directories are denoted by a trailing slash.
+.RE
+.SH "SEE ALSO"
+libzip(3),
+zip_unchange(3)
+.SH "AUTHORS"
+
+Dieter Baron <dillo@giga.or.at>
+and
+Thomas Klausner <tk@giga.or.at>