Class::Usul::Getopt::Usage - The usage description for Getopt::Long::Descriptive
use parent 'Getopt::Long::Descriptive'; use Class::Usul::Getopt::Usage; use Getopt::Long 2.38; sub usage_class { return 'Class::Usul::Getopt::Usage'; }
The usage description for Getopt::Long::Descriptive. Inherits from Getopt::Long::Descriptive::Usage
See Class::Usul::Options for more usage information
Defines no attributes
option_text
Returns the multiline string which is the usage text
usage_conf
A class accessor / mutator for the configuration hash reference. Supported attributes are;
highlight
Defaults to bold which causes the option argument types to be displayed in a bold font. Set to none to turn off highlighting
bold
none
option_type
One of; none, short, or verbose. Determines the amount of option type information displayed by the option_text method. Defaults to short
short
verbose
tabstop
Defaults to 3. The number of spaces to expand the leading tab in the usage string
type_map
A hash reference keyed by option type. By default maps int to i, key to k, num to n, and str to s
int
i
key
k
num
n
str
s
width
The total line width available for displaying usage text, defaults to 78
None
There are no known incompatibilities in this module
There are no known bugs in this module. Please report problems to http://rt.cpan.org/NoAuth/Bugs.html?Dist=Class-Usul. Patches are welcome
Larry Wall - For the Perl programming language
Peter Flanigan, <pjfl@cpan.org>
<pjfl@cpan.org>
Copyright (c) 2018 Peter Flanigan. All rights reserved
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic
This program is distributed in the hope that it will be useful, but WITHOUT WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
To install Class::Usul, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Class::Usul
CPAN shell
perl -MCPAN -e shell install Class::Usul
For more information on module installation, please visit the detailed CPAN module installation guide.