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