doc/text/archive_read_add_passphrase.3.txt

   1 ARCHIVE_READ_ADD_PASS... BSD Library Functions Manual ARCHIVE_READ_ADD_PASS...
   2
   3 NAME
   4      archive_read_add_passphrase, archive_read_set_passphrase_callback — func‐
   5      tions for reading encrypted archives
   6
   7 LIBRARY
   8      Streaming Archive Library (libarchive, -larchive)
   9
  10 SYNOPSIS
  11      #include <archive.h>
  12
  13      int
  14      archive_read_add_passphrase(struct archive *, const char *passphrase);
  15
  16      int
  17      archive_read_set_passphrase_callback(struct archive *, void *client_data,
  18          archive_passphrase_callback *);
  19
  20 DESCRIPTION
  21      archive_read_add_passphrase()
  22              Register passphrases for reading an encryption archive.  If
  23              passphrase is NULL or empty, this function will do nothing and
  24              ARCHIVE_FAILED will be returned.  Otherwise, ARCHIVE_OK will be
  25              returned.
  26
  27      archive_read_set_passphrase_callback()
  28              Register callback function that will be invoked to get a
  29              passphrase for decrption after trying all passphrases registered
  30              by the archive_read_add_passphrase() function failed.
  31
  32 SEE ALSO
  33      tar(1), libarchive(3), archive_read(3), archive_read_set_options(3)
  34
  35 BSD                           September 14, 2014                           BSD