31 Oct 2021 03:12:48 UTC
- Distribution: Getopt-Long-Descriptive
- Module version: 0.110
- Source (raw)
- Browse (raw)
- How to Contribute
- Repository (git clone)
- Testers (989 / 0 / 6)
- KwaliteeBus factor: 2
- 87.37% Coverage
- License: perl_5
- Perl: v5.12.0
- Activity24 month
- Download (33.74KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest version++ed by:21 non-PAUSE usersRJBS Ricardo SIGNES 😄
- PERL VERSION
- COPYRIGHT AND LICENSE
Getopt::Long::Descriptive::Usage - the usage description for GLD
use Getopt::Long::Descriptive; 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.
This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years.
Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.
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
post_textarguments are concatenated with the usage message with no line breaks, so supply this if you need them.
Hans Dieter Pearcey <email@example.com>
Ricardo Signes <firstname.lastname@example.org>
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.
Module Install Instructions
To install Getopt::Long::Descriptive, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Getopt::Long::Descriptive
For more information on module installation, please visit the detailed CPAN module installation guide.