"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_set_archive_comment.mdoc" (24 Jan 2020, 3020 Bytes) of package /linux/misc/libzip-1.6.0.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 latest Fossies "Diffs" side-by-side code changes report for "zip_set_archive_comment.mdoc": 1.5.2_vs_1.6.0.

    1 .\" zip_set_archive_comment.mdoc -- set zip archive comment
    2 .\" Copyright (C) 2006-2019 Dieter Baron and Thomas Klausner
    3 .\"
    4 .\" This file is part of libzip, a library to manipulate ZIP archives.
    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_SET_ARCHIVE_COMMENT 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_set_archive_comment
   37 .Nd set zip archive comment
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Ft int
   43 .Fn zip_set_archive_comment "zip_t *archive" "const char *comment" "zip_uint16_t len"
   44 .Sh DESCRIPTION
   45 The
   46 .Fn zip_set_archive_comment
   47 function sets the comment for the entire zip archive.
   48 If
   49 .Ar comment
   50 is
   51 .Dv NULL
   52 and
   53 .Ar len
   54 is 0, the archive comment will be removed.
   55 .Ar comment
   56 must be encoded in ASCII or UTF-8.
   57 .Sh RETURN VALUES
   58 Upon successful completion 0 is returned.
   59 Otherwise, \-1 is returned and the error information in
   60 .Ar archive
   61 is set to indicate the error.
   62 .Sh ERRORS
   63 .Fn zip_set_archive_comment
   64 fails if:
   65 .Bl -tag -width Er
   66 .It Bq Er ZIP_ER_INVAL
   67 .Ar len
   68 is less than 0 or longer than the maximum comment length in a zip file
   69 (65535), or
   70 .Ar comment
   71 is not a valid UTF-8 encoded string.
   72 .It Bq Er ZIP_ER_MEMORY
   73 Required memory could not be allocated.
   74 .El
   75 .Sh SEE ALSO
   76 .Xr libzip 3 ,
   77 .Xr zip_file_get_comment 3 ,
   78 .Xr zip_file_set_comment 3 ,
   79 .Xr zip_get_archive_comment 3
   80 .Sh HISTORY
   81 .Fn zip_set_archive_comment
   82 was added in libzip 0.7.
   83 In libzip 0.11 the type of
   84 .Ar len
   85 was changed from
   86 .Vt int
   87 to
   88 .Vt zip_uint16_t .
   89 .Sh AUTHORS
   90 .An -nosplit
   91 .An Dieter Baron Aq Mt dillo@nih.at
   92 and
   93 .An Thomas Klausner Aq Mt tk@giga.or.at