.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "GnuPG::Options 3pm"
.TH GnuPG::Options 3pm "2022-07-31" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
GnuPG::Options \- GnuPG options embodiment
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  # assuming $gnupg is a GnuPG::Interface object
\&  $gnupg\->options\->armor( 1 );
\&  $gnupg\->options\->push_recipients( \*(Aqftobin\*(Aq, \*(Aq0xABCD1234ABCD1234ABCD1234ABCD1234ABCD1234\*(Aq );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
GnuPG::Options objects are generally not instantiated on their
own, but rather as part of a GnuPG::Interface object.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.IP "new( \fI\f(CI%initialization_args\fI\fR )" 4
.IX Item "new( %initialization_args )"
This methods creates a new object.  The optional arguments are
initialization of data members.
.IP "hash_init( \fI\f(CI%args\fI\fR )." 4
.IX Item "hash_init( %args )."
.PD 0
.IP "copy" 4
.IX Item "copy"
.PD
Returns a copy of this object.  Useful for 'saving' options.
.IP "get_args" 4
.IX Item "get_args"
Returns a list of arguments to be passed to GnuPG based
on data members which are 'meta_' options, regular options,
and then \fIextra_args\fR, in that order.
.SH "OBJECT DATA MEMBERS"
.IX Header "OBJECT DATA MEMBERS"
.IP "homedir" 4
.IX Item "homedir"
.PD 0
.IP "armor" 4
.IX Item "armor"
.IP "textmode" 4
.IX Item "textmode"
.IP "default_key" 4
.IX Item "default_key"
.IP "no_greeting" 4
.IX Item "no_greeting"
.IP "verbose" 4
.IX Item "verbose"
.IP "no_verbose" 4
.IX Item "no_verbose"
.IP "quiet" 4
.IX Item "quiet"
.IP "batch" 4
.IX Item "batch"
.IP "always_trust" 4
.IX Item "always_trust"
.IP "comment" 4
.IX Item "comment"
.IP "status_fd" 4
.IX Item "status_fd"
.IP "logger_fd" 4
.IX Item "logger_fd"
.IP "passphrase_fd" 4
.IX Item "passphrase_fd"
.IP "compress_algo" 4
.IX Item "compress_algo"
.IP "force_v3_sigs" 4
.IX Item "force_v3_sigs"
.IP "rfc1991" 4
.IX Item "rfc1991"
.IP "openpgp" 4
.IX Item "openpgp"
.IP "options" 4
.IX Item "options"
.IP "no_options" 4
.IX Item "no_options"
.IP "encrypt_to" 4
.IX Item "encrypt_to"
.IP "recipients" 4
.IX Item "recipients"
.PD
.PP
These options correlate directly to many GnuPG options.  For those that
are boolean to GnuPG, simply that argument is passed.  For those
that are associated with a scalar, that scalar is passed passed
as an argument appropriate.  For those that can be specified more
than once, such as \fBrecipients\fR, those are considered lists
and passed accordingly.  Each are undefined or false to begin.
.SS "Meta Options"
.IX Subsection "Meta Options"
Meta options are those which do not correlate directly to any
option in GnuPG, but rather are generally a bundle of options
used to accomplish a specific goal, such as obtaining
compatibility with \s-1PGP 5.\s0  The actual arguments each of these
reflects may change with time.  Each defaults to false unless
otherwise specified.
.PP
These options are being designed and to provide a non-GnuPG-specific
abstraction, to help create compatibility with a possible
PGP::Interface module.
.PP
To help avoid confusion, methods with take a form of a key as
an object shall be prepended with \fI_id(s)\fR if they only
take an id; otherwise assume an object of type GnuPG::Key
is required.
.IP "meta_pgp_5_compatible" 4
.IX Item "meta_pgp_5_compatible"
If true, arguments are generated to try to be compatible with \s-1PGP 5\s0.x.
.IP "meta_pgp_2_compatible" 4
.IX Item "meta_pgp_2_compatible"
If true, arguments are generated to try to be compatible with \s-1PGP 2\s0.x.
.IP "meta_interactive" 4
.IX Item "meta_interactive"
If false, arguments are generated to try to help the using program
use GnuPG in a non-interactive environment, such as \s-1CGI\s0 scripts.
Default is true.
.IP "meta_signing_key_id" 4
.IX Item "meta_signing_key_id"
This scalar reflects the key used to sign messages.
Currently this is synonymous with \fIdefault-key\fR.
.IP "meta_signing_key" 4
.IX Item "meta_signing_key"
This GnuPG::Key object reflects the key used to sign messages.
.IP "meta_recipients_key_ids" 4
.IX Item "meta_recipients_key_ids"
This list of scalar key ids are used to generate the
appropriate arguments having these keys as recipients.
.IP "meta_recipients_keys" 4
.IX Item "meta_recipients_keys"
This list of keys of the type GnuPG::Key are used to generate the
appropriate arguments having these keys as recipients.
You probably want to have this list be of the inherited class
GnuPG::SubKey, as in most instances, OpenPGP keypairs have
the encyrption key as the subkey of the primary key, which is
used for signing.
.SS "Other Data Members"
.IX Subsection "Other Data Members"
.IP "extra_args" 4
.IX Item "extra_args"
This is a list of any other arguments used to pass to GnuPG.
Useful to pass an argument not yet covered in this package.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
GnuPG::Interface,