zip_error_str has been renamed to zip_error_to_str. --HG-- branch : HEAD
diff --git a/configure.ac b/configure.ac index 854b116..b1239ae 100644 --- a/configure.ac +++ b/configure.ac
@@ -63,7 +63,7 @@ man/zip_add.3:man/zip_add.${MANFMT} man/zip_close.3:man/zip_close.${MANFMT} man/zip_delete.3:man/zip_delete.${MANFMT} - man/zip_error_str.3:man/zip_error_str.${MANFMT} + man/zip_error_to_str.3:man/zip_error_to_str.${MANFMT} man/zip_fclose.3:man/zip_fclose.${MANFMT} man/zip_file_strerror.3:man/zip_file_strerror.${MANFMT} man/zip_fopen.3:man/zip_fopen.${MANFMT}
diff --git a/man/Makefile.am b/man/Makefile.am index cd432e0..7ddc68f 100644 --- a/man/Makefile.am +++ b/man/Makefile.am
@@ -7,7 +7,7 @@ MAN3= zip_add.3 \ zip_close.3 \ zip_delete.3 \ - zip_error_str.3 \ + zip_error_to_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 deleted file mode 100644 index 9abaa8d..0000000 --- a/man/zip_error_str.man +++ /dev/null
@@ -1,74 +0,0 @@ -.\" Converted with mdoc2man 0.2 -.\" from NiH: zip_error_str.mdoc,v 1.2 2004/11/17 22:26:09 wiz Exp -.\" $NiH: zip_error_str.mdoc,v 1.2 2004/11/17 22:26:09 wiz Exp $ -.\" -.\" 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_ERROR_STR 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 stores a string describing the zip error code -\fBze\fR -in the user-provided buffer -\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_to_str.mdoc similarity index 88% rename from man/zip_error_str.mdoc rename to man/zip_error_to_str.mdoc index e4faeac..b02da70 100644 --- a/man/zip_error_str.mdoc +++ b/man/zip_error_to_str.mdoc
@@ -1,6 +1,6 @@ -.\" $NiH: zip_error_str.mdoc,v 1.1 2003/12/27 22:25:58 wiz Exp $ +.\" $NiH: zip_error_to_str.mdoc,v 1.2 2004/11/17 22:26:09 wiz Exp $ .\" -.\" zip_error_str.mdoc -- get string representation of zip error code +.\" zip_error_to_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. @@ -31,21 +31,21 @@ .\" 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 +.Dd November 24, 2004 .Dt ZIP_ERROR_STR 3 .Os .Sh NAME -.Nm zip_error_str +.Nm zip_error_to_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" +.Fn zip_error_to_str "char *buf" "int len" "int ze" "int se" .Sh DESCRIPTION The -.Fn zip_error_str +.Fn zip_error_to_str function stores a string describing the zip error code .Ar ze in the user-provided buffer @@ -56,7 +56,7 @@ should be the value of the global variable .Ar errno at the time of the error. -.Fn zip_error_str +.Fn zip_error_to_str is especially useful if .Fn zip_open failed and no @@ -65,7 +65,7 @@ .Fn zip_strerror should be used. .Sh RETURN VALUES -.Fn zip_error_str +.Fn zip_error_to_str returns the number of characters that would have been written to a sufficiently sized .Ar buf ,
diff --git a/man/zip_open.mdoc b/man/zip_open.mdoc index b0f5f3e..26cbc0b 100644 --- a/man/zip_open.mdoc +++ b/man/zip_open.mdoc
@@ -1,4 +1,4 @@ -.\" $NiH: zip_open.mdoc,v 1.15 2003/12/28 00:51:51 wiz Exp $ +.\" $NiH: zip_open.mdoc,v 1.16 2004/11/17 21:55:16 wiz Exp $ .\" .\" zip_open.mdoc -- open zip archive .\" Copyright (C) 2003 Dieter Baron and Thomas Klausner @@ -128,4 +128,4 @@ .El .Sh SEE ALSO .Xr zip_close 3 , -.Xr zip_error_str 3 +.Xr zip_error_to_str 3