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.\" $FreeBSD$ 26.\" 27.Dd September 21, 2014 28.Dt ARCHIVE_WRITE_SET_PASSPHRASE 3 29.Os 30.Sh NAME 31.Nm archive_write_set_passphrase , 32.Nm archive_write_set_passphrase_callback 33.Nd functions for writing encrypted archives 34.Sh LIBRARY 35Streaming Archive Library (libarchive, -larchive) 36.Sh SYNOPSIS 37.In archive.h 38.Ft int 39.Fo archive_write_set_passphrase 40.Fa "struct archive *" 41.Fa "const char *passphrase" 42.Fc 43.Ft int 44.Fo archive_write_set_passphrase_callback 45.Fa "struct archive *" 46.Fa "void *client_data" 47.Fa "archive_passphrase_callback *" 48.Fc 49.Sh DESCRIPTION 50.Bl -tag -width indent 51.It Fn archive_write_set_passphrase 52Set a passphrase for writing an encrypted archive. 53If 54.Ar passphrase 55is 56.Dv NULL 57or empty, this function will do nothing and 58.Cm ARCHIVE_FAILED 59will be returned. 60Otherwise, 61.Cm ARCHIVE_OK 62will be returned. 63.It Fn archive_write_set_passphrase_callback 64Register a callback function that will be invoked to get a passphrase 65for encryption if the passphrase was not set by the 66.Fn archive_write_set_passphrase 67function. 68.El 69.\" .Sh ERRORS 70.Sh SEE ALSO 71.Xr tar 1 , 72.Xr archive_write 3 , 73.Xr archive_write_set_options 3 , 74.Xr libarchive 3 75