Section: User Contributed Perl Documentation (3)
Getopt::Long::Descriptive::Usage - the usage description for GLD
my ($opt, $usage) = describe_options( ... );
$usage->text; # complete usage message
$usage->die; # die with usage message
This document only describes the methods of the Usage object. For information
on how to use Getopt::Long::Descriptive, consult its documentation.
my $usage = Getopt::Long::Descriptive::Usage->new(\%arg);
You really don't need to call this. GLD will do it for you.
Valid arguments are:
options - an arrayref of options
leader_text - the text that leads the usage; this may go away!
This returns the full text of the usage message.
This returns the text that comes at the beginning of the usage message.
This returns the text describing the available options.
This warns with the usage message.
This throws the usage message as an exception.
Some arguments can be provided
pre_text - text to be prepended to the usage message
post_text - text to be appended to the usage message
The "pre_text" and "post_text" arguments are concatenated with the usage
message with no line breaks, so supply this if you need them.
Hans Dieter Pearcey <firstname.lastname@example.org>
Ricardo Signes <email@example.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2005 by Hans Dieter Pearcey.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.