Add man page for zip_error_str. --HG-- branch : HEAD
diff --git a/man/Makefile.am b/man/Makefile.am index 3df1f8f..cf8055d 100644 --- a/man/Makefile.am +++ b/man/Makefile.am
@@ -6,6 +6,7 @@ MAN1= zipcmp.1 MAN3= zip_close.3 \ zip_delete.3 \ + zip_error_str.3 \ zip_fclose.3 \ zip_file_strerror.3 \ zip_fopen.3 \
diff --git a/man/zip_error_str.man b/man/zip_error_str.man new file mode 100644 index 0000000..3390292 --- /dev/null +++ b/man/zip_error_str.man
@@ -0,0 +1,72 @@ +.\" $NiH$ +.\" +.\" zip_error_str.mdoc \-- get string representation of zip error code +.\" Copyright (C) 2003 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_STRERROR 3 "October 3, 2003" NiH +.SH "NAME" +zip_error_str \- get string representation of zip error +.SH "LIBRARY" +libzip (-lzip) +.SH "SYNOPSIS" +.In zip.h +.Ft int +.Fn zip_error_str "char *buf" "int len" "int ze" "int se" +.SH "DESCRIPTION" +The +.Fn zip_error_str +function returns a string describing the zip error code +\fBze\fR +in +\fBbuf\fR +which has size +\fBlen.\fR +\fBse\fR +should be the value of the global variable +\fBerrno\fR +at the time of the error. +.Fn zip_error_str +is especially useful if +.Fn zip_open +failed and no +.Vt struct zip +is available; otherwise +.Fn zip_strerror +should be used. +.SH "RETURN VALUES" +.Fn zip_error_str +returns the number of characters that would have been written to a +sufficiently sized +\fBbuf,\fR +excluding the terminating NUL character. +.SH "SEE ALSO" +zip_open(3), +zip_strerror(3)
diff --git a/man/zip_error_str.mdoc b/man/zip_error_str.mdoc new file mode 100644 index 0000000..31cb1df --- /dev/null +++ b/man/zip_error_str.mdoc
@@ -0,0 +1,75 @@ +.\" $NiH$ +.\" +.\" zip_error_str.mdoc -- get string representation of zip error code +.\" Copyright (C) 2003 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. +.\" +.Dd October 3, 2003 +.Dt ZIP_STRERROR 3 +.Os +.Sh NAME +.Nm zip_error_str +.Nd get string representation of zip error +.Sh LIBRARY +libzip (-lzip) +.Sh SYNOPSIS +.In zip.h +.Ft int +.Fn zip_error_str "char *buf" "int len" "int ze" "int se" +.Sh DESCRIPTION +The +.Fn zip_error_str +function returns a string describing the zip error code +.Ar ze +in +.Ar buf +which has size +.Ar len . +.Ar se +should be the value of the global variable +.Ar errno +at the time of the error. +.Fn zip_error_str +is especially useful if +.Fn zip_open +failed and no +.Vt struct zip +is available; otherwise +.Fn zip_strerror +should be used. +.Sh RETURN VALUES +.Fn zip_error_str +returns the number of characters that would have been written to a +sufficiently sized +.Ar buf , +excluding the terminating NUL character. +.Sh SEE ALSO +.Xr zip_open 3 , +.Xr zip_strerror 3