1GnuPG::Options(3) User Contributed Perl Documentation GnuPG::Options(3)
2
6 GnuPG::Options - GnuPG options embodiment
7
9 # assuming $gnupg is a GnuPG::Interface object
10 $gnupg->options->armor( 1 );
11 $gnupg->options->push_recipients( 'ftobin', '0xABCD1234' );
12
14 GnuPG::Options objects are generally not instantiated on their own, but
15 rather as part of a GnuPG::Interface object.
16
18 new( %initialization_args )
19 This methods creates a new object. The optional arguments are ini‐
20 tialization of data members; the initialization is done in a manner
21 according to the method created as described in "new_hash_init" in
22 Class::MethodMaker.
23 hash_init( %args ).
25 This method works as described in "new_hash_init" in Class::Method‐
26 Maker.
27 copy
29 Returns a copy of this object. Useful for 'saving' options.
30 get_args
32 Returns a list of arguments to be passed to GnuPG based on data
33 members which are 'meta_' options, regular options, and then
34 extra_args, in that order.
35
37 Note that these data members are interacted with via object methods
38 created using the methods described in "boolean" in Class::MethodMaker,
39 "get_set" in Class::MethodMaker, "object" in Class::MethodMaker, and
40 "list" in Class::MethodMaker. Please read there for more information.
41 homedir
43 armor
44 textmode
45 default_key
46 no_greeting
47 verbose
48 no_verbose
49 quiet
50 batch
51 always_trust
52 comment
53 status_fd
54 logger_fd
55 passphrase_fd
56 compress_algo
57 force_v3_sigs
58 rfc1991
59 openpgp
60 options
61 no_options
62 encrypt_to
63 recipients
64 These options correlate directly to many GnuPG options. For those
65 that are boolean to GnuPG, simply that argument is passed. For
66 those that are associated with a scalar, that scalar is passed
67 passed as an argument appropriate. For those that can be specified
68 more than once, such as recipients, those are considered lists and
69 passed accordingly. Each are undefined or false to begin.
70 Meta Options
72 Meta options are those which do not correlate directly to any option in
74 GnuPG, but rather are generally a bundle of options used to accomplish
75 a specific goal, such as obtaining compatibility with PGP 5. The
76 actual arguments each of these reflects may change with time. Each
77 defaults to false unless otherwise specified.
78 These options are being designed and to provide a non-GnuPG-specific
80 abstraction, to help create compatibility with a possible PGP::Inter‐
81 face module.
82 To help avoid confusion, methods with take a form of a key as an object
84 shall be prepended with _id(s) if they only take an id; otherwise
85 assume an object of type GnuPG::Key is required.
86 meta_pgp_5_compatible
88 If true, arguments are generated to try to be compatible with PGP
89 5.x.
90 meta_pgp_2_compatible
92 If true, arguments are generated to try to be compatible with PGP
93 2.x.
94 meta_interactive
96 If false, arguments are generated to try to help the using program
97 use GnuPG in a non-interactive environment, such as CGI scripts.
98 Default is true.
99 meta_signing_key_id
101 This scalar reflects the key used to sign messages. Currently this
102 is synonymous with default-key.
103 meta_signing_key
105 This GnuPG::Key object reflects the key used to sign messages.
106 meta_recipients_key_ids
108 This list of scalar key ids are used to generate the appropriate
109 arguments having these keys as recipients.
110 meta_recipients_keys
112 This list of keys of the type GnuPG::Key are used to generate the
113 appropriate arguments having these keys as recipients. You proba‐
114 bly want to have this list be of the inherited class GnuPG::SubKey,
115 as in most instances, OpenPGP keypairs have the encyrption key as
116 the subkey of the primary key, which is used for signing.
117 Other Data Members
119 extra_args
121 This is a list of any other arguments used to pass to GnuPG. Use‐
122 ful to pass an argument not yet covered in this package.
123
125 GnuPG::Interface, Class::MethodMaker
126perl v5.8.8 2001-08-21 GnuPG::Options(3)