X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FGetopt.pm;h=f78a7ac5c463c4e311521d88add832ad347b52a5;hb=HEAD;hp=87084e12a36e4fa82ebdaf14d8e1ff8e6f1b2c15;hpb=cdb3fe1ff847f238d25cde3b0e8f5cd4fc827c15;p=gitmo%2FMooseX-Getopt.git diff --git a/lib/MooseX/Getopt.pm b/lib/MooseX/Getopt.pm index 87084e1..f78a7ac 100644 --- a/lib/MooseX/Getopt.pm +++ b/lib/MooseX/Getopt.pm @@ -200,7 +200,9 @@ 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 option for each attribute to document. + -? --? + -h --help --usage @@ -220,9 +222,9 @@ un-mangled. B: By default, L will reject unrecognized I (that is, options that do not correspond with attributes using the Getopt -trait). To disable this, and allow options to also be saved in C (for example to pass along to another class's C), enable the -C option of L for your class: C +trait). To disable this, and allow options to also be saved in C (for example to pass along to another class's C), you can either enable the +C option of L for your class: C<< use Getopt::Long +qw(:config pass_through); >> or specify a value for L's C parameter. =method B @@ -234,6 +236,14 @@ L is used). 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 + +This method is called internally when the C state is true. +It prints the text from the C object (see above) to stdout and then the +program terminates normally. You can apply a method modification (see +L) if different behaviour is desired, for +example to include additional text. + =method B This returns the role meta object. @@ -248,9 +258,13 @@ C. =head2 More Customization Options -See L for many other customizations you +See L for many other customizations you can make to how options are parsed. Simply C in your class to set these. =cut +=head1 SEE ALSO + +L, an extension to generate man pages, with colour +