NAME

optargs - print an OptArgs program command summary

VERSION

0.1.21 (2022-09-29)

SYNOPSIS

optargs CLASS [NAME]

DESCRIPTION

optargs is a utility for developers writing Perl scripts with OptArgs. It prints out the synopsis for every sub-command in a program. The results are ordered according to the setting of the $OptArgs::SORT variable as set by CLASS.

Note that optargs does a use lib 'lib' to allow your in-development class to be loaded in preference to installed versions.

ARGUMENTS

CLASS

OptArgs-based module to map. Required.

NAME

Name of the command. If not specified then the last token of CLASS will be used as the command name.

OPTIONS

--indent, -i Int

Number of spaces to indent sub-commands. Defaults to 4.

--spacer, -s Str

Character to use for indent spaces. Defaults to a single space character ' '.

--full, -f

Print out the entire usage message instead of just the synopsis.

SEE ALSO

OptArgs

AUTHOR

Mark Lawrence <nomad@null.net>

LICENSE

Copyright 2012-2022 Mark Lawrence <nomad@null.net>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.