---
name: "MooX::Options::Descriptive::Usage"
section: "3pm"
platform: "linux"
package: "libmoox-options-perl"
version: "4.103-5"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/MooX::Options::Descriptive::Usage"
---

# MooX::Options::Descriptive::Usage(3pm)

Usage class

## NAME

MooX::Options::Descriptive::Usage - Usage class

## DESCRIPTION

Usage class to display the error message.

This class use the full size of your terminal

## ATTRIBUTES

Following attributes are present and behave as GLD::Usage describe them.

### leader\_text

Text that appear on top of your message

### options

The options spec of your message

## METHODS

### sub\_commands\_text

Return the list of sub commands if available.

### text

Return a compact help message.

### option\_help

Return the help message for your options

### option\_pod

Return the usage message in pod format

### option\_short\_usage

All options message without help

### warn

Warn your options help message

### die

Croak your options help message

## SUPPORT

You can find documentation for this module with the perldoc command.

```
    perldoc MooX::Options
```

You can also look for information at:

- •

  RT: CPAN's request tracker (report bugs here)

  \<http://rt.cpan.org/NoAuth/Bugs.html?Dist=MooX-Options\>

- •

  AnnoCPAN: Annotated CPAN documentation

  \<http://annocpan.org/dist/MooX-Options\>

- •

  CPAN Ratings

  \<http://cpanratings.perl.org/d/MooX-Options\>

- •

  Search CPAN

  \<http://search.cpan.org/dist/MooX-Options/\>

## AUTHOR

celogeek \<me@celogeek.com\>

## COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by celogeek \<me@celogeek.com\>.

This software is copyright (c) 2017 by Jens Rehsack.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.