Document zip_file_set_comment.
diff --git a/man/Makefile.am b/man/Makefile.am index 87c4cc5..a6febbb 100644 --- a/man/Makefile.am +++ b/man/Makefile.am
@@ -23,6 +23,7 @@ zip_file_add.mdoc \ zip_file_get_comment.mdoc \ zip_file_rename.mdoc \ + zip_file_set_comment.mdoc \ zip_file_strerror.mdoc \ zip_fopen.mdoc \ zip_fopen_encrypted.mdoc \
diff --git a/man/zip_file_set_comment.mdoc b/man/zip_file_set_comment.mdoc new file mode 100644 index 0000000..1b15b63 --- /dev/null +++ b/man/zip_file_set_comment.mdoc
@@ -0,0 +1,109 @@ +.\" zip_file_set_comment.mdoc -- set comment for file in zip +.\" Copyright (C) 2006-2012 Dieter Baron and Thomas Klausner +.\" +.\" This file is part of libzip, a library to manipulate ZIP files. +.\" The authors can be contacted at <libzip@nih.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 June 23, 2012 +.Dt ZIP_FILE_SET_COMMENT 3 +.Os +.Sh NAME +.Nm zip_file_set_comment +.Nd set comment for file in zip +.Sh LIBRARY +libzip (-lzip) +.Sh SYNOPSIS +.In zip.h +.Ft int +.Fn zip_set_file_comment "struct zip *archive" "zip_uint64_t index" \ +"const char *comment" "zip_uint16_t len" "zip_flags_t flags" +.Sh DESCRIPTION +The +.Fn zip_file_set_comment +function sets the comment for the file at position +.Ar index +in the zip archive to +.Ar comment +of length +.Ar len . +If +.Ar comment +is +.Dv NULL +and +.Ar len +is 0, the file comment will be removed. +The +.Ar flags +argument can be a combination of: +.Bl -tag -width XZIPXFLXENCXSTRICTXX +.It Dv ZIP_FL_ENC_GUESS +Guess encoding of +.Ar comment +(default). +.It Dv ZIP_FL_ENC_UTF_8 +Interpret +.Ar comment +as UTF-8. +.It Dv ZIP_FL_ENC_CP437 +Interpret +.Ar comment +as code page 437 (CP-437). +.El +.Sh RETURN VALUES +Upon successful completion 0 is returned. +Otherwise, \-1 is returned and the error information in +.Ar archive +is set to indicate the error. +.Sh ERRORS +.Fn zip_file_set_comment +fails if: +.Bl -tag -width Er +.It Bq Er ZIP_ER_INVAL +.Ar index +is not a valid file index in +.Ar archive , +or +.Ar len +is less than 0 or longer than the maximum comment length in a zip file +(65535), or +.Ar comment +is not a valid UTF-8 encoded string. +.It Bq Er ZIP_ER_MEMORY +Required memory could not be allocated. +.El +.Sh SEE ALSO +.Xr libzip 3 , +.Xr zip_get_archive_comment 3 , +.Xr zip_file_get_comment 3 , +.Xr zip_set_archive_comment 3 +.Sh AUTHORS +.An -nosplit +.An Dieter Baron Aq dillo@giga.or.at +and +.An Thomas Klausner Aq tk@giga.or.at
diff --git a/man/zip_set_file_comment.mdoc b/man/zip_set_file_comment.mdoc index 62d3c16..5fbb558 100644 --- a/man/zip_set_file_comment.mdoc +++ b/man/zip_set_file_comment.mdoc
@@ -29,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 February 20, 2012 +.Dd June 23, 2012 .Dt ZIP_SET_FILE_COMMENT 3 .Os .Sh NAME @@ -45,52 +45,22 @@ .Sh DESCRIPTION The .Fn zip_set_file_comment -function sets the comment for the file at position -.Ar index -in the zip archive to -.Ar comment -of length -.Ar len . -If -.Ar comment -is -.Dv NULL -and +function is the obsolete version of +.Xr zip_file_set_comment 3 . +The only differences are the type of the .Ar len -is 0, the file comment will be removed. -.Ar comment -must be encoded in ASCII or UTF-8. -.Sh RETURN VALUES -Upon successful completion 0 is returned. -Otherwise, \-1 is returned and the error information in -.Ar archive -is set to indicate the error. -.Sh ERRORS +argument and the additional +.Ar flags +argument. .Fn zip_set_file_comment -fails if: -.Bl -tag -width Er -.It Bq Er ZIP_ER_ENCMISMATCH -The file name is encoded in CP437 and the file comment is in UTF-8. -Workaround: see -.Xr zip_rename 3 . -.It Bq Er ZIP_ER_INVAL -.Ar index -is not a valid file index in -.Ar archive , -or -.Ar len -is less than 0 or longer than the maximum comment length in a zip file -(65535), or -.Ar comment -is not a valid UTF-8 encoded string. -.It Bq Er ZIP_ER_MEMORY -Required memory could not be allocated. -.El +is the same as calling +.Xr zip_file_set_comment 3 +with an empty +.Ar flags +argument. .Sh SEE ALSO .Xr libzip 3 , -.Xr zip_get_archive_comment 3 , -.Xr zip_get_file_comment 3 , -.Xr zip_set_archive_comment 3 +.Xr zip_file_set_comment 3 .Sh AUTHORS .An -nosplit .An Dieter Baron Aq dillo@giga.or.at