.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" 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 turned on, 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Module::Starter::PBP 3pm" .TH Module::Starter::PBP 3pm "2015-06-09" "perl v5.20.2" "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::PBP \- Create a module as recommended in "Perl Best Practices" .SH "VERSION" .IX Header "VERSION" This document describes Module::Starter::PBP version 0.0.3 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& # In your ~/.module\-starter/config file... \& \& author: \& email: \& plugins: Module::Starter::PBP \& template_dir: \& \& \& # Then on the command\-line... \& \& > module\-starter \-\-module=Your::New::Module \& \& \& # Or, if you\*(Aqre lazy and happy to go with \& # the recommendations in "Perl Best Practices"... \& \& > perl \-MModule::Starter::PBP=setup .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module implements a simple approach to creating modules and their support files, based on the Module::Starter approach. Module::Starter needs to be installed before this module can be used. .PP When used as a Module::Starter plugin, this module allows you to specify a simple directory of templates which are filled in with module-specific information, and thereafter form the basis of your new module. .PP The default templates that this module initially provides are based on the recommendations in the book \*(L"Perl Best Practices\*(R". .SH "INTERFACE" .IX Header "INTERFACE" Thsi module simply acts as a plugin for Module::Starter. So it uses the same command-line interface as that module. .PP The template files it is to use are specified in your Module::Starter \&\f(CW\*(C`config\*(C'\fR file, by adding a \f(CW\*(C`template_dir\*(C'\fR configuration variable that gives the full path name of the directory in which you want to put the templates. .PP The easiest way to set up this \f(CW\*(C`config\*(C'\fR file, the associated directory, and the necessary template files is to type: .PP .Vb 1 \& > perl \-MModule::Starter::PBP=setup .Ve .PP on the command line. You will then be asked for your name, email address, and the full path name of the directory where you want to keep the templates, after which they will be created and installed. .PP Then you can create a new module by typing: .PP .Vb 1 \& > module\-starter \-\-module=Your::New::Module .Ve .SS "Template format" .IX Subsection "Template format" The templates are plain files named: .PP .Vb 6 \& Build.PL \& Makefile.PL \& README \& Changes \& Module.pm \& t/whatever_you_like.t .Ve .PP The \f(CW\*(C`Module.pm\*(C'\fR file is the template for the \f(CW\*(C`.pm\*(C'\fR file for your module. Any files in the \f(CW\*(C`t/\*(C'\fR subdirectory become the templates for the testing files of your module. All the remaining files are templates for the ditribution files of the same names. .PP In those files, the following placeholders are replaced by the appropriate information specific to the file: .IP "<\s-1AUTHOR\s0>" 4 .IX Item "" The nominated author. Taken from the \f(CW\*(C`author\*(C'\fR setting in your Module::Starter \f(CW\*(C`config\*(C'\fR file. .IP "<\s-1BUILD INSTRUCTIONS\s0>" 4 .IX Item "" Makefile or Module::Build instructions. Computed automatically according to the \f(CW\*(C`builder\*(C'\fR setting in your Module::Starter \f(CW\*(C`config\*(C'\fR file. .IP "<\s-1DATE\s0>" 4 .IX Item "" The current date (as returned by \f(CW\*(C`localtime\*(C'\fR). Computed automagically .IP "<\s-1DISTRO\s0>" 4 .IX Item "" The name of the complete module distribution. Computed automatically from the name of the module. .IP "<\s-1EMAIL\s0>" 4 .IX Item "" Where to send feedback. Taken from the \f(CW\*(C`email\*(C'\fR setting in your Module::Starter \f(CW\*(C`config\*(C'\fR file. .IP "<\s-1LICENSE\s0>" 4 .IX Item "" The licence under which the module is released. Taken from the \f(CW\*(C`license\*(C'\fR setting in your Module::Starter \f(CW\*(C`config\*(C'\fR file. .IP "<\s-1MAIN MODULE\s0>" 4 .IX Item "
" The name of the main module of the distribution. .IP "<\s-1MAIN PM FILE\s0>" 4 .IX Item "
" The name of the \f(CW\*(C`.pm\*(C'\fR file for the main module. .IP "<\s-1MODULE NAME\s0>" 4 .IX Item "" The name of the current module being created within the distribution. .IP "<\s-1RT NAME\s0>" 4 .IX Item "" The name to use for bug reports to the \s-1RT\s0 system. That is: .Sp .Vb 2 \& Please report any bugs or feature requests to \& bug\-@rt.cpan.org> .Ve .IP "<\s-1YEAR\s0>" 4 .IX Item "" The current year. Computed automatically .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" .ie n .IP """Can\*(Aqt find directory that holds Module::Starter::PBP templates""" 4 .el .IP "\f(CWCan\*(Aqt find directory that holds Module::Starter::PBP templates\fR" 4 .IX Item "Cant find directory that holds Module::Starter::PBP templates" You did not tell Module::Starter::PBP where your templates are stored. You need a 'template_dir' specification. Typically this would go in your ~/.module\-starter/config file. Something like: .Sp .Vb 1 \& template_dir: /users/you/.module\-starter/Templates .Ve .ie n .IP """Can\*(Aqt access Module::Starter::PBP template directory""" 4 .el .IP "\f(CWCan\*(Aqt access Module::Starter::PBP template directory\fR" 4 .IX Item "Cant access Module::Starter::PBP template directory" You specified a 'template_dir', but the path didn't lead to a readable directory. .ie n .IP """The template: %s isn\*(Aqt in the template directory (%s)""" 4 .el .IP "\f(CWThe template: %s isn\*(Aqt in the template directory (%s)\fR" 4 .IX Item "The template: %s isnt in the template directory (%s)" One of the required templates: .Sp was missing from the template directory you specified. .ie n .IP """The template: %s isn\*(Aqt readable in the template directory (%s)""" 4 .el .IP "\f(CWThe template: %s isn\*(Aqt readable in the template directory (%s)\fR" 4 .IX Item "The template: %s isnt readable in the template directory (%s)" One of the templates in the template directory you specified was not readable. .ie n .IP """Unknown placeholder <%s> in %s""" 4 .el .IP "\f(CWUnknown placeholder <%s> in %s\fR" 4 .IX Item "Unknown placeholder <%s> in %s" One of the templates in the template directory contained a replacement item that wasn't a known piece of information. .SH "CONFIGURATION AND ENVIRONMENT" .IX Header "CONFIGURATION AND ENVIRONMENT" See the documentation for \f(CW\*(C`Module::Starter\*(C'\fR and \f(CW\*(C`module\-starter\*(C'\fR. .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" Requires the \f(CW\*(C`Module::Starter\*(C'\fR module. .SH "INCOMPATIBILITIES" .IX Header "INCOMPATIBILITIES" None reported. .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" No bugs have been reported. .PP Please report any bugs or feature requests to \&\f(CW\*(C`bug\-module\-starter\-pbp@rt.cpan.org\*(C'\fR, or through the web interface at . .SH "AUTHOR" .IX Header "AUTHOR" Damian Conway \f(CW\*(C`\*(C'\fR .SH "LICENCE AND COPYRIGHT" .IX Header "LICENCE AND COPYRIGHT" Copyright (c) 2005, Damian Conway \f(CW\*(C`\*(C'\fR. All rights reserved. .PP This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "DISCLAIMER OF WARRANTY" .IX Header "DISCLAIMER OF WARRANTY" \&\s-1BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0 .PP \&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE \s0(\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.\s0