man/zip_file_set_mtime.mdoc

   1 .\" zip_file_set_mtime.mdoc -- set mtime for file in zip
   2 .\" Copyright (C) 2014-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_MTIME 3
  34 .Os
  35 .Sh NAME
  36 .Nm zip_file_set_mtime
  37 .Nd set last modification time (mtime) 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_mtime "zip_t *archive" "zip_uint64_t index" "time_t mtime" "zip_flags_t flags"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn zip_file_set_mtime
  47 function sets the last modification time (mtime) for the file at
  48 position
  49 .Ar index
  50 in the zip archive to
  51 .Ar mtime .
  52 Currently, no support for any
  53 .Ar flags
  54 is implemented.
  55 .Sh RETURN VALUES
  56 Upon successful completion 0 is returned.
  57 Otherwise, \-1 is returned and the error information in
  58 .Ar archive
  59 is set to indicate the error.
  60 .Sh ERRORS
  61 .Fn zip_file_set_mtime
  62 fails if:
  63 .Bl -tag -width Er
  64 .It Bq Er ZIP_ER_INVAL
  65 .Ar index
  66 is not a valid file index in
  67 .Ar archive .
  68 .It Bq Er ZIP_ER_MEMORY
  69 Required memory could not be allocated.
  70 .It Bq Er ZIP_ER_RDONLY
  71 The
  72 .Ar archive
  73 was opened in read-only mode.
  74 .El
  75 .Sh SEE ALSO
  76 .Xr libzip 3 ,
  77 .Xr zip_stat 3
  78 .Sh HISTORY
  79 .Fn zip_file_set_mtime
  80 was added in libzip 1.0.
  81 .Sh AUTHORS
  82 .An -nosplit
  83 .An Dieter Baron Aq Mt dillo@nih.at
  84 and
  85 .An Thomas Klausner Aq Mt tk@giga.or.at