man/zip_rename.mdoc

   1 .\" zip_rename.mdoc -- rename file in zip archive
   2 .\" Copyright (C) 2003-2017 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_RENAME 3
  34 .Os
  35 .Sh NAME
  36 .Nm zip_rename
  37 .Nd rename file in zip archive (obsolete interface)
  38 .Sh LIBRARY
  39 libzip (-lzip)
  40 .Sh SYNOPSIS
  41 .In zip.h
  42 .Ft int
  43 .Fn zip_rename "zip_t *archive" "zip_uint64_t index" "const char *name"
  44 .Sh DESCRIPTION
  45 .Fn zip_rename
  46 is the obsolete version of
  47 .Xr zip_file_rename 3 .
  48 It is the same as calling
  49 .Xr zip_file_rename 3
  50 with an empty flags argument.
  51 .Sh SEE ALSO
  52 .Xr libzip 3 ,
  53 .Xr zip_file_rename 3
  54 .Sh HISTORY
  55 .Fn zip_rename
  56 was added in libzip 0.6.
  57 In libzip 0.10 the type of
  58 .Ar index
  59 was changed from
  60 .Vt int
  61 to
  62 .Vt zip_uint64_t .
  63 It was deprecated in libzip 0.11, use
  64 .Fn zip_file_rename
  65 instead.
  66 .Sh AUTHORS
  67 .An -nosplit
  68 .An Dieter Baron Aq Mt dillo@nih.at
  69 and
  70 .An Thomas Klausner Aq Mt tk@giga.or.at