| .\" zip_set_default_password.mdoc -- set default password for zip |
| .\" Copyright (C) 2011-2020 Dieter Baron and Thomas Klausner |
| .\" |
| .\" This file is part of libzip, a library to manipulate ZIP files. |
| .\" The authors can be contacted at <libzip@nih.at> |
| .\" |
| .\" Redistribution and use in source and binary forms, with or without |
| .\" modification, are permitted provided that the following conditions |
| .\" are met: |
| .\" 1. Redistributions of source code must retain the above copyright |
| .\" notice, this list of conditions and the following disclaimer. |
| .\" 2. Redistributions in binary form must reproduce the above copyright |
| .\" notice, this list of conditions and the following disclaimer in |
| .\" the documentation and/or other materials provided with the |
| .\" distribution. |
| .\" 3. The names of the authors may not be used to endorse or promote |
| .\" products derived from this software without specific prior |
| .\" written permission. |
| .\" |
| .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS |
| .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY |
| .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE |
| .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER |
| .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
| .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN |
| .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| .\" |
| .Dd September 15, 2020 |
| .Dt ZIP_SET_DEFAULT_PASSWORD 3 |
| .Os |
| .Sh NAME |
| .Nm zip_set_default_password |
| .Nd set default password for encrypted files in zip |
| .Sh LIBRARY |
| libzip (-lzip) |
| .Sh SYNOPSIS |
| .In zip.h |
| .Ft int |
| .Fn zip_set_default_password "zip_t *archive" "const char *password" |
| .Sh DESCRIPTION |
| The |
| .Fn zip_set_default_password |
| function sets the default password used when accessing encrypted files. |
| If |
| .Ar password |
| is |
| .Dv NULL |
| or the empty string, the default password is unset. |
| .Pp |
| If you prefer a different password for single files, use |
| .Xr zip_fopen_encrypted 3 |
| instead of |
| .Xr zip_fopen 3 . |
| Usually, however, the same password is used for every file in an |
| zip archive. |
| .Pp |
| The password is not verified when calling this function. |
| See the |
| .Sx CAVEATS |
| section in |
| .Xr zip_fopen_encrypted 3 |
| for more details about password handling. |
| .Sh RETURN VALUES |
| Upon successful completion 0 is returned. |
| Otherwise, \-1 is returned and the error information in |
| .Ar archive |
| is set to indicate the error. |
| .Sh ERRORS |
| .Fn zip_set_default_password |
| fails if: |
| .Bl -tag -width Er |
| .It Bq Er ZIP_ER_MEMORY |
| Required memory could not be allocated. |
| .El |
| .Sh SEE ALSO |
| .Xr libzip 3 , |
| .Xr zip_fopen 3 , |
| .Xr zip_fopen_encrypted 3 |
| .Sh HISTORY |
| .Fn zip_set_default_password |
| was added in libzip 0.10. |
| .Sh AUTHORS |
| .An -nosplit |
| .An Dieter Baron Aq Mt dillo@nih.at |
| and |
| .An Thomas Klausner Aq Mt tk@giga.or.at |
