/usr/share/doc/perl-doc-html/perlnewmod.html is in perl-doc-html 5.22.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>perlnewmod - perldoc.perl.org</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="Content-Language" content="en-gb">
<link rel="search" type="application/opensearchdescription+xml" title="Search perldoc.perl.org" href="/static/search.xml"/>
<link href="static/css-20100830.css" rel="stylesheet" rev="stylesheet" type="text/css" media="screen">
<link href="static/exploreperl.css" rel="stylesheet" rev="stylesheet" type="text/css">
</head>
<body onLoad="perldoc.startup();" onPageShow="if (event.persisted) perldoc.startup();">
<div id="page">
<div id="header">
<div id="homepage_link">
<a href="index.html"></a>
</div>
<div id="strapline">
Perl Programming Documentation
</div>
<div id="download_link" class="download">
<a href="http://www.perl.org/get.html">Download Perl</a>
</div>
<div id="explore_link" class="download">
<a id="explore_anchor" href="#">Explore</a>
</div>
</div>
<div id="body">
<div id="left_column">
<div class="side_group">
<div class="side_panel doc_panel">
<p>Manual</p>
<ul>
<li><a href="index-overview.html">Overview</a>
<li><a href="index-tutorials.html">Tutorials</a>
<li><a href="index-faq.html">FAQs</a>
<li><a href="index-history.html">History / Changes</a>
<li><a href="index-licence.html">License</a>
</ul>
</div>
<div class="side_panel doc_panel">
<p>Reference</p>
<ul>
<li><a href="index-language.html">Language</a>
<li><a href="index-functions.html">Functions</a>
<li><a href="perlop.html">Operators</a>
<li><a href="perlvar.html">Special Variables</a>
<li><a href="index-pragmas.html">Pragmas</a>
<li><a href="index-utilities.html">Utilities</a>
<li><a href="index-internals.html">Internals</a>
<li><a href="index-platforms.html">Platform Specific</a>
</ul>
</div>
<div class="side_panel doc_panel">
<p>Modules</p>
<ul>
<li>
<a href="index-modules-A.html">A</a>
•
<a href="index-modules-B.html">B</a>
•
<a href="index-modules-C.html">C</a>
•
<a href="index-modules-D.html">D</a>
•
<a href="index-modules-E.html">E</a>
<li>
<a href="index-modules-F.html">F</a>
•
<a href="index-modules-G.html">G</a>
•
<a href="index-modules-H.html">H</a>
•
<a href="index-modules-I.html">I</a>
•
<a href="index-modules-L.html">L</a>
<li>
<a href="index-modules-M.html">M</a>
•
<a href="index-modules-N.html">N</a>
•
<a href="index-modules-O.html">O</a>
•
<a href="index-modules-P.html">P</a>
•
<a href="index-modules-S.html">S</a>
<li>
<a href="index-modules-T.html">T</a>
•
<a href="index-modules-U.html">U</a>
•
<a href="index-modules-X.html">X</a>
</ul>
</div>
<div class="side_panel doc_panel">
<p>Tools</p>
<ul>
<li><a href="preferences.html">Preferences</a>
</ul>
</div>
</div>
</div>
<div id="centre_column">
<div id="content_header">
<div id="title_bar">
<div id="page_name">
<h1>perlnewmod</h1>
</div>
<div id="perl_version">
Perl 5 version 22.0 documentation
</div>
<div class="page_links" id="page_links_top">
<a href="#" onClick="toolbar.goToTop();return false;">Go to top</a>
</div>
<div class="page_links" id="page_links_bottom">
<a href="#" id="page_index_toggle">Show page index</a> •
<a href="#" id="recent_pages_toggle">Show recent pages</a>
</div>
<div id="search_form">
<form action="search.html" method="GET" id="search">
<input type="text" name="q" id="search_box" alt="Search">
</form>
</div>
</div>
<div id="breadcrumbs">
<a href="index.html">Home</a> >
<a href="index-language.html">Language reference</a> >
perlnewmod
</div>
</div>
<div id="content_body">
<!--[if lt IE 7]>
<div class="noscript">
<p>
<strong>It looks like you're using Internet Explorer 6. This is a very old
browser which does not offer full support for modern websites.</strong>
</p>
<p>
Unfortunately this means that this website will not work on
your computer.
</p>
<p>
Don't miss out though! To view the site (and get a better experience from
many other websites), simply upgrade to
<a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx">Internet
Explorer 8</a>
or download an alternative browser such as
<a href="http://www.mozilla.com/en-US/firefox/firefox.html">Firefox</a>,
<a href="http://www.apple.com/safari/download/">Safari</a>, or
<a href="http://www.google.co.uk/chrome">Google Chrome</a>.
</p>
<p>
All of these browsers are free. If you're using a PC at work, you may
need to contact your IT administrator.
</p>
</div>
<![endif]-->
<noscript>
<div class="noscript">
<p>
<strong>Please note: Many features of this site require JavaScript. You appear to have JavaScript disabled,
or are running a non-JavaScript capable web browser.</strong>
</p>
<p>
To get the best experience, please enable JavaScript or download a modern web browser such as <a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx">Internet Explorer 8</a>, <a href="http://www.mozilla.com/en-US/firefox/firefox.html">Firefox</a>, <a href="http://www.apple.com/safari/download/">Safari</a>, or <a href="http://www.google.co.uk/chrome">Google Chrome</a>.
</p>
</div>
</noscript>
<div id="recent_pages" class="hud_container">
<div id="recent_pages_header" class="hud_header">
<div id="recent_pages_close" class="hud_close"><a href="#" onClick="recentPages.hide();return false;"></a></div>
<div id="recent_pages_title" class="hud_title"><span class="hud_span_top">Recently read</span></div>
<div id="recent_pages_topright" class="hud_topright"></div>
</div>
<div id="recent_pages_content" class="hud_content">
</div>
<div id="recent_pages_footer" class="hud_footer">
<div id="recent_pages_bottomleft" class="hud_bottomleft"></div>
<div id="recent_pages_bottom" class="hud_bottom"><span class="hud_span_bottom"></span></div>
<div id="recent_pages_resize" class="hud_resize"></div>
</div>
</div>
<div id="from_search"></div>
<h1>perlnewmod</h1>
<!-- -->
<ul><li><a href="#NAME">NAME</a><li><a href="#DESCRIPTION">DESCRIPTION</a><ul><li><a href="#Warning">Warning</a><li><a href="#What-should-I-make-into-a-module%3f">What should I make into a module?</a><li><a href="#Step-by-step%3a-Preparing-the-ground">Step-by-step: Preparing the ground</a><li><a href="#Step-by-step%3a-Making-the-module">Step-by-step: Making the module</a><li><a href="#Step-by-step%3a-Distributing-your-module">Step-by-step: Distributing your module</a></ul><li><a href="#AUTHOR">AUTHOR</a><li><a href="#SEE-ALSO">SEE ALSO</a></ul><a name="NAME"></a><h1>NAME</h1>
<p>perlnewmod - preparing a new module for distribution</p>
<a name="DESCRIPTION"></a><h1>DESCRIPTION</h1>
<p>This document gives you some suggestions about how to go about writing
Perl modules, preparing them for distribution, and making them available
via CPAN.</p>
<p>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.</p>
<p>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 <a href="perlmod.html">perlmod</a>,
<a href="perlmodlib.html">perlmodlib</a> and <a href="perlmodinstall.html">perlmodinstall</a> before coming back here.</p>
<p>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 CPAN so that
others can benefit.</p>
<p>You should also take a look at <a href="perlmodstyle.html">perlmodstyle</a> for best practices in
making a module.</p>
<a name="Warning"></a><h2>Warning</h2>
<p>We're going to primarily concentrate on Perl-only modules here, rather
than XS modules. XS 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 XS module as a pure-Perl one.</p>
<a name="What-should-I-make-into-a-module%3f"></a><h2>What should I make into a module?</h2>
<p>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.</p>
<p>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.</p>
<p>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
<a href="Net/SMTP.html">Net::SMTP</a> which then talk to higher level modules analogous
to <a href="http://search.cpan.org/perldoc/Mail::Send">Mail::Send</a>. The choice is yours, but you do want to get
a module out for that server protocol.</p>
<p>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.</p>
<p>So hopefully you've now got a few ideas about what's good to modularise.
Let's now see how it's done.</p>
<a name="Step-by-step%3a-Preparing-the-ground"></a><h2>Step-by-step: Preparing the ground</h2>
<p>Before we even start scraping out the code, there are a few things we'll
want to do in advance.</p>
<ul>
<li><a name="Look-around"></a><b>Look around</b>
<p>Dig into a bunch of modules to see how they're written. I'd suggest
starting with <a href="Text/Tabs.html">Text::Tabs</a>, since it's in the standard
library and is nice and simple, and then looking at something a little
more complex like <a href="File/Copy.html">File::Copy</a>. For object oriented
code, <code class="inline"><span class="w">WWW::Mechanize</span></code>
or the <code class="inline"><span class="w">Email::</span>*</code>
modules provide some good
examples.</p>
<p>These should give you an overall feel for how modules are laid out and
written.</p>
</li>
<li><a name="Check-it's-new"></a><b>Check it's new</b>
<p>There are a lot of modules on CPAN, and it's easy to miss one that's
similar to what you're planning on contributing. Have a good plough
through the <a href="http://search.cpan.org">http://search.cpan.org</a> and make sure you're not the one
reinventing the wheel!</p>
</li>
<li><a name="Discuss-the-need"></a><b>Discuss the need</b>
<p>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 your module will have, consider sending out feelers
on the <code class="inline"><span class="w">comp</span>.<span class="w">lang</span>.<span class="w">perl</span>.<span class="w">modules</span></code>
newsgroup, or as a last resort, ask the
modules list at <code class="inline"><span class="w">modules</span><span class="i">@perl</span>.<span class="w">org</span></code>
. 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.</p>
</li>
<li><a name="Choose-a-name"></a><b>Choose a name</b>
<p>Perl modules included on CPAN have a naming hierarchy you should try to
fit in with. See <a href="perlmodlib.html">perlmodlib</a> for more details on how this works, and
browse around CPAN 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.</p>
</li>
<li><a name="Check-again"></a><b>Check again</b>
<p>While you're doing that, make really sure you haven't missed a module
similar to the one you're about to write.</p>
<p>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.</p>
</li>
</ul>
<a name="Step-by-step%3a-Making-the-module"></a><h2>Step-by-step: Making the module</h2>
<ul>
<li><a name="Start-with-_module-starter_-or-_h2xs_"></a><b>Start with <i>module-starter</i> or <i>h2xs</i></b>
<p>The <i>module-starter</i> utility is distributed as part of the
<a href="http://search.cpan.org/perldoc/Module::Starter">Module::Starter</a> CPAN package. It creates a directory
with stubs of all the necessary files to start a new module, according
to recent "best practice" for module development, and is invoked from
the command line, thus:</p>
<pre class="verbatim"><ol><li> module-starter --module=Foo::Bar \</li><li> --author="Your Name" --email=yourname@cpan.org</li></ol></pre><p>If you do not wish to install the <a href="http://search.cpan.org/perldoc/Module::Starter">Module::Starter</a>
package from CPAN, <i>h2xs</i> is an older tool, originally intended for the
development of XS modules, which comes packaged with the Perl
distribution.</p>
<p>A typical invocation of <a href="h2xs.html">h2xs</a> for a pure Perl module is:</p>
<pre class="verbatim"><ol><li> h2xs -AX --skip-exporter --use-new-tests -n Foo::Bar</li></ol></pre><p>The <code class="inline">-A</code>
omits the Autoloader code, <code class="inline"><a class="l_k" href="functions/-X.html">-X</a></code> omits XS elements,
<code class="inline">--<span class="w">skip</span>-<span class="w">exporter</span></code>
omits the Exporter code, <code class="inline">--<a class="l_k" href="functions/use.html">use</a>-<span class="w">new</span>-<span class="w">tests</span></code>
sets up a
modern testing environment, and <code class="inline">-<span class="w">n</span></code>
specifies the name of the module.</p>
</li>
<li><a name="Use-strict-and-warnings"></a><b>Use <a href="strict.html">strict</a> and <a href="warnings.html">warnings</a></b>
<p>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?</p>
</li>
<li><a name="Use-Carp"></a><b>Use <a href="Carp.html">Carp</a></b>
<p>The <a href="Carp.html">Carp</a> 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:</p>
<pre class="verbatim"><ol><li> <a class="l_k" href="functions/warn.html">warn</a> <span class="q">"No hostname given"</span><span class="sc">;</span></li></ol></pre><p>the user will see something like this:</p>
<pre class="verbatim"><ol><li> No hostname given at /usr/local/lib/perl5/site_perl/5.6.0/Net/Acme.pm</li><li> line 123.</li></ol></pre><p>which looks like your module is doing something wrong. Instead, you want
to put the blame on the user, and say this:</p>
<pre class="verbatim"><ol><li> <span class="w">No</span> <span class="w">hostname</span> given <span class="w">at</span> <span class="w">bad_code</span><span class="cm">,</span> <span class="w">line</span> <span class="n">10.</span></li></ol></pre><p>You do this by using <a href="Carp.html">Carp</a> and replacing your <code class="inline"><a class="l_k" href="functions/warn.html">warn</a></code>s with
<code class="inline"><span class="w">carp</span></code>
s. If you need to <code class="inline"><a class="l_k" href="functions/die.html">die</a></code>, say <code class="inline"><span class="w">croak</span></code>
instead. However, keep
<code class="inline"><a class="l_k" href="functions/warn.html">warn</a></code> and <code class="inline"><a class="l_k" href="functions/die.html">die</a></code> in place for your sanity checks - where it really is
your module at fault.</p>
</li>
<li><a name="Use-Exporter---wisely!"></a><b>Use <a href="Exporter.html">Exporter</a> - wisely!</b>
<p><a href="Exporter.html">Exporter</a> gives you a standard way of exporting symbols and
subroutines from your module into the caller's namespace. For instance,
saying <code class="inline"><a class="l_k" href="functions/use.html">use</a> <span class="w">Net::Acme</span> <span class="q">qw(&frob)</span></code>
would import the <code class="inline"><span class="w">frob</span></code>
subroutine.</p>
<p>The package variable <code class="inline"><span class="i">@EXPORT</span></code>
will determine which symbols will get
exported when the caller simply says <code class="inline"><a class="l_k" href="functions/use.html">use</a> <span class="w">Net::Acme</span></code>
- you will hardly
ever want to put anything in there. <code class="inline"><span class="i">@EXPORT_OK</span></code>
, on the other hand,
specifies which symbols you're willing to export. If you do want to
export a bunch of symbols, use the <code class="inline"><span class="i">%EXPORT_TAGS</span></code>
and define a standard
export set - look at <a href="Exporter.html">Exporter</a> for more details.</p>
</li>
<li><a name="Use-perlpod"></a><b>Use <a href="perlpod.html">plain old documentation</a></b>
<p>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.
<code class="inline"><span class="w">module</span>-<span class="w">starter</span></code>
or <code class="inline"><span class="w">h2xs</span></code>
will provide a stub for you to fill in; if
you're not sure about the format, look at <a href="perlpod.html">perlpod</a> 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 POD for end-user notes.</p>
</li>
<li><a name="Write-tests"></a><b>Write tests</b>
<p>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 CPAN, a host of testers will build your module and send
you the results of the tests. Again, <code class="inline"><span class="w">module</span>-<span class="w">starter</span></code>
and <code class="inline"><span class="w">h2xs</span></code>
provide a test framework which you can extend - you should do something
more than just checking your module will compile.
<a href="Test/Simple.html">Test::Simple</a> and <a href="Test/More.html">Test::More</a> are good
places to start when writing a test suite.</p>
</li>
<li><a name="Write-the-README"></a><b>Write the README</b>
<p>If you're uploading to CPAN, the automated gremlins will extract the
README file and place that in your CPAN directory. It'll also appear in
the main <i>by-module</i> and <i>by-category</i> 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.</p>
</li>
</ul>
<a name="Step-by-step%3a-Distributing-your-module"></a><h2>Step-by-step: Distributing your module</h2>
<ul>
<li><a name="Get-a-CPAN-user-ID"></a><b>Get a CPAN user ID</b>
<p>Every developer publishing modules on CPAN needs a CPAN ID. Visit
<code class="inline"><a href="http://pause.perl.org/">http://pause.perl.org/</a></code>, select "Request PAUSE Account", and wait for
your request to be approved by the PAUSE administrators.</p>
</li>
<li><a name="perl-Makefile.PL%3b-make-test%3b-make-dist"></a><b><code class="inline"><span class="w">perl</span> <span class="w">Makefile</span>.<span class="w">PL</span><span class="sc">;</span> <span class="w">make</span> <span class="w">test</span><span class="sc">;</span> <span class="w">make</span> <span class="w">dist</span></code>
</b>
<p>Once again, <code class="inline"><span class="w">module</span>-<span class="w">starter</span></code>
or <code class="inline"><span class="w">h2xs</span></code>
has done all the work for you.
They produce the standard <code class="inline"><span class="w">Makefile</span>.<span class="w">PL</span></code>
you see when you download and
install modules, and this produces a Makefile with a <code class="inline"><span class="w">dist</span></code>
target.</p>
<p>Once you've ensured that your module passes its own tests - always a
good thing to make sure - you can <code class="inline"><span class="w">make</span> <span class="w">dist</span></code>
, and the Makefile will
hopefully produce you a nice tarball of your module, ready for upload.</p>
</li>
<li><a name="Upload-the-tarball"></a><b>Upload the tarball</b>
<p>The email you got when you received your CPAN ID will tell you how to
log in to PAUSE, the Perl Authors Upload SErver. From the menus there,
you can upload your module to CPAN.</p>
</li>
<li><a name="Announce-to-the-modules-list"></a><b>Announce to the modules list</b>
<p>Once uploaded, it'll sit unnoticed in your author directory. If you want
it connected to the rest of the CPAN, you'll need to go to "Register
Namespace" on PAUSE. Once registered, your module will appear in the
by-module and by-category listings on CPAN.</p>
</li>
<li><a name="Announce-to-clpa"></a><b>Announce to clpa</b>
<p>If you have a burning desire to tell the world about your release, post
an announcement to the moderated <code class="inline"><span class="w">comp</span>.<span class="w">lang</span>.<span class="w">perl</span>.<span class="w">announce</span></code>
newsgroup.</p>
</li>
<li><a name="Fix-bugs!"></a><b>Fix bugs!</b>
<p>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...</p>
</li>
</ul>
<a name="AUTHOR"></a><h1>AUTHOR</h1>
<p>Simon Cozens, <code class="inline"><span class="w">simon</span><span class="i">@cpan</span>.<span class="w">org</span></code>
</p>
<p>Updated by Kirrily "Skud" Robert, <code class="inline"><span class="w">skud</span><span class="i">@cpan</span>.<span class="w">org</span></code>
</p>
<a name="SEE-ALSO"></a><h1>SEE ALSO</h1>
<p><a href="perlmod.html">perlmod</a>, <a href="perlmodlib.html">perlmodlib</a>, <a href="perlmodinstall.html">perlmodinstall</a>, <a href="h2xs.html">h2xs</a>, <a href="strict.html">strict</a>,
<a href="Carp.html">Carp</a>, <a href="Exporter.html">Exporter</a>, <a href="perlpod.html">perlpod</a>, <a href="Test/Simple.html">Test::Simple</a>, <a href="Test/More.html">Test::More</a>
<a href="ExtUtils/MakeMaker.html">ExtUtils::MakeMaker</a>, <a href="http://search.cpan.org/perldoc/Module::Build">Module::Build</a>, <a href="http://search.cpan.org/perldoc/Module::Starter">Module::Starter</a>
<a href="http://www.cpan.org/">http://www.cpan.org/</a> , Ken Williams's tutorial on building your own
module at <a href="http://mathforum.org/~ken/perl_modules.html">http://mathforum.org/~ken/perl_modules.html</a></p>
<div id="page_index" class="hud_container">
<div id="page_index_header" class="hud_header">
<div id="page_index_close" class="hud_close"><a href="#" onClick="pageIndex.hide();return false;"></a></div>
<div id="page_index_title" class="hud_title"><span class="hud_span_top">Page index</span></div>
<div id="page_index_topright" class="hud_topright"></div>
</div>
<div id="page_index_content" class="hud_content">
<ul><li><a href="#NAME">NAME</a><li><a href="#DESCRIPTION">DESCRIPTION</a><ul><li><a href="#Warning">Warning</a><li><a href="#What-should-I-make-into-a-module%3f">What should I make into a module?</a><li><a href="#Step-by-step%3a-Preparing-the-ground">Step-by-step: Preparing the ground</a><li><a href="#Step-by-step%3a-Making-the-module">Step-by-step: Making the module</a><li><a href="#Step-by-step%3a-Distributing-your-module">Step-by-step: Distributing your module</a></ul><li><a href="#AUTHOR">AUTHOR</a><li><a href="#SEE-ALSO">SEE ALSO</a></ul>
</div>
<div id="page_index_footer" class="hud_footer">
<div id="page_index_bottomleft" class="hud_bottomleft"></div>
<div id="page_index_bottom" class="hud_bottom"><span class="hud_span_bottom"></span></div>
<div id="page_index_resize" class="hud_resize"></div>
</div>
</div>
</div>
<div id="content_footer">
</div>
</div>
<div class="clear"></div>
</div>
<div id="footer">
<div id="footer_content">
<div id="footer_strapline">
perldoc.perl.org - Official documentation for the Perl programming language
</div>
<div id="footer_links">
<div id="address">
<p class="name">Contact details</p>
<p class="address">
Site maintained by <a href="mailto:jj@jonallen.info">Jon Allen (JJ)</a><br>
</p>
<p class="contact">
Documentation maintained by the <a href="http://lists.cpan.org/showlist.cgi?name=perl5-porters">Perl 5 Porters</a>
</p>
</div>
<ul class="f1">
<li>Manual
<ul class="f2">
<li><a href="index-overview.html">Overview</a>
<li><a href="index-tutorials.html">Tutorials</a>
<li><a href="index-faq.html">FAQs</a>
<li><a href="index-history.html">Changes</a>
</ul>
<li>Reference
<ul class="f2">
<li><a href="index-language.html">Language</a>
<li><a href="index-functions.html">Functions</a>
<li><a href="perlop.html">Operators</a>
<li><a href="perlvar.html">Variables</a>
</ul>
<li>Modules
<ul class="f2">
<li><a href="index-modules-A.html">Modules</a>
<li><a href="index-pragmas.html">Pragmas</a>
<li><a href="index-utilities.html">Utilities</a>
</ul>
<li>Misc
<ul class="f2">
<li><a href="index-licence.html">License</a>
<li><a href="index-internals.html">Internals</a>
<li><a href="index-platforms.html">Platforms</a>
</ul> </ul>
<div class="clear"></div>
</div>
</div>
<div id="footer_end">
</div>
</div>
</div>
<script language="JavaScript" type="text/javascript" src="static/exploreperl.js"></script>
<script language="JavaScript" src="static/combined-20100403.js" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
perldoc.setPath(0);
perldoc.pageName = 'perlnewmod';
perldoc.pageAddress = 'perlnewmod.html';
perldoc.contentPage = 1;
explorePerl.render();
explorePerl.addEvents('explore_anchor');
</script>
</body>
</html>
|