view release on metacpan or  search on metacpan

lib/CfgTie/TieGeneric.pm  view on Meta::CPAN

#!/usr/bin/perl -w
#Copyright 1998-2001, Randall Maas.  All rights reserved.  This program is free
#software; you can redistribute it and/or modify it under the same terms as
#PERL itself.

package CfgTie::TieGeneric;
use Secure::File;
use vars qw($VERSION @ISA);
use AutoLoader 'AUTOLOAD';
$VERSION='0.41';

=head1 NAME

CfgTie::TieGeneric -- A generic hash that automatically binds others

=head1 SYNOPSIS

This is an associative array that automatially ties other configuration hashes

=head1 DESCRIPTION

This is a tie to bring other ties together automatically so you, the busy
programmer and/or system administrator, don't have to.  The related Perl
module is not loaded unless it is needed at runtime.

        my %gen;
        tie %gen, 'CfgTie::TieGeneric';

=head2 Primary, or well-known, keys

=over 1

=item C<env>

This refers directly to the C<ENV> hash.

=item C<group>

=item C<mail>

This is a special key.  It forms a hash, with subkeys.  See below for more
information

=item C<net>

This is a special key.  It forms a hash with additional subkeys. See
below for more details.

=item C<user>

This is a link to the C<TieUser> module (L<CfgTie::TieUser>).

=item I<Composite>

Composite primary keys are just like absolute file paths.  For example, if
you wanted to do something like this:

        my %lusers = $gen{'user'};
        my $Favorite_User = $lusers{'mygirl'};

You could just do:

        my $Favorite_User = $gen{'/users/mygirl'};

=item others...

These are the things automatically included in.  This will be described below.

=back

=head2 Subkeys for C<mail>

=over 1

=item C<aliases>

L<CfgTie::TieAliases> 

=back

=head2 Subkeys for C<net>