NAME

File::ConfigDir::Install - Install (into) configuration directories

SYNOPSIS

    use ExtUtils::MakeMaker;
    use File::ConfigDir::Install;

    install_config 'etc';

    WriteMakefile( ... );       # As you normaly would

    package MY;
    use File::ConfigDir::Install qw(:MY);

DESCRIPTION

File::ConfigDir::Install allows you to install configuration files from a distribution.

EXPORT

:CONFIG

This tag contains the functions for configration stage of Makefile.PL

install_config

This function allows adding directories to be scanned for (config-)files which will be installed in a later stage.

:MY

postamble

Wrapper around ExtUtils::MY::postamble to inject a "config::" target into Makefile

install

Wrapper around ExtUtils::MY::install to inject install rules for config files. Injected rules are

perl

add "$(INST_ETC)" "$(DESTINSTALLETC)" to pure_perl_install target,

site

add "$(INST_ETC)" "$(DESTINSTALLSITEETC)" to pure_site_install target,

vendor

and add "$(INST_ETC)" "$(DESTINSTALLVENDORETC)" to pure_vendor_install target.

constants

Wrapper around ExtUtils::MY::constants to inject install constants for config files.

AUTHOR

Jens Rehsack, <rehsack at cpan.org>

LIMITATIONS

This early stage version has some limitations

• It is not trivially possible to mix this with other MakeMaker extensions overloading constants, install or postamble, respectively.

  A reasonable solution (around, Exporter::Tiny ?) is required ...

• Target directory is limited to static guess from one of "core_cfg_dir" in File::ConfigDir, "site_cfg_dir" in File::ConfigDir or "vendor_cfg_dir" in File::ConfigDir, respectively.

  A reasonable way to override might be more packager- and user-friendly.

• No VMS support

  Needs to be hacked ...

BUGS

Please report any bugs or feature requests to bug-file-configdir-install at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=File-ConfigDir-Install. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc File::ConfigDir::Install

You can also look for information at:

• RT: CPAN's request tracker (report bugs here)

  http://rt.cpan.org/NoAuth/Bugs.html?Dist=File-ConfigDir-Install

• AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/File-ConfigDir-Install

• CPAN Ratings

  http://cpanratings.perl.org/d/File-ConfigDir-Install

• Search CPAN

  http://search.cpan.org/dist/File-ConfigDir-Install/

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2014 Jens Rehsack.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

cpanm File::ConfigDir::Install

perl -MCPAN -e shell
install File::ConfigDir::Install