wml::mod::makemaker(3) [debian man page]

wml::mod::MakeMaker(3)						     EN Tools						    wml::mod::MakeMaker(3)

NAME

       wml::mod::MakeMaker - A Makefile generator

SYNOPSIS

	#!wml -o Makefile
	#use wml::mod::MakeMaker

	<write-makefile [attributes]>

DESCRIPTION

       This include file provides an easy way to write a Makefile to distribute your own WML modules. It is inspired by the "ExtUtils::MakeMaker"
       Perl module.

   Default targets
       make all
	   This is the default target. It will build all include files and their documentation.

       make install
	   Install include files and documentation in the locations given by ``wml -V2''.

       make clean
	   Remove files generated by make.

       make distclean
	   Like make clean, plus remove the Makefile too.

       make dist
	   Build a distribution. Should only be used by the module maintainer.	If there is a MANIFEST file, then the list of files to include is
	   taken from this file. Otherwise the tarball contains all source files, plus MakeMaker.wml, Makefile.wml, shtool and README if these
	   files exist.

   Overriding default targets
       To build the Makefile, all targets are put in separate buffers during pass 3, and those buffers are diverted by pass 5. You can override
       this defaukt target by redefining buffer contents.  Buffer names are explicit:

	   MK_ALL MK_INSTALL MK_CLEAN MK_DISTCLEAN MK_CONFIG MK_RELEASE

   Defining new targets
       The MK_USER is empty and devoted to this task.

ATTRIBUTES

       The first three attributes are mandatory.

       package
	   The name of the package

       version
	   Its version number

       modules
	   List of modules to build and install. This is a space separated list of filenames. Modules should reside in a sub-directory to be
	   compliant with actual file hierarchy. For instance, the declaration

		modules="math/log.tmpl math/exp.tmpl"

	   tells that after compilation, there are two modules which are "math/log.tmpl" and "math/exp.tmpl". This modules will be installed to
	   "LibDir/include/math/log.tmpl" and "LibDir/include/math/exp.tmpl".

	   These modules will then be called in a WML file by

	       #use tmpl::math::log
	       #use tmpl::math::exp

	   Source files for these modules are obtained by replacing the suffix by .src.

       src-ext
	   Defines an alternate suffix for the source files.

       man-ext
	   Section number of the manual in which man files are put. Default is 3.

       extradistfiles
	   Space separated list of files to include in a distribution. By default, all source files plus MakeMaker.wml, Makefile.wml,  README and
	   shtool are included in a distribution.

EXAMPLE

	<write-makefile
	   package="log"
	   version="3.14"
	   modules="math/log.tmpl"
	   source-ext="exp"
	>

       This will build the tmpl::math::log include module from the math/log.exp source file. This source file will also produce the
       tmpl::math::log(3) manpage.

NOTES

       Please do _not_ use a ".wml" suffix for your modules, they should be reserved for official WML modules shipped with WML. You may instead
       put your initials or anything else.

AUTHOR

	Denis Barbier
	barbier@engelschall.com

REQUIRES

	Internal: P1, P2, P3, P5
	External: --

EN Tools							    2014-04-16						    wml::mod::MakeMaker(3)

ExtUtils::MakeMaker::Tutorial(3pm)			 Perl Programmers Reference Guide			ExtUtils::MakeMaker::Tutorial(3pm)

NAME

       ExtUtils::MakeMaker::Tutorial - Writing a module with MakeMaker

SYNOPSIS

	   use ExtUtils::MakeMaker;

	   WriteMakefile(
	       NAME	       => 'Your::Module',
	       VERSION_FROM    => 'lib/Your/Module.pm'
	   );

DESCRIPTION

       This is a short tutorial on writing a simple module with MakeMaker.  It's really not that hard.

   The Mantra
       MakeMaker modules are installed using this simple mantra

	       perl Makefile.PL
	       make
	       make test
	       make install

       There are lots more commands and options, but the above will do it.

   The Layout
       The basic files in a module look something like this.

	       Makefile.PL
	       MANIFEST
	       lib/Your/Module.pm

       That's all that's strictly necessary.  There's additional files you might want:

	       lib/Your/Other/Module.pm
	       t/some_test.t
	       t/some_other_test.t
	       Changes
	       README
	       INSTALL
	       MANIFEST.SKIP
	       bin/some_program

       Makefile.PL
	   When you run Makefile.PL, it makes a Makefile.  That's the whole point of MakeMaker.  The Makefile.PL is a simple program which loads
	   ExtUtils::MakeMaker and runs the WriteMakefile() function to generate a Makefile.

	   Here's an example of what you need for a simple module:

	       use ExtUtils::MakeMaker;

	       WriteMakefile(
		   NAME 	   => 'Your::Module',
		   VERSION_FROM    => 'lib/Your/Module.pm'
	       );

	   NAME is the top-level namespace of your module.  VERSION_FROM is the file which contains the $VERSION variable for the entire
	   distribution.  Typically this is the same as your top-level module.

       MANIFEST
	   A simple listing of all the files in your distribution.

		   Makefile.PL
		   MANIFEST
		   lib/Your/Module.pm

	   File paths in a MANIFEST always use Unix conventions (ie. /) even if you're not on Unix.

	   You can write this by hand or generate it with 'make manifest'.

	   See ExtUtils::Manifest for more details.

       lib/
	   This is the directory where the .pm and .pod files you wish to have installed go.  They are laid out according to namespace.  So
	   Foo::Bar is lib/Foo/Bar.pm.

       t/  Tests for your modules go here.  Each test filename ends with a .t.	So t/foo.t/  'make test' will run these tests.	The directory is
	   flat, you cannot, for example, have t/foo/bar.t run by 'make test'.

	   Tests are run from the top level of your distribution.  So inside a test you would refer to ./lib to enter the lib directory, for
	   example.

       Changes
	   A log of changes you've made to this module.  The layout is free-form.  Here's an example:

	       1.01 Fri Apr 11 00:21:25 PDT 2003
		   - thing() does some stuff now
		   - fixed the wiggy bug in withit()

	       1.00 Mon Apr  7 00:57:15 PDT 2003
		   - "Rain of Frogs" now supported

       README
	   A short description of your module, what it does, why someone would use it and its limitations.  CPAN automatically pulls your README
	   file out of the archive and makes it available to CPAN users, it is the first thing they will read to decide if your module is right
	   for them.

       INSTALL
	   Instructions on how to install your module along with any dependencies.  Suggested information to include here:

	       any extra modules required for use
	       the minimum version of Perl required
	       if only works on certain operating systems

       MANIFEST.SKIP
	   A file full of regular expressions to exclude when using 'make manifest' to generate the MANIFEST.  These regular expressions are
	   checked against each file path found in the distribution (so you're matching against "t/foo.t" not "foo.t").

	   Here's a sample:

	       ~$	   # ignore emacs and vim backup files
	       .bak$	   # ignore manual backups
	       #	   # ignore CVS old revision files and emacs temp files

	   Since # can be used for comments, # must be escaped.

	   MakeMaker comes with a default MANIFEST.SKIP to avoid things like version control directories and backup files.  Specifying your own
	   will override this default.

       bin/

SEE ALSO

       perlmodstyle gives stylistic help writing a module.

       perlnewmod gives more information about how to write a module.

       There are modules to help you through the process of writing a module: ExtUtils::ModuleMaker, Module::Install, PAR

perl v5.18.2							    2014-01-06					ExtUtils::MakeMaker::Tutorial(3pm)