/ 
Class-Usul-0.72.1
River stage one • 3 direct dependents • 3 total dependents
/ Class::Usul::Getopt::Usage

Name

Class::Usul::Getopt::Usage - The usage description for Getopt::Long::Descriptive

Synopsis

use parent 'Getopt::Long::Descriptive';

use Class::Usul::Getopt::Usage;
use Getopt::Long 2.38;

sub usage_class {
   return 'Class::Usul::Getopt::Usage';
}

Description

The usage description for Getopt::Long::Descriptive. Inherits from Getopt::Long::Descriptive::Usage

See Class::Usul::Options for more usage information

Configuration and Environment

Defines no attributes

Subroutines/Methods

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

option_type

One of; none, short, or verbose. Determines the amount of option type information displayed by the option_text method. Defaults to short

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

width

The total line width available for displaying usage text, defaults to 78

Diagnostics

None

Dependencies

Getopt::Long::Descriptive::Usage
List::Util
Term::ANSIColor

Incompatibilities

There are no known incompatibilities in this module

Bugs and Limitations

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

Acknowledgements

Larry Wall - For the Perl programming language

Author

Peter Flanigan, <pjfl@cpan.org>

License and Copyright

Copyright (c) 2016 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