1.\" Copyright (c) 2014 Michihiro NAKAJIMA 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.Dd September 21, 2014 26.Dt ARCHIVE_WRITE_SET_PASSPHRASE 3 27.Os 28.Sh NAME 29.Nm archive_write_set_passphrase , 30.Nm archive_write_set_passphrase_callback 31.Nd functions for writing encrypted archives 32.Sh LIBRARY 33Streaming Archive Library (libarchive, -larchive) 34.Sh SYNOPSIS 35.In archive.h 36.Ft int 37.Fo archive_write_set_passphrase 38.Fa "struct archive *" 39.Fa "const char *passphrase" 40.Fc 41.Ft int 42.Fo archive_write_set_passphrase_callback 43.Fa "struct archive *" 44.Fa "void *client_data" 45.Fa "archive_passphrase_callback *" 46.Fc 47.Sh DESCRIPTION 48.Bl -tag -width indent 49.It Fn archive_write_set_passphrase 50Set a passphrase for writing an encrypted archive. 51If 52.Ar passphrase 53is 54.Dv NULL 55or empty, this function will do nothing and 56.Cm ARCHIVE_FAILED 57will be returned. 58Otherwise, 59.Cm ARCHIVE_OK 60will be returned. 61.It Fn archive_write_set_passphrase_callback 62Register a callback function that will be invoked to get a passphrase 63for encryption if the passphrase was not set by the 64.Fn archive_write_set_passphrase 65function. 66.El 67.\" .Sh ERRORS 68.Sh SEE ALSO 69.Xr tar 1 , 70.Xr archive_write 3 , 71.Xr archive_write_set_options 3 , 72.Xr libarchive 3 73