Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

gnupg::options(3pm) [debian man page]

GnuPG::Options(3pm)					User Contributed Perl Documentation				       GnuPG::Options(3pm)

NAME

       GnuPG::Options - GnuPG options embodiment

SYNOPSIS

	 # assuming $gnupg is a GnuPG::Interface object
	 $gnupg->options->armor( 1 );
	 $gnupg->options->push_recipients( 'ftobin', '0xABCD1234' );

DESCRIPTION

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

OBJECT METHODS

       new( %initialization_args )
	   This methods creates a new object.  The optional arguments are initialization of data members.

       hash_init( %args ).
       copy
	   Returns a copy of this object.  Useful for 'saving' options.

       get_args
	   Returns a list of arguments to be passed to GnuPG based on data members which are 'meta_' options, regular options, and then
	   extra_args, in that order.

OBJECT DATA MEMBERS

       homedir
       armor
       textmode
       default_key
       no_greeting
       verbose
       no_verbose
       quiet
       batch
       always_trust
       comment
       status_fd
       logger_fd
       passphrase_fd
       compress_algo
       force_v3_sigs
       rfc1991
       openpgp
       options
       no_options
       encrypt_to
       recipients

       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 recipients, those are considered lists and passed accordingly.  Each are undefined or false to begin.

   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 PGP 5.	The actual arguments each of these reflects may change with time.
       Each defaults to false unless otherwise specified.

       These options are being designed and to provide a non-GnuPG-specific abstraction, to help create compatibility with a possible
       PGP::Interface module.

       To help avoid confusion, methods with take a form of a key as an object shall be prepended with _id(s) if they only take an id; otherwise
       assume an object of type GnuPG::Key is required.

       meta_pgp_5_compatible
	   If true, arguments are generated to try to be compatible with PGP 5.x.

       meta_pgp_2_compatible
	   If true, arguments are generated to try to be compatible with PGP 2.x.

       meta_interactive
	   If false, arguments are generated to try to help the using program use GnuPG in a non-interactive environment, such as CGI scripts.
	   Default is true.

       meta_signing_key_id
	   This scalar reflects the key used to sign messages.	Currently this is synonymous with default-key.

       meta_signing_key
	   This GnuPG::Key object reflects the key used to sign messages.

       meta_recipients_key_ids
	   This list of scalar key ids are used to generate the appropriate arguments having these keys as recipients.

       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.

   Other Data Members
       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.

SEE ALSO

       GnuPG::Interface,

perl v5.12.4							    2010-05-10						       GnuPG::Options(3pm)

Check Out this Related Man Page

GnuPG::Handles(3pm)					User Contributed Perl Documentation				       GnuPG::Handles(3pm)

NAME

       GnuPG::Handles - GnuPG handles bundle

SYNOPSIS

	 use IO::Handle;
	 my ( $stdin, $stdout, $stderr,
	      $status_fh, $logger_fh, $passphrase_fh,
	    )
	   = ( IO::Handle->new(), IO::Handle->new(), IO::Handle->new(),
	       IO::Handle->new(), IO::Handle->new(), IO::Handle->new(),
	     );

	 my $handles = GnuPG::Handles->new
	   ( stdin	=> $stdin,
	     stdout	=> $stdout,
	     stderr	=> $stderr,
	     status	=> $status_fh,
	     logger	=> $logger_fh,
	     passphrase => $passphrase_fh,
	   );

DESCRIPTION

       GnuPG::Handles objects are generally instantiated to be used in conjunction with methods of objects of the class GnuPG::Interface.
       GnuPG::Handles objects represent a collection of handles that are used to communicate with GnuPG.

OBJECT METHODS

   Initialization Methods
       new( %initialization_args )
	   This methods creates a new object.  The optional arguments are initialization of data members.

       hash_init( %args ).

OBJECT DATA MEMBERS

       stdin
	   This handle is connected to the standard input of a GnuPG process.

       stdout
	   This handle is connected to the standard output of a GnuPG process.

       stderr
	   This handle is connected to the standard error of a GnuPG process.

       status
	   This handle is connected to the status output handle of a GnuPG process.

       logger
	   This handle is connected to the logger output handle of a GnuPG process.

       passphrase
	   This handle is connected to the passphrase input handle of a GnuPG process.

       command
	   This handle is connected to the command input handle of a GnuPG process.

       options
	   This is a hash of hashrefs of settings pertaining to the handles in this object.  The outer-level hash is keyed by the names of the
	   handle the setting is for, while the inner is keyed by the setting being referenced.  For example, to set the setting "direct" to true
	   for the filehandle "stdin", the following code will do:

	       # assuming $handles is an already-created
	       # GnuPG::Handles object, this sets all
	       # options for the filehandle stdin in one blow,
	       # clearing out all others
	       $handles->options( 'stdin', { direct => 1 } );

	       # this is useful to just make one change
	       # to the set of options for a handle
	       $handles->options( 'stdin' )->{direct} = 1;

	       # and to get the setting...
	       $setting = $handles->options( 'stdin' )->{direct};

	       # and to clear the settings for stdin
	       $handles->options( 'stdin', {} );

	   The currently-used settings are as follows:

	   direct
	       If the setting "direct" is true for a handle, the GnuPG process spawned will access the handle directly.  This is useful for having
	       the GnuPG process read or write directly to or from an already-opened file.

SEE ALSO

       GnuPG::Interface,

perl v5.12.4							    2009-04-21						       GnuPG::Handles(3pm)
Man Page