"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_file_get_comment.mdoc" (24 Jan 2020, 3742 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 last Fossies "Diffs" side-by-side code changes report for "zip_file_get_comment.mdoc": 1.3.2_vs_1.4.0.

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