"Fossies" - the Fresh Open Source Software Archive

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

    1 .\" zip_set_default_password.mdoc -- set default password for zip
    2 .\" Copyright (C) 2011-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_SET_DEFAULT_PASSWORD 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_set_default_password
   37 .Nd set default password for encrypted files in zip
   38 .Sh LIBRARY
   39 libzip (-lzip)
   40 .Sh SYNOPSIS
   41 .In zip.h
   42 .Ft int
   43 .Fn zip_set_default_password "zip_t *archive" "const char *password"
   44 .Sh DESCRIPTION
   45 The
   46 .Fn zip_set_default_password
   47 function sets the default password used when accessing encrypted files.
   48 If
   49 .Ar password
   50 is
   51 .Dv NULL ,
   52 the default password is unset.
   53 .Pp
   54 If you prefer a different password for single files, use
   55 .Xr zip_fopen_encrypted 3
   56 instead of
   57 .Xr zip_fopen 3 .
   58 Usually, however, the same password is used for every file in an
   59 zip archive.
   60 .Sh RETURN VALUES
   61 Upon successful completion 0 is returned.
   62 Otherwise, \-1 is returned and the error information in
   63 .Ar archive
   64 is set to indicate the error.
   65 .Sh ERRORS
   66 .Fn zip_set_default_password
   67 fails if:
   68 .Bl -tag -width Er
   69 .It Bq Er ZIP_ER_MEMORY
   70 Required memory could not be allocated.
   71 .El
   72 .Sh SEE ALSO
   73 .Xr libzip 3 ,
   74 .Xr zip_fopen 3 ,
   75 .Xr zip_fopen_encrypted 3
   76 .Sh HISTORY
   77 .Fn zip_set_default_password
   78 was added in libzip 0.10.
   79 .Sh AUTHORS
   80 .An -nosplit
   81 .An Dieter Baron Aq Mt dillo@nih.at
   82 and
   83 .An Thomas Klausner Aq Mt tk@giga.or.at