Blame doc/man/archive_read_add_passphrase.3

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