Document zip_stat_init. --HG-- branch : HEAD
diff --git a/man/Makefile.am b/man/Makefile.am index c3f9b22..66bd9e2 100644 --- a/man/Makefile.am +++ b/man/Makefile.am
@@ -36,6 +36,7 @@ zip_source_function.mdoc \ zip_source_zip.mdoc \ zip_stat.mdoc \ + zip_stat_init.mdoc \ zip_unchange.mdoc \ zip_unchange_all.mdoc \ zip_unchange_archive.mdoc
diff --git a/man/zip_source_function.mdoc b/man/zip_source_function.mdoc index 6e5af20..0c33541 100644 --- a/man/zip_source_function.mdoc +++ b/man/zip_source_function.mdoc
@@ -1,4 +1,4 @@ -.\" $NiH: zip_source_function.mdoc,v 1.15 2006/03/25 11:23:36 wiz Exp $ +.\" $NiH: zip_source_function.mdoc,v 1.16 2006/03/25 16:14:59 dillo Exp $ .\" .\" zip_source_function.mdoc -- create data source from function .\" Copyright (C) 2004-2006 Dieter Baron and Thomas Klausner @@ -31,7 +31,7 @@ .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd March 25, 2006 +.Dd December 16, 2006 .Dt ZIP_SOURCE_FUNCTION 3 .Os .Sh NAME @@ -86,6 +86,8 @@ Get meta information for the input data. .Ar data points to a struct zip_stat, which should be filled in. +(See +.Xr zip_stat_init 3 . ) Return sizeof(struct zip_stat) on success, \-1 on error. .It Dv ZIP_SOURCE_ERROR Get error information. @@ -143,7 +145,8 @@ .Xr zip_source_file 3 , .Xr zip_source_filep 3 , .Xr zip_source_free 3 , -.Xr zip_source_zip 3 +.Xr zip_source_zip 3 , +.Xr zip_stat_init 3 .Sh AUTHORS .An -nosplit .An Dieter Baron Aq dillo@giga.or.at
diff --git a/man/zip_stat.mdoc b/man/zip_stat.mdoc index 001b24a..61186ed 100644 --- a/man/zip_stat.mdoc +++ b/man/zip_stat.mdoc
@@ -1,4 +1,4 @@ -.\" $NiH: zip_stat.mdoc,v 1.10 2005/06/09 21:14:54 wiz Exp $ +.\" $NiH: zip_stat.mdoc,v 1.11 2006/04/09 14:52:03 wiz Exp $ .\" .\" zip_stat.mdoc -- get information about file .\" Copyright (C) 2003, 2004, 2005, 2006 Dieter Baron and Thomas Klausner @@ -31,7 +31,7 @@ .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd April 9, 2006 +.Dd December 16, 2006 .Dt ZIP_STAT 3 .Os .Sh NAME @@ -111,7 +111,8 @@ .Er ZIP_ER_CHANGED . .Sh SEE ALSO .Xr libzip 3 , -.Xr zip_name_locate 3 +.Xr zip_name_locate 3 , +.Xr zip_stat_init 3 .Sh AUTHORS .An -nosplit .An Dieter Baron Aq dillo@giga.or.at
diff --git a/man/zip_stat_init.mdoc b/man/zip_stat_init.mdoc new file mode 100644 index 0000000..fac9052 --- /dev/null +++ b/man/zip_stat_init.mdoc
@@ -0,0 +1,65 @@ +.\" $NiH$ +.\" +.\" zip_stat_init.mdoc -- init zip_stat structure +.\" Copyright (C) 2006 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 December 16, 2006 +.Dt ZIP_STAT_INIT 3 +.Os +.Sh NAME +.Nm zip_stat_init +.Nd initialize zip_stat structure +.Sh LIBRARY +libzip (-lzip) +.Sh SYNOPSIS +.In zip.h +.Ft void +.Fn zip_stat_init "struct zip_stat *sb" +.Sh DESCRIPTION +The +.Fn zip_stat_init +function initializes the members of a struct zip_stat. +The current members are described in +.Xr zip_stat 3 , +but this function should be used to initialize it to +make sure none are missed. +.Sh RETURN VALUES +If +.Ar sb +is valid, the function is always successful. +.Sh SEE ALSO +.Xr libzip 3 , +.Xr zip_stat 3 +.Sh AUTHORS +.An -nosplit +.An Dieter Baron Aq dillo@giga.or.at +and +.An Thomas Klausner Aq tk@giga.or.at