"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/zip_file_set_comment.mdoc" (12 Mar 2019, 3377 Bytes) of package /linux/misc/libzip-1.5.2.tar.xz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "zip_file_set_comment.mdoc": 1.3.2_vs_1.4.0.

    1 .\" zip_file_set_comment.mdoc -- set comment for file in zip
    2 .\" Copyright (C) 2006-2017 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 December 18, 2017
   33 .Dt ZIP_FILE_SET_COMMENT 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_file_set_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_file_set_comment "zip_t *archive" "zip_uint64_t index" "const char *comment" "zip_uint16_t len" "zip_flags_t flags"
   44 .Sh DESCRIPTION
   45 The
   46 .Fn zip_file_set_comment
   47 function sets the comment for the file at position
   48 .Ar index
   49 in the zip archive to
   50 .Ar comment
   51 of length
   52 .Ar len .
   53 If
   54 .Ar comment
   55 is
   56 .Dv NULL
   57 and
   58 .Ar len
   59 is 0, the file comment will be removed.
   60 The
   61 .Ar flags
   62 argument can be any of:
   63 .Bl -tag -width XZIPXFLXENCXSTRICTXX
   64 .It Dv ZIP_FL_ENC_GUESS
   65 Guess encoding of
   66 .Ar comment
   67 (default).
   68 .It Dv ZIP_FL_ENC_UTF_8
   69 Interpret
   70 .Ar comment
   71 as UTF-8.
   72 .It Dv ZIP_FL_ENC_CP437
   73 Interpret
   74 .Ar comment
   75 as code page 437 (CP-437).
   76 .El
   77 .Sh RETURN VALUES
   78 Upon successful completion 0 is returned.
   79 Otherwise, \-1 is returned and the error information in
   80 .Ar archive
   81 is set to indicate the error.
   82 .Sh ERRORS
   83 .Fn zip_file_set_comment
   84 fails if:
   85 .Bl -tag -width Er
   86 .It Bq Er ZIP_ER_INVAL
   87 .Ar index
   88 is not a valid file index in
   89 .Ar archive ,
   90 or
   91 .Ar len
   92 is less than 0 or longer than the maximum comment length in a zip file
   93 (65535), or
   94 .Ar comment
   95 is not a valid UTF-8 encoded string.
   96 .It Bq Er ZIP_ER_MEMORY
   97 Required memory could not be allocated.
   98 .It Bq Er ZIP_ER_RDONLY
   99 The
  100 .Ar archive
  101 was opened in read-only mode.
  102 .El
  103 .Sh SEE ALSO
  104 .Xr libzip 3 ,
  105 .Xr zip_file_get_comment 3 ,
  106 .Xr zip_get_archive_comment 3 ,
  107 .Xr zip_set_archive_comment 3
  108 .Sh HISTORY
  109 .Fn zip_file_set_comment
  110 was added in libzip 0.11.
  111 .Sh AUTHORS
  112 .An -nosplit
  113 .An Dieter Baron Aq Mt dillo@nih.at
  114 and
  115 .An Thomas Klausner Aq Mt tk@giga.or.at