.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Module::Starter::BuilderSet 3pm"
.TH Module::Starter::BuilderSet 3pm "2022-10-16" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Module::Starter::BuilderSet \- determine builder metadata
.SH "VERSION"
.IX Header "VERSION"
version 1.77
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    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();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Module::Starter::BuilderSet is a collection of utility methods used to
provide metadata about builders supported by Module::Starter.
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.ie n .SS """new()"""
.el .SS "\f(CWnew()\fP"
.IX Subsection "new()"
This method initializes and returns an object representing the set of
Builders supported by Module::Starter
.ie n .SS """supported_builders()"""
.el .SS "\f(CWsupported_builders()\fP"
.IX Subsection "supported_builders()"
This method returns a list of builders supported by Module::Starter
.ie n .SS """file_for_builder($builder)"""
.el .SS "\f(CWfile_for_builder($builder)\fP"
.IX Subsection "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
.ie n .SS """method_for_builder($builder)"""
.el .SS "\f(CWmethod_for_builder($builder)\fP"
.IX Subsection "method_for_builder($builder)"
This method returns the name of the method in the
\&\f(CW\*(C`Module::Starter::Simple\*(C'\fR package that is called to create the file
returned by \f(CW\*(C`file_for_builder($builder)\*(C'\fR
.ie n .SS """instructions_for_builder($builder)"""
.el .SS "\f(CWinstructions_for_builder($builder)\fP"
.IX Subsection "instructions_for_builder($builder)"
This method returns a list of commands that, when run from the command
line (or with \f(CW\*(C`system()\*(C'\fR), will cause the generated module to be
built, tested and installed.
.ie n .SS """deps_for_builder($builder)"""
.el .SS "\f(CWdeps_for_builder($builder)\fP"
.IX Subsection "deps_for_builder($builder)"
This method returns a list of dependencies in the following format:
\&\f(CW\*(C`( { command => "make",
    aliases => [ \*(Aqmake\*(Aq, \*(Aqgmake\*(Aq ],
   },
  { command => "another_command",
    aliases => [ \*(Aqalias0\*(Aq, \*(Aqalias1\*(Aq, \*(Aq...\*(Aq ],
   },
)\*(C'\fR
.ie n .SS """manifest_method($builder)"""
.el .SS "\f(CWmanifest_method($builder)\fP"
.IX Subsection "manifest_method($builder)"
This method returns the command to run to create the manifest according to the
builder asked.
.ie n .SS """check_compatibility(@builders)"""
.el .SS "\f(CWcheck_compatibility(@builders)\fP"
.IX Subsection "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.
.ie n .SS """default_builder()"""
.el .SS "\f(CWdefault_builder()\fP"
.IX Subsection "default_builder()"
This method returns the module name of the default builder.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to the bugtracker for this project
on GitHub at: <https://github.com/xsawyerx/module\-starter/issues>. I will be
notified, and then you'll automatically be notified of progress on your bug
as I make changes.
.SH "AUTHOR"
.IX Header "AUTHOR"
C.J. Adams-Collier, \f(CW\*(C`<cjac@colliertech.org>\*(C'\fR
.SH "Copyright & License"
.IX Header "Copyright & License"
Copyright 2007 C.J. Adams-Collier, All Rights Reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.PP
Please note that these modules are not products of or supported by the
employers of the various contributors to the code.