Add zip_add_dir.man, regen with latest mdoc2man (making output nearly
readable again).
--HG--
branch : HEAD
diff --git a/man/libzip.man b/man/libzip.man
index 434141f..9862f87 100644
--- a/man/libzip.man
+++ b/man/libzip.man
@@ -39,7 +39,7 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
+#include <zip.h>
.SH "DESCRIPTION"
.B libzip
is a library for reading, creating, and modifying zip archives.
diff --git a/man/zip_add.man b/man/zip_add.man
index 7a594f3..d98ebb5 100644
--- a/man/zip_add.man
+++ b/man/zip_add.man
@@ -40,34 +40,36 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_add "struct zip *archive" "const char *name" \
+#include <zip.h>
+.PP
+int
+zip_add(struct zip *archive, const char *name); \
"struct zip_source *source"
-.Ft int
-.Fn zip_replace "struct zip *archive" "int index" \
+.PP
+int
+zip_replace(struct zip *archive, int index); \
"struct zip_source *source"
.SH "DESCRIPTION"
The function
-.Fn zip_add
+zip_add
adds a file to a zip archive, while
-.Fn zip_replace
+zip_replace
replaces an existing file in a zip archive.
The argument
\fBarchive\fR
specifies the zip archive to which the file should be added.
\fBname\fR
is the file's name in the zip archive (for
-.Fn zip_add ),
+zip_add ),
while
\fBindex\fR
specifies which file should be replaced (for
-.Fn zip_replace ).
+zip_replace ).
The data is obtained from the
\fBsource\fR
argument.
See the
-.Fn zip_source_*
+zip_source_*
functions cited in
SEE ALSO.
.SH "RETURN VALUES"
@@ -87,20 +89,20 @@
}
.Ed
.SH "ERRORS"
-.Fn zip_add
+zip_add
and
-.Fn zip_replace
+zip_replace
fail if:
.RS
.TP 4
-Bq Er ZIP_ER_EXISTS
+[ZIP_ER_EXISTS]
There is already a file called
\fBname\fR
in the archive.
(Only applies to
-.Fn zip_add ).
+zip_add ).
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
\fBsource\fR
or
\fBname\fR
@@ -110,7 +112,7 @@
\fBindex\fR
is invalid.
.TP 4
-Bq Er ZIP_ER_MEMORY
+[ZIP_ER_MEMORY]
Required memory could not be allocated.
.RE
.SH "SEE ALSO"
diff --git a/man/zip_add_dir.man b/man/zip_add_dir.man
new file mode 100644
index 0000000..6b3525c
--- /dev/null
+++ b/man/zip_add_dir.man
@@ -0,0 +1,88 @@
+.\" Converted with mdoc2man 0.2
+.\" from NiH: zip_add_dir.mdoc,v 1.1 2006/10/03 18:55:51 wiz Exp
+.\" $NiH: zip_add_dir.mdoc,v 1.1 2006/10/03 18:55:51 wiz Exp $
+.\"
+.\" zip_add_dir.mdoc \-- add directory to zip archive
+.\" Copyright (C) 2006 Dieter Baron and Thomas Klausner
+.\"
+.\" This file is part of libzip, a library to manipulate ZIP archives.
+.\" The authors can be contacted at <nih@giga.or.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_ADD_DIR 3 "October 3, 2006" NiH
+.SH "NAME"
+zip_add_dir \- add directory to zip archive
+.SH "LIBRARY"
+libzip (-lzip)
+.SH "SYNOPSIS"
+#include <zip.h>
+.PP
+int
+zip_add_dir(struct zip *archive, const char *name);
+.SH "DESCRIPTION"
+The function
+zip_add_dir
+adds a directory to a zip archive.
+The argument
+\fBarchive\fR
+specifies the zip archive to which the file should be added.
+\fBname\fR
+is the directory's name in the zip archive.
+.SH "RETURN VALUES"
+Upon successful completion, the index of the new entry in the archive
+is returned.
+Otherwise, \-1 is returned and the error code in
+\fBarchive\fR
+is set to indicate the error.
+.SH "ERRORS"
+zip_add_dir
+fails if:
+.RS
+.TP 4
+[ZIP_ER_EXISTS]
+There is already an entry called
+\fBname\fR
+in the archive.
+.TP 4
+[ZIP_ER_INVAL]
+\fBarchive\fR
+or
+\fBname\fR
+are
+\fBNULL.\fR
+.TP 4
+[ZIP_ER_MEMORY]
+Required memory could not be allocated.
+.RE
+.SH "SEE ALSO"
+libzip(3),
+zip_add(3)
+.SH "AUTHORS"
+
+Dieter Baron <dillo@giga.or.at>
+and
+Thomas Klausner <tk@giga.or.at>
diff --git a/man/zip_close.man b/man/zip_close.man
index e485606..1873ec7 100644
--- a/man/zip_close.man
+++ b/man/zip_close.man
@@ -39,19 +39,20 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_close "struct zip *archive"
+#include <zip.h>
+.PP
+int
+zip_close(struct zip *archive);
.SH "DESCRIPTION"
The
-.Fn zip_close
+zip_close
function closes
\fBarchive\fR
and frees the memory allocated for it.
If any files within were changed, those changes are written to disk
first.
If writing changes fails,
-.Fn zip_close
+zip_close
fails and
\fBarchive\fR
is left unchanged.
@@ -61,45 +62,45 @@
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.Fn zip_close
+zip_close
will fail if:
.RS
.TP 4
-Bq Er ZIP_ER_EOF
+[ZIP_ER_EOF]
Unexpected end-of-file found while reading from a file.
.TP 4
-Bq Er ZIP_ER_INTERNAL
+[ZIP_ER_INTERNAL]
The callback function of an added or replaced file returned an
error but failed to report which.
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
The
\fBpath\fR
argument is
\fBNULL.\fR
.TP 4
-Bq Er ZIP_ER_MEMORY
+[ZIP_ER_MEMORY]
Required memory could not be allocated.
.TP 4
-Bq Er ZIP_ER_NOZIP
+[ZIP_ER_NOZIP]
File is not a zip archive.
.TP 4
-Bq Er ZIP_ER_READ
+[ZIP_ER_READ]
A file read failed.
.TP 4
-Bq Er ZIP_ER_RENAME
+[ZIP_ER_RENAME]
A temporary file could not be renamed to its final name.
.TP 4
-Bq Er ZIP_ER_SEEK
+[ZIP_ER_SEEK]
A file seek failed.
.TP 4
-Bq Er ZIP_ER_TMPOPEN
+[ZIP_ER_TMPOPEN]
A temporary file could not be created.
.TP 4
-Bq Er ZIP_ER_WRITE
+[ZIP_ER_WRITE]
A file write failed.
.TP 4
-Bq Er ZIP_ER_ZLIB
+[ZIP_ER_ZLIB]
An error occurred while (de)compressing a stream with
zlib(3).
.RE
diff --git a/man/zip_delete.man b/man/zip_delete.man
index 80fc469..7497256 100644
--- a/man/zip_delete.man
+++ b/man/zip_delete.man
@@ -39,9 +39,10 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_delete "struct zip *archive" "int index"
+#include <zip.h>
+.PP
+int
+zip_delete(struct zip *archive, int index);
.SH "DESCRIPTION"
The file at position
\fBindex\fR
@@ -54,11 +55,11 @@
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.Fn zip_delete
+zip_delete
fails if:
.RS
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
\fBindex\fR
is not a valid file index in
\fBarchive.\fR
diff --git a/man/zip_error_get.man b/man/zip_error_get.man
index f08b612..73b12bc 100644
--- a/man/zip_error_get.man
+++ b/man/zip_error_get.man
@@ -40,14 +40,16 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft void
-.Fn zip_error_get "struct zip *archive" "int *zep" "int *sep"
-.Ft void
-.Fn zip_file_error_get "struct zip_file *file" "int *zep" "int *sep"
+#include <zip.h>
+.PP
+void
+zip_error_get(struct zip *archive, int *zep, int *sep);
+.PP
+void
+zip_file_error_get(struct zip_file *file, int *zep, int *sep);
.SH "DESCRIPTION"
The
-.Fn zip_error_get
+zip_error_get
function returns the error codes for the zip archive
\fBarchive.\fR
If
@@ -63,11 +65,11 @@
is not
\fBNULL;\fR
use
-.Fn zip_error_get_sys_type
+zip_error_get_sys_type
to determine the type of system error code.
.PP
The
-.Fn zip_file_error_get
+zip_file_error_get
function does the same for the zip file
\fBfile.\fR
.SH "SEE ALSO"
diff --git a/man/zip_error_get_sys_type.man b/man/zip_error_get_sys_type.man
index 2bd61ae..f0b1abb 100644
--- a/man/zip_error_get_sys_type.man
+++ b/man/zip_error_get_sys_type.man
@@ -39,12 +39,13 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_error_get_sys_type "int ze"
+#include <zip.h>
+.PP
+int
+zip_error_get_sys_type(int ze);
.SH "DESCRIPTION"
The
-.Fn zip_error_get_sys_type
+zip_error_get_sys_type
function returns the type of the system error code for the libzip error
\fBze.\fR
Possible types are:
diff --git a/man/zip_error_to_str.man b/man/zip_error_to_str.man
index b1556e3..b9d1460 100644
--- a/man/zip_error_to_str.man
+++ b/man/zip_error_to_str.man
@@ -39,12 +39,13 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_error_to_str "char *buf" "int len" "int ze" "int se"
+#include <zip.h>
+.PP
+int
+zip_error_to_str(char *buf, int len, int ze, int se);
.SH "DESCRIPTION"
The
-.Fn zip_error_to_str
+zip_error_to_str
function stores a string describing the libzip error code
\fBze\fR
in the user-provided buffer
@@ -58,18 +59,18 @@
at the time of the error or the zlib error code, depending on
\fBze.\fR
.PP
-.Fn zip_error_to_str
+zip_error_to_str
is especially useful if
-.Fn zip_open
+zip_open
failed, since then there is no
.Vt struct zip
is available to store the error code; otherwise
-.Fn zip_strerror
+zip_strerror
or
-.Fn zip_file_strerror
+zip_file_strerror
are more convenient.
.SH "RETURN VALUES"
-.Fn zip_error_to_str
+zip_error_to_str
returns the number of characters that would have been written to a
sufficiently sized
\fBbuf,\fR
diff --git a/man/zip_errors.man b/man/zip_errors.man
index bf50fa3..c8e2fdd 100644
--- a/man/zip_errors.man
+++ b/man/zip_errors.man
@@ -44,81 +44,81 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
+#include <zip.h>
.SH "DESCRIPTION"
The following error codes are used by libzip:
.RS
.TP 23
-Bq Er ZIP_ER_OK
+[ZIP_ER_OK]
No error.
.TP 23
-Bq Er ZIP_ER_MULTIDISK
+[ZIP_ER_MULTIDISK]
Multi-disk zip archives not supported.
.TP 23
-Bq Er ZIP_ER_RENAME
+[ZIP_ER_RENAME]
Renaming temporary file failed.
.TP 23
-Bq Er ZIP_ER_CLOSE
+[ZIP_ER_CLOSE]
Closing zip archive failed.
.TP 23
-Bq Er ZIP_ER_SEEK
+[ZIP_ER_SEEK]
Seek error.
.TP 23
-Bq Er ZIP_ER_READ
+[ZIP_ER_READ]
Read error.
.TP 23
-Bq Er ZIP_ER_WRITE
+[ZIP_ER_WRITE]
Write error.
.TP 23
-Bq Er ZIP_ER_CRC
+[ZIP_ER_CRC]
CRC error.
.TP 23
-Bq Er ZIP_ER_ZIPCLOSED
+[ZIP_ER_ZIPCLOSED]
Containing zip archive was closed.
.TP 23
-Bq Er ZIP_ER_NOENT
+[ZIP_ER_NOENT]
No such file.
.TP 23
-Bq Er ZIP_ER_EXISTS
+[ZIP_ER_EXISTS]
File already exists.
.TP 23
-Bq Er ZIP_ER_OPEN
+[ZIP_ER_OPEN]
Can't open file.
.TP 23
-Bq Er ZIP_ER_TMPOPEN
+[ZIP_ER_TMPOPEN]
Failure to create temporary file.
.TP 23
-Bq Er ZIP_ER_ZLIB
+[ZIP_ER_ZLIB]
Zlib error.
.TP 23
-Bq Er ZIP_ER_MEMORY
+[ZIP_ER_MEMORY]
Malloc failure.
.TP 23
-Bq Er ZIP_ER_CHANGED
+[ZIP_ER_CHANGED]
Entry has been changed.
.TP 23
-Bq Er ZIP_ER_COMPNOTSUPP
+[ZIP_ER_COMPNOTSUPP]
Compression method not supported.
.TP 23
-Bq Er ZIP_ER_EOF
+[ZIP_ER_EOF]
Premature EOF.
.TP 23
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
Invalid argument.
.TP 23
-Bq Er ZIP_ER_NOZIP
+[ZIP_ER_NOZIP]
Not a zip archive.
.TP 23
-Bq Er ZIP_ER_INTERNAL
+[ZIP_ER_INTERNAL]
Internal error.
.TP 23
-Bq Er ZIP_ER_INCONS
+[ZIP_ER_INCONS]
Zip archive inconsistent.
.TP 23
-Bq Er ZIP_ER_REMOVE
+[ZIP_ER_REMOVE]
Can't remove file.
.TP 23
-Bq Er ZIP_ER_DELETED
+[ZIP_ER_DELETED]
Entry has been deleted.
.RE
.SH "AUTHORS"
diff --git a/man/zip_fclose.man b/man/zip_fclose.man
index 5b25dee..a0be20a 100644
--- a/man/zip_fclose.man
+++ b/man/zip_fclose.man
@@ -39,12 +39,13 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_fclose "struct zip_file *file"
+#include <zip.h>
+.PP
+int
+zip_fclose(struct zip_file *file);
.SH "DESCRIPTION"
The
-.Fn zip_fclose
+zip_fclose
function closes
\fBfile\fR
and frees the memory allocated for it.
diff --git a/man/zip_file_strerror.man b/man/zip_file_strerror.man
index 5abf83f..a995bf0 100644
--- a/man/zip_file_strerror.man
+++ b/man/zip_file_strerror.man
@@ -40,18 +40,20 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft const char *
-.Fn zip_file_strerror "struct zip_file *file"
-.Ft const char *
-.Fn zip_strerror "struct zip *archive"
+#include <zip.h>
+.PP
+const char *
+zip_file_strerror(struct zip_file *file);
+.PP
+const char *
+zip_strerror(struct zip *archive);
.SH "DESCRIPTION"
The
-.Fn zip_strerror
+zip_strerror
function returns a string describing the last error for the zip archive
\fBarchive,\fR
while the
-.Fn zip_file_strerror
+zip_file_strerror
function does the same for a zip file
\fBfile\fR
(one file in an archive).
@@ -61,15 +63,15 @@
\fBfile,\fR
respectively,
is closed or on the next call to
-.Fn zip_strerror
+zip_strerror
or
-.Fn zip_file_strerror,
+zip_file_strerror,
respectively,
for the same archive.
.SH "RETURN VALUES"
-.Fn zip_file_strerror
+zip_file_strerror
and
-.Fn zip_strerror
+zip_strerror
return a pointer to the error string.
.SH "SEE ALSO"
libzip(3),
diff --git a/man/zip_fopen.man b/man/zip_fopen.man
index 5cc7eba..b4f7bf9 100644
--- a/man/zip_fopen.man
+++ b/man/zip_fopen.man
@@ -40,14 +40,16 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft struct zip_file *
-.Fn zip_fopen "struct zip *archive" "const char *fname" "int flags"
-.Ft struct zip_file *
-.Fn zip_fopen_index "struct zip *archive" "int index" "int flags"
+#include <zip.h>
+.PP
+struct zip_file *
+zip_fopen(struct zip *archive, const char *fname, int flags);
+.PP
+struct zip_file *
+zip_fopen_index(struct zip *archive, int index, int flags);
.SH "DESCRIPTION"
The
-.Fn zip_fopen
+zip_fopen
function opens the file name
\fBfname\fR
in
@@ -65,7 +67,7 @@
\fBZIP_FL_COMPRESSED\fR
Read the compressed data.
Otherwise the data is uncompressed by
-.Fn zip_fread.
+zip_fread.
.TP 19
\fBZIP_FL_UNCHANGED\fR
Read the original data from the zip archive, ignoring any changes made
@@ -73,12 +75,13 @@
.RE
.PP
The
-.Fn zip_fopen_index
+zip_fopen_index
function opens the file at position
\fBindex.\fR
.SH "RETURN VALUES"
Upon successful completion, a
-.Ft struct zip_file
+.PP
+struct zip_file
pointer is returned.
Otherwise,
\fBNULL\fR
@@ -88,36 +91,36 @@
.SH "ERRORS"
.RS
.TP 4
-Bq Er ZIP_ER_CHANGED
+[ZIP_ER_CHANGED]
The file data has been changed.
.TP 4
-Bq Er ZIP_ER_COMPNOTSUPP
+[ZIP_ER_COMPNOTSUPP]
The compression method used is not supported.
.TP 4
-Bq Er ZIP_ER_MEMORY
+[ZIP_ER_MEMORY]
Required memory could not be allocated.
.TP 4
-Bq Er ZIP_ER_READ
+[ZIP_ER_READ]
A file read error occurred.
.TP 4
-Bq Er ZIP_ER_SEEK
+[ZIP_ER_SEEK]
A file seek error occurred.
.TP 4
-Bq Er ZIP_ER_ZLIB
+[ZIP_ER_ZLIB]
Initializing the zlib stream failed.
.RE
.PP
The function
-.Fn zip_fopen
+zip_fopen
may also fail and set
.Va zip_err
for any of the errors specified for the routine
zip_name_locate(3).
.PP
The function
-.Fn zip_fopen_index
+zip_fopen_index
may also fail with
-.Er ZIP_ER_INVAL
+ZIP_ER_INVAL
if
\fBindex\fR
is invalid.
diff --git a/man/zip_fread.man b/man/zip_fread.man
index f2ceb76..c00c759 100644
--- a/man/zip_fread.man
+++ b/man/zip_fread.man
@@ -39,12 +39,13 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_fread "struct zip_file *file" "void *buf" "int nbytes"
+#include <zip.h>
+.PP
+int
+zip_fread(struct zip_file *file, void *buf, int nbytes);
.SH "DESCRIPTION"
The
-.Fn zip_fread
+zip_fread
function reads at most
\fBnbytes\fR
bytes from
diff --git a/man/zip_get_archive_comment.man b/man/zip_get_archive_comment.man
index 38b9302..e584776 100644
--- a/man/zip_get_archive_comment.man
+++ b/man/zip_get_archive_comment.man
@@ -39,12 +39,13 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft const char *
-.Fn zip_get_archive_comment "struct zip *archive" "int *lenp" "int flags"
+#include <zip.h>
+.PP
+const char *
+zip_get_archive_comment(struct zip *archive, int *lenp, int flags);
.SH "DESCRIPTION"
The
-.Fn zip_get_archive_comment
+zip_get_archive_comment
function returns the comment for the entire zip archive.
This pointer should not be modified or
free(3)
diff --git a/man/zip_get_file_comment.man b/man/zip_get_file_comment.man
index 5266343..4b4dfdb 100644
--- a/man/zip_get_file_comment.man
+++ b/man/zip_get_file_comment.man
@@ -39,12 +39,13 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft const char *
-.Fn zip_get_file_comment "struct zip *archive" "int index" "int *lenp" "int flags"
+#include <zip.h>
+.PP
+const char *
+zip_get_file_comment(struct zip *archive, int index, int *lenp, int flags);
.SH "DESCRIPTION"
The
-.Fn zip_get_file_comment
+zip_get_file_comment
function returns the comment for the file at position
\fBindex\fR
in the zip archive.
@@ -73,11 +74,11 @@
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.Fn zip_get_file_comment
+zip_get_file_comment
fails if:
.RS
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
\fBindex\fR
is not a valid file index in
\fBarchive.\fR
diff --git a/man/zip_get_name.man b/man/zip_get_name.man
index 3a15434..d760266 100644
--- a/man/zip_get_name.man
+++ b/man/zip_get_name.man
@@ -39,12 +39,13 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft const char *
-.Fn zip_get_name "struct zip *archive" "int index" "int flags"
+#include <zip.h>
+.PP
+const char *
+zip_get_name(struct zip *archive, int index, int flags);
.SH "DESCRIPTION"
The
-.Fn zip_get_name
+zip_get_name
function returns the name of the file at position
\fBindex\fR
in
@@ -65,18 +66,18 @@
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.Fn zip_get_name
+zip_get_name
fails if:
.RS
.TP 4
-Bq Er ZIP_ER_DELETED
+[ZIP_ER_DELETED]
\fBindex\fR
refers to a file that has been deleted
(see
zip_delete(3)
).
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
\fBindex\fR
is not a valid file index in
\fBarchive,\fR
diff --git a/man/zip_get_num_files.man b/man/zip_get_num_files.man
index 808b393..d7bc88e 100644
--- a/man/zip_get_num_files.man
+++ b/man/zip_get_num_files.man
@@ -39,16 +39,17 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_get_num_files "struct zip *archive"
+#include <zip.h>
+.PP
+int
+zip_get_num_files(struct zip *archive);
.SH "DESCRIPTION"
The
-.Fn zip_get_num_files
+zip_get_num_files
function returns the number of files in
\fBarchive.\fR
.SH "RETURN VALUES"
-.Fn zip_get_num_files
+zip_get_num_files
returns the number of files in the zip archive,
or \-1 if
\fBarchive\fR
diff --git a/man/zip_name_locate.man b/man/zip_name_locate.man
index 76f1533..50670e6 100644
--- a/man/zip_name_locate.man
+++ b/man/zip_name_locate.man
@@ -39,12 +39,13 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_name_locate "struct zip *archive" "const char *fname" "int flags"
+#include <zip.h>
+.PP
+int
+zip_name_locate(struct zip *archive, const char *fname, int flags);
.SH "DESCRIPTION"
The
-.Fn zip_name_locate
+zip_name_locate
function returns the index of the file named
\fBfname\fR
in
diff --git a/man/zip_open.man b/man/zip_open.man
index f3d09c7..d357cc8 100644
--- a/man/zip_open.man
+++ b/man/zip_open.man
@@ -39,14 +39,16 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft struct zip *
-.Fn zip_open "const char *path" "int flags" "int *errorp"
+#include <zip.h>
+.PP
+struct zip *
+zip_open(const char *path, int flags, int *errorp);
.SH "DESCRIPTION"
The zip archive specified by
\fBpath\fR
is opened and a pointer to a
-.Ft struct zip,
+.PP
+struct zip,
used to manipulate the archive, is returned.
The
.Fa flags
@@ -71,9 +73,10 @@
is non-NULL, it will be set to the corresponding error code.
.SH "RETURN VALUES"
Upon successful completion
-.Fn zip_open
+zip_open
returns a
-.Ft struct zip
+.PP
+struct zip
pointer.
Otherwise,
\fBNULL\fR
@@ -86,52 +89,52 @@
is opened unless:
.RS
.TP 4
-Bq Er ZIP_ER_EXISTS
+[ZIP_ER_EXISTS]
The file specified by
\fBpath\fR
exists and
\fBZIP_EXCL\fR
is set.
.TP 4
-Bq Er ZIP_ER_INCONS
+[ZIP_ER_INCONS]
Inconsistencies were found in the file specified by
\fBpath\fR
and
\fBZIP_CHECKCONS\fR
was specified.
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
The
\fBpath\fR
argument is
\fBNULL.\fR
.TP 4
-Bq Er ZIP_ER_MEMORY
+[ZIP_ER_MEMORY]
Required memory could not be allocated.
.TP 4
-Bq Er ZIP_ER_NOENT
+[ZIP_ER_NOENT]
The file specified by
\fBpath\fR
does not exist and
\fBZIP_CREATE\fR
is not set.
.TP 4
-Bq Er ZIP_ER_NOZIP
+[ZIP_ER_NOZIP]
The file specified by
\fBpath\fR
is not a zip archive.
.TP 4
-Bq Er ZIP_ER_OPEN
+[ZIP_ER_OPEN]
The file specified by
\fBpath\fR
could not be opened.
.TP 4
-Bq Er ZIP_ER_READ
+[ZIP_ER_READ]
A read error occurred; see
.Va errno
for details.
.TP 4
-Bq Er ZIP_ER_SEEK
+[ZIP_ER_SEEK]
The file specified by
\fBpath\fR
does not allow seeks.
diff --git a/man/zip_rename.man b/man/zip_rename.man
index 4d5a445..0622ef0 100644
--- a/man/zip_rename.man
+++ b/man/zip_rename.man
@@ -39,9 +39,10 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_rename "struct zip *archive" "int index" "const char *name"
+#include <zip.h>
+.PP
+int
+zip_rename(struct zip *archive, int index, const char *name);
.SH "DESCRIPTION"
The file at position
\fBindex\fR
@@ -55,16 +56,16 @@
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.Fn zip_rename
+zip_rename
fails if:
.RS
.TP 4
-Bq Er ZIP_ER_EXISTS
+[ZIP_ER_EXISTS]
There is already a file called
\fBname\fR
in the archive.
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
\fBindex\fR
is not a valid file index in
\fBarchive.\fR
diff --git a/man/zip_set_archive_comment.man b/man/zip_set_archive_comment.man
index 2d5afda..55809da 100644
--- a/man/zip_set_archive_comment.man
+++ b/man/zip_set_archive_comment.man
@@ -39,13 +39,14 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_set_archive_comment "struct zip *archive" \
+#include <zip.h>
+.PP
+int
+zip_set_archive_comment(struct zip *archive); \
"const char *comment" "int *lenp"
.SH "DESCRIPTION"
The
-.Fn zip_set_archive_comment
+zip_set_archive_comment
function sets the comment for the entire zip archive.
If
\fBcomment\fR
@@ -60,16 +61,16 @@
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.Fn zip_set_archive_comment
+zip_set_archive_comment
fails if:
.RS
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
\fBlen\fR
is less than 0 or longer than the maximum comment length in a zip file
(65535).
.TP 4
-Bq Er ZIP_ER_MEMORY
+[ZIP_ER_MEMORY]
Required memory could not be allocated.
.RE
.SH "SEE ALSO"
diff --git a/man/zip_set_file_comment.man b/man/zip_set_file_comment.man
index 3564dbe..e12a06a 100644
--- a/man/zip_set_file_comment.man
+++ b/man/zip_set_file_comment.man
@@ -39,13 +39,14 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_set_file_comment "struct zip *archive" "int index" \
+#include <zip.h>
+.PP
+int
+zip_set_file_comment(struct zip *archive, int index); \
"const char *comment" "int len"
.SH "DESCRIPTION"
The
-.Fn zip_set_file_comment
+zip_set_file_comment
function sets the comment for the file at position
\fBindex\fR
in the zip archive to
@@ -65,11 +66,11 @@
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.Fn zip_set_file_comment
+zip_set_file_comment
fails if:
.RS
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
\fBindex\fR
is not a valid file index in
\fBarchive,\fR
@@ -78,7 +79,7 @@
is less than 0 or longer than the maximum comment length in a zip file
(65535).
.TP 4
-Bq Er ZIP_ER_MEMORY
+[ZIP_ER_MEMORY]
Required memory could not be allocated.
.RE
.SH "SEE ALSO"
diff --git a/man/zip_source_buffer.man b/man/zip_source_buffer.man
index 5225a44..8cf8360 100644
--- a/man/zip_source_buffer.man
+++ b/man/zip_source_buffer.man
@@ -39,13 +39,14 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft struct zip_source *
-.Fn zip_source_buffer "struct zip *archive" "const void *data" "off_t len" \
+#include <zip.h>
+.PP
+struct zip_source *
+zip_source_buffer(struct zip *archive, const void *data, off_t len); \
"int freep"
.SH "DESCRIPTION"
The function
-.Fn zip_source_buffer
+zip_source_buffer
creates a zip source from the buffer
\fBdata\fR
of size
@@ -61,11 +62,11 @@
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.Fn zip_source_buffer
+zip_source_buffer
fails if:
.RS
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
\fBlen\fR
is negative, or
\fBlen\fR
@@ -74,7 +75,7 @@
is
\fBNULL.\fR
.TP 4
-Bq Er ZIP_ER_MEMORY
+[ZIP_ER_MEMORY]
Required memory could not be allocated.
.RE
.SH "SEE ALSO"
diff --git a/man/zip_source_file.man b/man/zip_source_file.man
index 9e2e9c5..745faf6 100644
--- a/man/zip_source_file.man
+++ b/man/zip_source_file.man
@@ -39,13 +39,14 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.Ft struct zip_source *
-.Fn zip_source_file "struct zip *archive" "const char *fname" "off_t start" "off_t len"
+.PP
+struct zip_source *
+zip_source_file(struct zip *archive, const char *fname, off_t start, off_t len);
.SH "DESCRIPTION"
The function
-.Fn zip_source_file
+zip_source_file
creates a zip source from a file.
-.Fn zip_source_file
+zip_source_file
opens
\fBfname\fR
and reads
@@ -66,21 +67,21 @@
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.Fn zip_source_file
+zip_source_file
fails if:
.RS
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
\fBfname,\fR
\fBstart,\fR
or
\fBlen\fR
are invalid.
.TP 4
-Bq Er ZIP_ER_MEMORY
+[ZIP_ER_MEMORY]
Required memory could not be allocated.
.TP 4
-Bq Er ZIP_ER_OPEN
+[ZIP_ER_OPEN]
Opening
\fBfname\fR
failed.
diff --git a/man/zip_source_filep.man b/man/zip_source_filep.man
index fd9feb2..a3ec7b2 100644
--- a/man/zip_source_filep.man
+++ b/man/zip_source_filep.man
@@ -39,13 +39,14 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.Ft struct zip_source *
-.Fn zip_source_filep "struct zip *archive" "FILE *file" "off_t start" "off_t len"
+.PP
+struct zip_source *
+zip_source_filep(struct zip *archive, FILE *file, off_t start, off_t len);
.SH "DESCRIPTION"
The function
-.Fn zip_source_filep
+zip_source_filep
creates a zip source from a file stream.
-.Fn zip_source_filep
+zip_source_filep
reads
\fBlen\fR
bytes from offset
@@ -65,18 +66,18 @@
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.Fn zip_source_filep
+zip_source_filep
fails if:
.RS
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
\fBfile,\fR
\fBstart,\fR
or
\fBlen\fR
are invalid.
.TP 4
-Bq Er ZIP_ER_MEMORY
+[ZIP_ER_MEMORY]
Required memory could not be allocated.
.RE
.SH "SEE ALSO"
diff --git a/man/zip_source_free.man b/man/zip_source_free.man
index fcee13f..ed13b65 100644
--- a/man/zip_source_free.man
+++ b/man/zip_source_free.man
@@ -39,12 +39,13 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft void
-.Fn zip_source_free "struct zip_source *source"
+#include <zip.h>
+.PP
+void
+zip_source_free(struct zip_source *source);
.SH "DESCRIPTION"
The function
-.Fn zip_source_free
+zip_source_free
frees the zip data source
\fBsource.\fR
If
diff --git a/man/zip_source_function.man b/man/zip_source_function.man
index 777a3c7..fa9f1cc 100644
--- a/man/zip_source_function.man
+++ b/man/zip_source_function.man
@@ -39,12 +39,13 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft struct zip_source *
-.Fn zip_source_function "struct zip *archive" "zip_source_callback fn" "void *userdata"
+#include <zip.h>
+.PP
+struct zip_source *
+zip_source_function(struct zip *archive, zip_source_callback fn, void *userdata);
.SH "DESCRIPTION"
The function
-.Fn zip_source_function
+zip_source_function
creates a zip source from the user-provided function
\fBfn,\fR
which must be of the following type:
@@ -56,7 +57,7 @@
When called by the library, the first argument is the
\fBuserdata\fR
argument supplied to
-.Fn zip_source_function.
+zip_source_function.
The next two arguments are a buffer
\fBdata\fR
of size
@@ -134,11 +135,11 @@
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.Fn zip_source_function
+zip_source_function
fails if:
.RS
.TP 4
-Bq Er ZIP_ER_MEMORY
+[ZIP_ER_MEMORY]
Required memory could not be allocated.
.RE
.SH "SEE ALSO"
diff --git a/man/zip_source_zip.man b/man/zip_source_zip.man
index d23df4c..12f83e6 100644
--- a/man/zip_source_zip.man
+++ b/man/zip_source_zip.man
@@ -39,13 +39,14 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft struct zip_source *
-.Fn zip_source_zip "struct zip *archive" "struct zip *srcarchive" \
+#include <zip.h>
+.PP
+struct zip_source *
+zip_source_zip(struct zip *archive, struct zip *srcarchive); \
"int srcidx" "int flags" "off_t start" "off_t len"
.SH "DESCRIPTION"
The function
-.Fn zip_source_zip
+zip_source_zip
creates a zip source from a file in a zip archive.
The
\fBsrcarchive\fR
@@ -70,7 +71,7 @@
\fBflags\fR
is
\fBZIP_FL_UNCHANGED,\fR
-.Fn zip_source_zip
+zip_source_zip
will try to get the original data without any changes that may
have been made to
\fBsrcarchive\fR
@@ -83,14 +84,14 @@
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.Fn zip_source_zip
+zip_source_zip
fails if:
.RS
.TP 4
-Bq Er ZIP_ER_CHANGED
+[ZIP_ER_CHANGED]
Unchanged data was requested, but it is not available.
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
\fBsrcarchive,\fR
\fBsrcidx,\fR
\fBstart,\fR
@@ -98,13 +99,13 @@
\fBlen\fR
are invalid.
.TP 4
-Bq Er ZIP_ER_MEMORY
+[ZIP_ER_MEMORY]
Required memory could not be allocated.
.RE
Additionally, it can return all error codes from
-.Fn zip_stat_index
+zip_stat_index
and
-.Fn zip_fopen_index.
+zip_fopen_index.
.SH "SEE ALSO"
libzip(3),
zip_add(3),
diff --git a/man/zip_stat.man b/man/zip_stat.man
index a47e6e7..078b03b 100644
--- a/man/zip_stat.man
+++ b/man/zip_stat.man
@@ -40,14 +40,16 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_stat "struct zip *archive" "const char *fname" "int flags" "struct zip_stat *sb"
-.Ft int
-.Fn zip_stat_index "struct zip *archive" "int index" "int flags" "struct zip_stat *sb"
+#include <zip.h>
+.PP
+int
+zip_stat(struct zip *archive, const char *fname, int flags, struct zip_stat *sb);
+.PP
+int
+zip_stat_index(struct zip *archive, int index, int flags, struct zip_stat *sb);
.SH "DESCRIPTION"
The
-.Fn zip_stat
+zip_stat
function obtains information about the file named
\fBfname\fR
in
@@ -65,14 +67,15 @@
ignoring any changes made.
.PP
The
-.Fn zip_stat_index
+zip_stat_index
function obtains information about the file at position
\fBindex.\fR
.PP
The
\fBsb\fR
argument is a pointer to a
-.Ft struct zip_stat
+.PP
+struct zip_stat
(shown below), into which information about the file is placed.
.Bd \-literal
struct zip_stat {
@@ -92,14 +95,14 @@
is set to indicate the error.
.SH "ERRORS"
The function
-.Fn zip_stat
+zip_stat
can fail for any of the errors specified for the routine
zip_name_locate(3).
.PP
The function
-.Fn zip_stat_index
+zip_stat_index
fails and sets the error information to
-.Er ZIP_ER_INVAL
+ZIP_ER_INVAL
if
\fBindex\fR
is invalid.
@@ -107,7 +110,7 @@
\fBZIP_FL_UNCHANGED\fR
is not set and no information can be obtained from the source
callback, the error information is set to
-.Er ZIP_ER_CHANGED.
+ZIP_ER_CHANGED.
.SH "SEE ALSO"
libzip(3),
zip_name_locate(3)
diff --git a/man/zip_unchange.man b/man/zip_unchange.man
index 514062d..caa2aaf 100644
--- a/man/zip_unchange.man
+++ b/man/zip_unchange.man
@@ -39,9 +39,10 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_unchange "struct zip *archive" "int index"
+#include <zip.h>
+.PP
+int
+zip_unchange(struct zip *archive, int index);
.SH "DESCRIPTION"
Changes to the file at position
\fBindex\fR
@@ -52,14 +53,14 @@
\fBarchive\fR
is set to indicate the error.
.SH "ERRORS"
-.Fn zip_unchange
+zip_unchange
fails if:
.RS
.TP 4
-Bq Er ZIP_ER_EXISTS
+[ZIP_ER_EXISTS]
Unchanging the name would result in a duplicate name in the archive.
.TP 4
-Bq Er ZIP_ER_INVAL
+[ZIP_ER_INVAL]
\fBindex\fR
is not a valid file index in
\fBzip.\fR
diff --git a/man/zip_unchange_all.man b/man/zip_unchange_all.man
index df6e298..b995fc8 100644
--- a/man/zip_unchange_all.man
+++ b/man/zip_unchange_all.man
@@ -39,9 +39,10 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_unchange_all "struct zip *archive"
+#include <zip.h>
+.PP
+int
+zip_unchange_all(struct zip *archive);
.SH "DESCRIPTION"
All changes to files and global information in
\fBarchive\fR
diff --git a/man/zip_unchange_archive.man b/man/zip_unchange_archive.man
index 8f26758..be0bdad 100644
--- a/man/zip_unchange_archive.man
+++ b/man/zip_unchange_archive.man
@@ -39,9 +39,10 @@
.SH "LIBRARY"
libzip (-lzip)
.SH "SYNOPSIS"
-.In zip.h
-.Ft int
-.Fn zip_unchange_archive "struct zip *archive"
+#include <zip.h>
+.PP
+int
+zip_unchange_archive(struct zip *archive);
.SH "DESCRIPTION"
Revert all global changes to the archive
\fBarchive.\fR
diff --git a/man/zipcmp.man b/man/zipcmp.man
index 6da7d99..00d5be5 100644
--- a/man/zipcmp.man
+++ b/man/zipcmp.man
@@ -1,6 +1,6 @@
.\" Converted with mdoc2man 0.2
-.\" from NiH: zipcmp.mdoc,v 1.11 2005/06/09 21:13:13 wiz Exp
-.\" $NiH: zipcmp.mdoc,v 1.11 2005/06/09 21:13:13 wiz Exp $
+.\" from NiH: zipcmp.mdoc,v 1.12 2005/06/17 12:59:06 wiz Exp
+.\" $NiH: zipcmp.mdoc,v 1.12 2005/06/17 12:59:06 wiz Exp $
.\"
.\" zipcmp.mdoc \-- compare zip archives
.\" Copyright (C) 2003, 2005 Dieter Baron and Thomas Klausner
