| 1 |
Getargs::Long - Named subroutine arguments, with optional type checking |
| 2 |
|
| 3 |
The "Getargs::Long" module allows usage of named parameters in function calls, |
| 4 |
along with optional argument type-checking. It provides an easy way to get at |
| 5 |
the parameters within the routine, and yields concise descriptions for the |
| 6 |
common cases of all-mandatory and all-optional parameter lists. |
| 7 |
|
| 8 |
*** This is alpha software -- use at your own risk *** |
| 9 |
|
| 10 |
MODULE DEPENDENCIES |
| 11 |
|
| 12 |
To use this module, you will need to install: |
| 13 |
|
| 14 |
- Log::Agent |
| 15 |
- version::Limit |
| 16 |
|
| 17 |
To test this module, you will need to install: |
| 18 |
|
| 19 |
- Test::More |
| 20 |
|
| 21 |
|
| 22 |
INSTALLATION |
| 23 |
|
| 24 |
To install this package, change to the directory where you unarchived this |
| 25 |
distribution and type the following: |
| 26 |
|
| 27 |
perl Makefile.PL |
| 28 |
make |
| 29 |
make test |
| 30 |
make install |
| 31 |
|
| 32 |
You can install this package into a non-default location by appending one of |
| 33 |
the following to the "perl Makefile.PL" command: |
| 34 |
|
| 35 |
- "PREFIX=/installation/path" (for installation into a custom location), |
| 36 |
- "INSTALLDIRS=site" (for installation into site-specific Perl directories) |
| 37 |
- "INSTALLDIRS=perl" (for installation into standard Perl directories). |
| 38 |
|
| 39 |
If you make the installation into your own directory, then remember that you |
| 40 |
must tell perl where to search for modules before trying to 'use' them. For |
| 41 |
example: |
| 42 |
|
| 43 |
use lib '/home/userid/lib'; |
| 44 |
use Getargs::Long; |
| 45 |
|
| 46 |
|
| 47 |
INSTALLATION PROBLEMS |
| 48 |
|
| 49 |
If "make test" fails, run |
| 50 |
|
| 51 |
make test TEST_VERBOSE=1 |
| 52 |
|
| 53 |
and see which test(s) are failing. Please email the results to the address |
| 54 |
below, or submit a bug report on the project website as described in the |
| 55 |
section REPORTING BUGS below. |
| 56 |
|
| 57 |
For other bugs, see the section REPORTING BUGS below. |
| 58 |
|
| 59 |
|
| 60 |
DOCUMENTATION |
| 61 |
|
| 62 |
Just "perldoc Getargs::Long". After installation on Unix systems, you can also |
| 63 |
do "man Getargs::Long". |
| 64 |
|
| 65 |
|
| 66 |
RESOURCES |
| 67 |
|
| 68 |
The CPAN Page: |
| 69 |
http://search.cpan.org/dist/Getargs-Long/ |
| 70 |
|
| 71 |
The GitHub page: |
| 72 |
https://github.com/coppit/getargs-long/ |
| 73 |
|
| 74 |
Bug and feature tracking: |
| 75 |
http://rt.cpan.org/Public/Dist/Display.html?Name=Getargs-Long |
| 76 |
|
| 77 |
|
| 78 |
KNOWN BUGS |
| 79 |
|
| 80 |
This module is known to exercise a bug in perl 5.6.0. Don't use that |
| 81 |
version of perl: use 5.005_03, or try 5.6.1. |
| 82 |
|
| 83 |
The interface of this module changed between 0.1.2 and 0.1.3, and is |
| 84 |
NOT backward compatible. |
| 85 |
|
| 86 |
|
| 87 |
COPYRIGHT |
| 88 |
|
| 89 |
Copyright (c) Mar 2 2001-Mar 20 2001 Raphael Manfredi. Copyright (c) Mar 20 |
| 90 |
2001-2015 David Coppit. All rights reserved, save those granted by the |
| 91 |
license. See the file LICENSE for licensing terms. |
| 92 |
|
| 93 |
|
| 94 |
AUTHOR |
| 95 |
|
| 96 |
David Coppit <[email protected]> (current maintainer) |
| 97 |
Raphael Manfredi <[email protected]> (original author) |