An open API service indexing awesome lists of open source software.

https://github.com/mjgardner/getopt-proclus

Successor to Getopt::Euclid
https://github.com/mjgardner/getopt-proclus

Last synced: 3 months ago
JSON representation

Successor to Getopt::Euclid

Awesome Lists containing this project

README

        

=pod

=for :stopwords Mark Gardner Damian Conway Kevin Galinsky GSI
Commerce cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee
diff irc mailto metadata placeholders

=encoding utf8

=head1 NAME

Getopt::Proclus - POD-Readable Options for Command-Line Uniform Syntax

=head1 VERSION

version 0.300

=head1 SYNOPSIS

package My::Command;
use Getopt::Proclus;

sub read_file {
my $self = shift;
say 'reading ', $self->infile->stringify();
return;
}

1;

=head1 REQUIRED ARGUMENTS

=over

=item -i[nfile] [=]

Specify input file

=for Proclus:
file.is: ro
file.isa: File

=head1 DESCRIPTION

This module enables you to specify command line options for setting attributes
in a L class by writing them as L within your class.
You can then be assured that your documentation and options available are
always in sync.

=head1 METHODS

=head2 init_meta

Automatically called when you C.
Moosifies the class and then reads its POD for options to parse from the
command line, returning the modified metaclass.

=head1 SEE ALSO

=over

=item L

The inspiration for this distribution

=back

=head1 SUPPORT

=head2 Perldoc

You can find documentation for this module with the perldoc command.

perldoc Getopt::Proclus

=head2 Websites

The following websites have more information about this module, and may be of help to you. As always,
in addition to those websites please use your favorite search engine to discover more resources.

=over 4

=item *

Search CPAN

The default CPAN search engine, useful to view POD in HTML format.

L

=item *

AnnoCPAN

The AnnoCPAN is a website that allows community annonations of Perl module documentation.

L

=item *

CPAN Ratings

The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.

L

=item *

CPANTS

The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

L

=item *

CPAN Testers

The CPAN Testers is a network of smokers who run automated tests on uploaded CPAN distributions.

L

=item *

CPAN Testers Matrix

The CPAN Testers Matrix is a website that provides a visual way to determine what Perls/platforms PASSed for a distribution.

L

=item *

CPAN Testers Dependencies

The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

L

=back

=head2 Bugs / Feature Requests

Please report any bugs or feature requests through the web
interface at L. You will be automatically notified of any
progress on the request by the system.

=head2 Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play
with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull
from your repository :)

L

git clone git://github.com/mjgardner/getopt-proclus.git

=head1 AUTHORS

=over 4

=item *

Mark Gardner

=item *

Damian Conway

=item *

Kevin Galinsky

=back

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by GSI Commerce.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.