aboutsummaryrefslogtreecommitdiff
path: root/externals/libmpq/doc/man3
diff options
context:
space:
mode:
Diffstat (limited to 'externals/libmpq/doc/man3')
-rw-r--r--externals/libmpq/doc/man3/Makefile.am1
-rw-r--r--externals/libmpq/doc/man3/libmpq.33
-rw-r--r--externals/libmpq/doc/man3/libmpq__strerror.345
3 files changed, 49 insertions, 0 deletions
diff --git a/externals/libmpq/doc/man3/Makefile.am b/externals/libmpq/doc/man3/Makefile.am
index 80bff4e7461..cad3d865dc1 100644
--- a/externals/libmpq/doc/man3/Makefile.am
+++ b/externals/libmpq/doc/man3/Makefile.am
@@ -27,4 +27,5 @@ man_MANS = \
libmpq__file_packed_size.3 \
libmpq__file_read.3 \
libmpq__file_unpacked_size.3 \
+ libmpq__strerror.3 \
libmpq__version.3
diff --git a/externals/libmpq/doc/man3/libmpq.3 b/externals/libmpq/doc/man3/libmpq.3
index 349451f87b1..768dab0a712 100644
--- a/externals/libmpq/doc/man3/libmpq.3
+++ b/externals/libmpq/doc/man3/libmpq.3
@@ -29,6 +29,8 @@ libmpq \- cross-platform C library for manipulating mpq archives.
.sp
.BI "const char *libmpq__version();"
.sp
+.BI "const char *libmpq__strerror(int32_t returncode);"
+.sp
.BI "int32_t libmpq__archive_open("
.BI " mpq_archive_s **" "mpq_archive",
.BI " const char *" "mpq_filename",
@@ -172,6 +174,7 @@ libmpq \- cross-platform C library for manipulating mpq archives.
The \fIlibmpq\fP library supports decrypting, decompressing, exploding and various manipulations of the MoPaQ archive files. It uses \fIzlib(3)\fP and \fIbzip2(1)\fP compression library. At this moment \fIlibmpq\fP is not able to create MoPaQ archives, this limitation will be removed in a future version.
.SH SEE ALSO
.BR libmpq__version (3),
+.BR libmpq__strerror (3),
.BR libmpq__archive_open (3),
.BR libmpq__archive_close (3),
.BR libmpq__archive_packed_size (3),
diff --git a/externals/libmpq/doc/man3/libmpq__strerror.3 b/externals/libmpq/doc/man3/libmpq__strerror.3
new file mode 100644
index 00000000000..246f422eed0
--- /dev/null
+++ b/externals/libmpq/doc/man3/libmpq__strerror.3
@@ -0,0 +1,45 @@
+.\" Copyright (c) 2010 Georg Lukas <georg@op-co.de>
+.\"
+.\" This is free documentation; you can redistribute it and/or
+.\" modify it under the terms of the GNU General Public License as
+.\" published by the Free Software Foundation; either version 2 of
+.\" the License, or (at your option) any later version.
+.\"
+.\" The GNU General Public License's references to "object code"
+.\" and "executables" are to be interpreted as the output of any
+.\" document formatting or typesetting system, including
+.\" intermediate and printed output.
+.\"
+.\" This manual is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public
+.\" License along with this manual; if not, write to the Free
+.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
+.\" USA.
+.TH libmpq 3 2010-07-18 "The MoPaQ archive library"
+.SH NAME
+libmpq__strerror \- return string describing libmpq error number
+.SH SYNOPSIS
+.nf
+.B
+#include <mpq.h>
+.sp
+.BI "const char *libmpq__strerror(int32_t returncode);"
+.fi
+.SH DESCRIPTION
+.PP
+Call \fBlibmpq__strerror\fP() to get a string message for the return code of one of the other libmpq functions.
+.SH RETURN VALUE
+The function returns a string pointer to non-writable memory or NULL if \fBreturncode\fP is not a return code of a libmpq function.
+.SH SEE ALSO
+.BR libmpq (3), strerror (3)
+.SH AUTHOR
+Check documentation.
+.TP
+libmpq is (c) 2003-2008
+.B Maik Broemme <mbroemme@plusserver.de>
+.PP
+The above e-mail address can be used to send bug reports, feedbacks or library enhancements.