module::starter::plugin::inlinestore(3pm) [debian man page]

Module::Starter::Plugin::InlineStore(3pm)		User Contributed Perl Documentation		 Module::Starter::Plugin::InlineStore(3pm)

NAME

       Module::Starter::Plugin::InlineStore -- inline module template files

VERSION

       version 0.144

SYNOPSIS

	use Module::Starter qw(
	  Module::Starter::Simple
	  Module::Starter::Plugin::Template
	  Module::Starter::Plugin::InlineStore
	  ...
	);

	Module::Starter->create_distro( ... );

DESCRIPTION

       This Module::Starter plugin is intended to be loaded after Module::Starter::Plugin::Template.  It implements the "templates" method,
       required by the Template plugin.  The "InlineStore" plugin stores all the required templates in a single file, delimited with filenames
       between triple-underscores.  In other words, a very simple template file might look like this:

	___Module.pm___
	package {modulename};
	1;
	___Makefile.PL___
	die "lousy template"

       Originally, this module was to use Inline::Files, or at least standard double-underscore indication of file names, but it's just simpler
       this way.  Patches welcome.

METHODS

   "templates"
       This method reads in the template file (described above) and populates the object's "templates" attribute.  The module template file is
       found by checking the MODULE_TEMPLATE_FILE environment variable and then the "template_file" config option.

AUTHOR

       Ricardo SIGNES, "<rjbs@cpan.org>"

Bugs
       Please report any bugs or feature requests to "bug-module-starter-plugin-inlinestore@rt.cpan.org", or through the web interface at
       <http://rt.cpan.org>.  I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

COPYRIGHT

       Copyright 2004 Ricardo SIGNES, All Rights Reserved.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2011-12-23				 Module::Starter::Plugin::InlineStore(3pm)

Module::Starter::BuilderSet(3pm)			User Contributed Perl Documentation			  Module::Starter::BuilderSet(3pm)

NAME

       Module::Starter::BuilderSet - determine builder metadata

VERSION

       Version 1.58

SYNOPSIS

	   use Module::Starter::BuilderSet;

	   my $builder_set = Module::Starter::BuilderSet->new;
	   my @supported_builders = $builder_set->supported_builders();
	   my $default_builder = $builder_set->default_builder();
	   my $output_file = $builder_set->file_for_builder($default_builder);

	   my $create_method = $builder_set->method_for_builder($default_builder);
	   Module::Starter::Simple->$create_method($default_builder); # eeew.

	   my @build_commands = $builder_set->instructions_for_builder($default_builder);
	   my @builder_dependencies = $builder_set->deps_for_builder($default_builder);
	   my @compatible_builders = $builder_set->check_compatibility(@builder_list);

	   my $ms_simple    = Module::Starter::Simple->new();
	   my $build_method = $builder_set->manifest_method($builder);
	   $ms_simple->$build_method();

DESCRIPTION

       Module::Starter::BuilderSet is a collection of utility methods used to provide metadata about builders supported by Module::Starter.

CLASS METHODS

   "new()"
       This method initializes and returns an object representing the set of Builders supported by Module::Starter

   "supported_builders()"
       This method returns a list of builders supported by Module::Starter

   "file_for_builder($builder)"
       This method returns the name of the file generated by Module::Starter that will be used to build the generated module

   "method_for_builder($builder)"
       This method returns the name of the method in the "Module::Starter::Simple" package that is called to create the file returned by
       "file_for_builder($builder)"

   "instructions_for_builder($builder)"
       This method returns a list of commands that, when run from the command line (or with "system()"), will cause the generated module to be
       built, tested and installed.

   "deps_for_builder($builder)"
       This method returns a list of dependencies in the following format: "( { command => "make",
	   aliases => [ 'make', 'gmake' ],
	  },
	 { command => "another_command",
	   aliases => [ 'alias0', 'alias1', '...' ],
	  }, )"

   "manifest_method($builder)"
       This method returns the command to run to create the manifest according to the builder asked.

   "check_compatibility(@builders)"
       This method accepts a list of builders and filters out the ones that are unsupported or mutually exclusive, returning the builders that
       passed the filter.  If none pass the filter, the default builder is returned.

   "default_builder()"
       This method returns the module name of the default builder.

BUGS

       Please report any bugs or feature requests to "bug-module-starter at rt.cpan.org", or through the web interface at <http://rt.cpan.org>.  I
       will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

AUTHOR

       C.J. Adams-Collier, "<cjac@colliertech.org>"

Copyright &; License
       Copyright 2007 C.J. Adams-Collier, All Rights Reserved.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

       Please note that these modules are not products of or supported by the employers of the various contributors to the code.

perl v5.12.4							    2011-07-02					  Module::Starter::BuilderSet(3pm)