"Fossies" - the Fresh Open Source Software Archive

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

    1 .\" zip_fopen_encrypted.mdoc -- open encrypted file in zip archive for reading
    2 .\" Copyright (C) 2011-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_FOPEN_ENCRYPTED 3
   34 .Os
   35 .Sh NAME
   36 .Nm zip_fopen_encrypted ,
   37 .Nm zip_fopen_index_encrypted
   38 .Nd open encrypted file in zip archive for reading
   39 .Sh LIBRARY
   40 libzip (-lzip)
   41 .Sh SYNOPSIS
   42 .In zip.h
   43 .Ft zip_file_t *
   44 .Fn zip_fopen_encrypted "zip_t *archive" "const char *fname" "zip_flags_t flags" "const char *password"
   45 .Ft zip_file_t *
   46 .Fn zip_fopen_index_encrypted "zip_t *archive" "zip_uint64_t index" "zip_flags_t flags" "const char *password"
   47 .Sh DESCRIPTION
   48 The
   49 .Fn zip_fopen_encrypted
   50 function opens the encrypted file name
   51 .Ar fname
   52 in
   53 .Ar archive
   54 using the password given in the
   55 .Ar password
   56 argument.
   57 The
   58 .Ar flags
   59 argument are the same as for
   60 .Xr zip_fopen 3 .
   61 .Pp
   62 The
   63 .Fn zip_fopen_index_encrypted
   64 function opens the file at position
   65 .Ar index ,
   66 see
   67 .Xr zip_fopen_index 3 .
   68 These functions are called automatically by
   69 .Xr zip_fopen 3 ;
   70 you only need to call them if you want to specify a non-default password
   71 (see
   72 .Xr zip_set_default_password 3 ) .
   73 .Sh RETURN VALUES
   74 Upon successful completion, a
   75 .Ft struct zip_file
   76 pointer is returned.
   77 Otherwise,
   78 .Dv NULL
   79 is returned and the error code in
   80 .Ar archive
   81 is set to indicate the error.
   82 .Sh ERRORS
   83 .Bl -tag -width ZIP_ER_ENCRNOTSUPPXX
   84 .It Bq Er ZIP_ER_NOPASSWD
   85 No password was provided.
   86 .El
   87 .Pp
   88 The function
   89 .Fn zip_fopen_encrypted
   90 may also fail and set
   91 .Va zip_err
   92 for any of the errors specified for the routine
   93 .Xr zip_fopen 3 .
   94 .Pp
   95 The function
   96 .Fn zip_fopen_index_encrypted
   97 may also fail and set
   98 .Va zip_err
   99 for any of the errors specified for the routine
  100 .Xr zip_fopen_index 3 .
  101 .Sh SEE ALSO
  102 .Xr libzip 3 ,
  103 .Xr zip_fclose 3 ,
  104 .Xr zip_fopen 3 ,
  105 .Xr zip_fread 3 ,
  106 .Xr zip_get_num_entries 3 ,
  107 .Xr zip_name_locate 3
  108 .Sh HISTORY
  109 .Fn zip_fopen_encrypted
  110 and
  111 .Fn zip_fopen_index_encrypted
  112 were added in libzip 1.0.
  113 .Sh AUTHORS
  114 .An -nosplit
  115 .An Dieter Baron Aq Mt dillo@nih.at
  116 and
  117 .An Thomas Klausner Aq Mt tk@giga.or.at