1GnuPG::Options(3)     User Contributed Perl Documentation    GnuPG::Options(3)
2
3
4

NAME

6       GnuPG::Options - GnuPG options embodiment
7

SYNOPSIS

9         # assuming $gnupg is a GnuPG::Interface object
10         $gnupg->options->armor( 1 );
11         $gnupg->options->push_recipients( 'ftobin', '0xABCD1234ABCD1234ABCD1234ABCD1234ABCD1234' );
12

DESCRIPTION

14       GnuPG::Options objects are generally not instantiated on their own, but
15       rather as part of a GnuPG::Interface object.
16

OBJECT METHODS

18       new( %initialization_args )
19           This methods creates a new object.  The optional arguments are
20           initialization of data members.
21
22       hash_init( %args ).
23       copy
24           Returns a copy of this object.  Useful for 'saving' options.
25
26       get_args
27           Returns a list of arguments to be passed to GnuPG based on data
28           members which are 'meta_' options, regular options, and then
29           extra_args, in that order.
30

OBJECT DATA MEMBERS

32       homedir
33       armor
34       textmode
35       default_key
36       no_greeting
37       verbose
38       no_verbose
39       quiet
40       batch
41       always_trust
42       comment
43       status_fd
44       logger_fd
45       passphrase_fd
46       compress_algo
47       force_v3_sigs
48       rfc1991
49       openpgp
50       options
51       no_options
52       encrypt_to
53       recipients
54
55       These options correlate directly to many GnuPG options.  For those that
56       are boolean to GnuPG, simply that argument is passed.  For those that
57       are associated with a scalar, that scalar is passed passed as an
58       argument appropriate.  For those that can be specified more than once,
59       such as recipients, those are considered lists and passed accordingly.
60       Each are undefined or false to begin.
61
62   Meta Options
63       Meta options are those which do not correlate directly to any option in
64       GnuPG, but rather are generally a bundle of options used to accomplish
65       a specific goal, such as obtaining compatibility with PGP 5.  The
66       actual arguments each of these reflects may change with time.  Each
67       defaults to false unless otherwise specified.
68
69       These options are being designed and to provide a non-GnuPG-specific
70       abstraction, to help create compatibility with a possible
71       PGP::Interface module.
72
73       To help avoid confusion, methods with take a form of a key as an object
74       shall be prepended with _id(s) if they only take an id; otherwise
75       assume an object of type GnuPG::Key is required.
76
77       meta_pgp_5_compatible
78           If true, arguments are generated to try to be compatible with PGP
79           5.x.
80
81       meta_pgp_2_compatible
82           If true, arguments are generated to try to be compatible with PGP
83           2.x.
84
85       meta_interactive
86           If false, arguments are generated to try to help the using program
87           use GnuPG in a non-interactive environment, such as CGI scripts.
88           Default is true.
89
90       meta_signing_key_id
91           This scalar reflects the key used to sign messages.  Currently this
92           is synonymous with default-key.
93
94       meta_signing_key
95           This GnuPG::Key object reflects the key used to sign messages.
96
97       meta_recipients_key_ids
98           This list of scalar key ids are used to generate the appropriate
99           arguments having these keys as recipients.
100
101       meta_recipients_keys
102           This list of keys of the type GnuPG::Key are used to generate the
103           appropriate arguments having these keys as recipients.  You
104           probably want to have this list be of the inherited class
105           GnuPG::SubKey, as in most instances, OpenPGP keypairs have the
106           encyrption key as the subkey of the primary key, which is used for
107           signing.
108
109   Other Data Members
110       extra_args
111           This is a list of any other arguments used to pass to GnuPG.
112           Useful to pass an argument not yet covered in this package.
113

SEE ALSO

115       GnuPG::Interface,
116
117
118
119perl v5.36.0                      2022-07-22                 GnuPG::Options(3)
Impressum