add zip_fclose and zip_fread man pages --HG-- branch : HEAD
diff --git a/TODO b/TODO index 8619716..e383b5a 100644 --- a/TODO +++ b/TODO
@@ -1,4 +1,7 @@ -* documentation +* documentation: zip_add*, zip_get_name, zip_name_locate, zip_rename, + zip_replace* + [zip_free_meta, zip_meta_new] +* function to get status of struct zip_file (member flags) * correct version in installed libzip.so.x.y * fix warnings in zipcmp * regression tests
diff --git a/configure.ac b/configure.ac index 367bce1..46f386b 100644 --- a/configure.ac +++ b/configure.ac
@@ -62,7 +62,9 @@ AC_CONFIG_LINKS([man/zipcmp.1:man/zipcmp.${MANFMT} man/zip_close.3:man/zip_close.${MANFMT} man/zip_delete.3:man/zip_delete.${MANFMT} + man/zip_fclose.3:man/zip_fclose.${MANFMT} man/zip_fopen.3:man/zip_fopen.${MANFMT} + man/zip_fread.3:man/zip_fread.${MANFMT} man/zip_unchange.3:man/zip_unchange.${MANFMT} man/zip_unchange_all.3:man/zip_unchange_all.${MANFMT} man/zip_open.3:man/zip_open.${MANFMT}])
diff --git a/man/zip_fclose.mdoc b/man/zip_fclose.mdoc new file mode 100644 index 0000000..44ded79 --- /dev/null +++ b/man/zip_fclose.mdoc
@@ -0,0 +1,61 @@ +.\" $NiH$ +.\" +.\" zip_fclose.mdoc -- close file in zip archive +.\" 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_FCLOSE 3 +.Os +.Sh NAME +.Nm zip_fclose +.Nd close file in zip archive +.Sh LIBRARY +.Lb libzip +.Sh SYNOPSIS +.In zip.h +.Ft int +.Fn zip_fclose "struct zip_file *file" +.Sh DESCRIPTION +The +.Fn zip_fclose +function closes +.Ar file +and frees the memory allocated for it. +.Sh RETURN VALUES +Upon successful completion 0 is returned. +Otherwise, \-1 is returned and the global variable +.Va zip_err +is set to indicate the error. +.\" .Sh ERRORS +.\" XXX: the code needs checking. +.Sh SEE ALSO +.Xr zip_fopen 3 , +.Xr zip_fread 3 \ No newline at end of file
diff --git a/man/zip_fread.mdoc b/man/zip_fread.mdoc new file mode 100644 index 0000000..c4f9c8b --- /dev/null +++ b/man/zip_fread.mdoc
@@ -0,0 +1,63 @@ +.\" $NiH$ +.\" +.\" zip_fread.mdoc -- read from file +.\" 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_FREAD 3 +.Os +.Sh NAME +.Nm zip_fread +.Nd read from file +.Sh LIBRARY +.Lb libzip +.Sh SYNOPSIS +.In zip.h +.Ft int +.\" XXX: buf should be void * +.Fn zip_fread "struct zip_file *file" "char *buf, "int nbytes" +.Sh DESCRIPTION +The +.Fn zip_fread +function reads at most +.Ar nbytes +bytes from +.Ar file +into +.Ar buf . +.Sh RETURN VALUES +If successful, the nuber of bytes actually read is returned. +Otherwise, \-1 is returned. +.\" .Sh ERRORS +.\" XXX: the code needs checking. +.Sh SEE ALSO +.Xr zip_fopen 3 , +.Xr zip_fclose 3