"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.5.2/man/zip_file_extra_field_set.mdoc" (12 Mar 2019, 3871 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_extra_field_set.mdoc": 1.3.2_vs_1.4.0.

    1 .\" zip_file_extra_field_set.mdoc -- set extra field for file in zip
    2 .\" Copyright (C) 2012-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_EXTRA_FIELD_SET 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_file_extra_field_set
   37 .Nd set extra field for file in zip
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Ft int
   43 .Fn zip_file_extra_field_set "zip_t *archive" "zip_uint64_t index" "zip_uint16_t extra_field_id" "zip_uint16_t extra_field_index" "const zip_uint8_t *extra_field_data" "zip_uint16_t len" "zip_flags_t flags"
   44 .Sh DESCRIPTION
   45 The
   46 .Fn zip_file_extra_field_set
   47 function sets the extra field with ID (two-byte signature)
   48 .Ar extra_field_id
   49 and index
   50 .Ar extra_field_index
   51 for the file at position
   52 .Ar index
   53 in the zip archive.
   54 The extra field's data will be set to
   55 .Ar extra_field_data
   56 and length
   57 .Ar len .
   58 If a new entry shall be appended, set
   59 .Ar extra_field_index
   60 to
   61 .Dv ZIP_EXTRA_FIELD_NEW .
   62 .Pp
   63 At least one of the following
   64 .Ar flags
   65 must be set:
   66 .Bl -tag -width ZIP_FL_CENTRALXX -offset indent
   67 .It Dv ZIP_FL_CENTRAL
   68 Set extra field in the archive's central directory.
   69 .It Dv ZIP_FL_LOCAL
   70 Set extra field in the local file headers.
   71 .El
   72 .Pp
   73 Please note that the extra field IDs 0x0001 (ZIP64 extension),
   74 0x6375 (Infozip UTF-8 comment), and
   75 0x7075 (Infozip UTF-8 file name) can not be set using
   76 .Fn zip_file_extra_field_set
   77 since they are set by
   78 .Xr libzip 3
   79 automatically when needed.
   80 .Sh RETURN VALUES
   81 Upon successful completion 0 is returned.
   82 Otherwise, \-1 is returned and the error code in
   83 .Ar archive
   84 is set to indicate the error.
   85 .Sh ERRORS
   86 .Fn zip_file_extra_field_set
   87 fails if:
   88 .Bl -tag -width Er
   89 .It Bq Er ZIP_ER_INVAL
   90 The extra field size is too large (ID and length need 4 bytes; the
   91 maximum length of all extra fields for one file combined is 65536
   92 bytes).
   93 This error also occurs if
   94 .Ar extra_field_index
   95 is too large.
   96 .It Bq Er ZIP_ER_MEMORY
   97 Required memory could not be allocated.
   98 .It Bq Er ZIP_ER_NOENT
   99 .Ar index
  100 is not a valid file index in
  101 .Ar archive .
  102 .El
  103 .Sh SEE ALSO
  104 .Xr libzip 3 ,
  105 .Xr zip_file_extra_field_delete 3 ,
  106 .Xr zip_file_extra_field_get 3 ,
  107 .Xr zip_file_extra_fields_count 3
  108 .Sh HISTORY
  109 .Fn zip_file_extra_field_set
  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