.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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. | will give a
.\" real vertical bar. \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "PERLNEWMOD 1"
.TH PERLNEWMOD 1 "2002-11-24" "perl v5.8.0" "Perl Programmers Reference Guide"
.SH "NAME"
perlnewmod \- preparing a new module for distribution
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This document gives you some suggestions about how to go about writing
Perl modules, preparing them for distribution, and making them available
via \s-1CPAN\s0.
.PP
One of the things that makes Perl really powerful is the fact that Perl
hackers tend to want to share the solutions to problems they've faced,
so you and I don't have to battle with the same problem again.
.PP
The main way they do this is by abstracting the solution into a Perl
module. If you don't know what one of these is, the rest of this
document isn't going to be much use to you. You're also missing out on
an awful lot of useful code; consider having a look at perlmod,
perlmodlib and perlmodinstall before coming back here.
.PP
When you've found that there isn't a module available for what you're
trying to do, and you've had to write the code yourself, consider
packaging up the solution into a module and uploading it to \s-1CPAN\s0 so that
others can benefit.
.Sh "Warning"
.IX Subsection "Warning"
We're going to primarily concentrate on Perl-only modules here, rather
than \s-1XS\s0 modules. \s-1XS\s0 modules serve a rather different purpose, and
you should consider different things before distributing them \- the
popularity of the library you are gluing, the portability to other
operating systems, and so on. However, the notes on preparing the Perl
side of the module and packaging and distributing it will apply equally
well to an \s-1XS\s0 module as a pure-Perl one.
.Sh "What should I make into a module?"
.IX Subsection "What should I make into a module?"
You should make a module out of any code that you think is going to be
useful to others. Anything that's likely to fill a hole in the communal
library and which someone else can slot directly into their program. Any
part of your code which you can isolate and extract and plug into
something else is a likely candidate.
.PP
Let's take an example. Suppose you're reading in data from a local
format into a hash-of-hashes in Perl, turning that into a tree, walking
the tree and then piping each node to an Acme Transmogrifier Server.
.PP
Now, quite a few people have the Acme Transmogrifier, and you've had to
write something to talk the protocol from scratch \- you'd almost
certainly want to make that into a module. The level at which you pitch
it is up to you: you might want protocol-level modules analogous to
Net::SMTP which then talk to higher level modules analogous
to Mail::Send. The choice is yours, but you do want to get
a module out for that server protocol.
.PP
Nobody else on the planet is going to talk your local data format, so we
can ignore that. But what about the thing in the middle? Building tree
structures from Perl variables and then traversing them is a nice,
general problem, and if nobody's already written a module that does
that, you might want to modularise that code too.
.PP
So hopefully you've now got a few ideas about what's good to modularise.
Let's now see how it's done.
.Sh "Step\-by\-step: Preparing the ground"
.IX Subsection "Step-by-step: Preparing the ground"
Before we even start scraping out the code, there are a few things we'll
want to do in advance.
.IP "Look around" 3
.IX Item "Look around"
Dig into a bunch of modules to see how they're written. I'd suggest
starting with Text::Tabs, since it's in the standard
library and is nice and simple, and then looking at something like
Time::Zone, File::Copy and then some of the
\&\f(CW\*(C`Mail::*\*(C'\fR modules if you're planning on writing object oriented code.
.Sp
These should give you an overall feel for how modules are laid out and
written.
.IP "Check it's new" 3
.IX Item "Check it's new"
There are a lot of modules on \s-1CPAN\s0, and it's easy to miss one that's
similar to what you're planning on contributing. Have a good plough
through the modules list and the \fIby-module\fR directories, and make sure
you're not the one reinventing the wheel!
.IP "Discuss the need" 3
.IX Item "Discuss the need"
You might love it. You might feel that everyone else needs it. But there
might not actually be any real demand for it out there. If you're unsure
about the demand you're module will have, consider sending out feelers
on the \f(CW\*(C`comp.lang.perl.modules\*(C'\fR newsgroup, or as a last resort, ask the
modules list at \f(CW\*(C`[email protected]\*(C'\fR. Remember that this is a closed list
with a very long turn-around time \- be prepared to wait a good while for
a response from them.
.IP "Choose a name" 3
.IX Item "Choose a name"
Perl modules included on \s-1CPAN\s0 have a naming hierarchy you should try to
fit in with. See perlmodlib for more details on how this works, and
browse around \s-1CPAN\s0 and the modules list to get a feel of it. At the very
least, remember this: modules should be title capitalised, (This::Thing)
fit in with a category, and explain their purpose succinctly.
.IP "Check again" 3
.IX Item "Check again"
While you're doing that, make really sure you haven't missed a module
similar to the one you're about to write.
.Sp
When you've got your name sorted out and you're sure that your module is
wanted and not currently available, it's time to start coding.
.Sh "Step\-by\-step: Making the module"
.IX Subsection "Step-by-step: Making the module"
.IP "Start with \fIh2xs\fR" 3
.IX Item "Start with h2xs"
Originally a utility to convert C header files into \s-1XS\s0 modules,
h2xs has become a useful utility for churning out skeletons for
Perl-only modules as well. If you don't want to use the
Autoloader which splits up big modules into smaller
subroutine-sized chunks, you'll say something like this:
.Sp
.Vb 1
\& h2xs -AX -n Net::Acme
.Ve
.Sp
The \f(CW\*(C`\-A\*(C'\fR omits the Autoloader code, \f(CW\*(C`\-X\*(C'\fR omits \s-1XS\s0 elements, and \f(CW\*(C`\-n\*(C'\fR
specifies the name of the module.
.IP "Use strict and warnings" 3
.IX Item "Use strict and warnings"
A module's code has to be warning and strict\-clean, since you can't
guarantee the conditions that it'll be used under. Besides, you wouldn't
want to distribute code that wasn't warning or strict-clean anyway,
right?
.IP "Use Carp" 3
.IX Item "Use Carp"
The Carp module allows you to present your error messages from
the caller's perspective; this gives you a way to signal a problem with
the caller and not your module. For instance, if you say this:
.Sp
.Vb 1
\& warn "No hostname given";
.Ve
.Sp
the user will see something like this:
.Sp
.Vb 2
\& No hostname given at /usr/local/lib/perl5/site_perl/5.6.0/Net/Acme.pm
\& line 123.
.Ve
.Sp
which looks like your module is doing something wrong. Instead, you want
to put the blame on the user, and say this:
.Sp
.Vb 1
\& No hostname given at bad_code, line 10.
.Ve
.Sp
You do this by using Carp and replacing your \f(CW\*(C`warn\*(C'\fRs with
\&\f(CW\*(C`carp\*(C'\fRs. If you need to \f(CW\*(C`die\*(C'\fR, say \f(CW\*(C`croak\*(C'\fR instead. However, keep
\&\f(CW\*(C`warn\*(C'\fR and \f(CW\*(C`die\*(C'\fR in place for your sanity checks \- where it really is
your module at fault.
.IP "Use Exporter \- wisely!" 3
.IX Item "Use Exporter - wisely!"
\&\f(CW\*(C`h2xs\*(C'\fR provides stubs for Exporter, which gives you a
standard way of exporting symbols and subroutines from your module into
the caller's namespace. For instance, saying \f(CW\*(C`use Net::Acme qw(&frob)\*(C'\fR
would import the \f(CW\*(C`frob\*(C'\fR subroutine.
.Sp
The package variable \f(CW@EXPORT\fR will determine which symbols will get
exported when the caller simply says \f(CW\*(C`use Net::Acme\*(C'\fR \- you will hardly
ever want to put anything in there. \f(CW@EXPORT_OK\fR, on the other hand,
specifies which symbols you're willing to export. If you do want to
export a bunch of symbols, use the \f(CW%EXPORT_TAGS\fR and define a standard
export set \- look at Exporter for more details.
.IP "Use plain old documentation" 3
.IX Item "Use plain old documentation"
The work isn't over until the paperwork is done, and you're going to
need to put in some time writing some documentation for your module.
\&\f(CW\*(C`h2xs\*(C'\fR will provide a stub for you to fill in; if you're not sure about
the format, look at perlpod for an introduction. Provide a good
synopsis of how your module is used in code, a description, and then
notes on the syntax and function of the individual subroutines or
methods. Use Perl comments for developer notes and \s-1POD\s0 for end-user
notes.
.IP "Write tests" 3
.IX Item "Write tests"
You're encouraged to create self-tests for your module to ensure it's
working as intended on the myriad platforms Perl supports; if you upload
your module to \s-1CPAN\s0, a host of testers will build your module and send
you the results of the tests. Again, \f(CW\*(C`h2xs\*(C'\fR provides a test framework
which you can extend \- you should do something more than just checking
your module will compile.
.IP "Write the \s-1README\s0" 3
.IX Item "Write the README"
If you're uploading to \s-1CPAN\s0, the automated gremlins will extract the
\&\s-1README\s0 file and place that in your \s-1CPAN\s0 directory. It'll also appear in
the main \fIby-module\fR and \fIby-category\fR directories if you make it onto
the modules list. It's a good idea to put here what the module actually
does in detail, and the user-visible changes since the last release.
.Sh "Step\-by\-step: Distributing your module"
.IX Subsection "Step-by-step: Distributing your module"
.IP "Get a \s-1CPAN\s0 user \s-1ID\s0" 3
.IX Item "Get a CPAN user ID"
Every developer publishing modules on \s-1CPAN\s0 needs a \s-1CPAN\s0 \s-1ID\s0. See the
instructions at \f(CW\*(C`http://www.cpan.org/modules/04pause.html\*(C'\fR (or
equivalent on your nearest mirror) to find out how to do this.
.ie n .IP """perl Makefile.PL; make test; make dist""" 3
.el .IP "\f(CWperl Makefile.PL; make test; make dist\fR" 3
.IX Item "perl Makefile.PL; make test; make dist"
Once again, \f(CW\*(C`h2xs\*(C'\fR has done all the work for you. It produces the
standard \f(CW\*(C`Makefile.PL\*(C'\fR you'll have seen when you downloaded and
installs modules, and this produces a Makefile with a \f(CW\*(C`dist\*(C'\fR target.
.Sp
Once you've ensured that your module passes its own tests \- always a
good thing to make sure \- you can \f(CW\*(C`make dist\*(C'\fR, and the Makefile will
hopefully produce you a nice tarball of your module, ready for upload.
.IP "Upload the tarball" 3
.IX Item "Upload the tarball"
The email you got when you received your \s-1CPAN\s0 \s-1ID\s0 will tell you how to
log in to \s-1PAUSE\s0, the Perl Authors Upload SErver. From the menus there,
you can upload your module to \s-1CPAN\s0.
.IP "Announce to the modules list" 3
.IX Item "Announce to the modules list"
Once uploaded, it'll sit unnoticed in your author directory. If you want
it connected to the rest of the \s-1CPAN\s0, you'll need to tell the modules
list about it. The best way to do this is to email them a line in the
style of the modules list, like this:
.Sp
.Vb 15
\& Net::Acme bdpOP Interface to Acme Frobnicator servers FOOBAR
\& ^ ^^^^^ ^ ^
\& | ||||| Module description Your ID
\& | |||||
\& | ||||\e-Public Licence: (p)standard Perl, (g)GPL, (b)BSD,
\& | |||| (l)LGPL, (a)rtistic, (o)ther
\& | ||||
\& | |||\e- Interface: (O)OP, (r)eferences, (h)ybrid, (f)unctions
\& | |||
\& | ||\e-- Language: (p)ure Perl, C(+)+, (h)ybrid, (C), (o)ther
\& | ||
\& Module |\e--- Support: (d)eveloper, (m)ailing list, (u)senet, (n)one
\& Name |
\& \e---- Development: (i)dea, (c)onstructions, (a)lpha, (b)eta,
\& (R)eleased, (M)ature, (S)tandard
.Ve
.Sp
plus a description of the module and why you think it should be
included. If you hear nothing back, that means your module will
probably appear on the modules list at the next update. Don't try
subscribing to \f(CW\*(C`[email protected]\*(C'\fR; it's not another mailing list. Just
have patience.
.IP "Announce to clpa" 3
.IX Item "Announce to clpa"
If you have a burning desire to tell the world about your release, post
an announcement to the moderated \f(CW\*(C`comp.lang.perl.announce\*(C'\fR newsgroup.
.IP "Fix bugs!" 3
.IX Item "Fix bugs!"
Once you start accumulating users, they'll send you bug reports. If
you're lucky, they'll even send you patches. Welcome to the joys of
maintaining a software project...
.SH "AUTHOR"
.IX Header "AUTHOR"
Simon Cozens, \f(CW\*(C`[email protected]\*(C'\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perlmod, perlmodlib, perlmodinstall, h2xs, strict,
Carp, Exporter, perlpod, Test, ExtUtils::MakeMaker,
http://www.cpan.org/ , Ken Williams' tutorial on building your own
module at http://mathforum.org/~ken/perl_modules.html
|
