man/zip_set_file_comment.mdoc

   1 .\" zip_set_file_comment.mdoc -- set comment for file in zip
   2 .\" Copyright (C) 2006-2016 Dieter Baron and Thomas Klausner
   3 .\"
   4 .\" This file is part of libzip, a library to manipulate ZIP files.
   5 .\" The authors can be contacted at <libzip@nih.at>
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\" 3. The names of the authors may not be used to endorse or promote
  17 .\"    products derived from this software without specific prior
  18 .\"    written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
  21 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  22 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
  24 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  26 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  28 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  30 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 .\"
  32 .Dd June 23, 2012
  33 .Dt ZIP_SET_FILE_COMMENT 3
  34 .Os
  35 .Sh NAME
  36 .Nm zip_set_file_comment
  37 .Nd set comment for file in zip
  38 .Sh LIBRARY
  39 libzip (-lzip)
  40 .Sh SYNOPSIS
  41 .In zip.h
  42 .Ft int
  43 .Fn zip_set_file_comment "zip_t *archive" "zip_uint64_t index" "const char *comment" "int len"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn zip_set_file_comment
  47 function is the obsolete version of
  48 .Xr zip_file_set_comment 3 .
  49 The only differences are the type of the
  50 .Ar len
  51 argument and the additional
  52 .Ar flags
  53 argument.
  54 .Fn zip_set_file_comment
  55 is the same as calling
  56 .Xr zip_file_set_comment 3
  57 with an empty
  58 .Ar flags
  59 argument.
  60 .Sh SEE ALSO
  61 .Xr libzip 3 ,
  62 .Xr zip_file_set_comment 3
  63 .Sh AUTHORS
  64 .An -nosplit
  65 .An Dieter Baron Aq Mt dillo@nih.at
  66 and
  67 .An Thomas Klausner Aq Mt tk@giga.or.at