man/zip_set_default_password.man

   1 .\" Automatically generated from an mdoc input file.  Do not edit.
   2 .\" zip_set_default_password.mdoc -- set default password for zip
   3 .\" Copyright (C) 2011-2021 Dieter Baron and Thomas Klausner
   4 .\"
   5 .\" This file is part of libzip, a library to manipulate ZIP files.
   6 .\" The authors can be contacted at <info@libzip.org>
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in
  15 .\"    the documentation and/or other materials provided with the
  16 .\"    distribution.
  17 .\" 3. The names of the authors may not be used to endorse or promote
  18 .\"    products derived from this software without specific prior
  19 .\"    written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
  22 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  23 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
  25 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  27 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  29 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  30 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  31 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 .\"
  33 .TH "ZIP_SET_DEFAULT_PASSWORD" "3" "September 15, 2020" "NiH" "Library Functions Manual"
  34 .nh
  35 .if n .ad l
  36 .SH "NAME"
  37 \fBzip_set_default_password\fR
  38 \- set default password for encrypted files in zip
  39 .SH "LIBRARY"
  40 libzip (-lzip)
  41 .SH "SYNOPSIS"
  42 \fB#include <zip.h>\fR
  43 .sp
  44 \fIint\fR
  45 .br
  46 .PD 0
  47 .HP 4n
  48 \fBzip_set_default_password\fR(\fIzip_t\ *archive\fR, \fIconst\ char\ *password\fR);
  49 .PD
  50 .SH "DESCRIPTION"
  51 The
  52 \fBzip_set_default_password\fR()
  53 function sets the default password used when accessing encrypted files.
  54 If
  55 \fIpassword\fR
  56 is
  57 \fRNULL\fR
  58 or the empty string, the default password is unset.
  59 .PP
  60 If you prefer a different password for single files, use
  61 zip_fopen_encrypted(3)
  62 instead of
  63 zip_fopen(3).
  64 Usually, however, the same password is used for every file in an
  65 zip archive.
  66 .PP
  67 The password is not verified when calling this function.
  68 See the
  69 \fICAVEATS\fR
  70 section in
  71 zip_fopen_encrypted(3)
  72 for more details about password handling.
  73 .SH "RETURN VALUES"
  74 Upon successful completion 0 is returned.
  75 Otherwise, \-1 is returned and the error information in
  76 \fIarchive\fR
  77 is set to indicate the error.
  78 .SH "ERRORS"
  79 \fBzip_set_default_password\fR()
  80 fails if:
  81 .TP 19n
  82 [\fRZIP_ER_MEMORY\fR]
  83 Required memory could not be allocated.
  84 .SH "SEE ALSO"
  85 libzip(3),
  86 zip_fopen(3),
  87 zip_fopen_encrypted(3)
  88 .SH "HISTORY"
  89 \fBzip_set_default_password\fR()
  90 was added in libzip 0.10.
  91 .SH "AUTHORS"
  92 Dieter Baron <\fIdillo@nih.at\fR>
  93 and
  94 Thomas Klausner <\fItk@giga.or.at\fR>