Document ZIP_FL_RECOMPRESS. --HG-- branch : HEAD
diff --git a/man/zip_source_zip.man b/man/zip_source_zip.man index 704740c..b817995 100644 --- a/man/zip_source_zip.man +++ b/man/zip_source_zip.man
@@ -1,9 +1,5 @@ -.\" Converted with mdoc2man 0.2 -.\" from NiH: zip_source_zip.mdoc,v 1.7 2005/07/20 17:18:04 wiz Exp -.\" $NiH: zip_source_zip.mdoc,v 1.7 2005/07/20 17:18:04 wiz Exp $ -.\" .\" zip_source_zip.mdoc \-- create data source from zip file -.\" Copyright (C) 2004, 2005 Dieter Baron and Thomas Klausner +.\" Copyright (C) 2004, 2005, 2008 Dieter Baron and Thomas Klausner .\" .\" This file is part of libzip, a library to manipulate ZIP archives. .\" The authors can be contacted at <libzip@nih.at> @@ -33,7 +29,7 @@ .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.TH ZIP_SOURCE_ZIP 3 "July 29, 2005" NiH +.TH ZIP_SOURCE_ZIP 3 "June 4, 2008" NiH .SH "NAME" zip_source_zip \- create data source from zip file .SH "LIBRARY" @@ -67,16 +63,22 @@ is zero and \fBlen\fR is \-1, the whole file will be copied without decompressing it. -If -\fBflags\fR -is -\fBZIP_FL_UNCHANGED,\fR -zip_source_zip -will try to get the original data without any changes that may -have been made to +.PP +Supported flags are: +.RS +.TP 23 +\fBZIP_FL_UNCHANGED\fR +Try to get the original data without any changes that may have been +made to \fBsrcarchive\fR after opening it. -.\" XXX: document ZIP_FL_RECOMPRESS +.TP 23 +\fBZIP_FL_RECOMPRESS\fR +When adding the data from +\fBsrcarchive,\fR +re-compress it using the current settings instead of copying the +compressed data. +.RE .SH "RETURN VALUES" Upon successful completion, the created source is returned. Otherwise,
diff --git a/man/zip_source_zip.mdoc b/man/zip_source_zip.mdoc index 860c2c3..6f9e136 100644 --- a/man/zip_source_zip.mdoc +++ b/man/zip_source_zip.mdoc
@@ -1,7 +1,5 @@ -.\" $NiH: zip_source_zip.mdoc,v 1.7 2005/07/20 17:18:04 wiz Exp $ -.\" .\" zip_source_zip.mdoc -- create data source from zip file -.\" Copyright (C) 2004, 2005 Dieter Baron and Thomas Klausner +.\" Copyright (C) 2004, 2005, 2008 Dieter Baron and Thomas Klausner .\" .\" This file is part of libzip, a library to manipulate ZIP archives. .\" The authors can be contacted at <libzip@nih.at> @@ -31,7 +29,7 @@ .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd July 29, 2005 +.Dd June 4, 2008 .Dt ZIP_SOURCE_ZIP 3 .Os .Sh NAME @@ -67,16 +65,20 @@ is zero and .Ar len is \-1, the whole file will be copied without decompressing it. -If -.Ar flags -is -.Dv ZIP_FL_UNCHANGED , -.Fn zip_source_zip -will try to get the original data without any changes that may -have been made to +.Pp +Supported flags are: +.Bl -tag -width XZIPXFLXRECOMPRESSXXX +.It Dv ZIP_FL_UNCHANGED +Try to get the original data without any changes that may have been +made to .Ar srcarchive after opening it. -.\" XXX: document ZIP_FL_RECOMPRESS +.It Dv ZIP_FL_RECOMPRESS +When adding the data from +.Ar srcarchive , +re-compress it using the current settings instead of copying the +compressed data. +.El .Sh RETURN VALUES Upon successful completion, the created source is returned. Otherwise,