NAME

Egg::Plugin::rc - Loading the resource code file for Egg is supported.

SYNOPSIS

use Egg qw/ rc /;

my $rc= $e->load_rc;

DESCRIPTION

This plugin supports loading the resource code file for Egg.

Please prepare the resource code file in the following places.

./.egg_releaserc
/project_root/.egg_releaserc
~/.egg_releaserc
/etc/egg_releaserc

* The content of the resource code file is a thing that is the YAML form for HASH.

If file name is changed, environment variable EGG_RC_NAME is set. Default is egg_releaserc.

It tries to read the EGG_RC_NAME name like the miso when it evaluates under the control of '/etc'. EGG_RC_NAME that puts '.' on the head is read usually.

The key used with Egg::Helper is as follows.

  • author ..... Writer's data.

  • copywright ..... Mark of copyright.

  • headcopy ..... It inserts it in the header of the generation module.

  • license ..... License form. Perl and GPL, etc.

METHODS

load_rc ([ATTR_HASH])

If the rc file is found, YAML::LoadFile. Goes and returns the result.

PATH can be set in 'current_dir' of ATTR_HASH and the rc file of an arbitrary place be read.

my $rc= $e->load_rc('/path/to');

SEE ALSO

Egg::Release, Egg::YAML,

AUTHOR

Masatoshi Mizuno <lushe@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2008 by Bee Flag, Corp. <http://egg.bomcity.com/>.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.