Blame doc/man/archive_read_add_passphrase.3

Packit Service 1d0348
.TH ARCHIVE_READ_ADD_PASSPHRASE 3 "September 14, 2014" ""
Packit Service 1d0348
.SH NAME
Packit Service 1d0348
.ad l
Packit Service 1d0348
\fB\%archive_read_add_passphrase\fP,
Packit Service 1d0348
\fB\%archive_read_set_passphrase_callback\fP
Packit Service 1d0348
\- functions for reading encrypted archives
Packit Service 1d0348
.SH LIBRARY
Packit Service 1d0348
.ad l
Packit Service 1d0348
Streaming Archive Library (libarchive, -larchive)
Packit Service 1d0348
.SH SYNOPSIS
Packit Service 1d0348
.ad l
Packit Service 1d0348
\fB#include <archive.h>\fP
Packit Service 1d0348
.br
Packit Service 1d0348
\fIint\fP
Packit Service 1d0348
.br
Packit Service 1d0348
\fB\%archive_read_add_passphrase\fP(\fI\%struct\ archive\ *\fP, \fI\%const\ char\ *passphrase\fP);
Packit Service 1d0348
.br
Packit Service 1d0348
\fIint\fP
Packit Service 1d0348
.br
Packit Service 1d0348
\fB\%archive_read_set_passphrase_callback\fP(\fI\%struct\ archive\ *\fP, \fI\%void\ *client_data\fP, \fI\%archive_passphrase_callback\ *\fP);
Packit Service 1d0348
.SH DESCRIPTION
Packit Service 1d0348
.ad l
Packit Service 1d0348
.RS 5
Packit Service 1d0348
.TP
Packit Service 1d0348
\fB\%archive_read_add_passphrase\fP()
Packit Service 1d0348
Register passphrases for reading an encryption archive.
Packit Service 1d0348
If
Packit Service 1d0348
\fIpassphrase\fP
Packit Service 1d0348
is
Packit Service 1d0348
.BR NULL
Packit Service 1d0348
or empty, this function will do nothing and
Packit Service 1d0348
\fBARCHIVE_FAILED\fP
Packit Service 1d0348
will be returned.
Packit Service 1d0348
Otherwise,
Packit Service 1d0348
\fBARCHIVE_OK\fP
Packit Service 1d0348
will be returned. 
Packit Service 1d0348
.TP
Packit Service 1d0348
\fB\%archive_read_set_passphrase_callback\fP()
Packit Service 1d0348
Register callback function that will be invoked to get a passphrase 
Packit Service 1d0348
for decrption after trying all passphrases registered by the
Packit Service 1d0348
\fB\%archive_read_add_passphrase\fP()
Packit Service 1d0348
function failed.
Packit Service 1d0348
.RE
Packit Service 1d0348
.SH SEE ALSO
Packit Service 1d0348
.ad l
Packit Service 1d0348
\fBtar\fP(1),
Packit Service 1d0348
\fBlibarchive\fP(3),
Packit Service 1d0348
\fBarchive_read\fP(3),
Packit Service 1d0348
\fBarchive_read_set_options\fP(3)