Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??

This appears to be an XY Problem. Can you describe what the objective/purpose/use cases of your module are?

I usually use Module::Starter to create a shell module. It actually creates a full blown distribution. Here's an example:

$ cpanm Module::Starter # Module::Starter installs the module-starter binary: $ module-starter --module="MyModule" --author="My Name" --email="my@em +ail.com" --eumm $ cd MyModule $ ls Changes ignore.txt lib Makefile.PL MANIFEST README t xt

Now, you can keep the whole distribution intact (so you can run the likes of tests, and make install etc, but you can also take just the lib/MyModule.pm file out and use it standalone.

The result is a module base that you edit to your needs. It includes a POD section and everything. Just put your code under the use warnings; line.

package MyModule; use 5.006; use strict; use warnings; =head1 NAME MyModule - The great new MyModule! =head1 VERSION Version 0.01 =cut our $VERSION = '0.01'; =head1 SYNOPSIS Quick summary of what the module does. Perhaps a little code snippet. use MyModule; my $foo = MyModule->new(); ... =head1 EXPORT A list of functions that can be exported. You can delete this section if you don't export anything, such as for a purely object-oriented mod +ule. =head1 SUBROUTINES/METHODS =head2 function1 =cut sub function1 { } =head2 function2 =cut sub function2 { } =head1 AUTHOR My Name, C<< <my at email.com> >> =head1 BUGS Please report any bugs or feature requests to C<bug-mymodule at rt.cpa +n.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue= +MyModule>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. =head1 SUPPORT You can find documentation for this module with the perldoc command. perldoc MyModule You can also look for information at: =over 4 =item * RT: CPAN's request tracker (report bugs here) L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=MyModule> =item * AnnoCPAN: Annotated CPAN documentation L<http://annocpan.org/dist/MyModule> =item * CPAN Ratings L<http://cpanratings.perl.org/d/MyModule> =item * Search CPAN L<http://search.cpan.org/dist/MyModule/> =back =head1 ACKNOWLEDGEMENTS =head1 LICENSE AND COPYRIGHT Copyright 2016 My Name. This program is free software; you can redistribute it and/or modify i +t under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at: L<http://www.perlfoundation.org/artistic_license_2_0> Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license. If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure tha +t your Modified Version complies with the requirements of this license. This license does not grant you the right to use any trademark, servic +e mark, tradename, or logo of the Copyright Holder. This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import an +d otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by t +he Package. If you institute patent litigation (including a cross-claim o +r counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed. Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDE +R AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES +. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE +, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. =cut 1; # End of MyModule

In reply to Re: Template to create modules by stevieb
in thread Template to create modules by guiwp

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others browsing the Monastery: (2)
As of 2024-04-26 07:18 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found