ExtUtils::MakeMaker::Tutorial - Writing a module with MakeMaker |
ExtUtils::MakeMaker::Tutorial - Writing a module with MakeMaker
use ExtUtils::MakeMaker;
WriteMakefile( NAME => 'Your::Module', VERSION_FROM => 'lib/Your/Module.pm' );
This is a short tutorial on writing a simple module with MakeMaker. Its really not that hard.
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 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
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.
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 the ExtUtils::Manifest manpage for more details.
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.
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
any extra modules required for use the minimum version of Perl required if only works on certain operating systems
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.
the perlmodstyle manpage gives stylistic help writing a module.
the perlnewmod manpage gives more information about how to write a module.
There are modules to help you through the process of writing a module: the ExtUtils::ModuleMaker manpage, the Module::Install manpage, PAR
ExtUtils::MakeMaker::Tutorial - Writing a module with MakeMaker |