diff options
Diffstat (limited to 'dep/libmpq/doc/man3')
24 files changed, 1472 insertions, 0 deletions
diff --git a/dep/libmpq/doc/man3/Makefile.am b/dep/libmpq/doc/man3/Makefile.am new file mode 100644 index 00000000000..cad3d865dc1 --- /dev/null +++ b/dep/libmpq/doc/man3/Makefile.am @@ -0,0 +1,31 @@ +# minimum required automake 1.6 +AUTOMAKE_OPTIONS = 1.6 + +# manual page directory. +EXTRA_DIST = $(man_MANS) + +# manual pages for the installed binaries. +man_MANS = \ + libmpq.3 \ + libmpq__archive_close.3 \ + libmpq__archive_files.3 \ + libmpq__archive_offset.3 \ + libmpq__archive_open.3 \ + libmpq__archive_packed_size.3 \ + libmpq__archive_unpacked_size.3 \ + libmpq__archive_version.3 \ + libmpq__block_close_offset.3 \ + libmpq__block_open_offset.3 \ + libmpq__block_read.3 \ + libmpq__block_unpacked_size.3 \ + libmpq__file_blocks.3 \ + libmpq__file_compressed.3 \ + libmpq__file_encrypted.3 \ + libmpq__file_imploded.3 \ + libmpq__file_number.3 \ + libmpq__file_offset.3 \ + libmpq__file_packed_size.3 \ + libmpq__file_read.3 \ + libmpq__file_unpacked_size.3 \ + libmpq__strerror.3 \ + libmpq__version.3 diff --git a/dep/libmpq/doc/man3/libmpq.3 b/dep/libmpq/doc/man3/libmpq.3 new file mode 100644 index 00000000000..768dab0a712 --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq.3 @@ -0,0 +1,207 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-04-29 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.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", +.BI " off_t " "archive_offset" +.BI ");" +.sp +.BI "int32_t libmpq__archive_close(" +.BI " mpq_archive_s *" "mpq_archive" +.BI ");" +.sp +.BI "int32_t libmpq__archive_packed_size(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " off_t *" "packed_size" +.BI ");" +.sp +.BI "int32_t libmpq__archive_unpacked_size(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " off_t *" "unpacked_size" +.BI ");" +.sp +.BI "int32_t libmpq__archive_offset(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " off_t *" "offset" +.BI ");" +.sp +.BI "int32_t libmpq__archive_version(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t *" "version" +.BI ");" +.sp +.BI "int32_t libmpq__archive_files(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t *" "files" +.BI ");" +.sp +.BI "int32_t libmpq__file_packed_size(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " off_t *" "packed_size" +.BI ");" +.sp +.BI "int32_t libmpq__file_unpacked_size(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " off_t *" "unpacked_size" +.BI ");" +.sp +.BI "int32_t libmpq__file_offset(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " off_t *" "offset" +.BI ");" +.sp +.BI "int32_t libmpq__file_blocks(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " off_t *" "blocks" +.BI ");" +.sp +.BI "int32_t libmpq__file_encrypted(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " off_t *" "encrypted" +.BI ");" +.sp +.BI "int32_t libmpq__file_compressed(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " off_t *" "compressed" +.BI ");" +.sp +.BI "int32_t libmpq__file_imploded(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " off_t *" "imploded" +.BI ");" +.sp +.BI "int32_t libmpq__file_number(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " const char *" "filename", +.BI " uint32_t *" "number" +.BI ");" +.sp +.BI "int32_t libmpq__file_read(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " uint8_t *" "out_buf", +.BI " off_t " "out_size", +.BI " off_t *" "transferred" +.BI ");" +.sp +.BI "int32_t libmpq__block_open_offset(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number" +.BI ");" +.sp +.BI "int32_t libmpq__block_close_offset(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number" +.BI ");" +.sp +.BI "int32_t libmpq__block_packed_size(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " uint32_t " "block_number", +.BI " off_t *" "packed_size" +.BI ");" +.sp +.BI "int32_t libmpq__block_unpacked_size(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " uint32_t " "block_number", +.BI " off_t *" "unpacked_size" +.BI ");" +.sp +.BI "int32_t libmpq__block_offset(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " uint32_t " "block_number", +.BI " off_t *" "offset" +.BI ");" +.sp +.BI "int32_t libmpq__block_seed(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " uint32_t " "block_number", +.BI " uint32_t *" "seed" +.BI ");" +.sp +.BI "int32_t libmpq__block_read(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " uint32_t " "block_number", +.BI " uint8_t *" "out_buf", +.BI " off_t " "out_size", +.BI " off_t *" "transferred" +.BI ");" +.fi +.SH DESCRIPTION +.PP +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), +.BR libmpq__archive_unpacked_size (3), +.BR libmpq__archive_offset (3), +.BR libmpq__archive_version (3), +.BR libmpq__archive_files (3), +.BR libmpq__file_packed_size (3), +.BR libmpq__file_unpacked_size (3), +.BR libmpq__file_offset (3), +.BR libmpq__file_blocks (3), +.BR libmpq__file_encrypted (3), +.BR libmpq__file_compressed (3), +.BR libmpq__file_imploded (3), +.BR libmpq__file_number (3), +.BR libmpq__file_read (3), +.BR libmpq__block_open_offset (3), +.BR libmpq__block_close_offset (3), +.BR libmpq__block_packed_size (3), +.BR libmpq__block_unpacked_size (3), +.BR libmpq__block_offset (3), +.BR libmpq__block_seed (3), +.BR libmpq__block_read (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. diff --git a/dep/libmpq/doc/man3/libmpq__archive_close.3 b/dep/libmpq/doc/man3/libmpq__archive_close.3 new file mode 100644 index 00000000000..dfc652a6721 --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__archive_close.3 @@ -0,0 +1,57 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-04-29 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__archive_close(" +.BI " mpq_archive_s *" "mpq_archive" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__archive_close\fP() to close a mpq archive which was opened by \fBlibmpq__archive_open\fP(). The function frees the archive structure itself and the contents of it. +.LP +The \fBlibmpq__archive_close\fP() function one takes one argument of the archive structure \fImpq_archive\fP which has to be set by \fBlibmpq__archive_open\fP. +.SH RETURN VALUE +On success, a zero is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_CLOSE +The given file could not be closed. +.SH SEE ALSO +.BR libmpq__archive_open (3), +.BR libmpq__archive_packed_size (3), +.BR libmpq__archive_unpacked_size (3), +.BR libmpq__archive_offset (3), +.BR libmpq__archive_version (3), +.BR libmpq__archive_files (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. diff --git a/dep/libmpq/doc/man3/libmpq__archive_files.3 b/dep/libmpq/doc/man3/libmpq__archive_files.3 new file mode 100644 index 00000000000..6663b99161a --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__archive_files.3 @@ -0,0 +1,50 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-14 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__archive_files(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t *" "files" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__archive_files\fP() to get the number of files inside the archive. It will count only valid files and skip files which have deleted or freed hash entries. +.LP +The \fBlibmpq__archive_files\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument is a reference to the number of \fIfiles\fP in the archive. +.SH RETURN VALUE +On success, a zero is returned. +.SH SEE ALSO +.BR libmpq__file_blocks (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. diff --git a/dep/libmpq/doc/man3/libmpq__archive_offset.3 b/dep/libmpq/doc/man3/libmpq__archive_offset.3 new file mode 100644 index 00000000000..696ac5e809f --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__archive_offset.3 @@ -0,0 +1,51 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-14 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__archive_offset(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " off_t *" "offset" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__archive_offset\fP() to get the offset of the archive, which is the absolute position in the file. It also supports archives within archives. +.LP +The \fBlibmpq__archive_offset\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument is a reference to the archive starting position \fIoffset\fP in file. +.SH RETURN VALUE +On success, a zero is returned. +.SH SEE ALSO +.BR libmpq__file_offset (3), +.BR libmpq__block_offset (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. diff --git a/dep/libmpq/doc/man3/libmpq__archive_open.3 b/dep/libmpq/doc/man3/libmpq__archive_open.3 new file mode 100644 index 00000000000..02c021f8948 --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__archive_open.3 @@ -0,0 +1,71 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-04-29 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__archive_open(" +.BI " mpq_archive_s **" "mpq_archive", +.BI " const char *" "mpq_filename", +.BI " off_t " "archive_offset" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__archive_open\fP() to open a given mpq archive for later use to extract or manipulate files inside the archive. It will create all required file structures and you have to call \fBlibmpq__archive_close\fP() on success to clean the opened structures. On failure there is no need to call \fBlibmpq__archive_close\fP() because everything will be cleaned up. +.LP +The \fBlibmpq__archive_open\fP() function takes as first argument a reference to the archive structure \fImpq_archive\fP and will open the file \fImpq_filename\fP to the structure pointed to by \fImpq_archive\fP. The last argument, \fIarchive_offset\fP is normally -1, but can be specified when the archive offset is known, or not 512-byte aligned. +.SH RETURN VALUE +On success, *\fImpq_archive\fP is set to a new \fBmpq_archive_s\fP* and zero is returned, and on error one of the following constants is returned. +.TP +.B LIBMPQ_ERROR_OPEN +The given file could not be opened. +.TP +.B LIBMPQ_ERROR_MALLOC +Not enough memory for creating required structures. +.TP +.B LIBMPQ_ERROR_SEEK +Seeking in file failed. +.TP +.B LIBMPQ_ERROR_FORMAT +The given file is no valid mpq archive. +.TP +.B LIBMPQ_ERROR_READ +Reading in archive failed. +.SH SEE ALSO +.BR libmpq__archive_close (3), +.BR libmpq__archive_packed_size (3), +.BR libmpq__archive_unpacked_size (3), +.BR libmpq__archive_offset (3), +.BR libmpq__archive_version (3), +.BR libmpq__archive_files (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. diff --git a/dep/libmpq/doc/man3/libmpq__archive_packed_size.3 b/dep/libmpq/doc/man3/libmpq__archive_packed_size.3 new file mode 100644 index 00000000000..6c3061f2031 --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__archive_packed_size.3 @@ -0,0 +1,51 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-04-29 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__archive_packed_size(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " off_t *" "packed_size" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__archive_packed_size\fP() to get the packed size of all files in the archive. It will count compressed and imploded files as well as stored only. +.LP +The \fBlibmpq__archive_packed_size\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument is a reference to the compressed, imploded or stored size \fIpacked_size\fP of file. +.SH RETURN VALUE +On success, a zero is returned. +.SH SEE ALSO +.BR libmpq__file_packed_size (3), +.BR libmpq__block_packed_size (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. diff --git a/dep/libmpq/doc/man3/libmpq__archive_unpacked_size.3 b/dep/libmpq/doc/man3/libmpq__archive_unpacked_size.3 new file mode 100644 index 00000000000..d2ba923c8f0 --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__archive_unpacked_size.3 @@ -0,0 +1,51 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-04-29 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__archive_unpacked_size(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " off_t *" "unpacked_size" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__archive_unpacked_size\fP() to get the unpacked size of all files in the archive. It will count uncompressed and exploded files as well as stored only. +.LP +The \fBlibmpq__archive_unpacked_size\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument is a reference to the uncompressed, exploded or stored size \fIunpacked_size\fP of file. +.SH RETURN VALUE +On success, a zero is returned. +.SH SEE ALSO +.BR libmpq__file_unpacked_size (3), +.BR libmpq__block_unpacked_size (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. diff --git a/dep/libmpq/doc/man3/libmpq__archive_version.3 b/dep/libmpq/doc/man3/libmpq__archive_version.3 new file mode 100644 index 00000000000..1764046895a --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__archive_version.3 @@ -0,0 +1,48 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-14 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__archive_version(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t *" "version" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__archive_version\fP() to get the archive version. Currently there exist two known versions, version 1 which supports archives until 2GB total size and version 2 which supports archives above 2GB total size and both are supported. +.LP +The \fBlibmpq__archive_version\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument is a reference to the \fIversion\fP of archive. +.SH RETURN VALUE +On success, a zero is returned. +.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. diff --git a/dep/libmpq/doc/man3/libmpq__block_close_offset.3 b/dep/libmpq/doc/man3/libmpq__block_close_offset.3 new file mode 100644 index 00000000000..1ec0c06f70d --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__block_close_offset.3 @@ -0,0 +1,53 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-16 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__block_close_offset(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__block_close_offset\fP() to close the block offset table for the given file. It will close the block offset table regardless of compression (compressed, imploded or stored) type of file. +.LP +The \fBlibmpq__block_close_offset\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument \fIfile_number\fP is the number of file to close. +.SH RETURN VALUE +On success, a zero is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_EXIST +File or block does not exist in archive. +.SH SEE ALSO +.BR libmpq__block_open_offset (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. diff --git a/dep/libmpq/doc/man3/libmpq__block_open_offset.3 b/dep/libmpq/doc/man3/libmpq__block_open_offset.3 new file mode 100644 index 00000000000..a60b133f406 --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__block_open_offset.3 @@ -0,0 +1,65 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-16 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__block_open_offset(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__block_open_offset\fP() to open the block offset table for the given file. It will open the block offset table regardless of compression (compressed, imploded or stored) type of file. +.LP +The \fBlibmpq__block_open_offset\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument \fIfile_number\fP is the number of file to open. +.SH RETURN VALUE +On success, a zero is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_EXIST +File or block does not exist in archive. +.TP +.B LIBMPQ_ERROR_SEEK +Seeking in file failed. +.TP +.B LIBMPQ_ERROR_MALLOC +Not enough memory for creating required structures. +.TP +.B LIBMPQ_ERROR_READ +Reading in archive failed. +.TP +.B LIBMPQ_ERROR_DECRYPT +Decrypting block failed. +.SH SEE ALSO +.BR libmpq__block_close_offset (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. diff --git a/dep/libmpq/doc/man3/libmpq__block_read.3 b/dep/libmpq/doc/man3/libmpq__block_read.3 new file mode 100644 index 00000000000..3272c64c7ed --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__block_read.3 @@ -0,0 +1,78 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-16 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__block_read(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " uint32_t " "block_number, +.BI " uint8_t *" "out_buf", +.BI " off_t " "out_size", +.BI " off_t " "transferred" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__block_read\fP() to read a given block into memory. If the block is encrypted it will be first decrypted and then if it is packed (compressed or imploded) it will be unpacked. +.LP +The \fBlibmpq__block_read\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument \fIfile_number\fP is the number of file, the third argument \fIblock_number\fP is the number of block. The fourth argument \fIout_buf\fP is the output data buffer which contains the extracted data and the fifth argument \fIout_size\fP is the size of \fIout_buf\fP. The sixth argument is a reference to the \fItransferred\fP bytes of the file. +.SH RETURN VALUE +On success, a zero is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_EXIST +Block does not exist in archive. +.TP +.B LIBMPQ_ERROR_OPEN +Block offset table was not opened by calling \fBlibmpq__block_open_offset\fP(), or it was closed by an \fBlibmpq__block_close_offset\fP() call. +.TP +.B LIBMPQ_ERROR_SIZE +The output buffer is to small. +.TP +.B LIBMPQ_ERROR_SEEK +Seeking in file failed. +.TP +.B LIBMPQ_ERROR_MALLOC +Not enough memory for creating required structures. +.TP +.B LIBMPQ_ERROR_READ +Reading in archive failed. +.TP +.B LIBMPQ_ERROR_DECRYPT +Decrypting block failed. +.TP +.B LIBMPQ_ERROR_UNPACK +Unpacking block failed. +.SH SEE ALSO +.BR libmpq__file_read (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. diff --git a/dep/libmpq/doc/man3/libmpq__block_unpacked_size.3 b/dep/libmpq/doc/man3/libmpq__block_unpacked_size.3 new file mode 100644 index 00000000000..a21ca48159a --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__block_unpacked_size.3 @@ -0,0 +1,59 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-16 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__block_unpacked_size(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " uint32_t " "block_number", +.BI " off_t *" "unpacked_size" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__block_unpacked_size\fP() to get the unpacked size of a given block in the file. It will return a valid size for compressed and imploded blocks as well as stored only. +.LP +The \fBlibmpq__block_unpacked_size\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument \fIfile_number\fP is the number of file, the third argument \fIblock_number\fP is the number of block and the fourth argument is a reference to the uncompressed, exploded or stored size \fIunpacked_size\fP of block. +.SH RETURN VALUE +On success, a zero is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_EXIST +File or block does not exist in archive. +.TP +.B LIBMPQ_ERROR_OPEN +Block offset table was not opened by calling \fBlibmpq__block_open_offset\fP(), or it was closed by an \fBlibmpq__block_close_offset\fP() call. +.SH SEE ALSO +.BR libmpq__archive_unpacked_size (3), +.BR libmpq__file_unpacked_size (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. diff --git a/dep/libmpq/doc/man3/libmpq__file_blocks.3 b/dep/libmpq/doc/man3/libmpq__file_blocks.3 new file mode 100644 index 00000000000..85baeffc603 --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__file_blocks.3 @@ -0,0 +1,54 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-16 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__file_blocks(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " uint32_t *" "blocks" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__file_blocks\fP() to get the number of blocks for a given file. It will count all blocks for files stored in multiple sectors or count one for files stored in single sector. +.LP +The \fBlibmpq__file_blocks\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument \fIfile_number\fP is the number of file and the third argument is a reference to the number of \fIblocks\fP of the file. +.SH RETURN VALUE +On success, a zero is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_EXIST +File does not exist in archive. +.SH SEE ALSO +.BR libmpq__archive_files (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. diff --git a/dep/libmpq/doc/man3/libmpq__file_compressed.3 b/dep/libmpq/doc/man3/libmpq__file_compressed.3 new file mode 100644 index 00000000000..24b44f0b666 --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__file_compressed.3 @@ -0,0 +1,54 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-16 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__file_compressed(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " uint32_t *" "compressed" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__file_compressed\fP() to get the compression status of the given file. It will return true for compressed files and false otherwise. +.LP +The \fBlibmpq__file_compressed\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument \fIfile_number\fP is the number of file and the third argument is a reference to the compression status \fIcompressed\fP of the file. +.SH RETURN VALUE +On success, a zero is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_EXIST +File does not exist in archive. +.SH SEE ALSO +.BR libmpq__archive_files (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. diff --git a/dep/libmpq/doc/man3/libmpq__file_encrypted.3 b/dep/libmpq/doc/man3/libmpq__file_encrypted.3 new file mode 100644 index 00000000000..798f4019c7a --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__file_encrypted.3 @@ -0,0 +1,54 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-16 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__file_encrypted(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " uint32_t *" "encrypted" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__file_encrypted\fP() to get the encryption status of the given file. It will return true for encrypted files and false otherwise. +.LP +The \fBlibmpq__file_encrypted\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument \fIfile_number\fP is the number of file and the third argument is a reference to the encryption status \fIencrypted\fP of the file. +.SH RETURN VALUE +On success, a zero is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_EXIST +File does not exist in archive. +.SH SEE ALSO +.BR libmpq__archive_files (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. diff --git a/dep/libmpq/doc/man3/libmpq__file_imploded.3 b/dep/libmpq/doc/man3/libmpq__file_imploded.3 new file mode 100644 index 00000000000..9adce38cb5f --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__file_imploded.3 @@ -0,0 +1,54 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-16 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__file_imploded(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " uint32_t *" "imploded" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__file_imploded\fP() to get the implosion status of the given file. It will return true for imploded files and false otherwise. +.LP +The \fBlibmpq__file_imploded\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument \fIfile_number\fP is the number of file and the third argument is a reference to the implosion status \fIimploded\fP of the file. +.SH RETURN VALUE +On success, a zero is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_EXIST +File does not exist in archive. +.SH SEE ALSO +.BR libmpq__archive_files (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. diff --git a/dep/libmpq/doc/man3/libmpq__file_number.3 b/dep/libmpq/doc/man3/libmpq__file_number.3 new file mode 100644 index 00000000000..8d7a47769ee --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__file_number.3 @@ -0,0 +1,52 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-16 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__file_number(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " const char *" "filename", +.BI " uint32_t *" "number" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__file_number\fP() to get the number of a given file in the archive. This function will return a file number regardless of a known or opened listfile. +.LP +The \fBlibmpq__file_number\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument \fIfilename\fP is the name of the file and the third argument is a reference to the \fInumber\fP of the file. +.SH RETURN VALUE +On success, the number of the file is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_EXIST +File does not exist in archive. +.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. diff --git a/dep/libmpq/doc/man3/libmpq__file_offset.3 b/dep/libmpq/doc/man3/libmpq__file_offset.3 new file mode 100644 index 00000000000..392a66d0b04 --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__file_offset.3 @@ -0,0 +1,55 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-15 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__file_offset(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " off_t *" "offset" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__file_offset\fP() to get the offset of the file, which is the absolute position in the archive. It also supports archives within archives. +.LP +The \fBlibmpq__file_offset\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument \fIfile_number\fP is the number of file and the third argument is a reference to the file starting position \fIoffset\fP in archive. +.SH RETURN VALUE +On success, a zero is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_EXIST +File does not exist in archive. +.SH SEE ALSO +.BR libmpq__archive_offset (3), +.BR libmpq__block_offset (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. diff --git a/dep/libmpq/doc/man3/libmpq__file_packed_size.3 b/dep/libmpq/doc/man3/libmpq__file_packed_size.3 new file mode 100644 index 00000000000..b584ddf77dd --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__file_packed_size.3 @@ -0,0 +1,55 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-15 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__file_packed_size(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " off_t *" "packed_size" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__file_packed_size\fP() to get the packed size of a given file in the archive. It will return a valid size for compressed and imploded files as well as stored only. +.LP +The \fBlibmpq__file_packed_size\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument \fIfile_number\fP is the number of file and the third argument is a reference to the compressed, imploded or stored size \fIpacked_size\fP of file. +.SH RETURN VALUE +On success, a zero is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_EXIST +File does not exist in archive. +.SH SEE ALSO +.BR libmpq__archive_packed_size (3), +.BR libmpq__block_packed_size (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. diff --git a/dep/libmpq/doc/man3/libmpq__file_read.3 b/dep/libmpq/doc/man3/libmpq__file_read.3 new file mode 100644 index 00000000000..cbfafbd0f4f --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__file_read.3 @@ -0,0 +1,77 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-16 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__file_read(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " uint8_t *" "out_buf", +.BI " off_t " "out_size", +.BI " off_t *" "transferred" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__file_read\fP() to read a given file into memory. If the file is encrypted it will be first decrypted and then if it is packed (compressed or imploded) it will be unpacked. +.LP +The \fBlibmpq__file_read\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument \fIfile_number\fP is the file to extract, the third argument \fIout_buf\fP is the output data buffer which contains the extracted data. The fourth argument \fIout_size\fP is the size of \fIout_buf\fP and the fifth argument is a reference to the \fItransferred\fP bytes of the file. +.SH RETURN VALUE +On success, a zero is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_EXIST +File does not exist in archive. +.TP +.B LIBMPQ_ERROR_OPEN +Block offset table was not opened by calling \fBlibmpq__block_open_offset\fP(), or it was closed by an \fBlibmpq__block_close_offset\fP() call. +.TP +.B LIBMPQ_ERROR_SIZE +The output buffer is to small. +.TP +.B LIBMPQ_ERROR_SEEK +Seeking in file failed. +.TP +.B LIBMPQ_ERROR_MALLOC +Not enough memory for creating required structures. +.TP +.B LIBMPQ_ERROR_READ +Reading in archive failed. +.TP +.B LIBMPQ_ERROR_DECRYPT +Decrypting file failed. +.TP +.B LIBMPQ_ERROR_UNPACK +Unpacking file failed. +.SH SEE ALSO +.BR libmpq__block_read (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. diff --git a/dep/libmpq/doc/man3/libmpq__file_unpacked_size.3 b/dep/libmpq/doc/man3/libmpq__file_unpacked_size.3 new file mode 100644 index 00000000000..a81cf7a4e76 --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__file_unpacked_size.3 @@ -0,0 +1,55 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-05-15 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "int32_t libmpq__file_unpacked_size(" +.BI " mpq_archive_s *" "mpq_archive", +.BI " uint32_t " "file_number", +.BI " off_t *" "unpacked_size" +.BI ");" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__file_unpacked_size\fP() to get the unpacked size of a given file in the archive. It will return a valid size for compressed and imploded files as well as stored only. +.LP +The \fBlibmpq__file_unpacked_size\fP() function takes as first argument the archive structure \fImpq_archive\fP which have to be allocated first and opened by \fBlibmpq__archive_open\fP(). The second argument \fIfile_number\fP is the number of file and the third argument is a reference to the uncompressed, exploded or stored size \fIunpacked_size\fP of file. +.SH RETURN VALUE +On success, a zero is returned and on error one of the following constants. +.TP +.B LIBMPQ_ERROR_EXIST +File does not exist in archive. +.SH SEE ALSO +.BR libmpq__archive_unpacked_size (3), +.BR libmpq__block_unpacked_size (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. diff --git a/dep/libmpq/doc/man3/libmpq__strerror.3 b/dep/libmpq/doc/man3/libmpq__strerror.3 new file mode 100644 index 00000000000..246f422eed0 --- /dev/null +++ b/dep/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. diff --git a/dep/libmpq/doc/man3/libmpq__version.3 b/dep/libmpq/doc/man3/libmpq__version.3 new file mode 100644 index 00000000000..5500d7314f5 --- /dev/null +++ b/dep/libmpq/doc/man3/libmpq__version.3 @@ -0,0 +1,45 @@ +.\" Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.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 2008-03-31 "The MoPaQ archive library" +.SH NAME +libmpq \- cross-platform C library for manipulating mpq archives. +.SH SYNOPSIS +.nf +.B +#include <mpq.h> +.sp +.BI "const char *libmpq__version();" +.fi +.SH DESCRIPTION +.PP +Call \fBlibmpq__version\fP() to get information about the version of the library, it is useful to create minimum required version verifications. +.SH RETURN VALUE +The function returns the library version. +.SH SEE ALSO +.BR libmpq (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. |