doc patches, re Getopt::Long config and extra_argv.

[gitmo/MooseX-Getopt.git] / lib / MooseX / Getopt.pm

diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm
index cc2e19a..cd0cd8b 100644 (file)
--- a/lib/MooseX/Getopt.pm
+++ b/lib/MooseX/Getopt.pm
@@ -195,8 +195,9 @@ If L<Getopt::Long/GetOptions> fails (due to invalid arguments),
 C<new_with_options> will throw an exception.
 
 If L<Getopt::Long::Descriptive> is installed and any of the following
-command line params are passed, the program will exit with usage 
-information. You can add descriptions for each option by including a
+command line params are passed, the program will exit with usage
+information (and the option's state will be stored in the help_flag
+attribute). You can add descriptions for each option by including a
 B<documentation> option for each attribute to document.
 
   --?
@@ -204,7 +205,7 @@ B<documentation> option for each attribute to document.
   --usage
 
 If you have L<Getopt::Long::Descriptive> the C<usage> param is also passed to
-C<new>.
+C<new> as the usage option.
 
 =method B<ARGV>
 
@@ -217,8 +218,40 @@ This accessor contains an arrayref of leftover C<@ARGV> elements that
 L<Getopt::Long> did not parse.  Note that the real C<@ARGV> is left
 un-mangled.
 
+B<Important>: By default, L<Getopt::Long> will reject unrecognized arguments
+(that is, arguments that do not correspond with attributes using the Getopt
+trait). To disable this, and allow the population of C<extra_argv>, enable the
+C<pass_through> option of L<Getopt::Long> for your class:  C<use Getopt::Long
+qw(:config pass_through);>
+
+=method B<usage>
+
+This accessor contains the L<Getopt::Long::Descriptive::Usage> object (if
+L<Getopt::Long::Descriptive> is used).
+
+=method B<help_flag>
+
+This accessor contains the boolean state of the --help, --usage and --?
+options (true if any of these options were passed on the command line).
+
 =method B<meta>
 
 This returns the role meta object.
 
+=method B<process_argv (%params)>
+
+This does most of the work of C<new_with_options>, analyzing the parameters
+and argv, except for actually calling the constructor. It returns a
+L<MooseX::Getopt::ProcessedArgv> object. C<new_with_options> uses this
+method internally, so modifying this method via subclasses/roles will affect
+C<new_with_options>.
+
+=head2 More Customization Options
+
+See L<Getopt::Long#Configuring_Getopt::Long> for many other customizations you
+can make to how options are parsed. Simply C<use Getopt::Long qw(:config
+other_options...)> in your class to set these.
+
+=back
+
 =cut