improve
--HG--
branch : HEAD
diff --git a/man/zip_error_to_str.mdoc b/man/zip_error_to_str.mdoc
index b02da70..5687f16 100644
--- a/man/zip_error_to_str.mdoc
+++ b/man/zip_error_to_str.mdoc
@@ -1,7 +1,7 @@
-.\" $NiH: zip_error_to_str.mdoc,v 1.2 2004/11/17 22:26:09 wiz Exp $
+.\" $NiH: zip_error_to_str.mdoc,v 1.1 2004/11/24 16:15:53 wiz Exp $
.\"
.\" zip_error_to_str.mdoc -- get string representation of zip error code
-.\" Copyright (C) 2003 Dieter Baron and Thomas Klausner
+.\" Copyright (C) 2003, 2004 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>
@@ -32,7 +32,7 @@
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd November 24, 2004
-.Dt ZIP_ERROR_STR 3
+.Dt ZIP_ERROR_TO_STR 3
.Os
.Sh NAME
.Nm zip_error_to_str
@@ -46,24 +46,29 @@
.Sh DESCRIPTION
The
.Fn zip_error_to_str
-function stores a string describing the zip error code
+function stores a string describing the libzip error code
.Ar ze
in the user-provided buffer
-.Ar buf
+.Ar buf
which has size
.Ar len .
+The buffer is always NUL-terminated.
.Ar se
should be the value of the global variable
.Ar errno
-at the time of the error.
+at the time of the error or the zlib error code, depending on
+.Ar ze .
+.Pp
.Fn zip_error_to_str
is especially useful if
.Fn zip_open
-failed and no
+failed, since then there is no
.Vt struct zip
-is available; otherwise
+is available to store the error code; otherwise
.Fn zip_strerror
-should be used.
+or
+.Fn zip_file_strerror
+are more convenient.
.Sh RETURN VALUES
.Fn zip_error_to_str
returns the number of characters that would have been written to a
@@ -71,5 +76,9 @@
.Ar buf ,
excluding the terminating NUL character.
.Sh SEE ALSO
+.Xr zip_error_get 3 ,
+.Xr zip_error_sys_type 3 ,
+.Xr zip_file_error_get 3 ,
+.Xr zip_file_strerror 3 ,
.Xr zip_open 3 ,
-.Xr zip_strerror 3
+.Xr zip_strerror 3
