"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/zip_get_archive_comment.mdoc" (12 Mar 2019, 3570 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 latest Fossies "Diffs" side-by-side code changes report for "zip_get_archive_comment.mdoc": 1.5.1_vs_1.5.2.

    1 .\" zip_get_archive_comment.mdoc -- get zip archive comment
    2 .\" Copyright (C) 2006-2018 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 July 22, 2018
   33 .Dt ZIP_GET_ARCHIVE_COMMENT 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_get_archive_comment
   37 .Nd get zip archive comment
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Ft const char *
   43 .Fn zip_get_archive_comment "zip_t *archive" "int *lenp" "zip_flags_t flags"
   44 .Sh DESCRIPTION
   45 The
   46 .Fn zip_get_archive_comment
   47 function returns the comment for the entire zip archive.
   48 The return value is in UTF-8 encoding unless
   49 .Dv ZIP_FL_ENC_RAW
   50 was specified (see below).
   51 This pointer should not be modified or
   52 .Xr free 3 Ap d ,
   53 and becomes invalid when
   54 .Ar archive
   55 is closed.
   56 If
   57 .Ar lenp
   58 is not
   59 .Dv NULL ,
   60 the integer to which it points will be set to the length of the
   61 comment.
   62 If
   63 .Ar flags
   64 is set to
   65 .Dv ZIP_FL_UNCHANGED ,
   66 the original unchanged comment is returned.
   67 .Pp
   68 Additionally, the following
   69 .Ar flags
   70 are supported:
   71 .Bl -tag -width ZIP_FL_ENC_STRICTXX -offset indent
   72 .It Dv ZIP_FL_ENC_RAW
   73 Return the unmodified archive comment as it is in the ZIP archive.
   74 .It Dv ZIP_FL_ENC_GUESS
   75 (Default.)
   76 Guess the encoding of the archive comment in the ZIP archive and convert it
   77 to UTF-8, if necessary.
   78 .It Dv ZIP_FL_ENC_STRICT
   79 Follow the ZIP specification for file names and extend it to the
   80 archive comment, thus also expecting it in CP-437 encoding.
   81 Convert it to UTF-8.
   82 .El
   83 .Em Note :
   84 ASCII is a subset of both CP-437 and UTF-8.
   85 .Sh RETURN VALUES
   86 Upon successful completion, a pointer to the comment is returned,
   87 or
   88 .Dv NULL
   89 if there is no comment.
   90 .\" In case of an error,
   91 .\" .Dv NULL
   92 .\" is returned and the error code in
   93 .\" .Ar archive
   94 .\" is set to indicate the error.
   95 .Sh SEE ALSO
   96 .Xr libzip 3 ,
   97 .Xr zip_file_get_comment 3
   98 .Sh HISTORY
   99 .Fn zip_get_archive_comment
  100 was added in libzip 0.7.
  101 In libzip 0.11 the type of
  102 .Ar flags
  103 was changed from
  104 .Vt int
  105 to
  106 .Vt zip_flags_t .
  107 .Sh AUTHORS
  108 .An -nosplit
  109 .An Dieter Baron Aq Mt dillo@nih.at
  110 and
  111 .An Thomas Klausner Aq Mt tk@giga.or.at