Unix and Linux Discussions Tagged with usage |
|
Thread / Thread Starter |
Last Post |
Replies |
Views |
Forum |
|
|
|
5 |
10,825 |
UNIX for Advanced & Expert Users |
|
|
|
6 |
8,999 |
UNIX for Advanced & Expert Users |
|
|
|
3 |
14,146 |
UNIX for Advanced & Expert Users |
|
|
|
2 |
5,110 |
UNIX for Beginners Questions & Answers |
|
|
|
7 |
6,065 |
Shell Programming and Scripting |
|
|
|
0 |
2,173 |
UNIX for Beginners Questions & Answers |
|
|
|
2 |
2,848 |
Programming |
|
|
|
10 |
8,080 |
Ubuntu |
|
|
|
5 |
1,196 |
Shell Programming and Scripting |
|
|
|
8 |
14,552 |
Shell Programming and Scripting |
|
|
|
4 |
1,636 |
UNIX for Beginners Questions & Answers |
|
|
|
3 |
1,151 |
UNIX for Beginners Questions & Answers |
|
|
|
5 |
2,530 |
UNIX for Advanced & Expert Users |
|
|
|
2 |
6,792 |
UNIX for Advanced & Expert Users |
|
|
|
7 |
15,892 |
UNIX for Dummies Questions & Answers |
|
|
|
2 |
2,213 |
Red Hat |
|
|
|
1 |
7,080 |
UNIX for Dummies Questions & Answers |
|
|
|
2 |
5,768 |
Filesystems, Disks and Memory |
|
|
|
0 |
2,077 |
OS X Support RSS |
|
|
|
6 |
7,781 |
Shell Programming and Scripting |
|
|
|
4 |
14,273 |
HP-UX |
|
|
|
0 |
2,902 |
UNIX and Linux RSS News |
|
|
|
3 |
6,489 |
AIX |
|
|
|
2 |
5,224 |
Programming |
|
|
|
2 |
2,193 |
UNIX for Dummies Questions & Answers |
|
|
|
4 |
2,213 |
Shell Programming and Scripting |
|
|
|
8 |
5,727 |
Shell Programming and Scripting |
|
|
|
2 |
3,411 |
UNIX and Linux Applications |
|
|
|
2 |
5,723 |
UNIX for Dummies Questions & Answers |
|
|
|
0 |
2,219 |
Solaris BigAdmin RSS |
|
|
|
5 |
3,213 |
UNIX for Dummies Questions & Answers |
|
|
|
6 |
1,909 |
Shell Programming and Scripting |
|
|
|
28 |
9,493 |
UNIX for Dummies Questions & Answers |
|
|
|
5 |
2,840 |
Shell Programming and Scripting |
|
|
|
7 |
39,836 |
UNIX for Advanced & Expert Users |
|
|
|
7 |
20,363 |
Shell Programming and Scripting |
|
|
|
6 |
3,972 |
UNIX for Advanced & Expert Users |
|
|
|
14 |
31,631 |
Gentoo |
|
|
|
3 |
4,527 |
UNIX for Advanced & Expert Users |
|
|
|
8 |
5,543 |
Programming |
Getopt::Usaginator(3pm) User Contributed Perl Documentation Getopt::Usaginator(3pm)
NAME
Getopt::Usaginator - Conjure up a usage function for your applications
VERSION
version 0.0012
SYNOPSIS
use Getopt::Usaginator <<_END_;
Usage: xyzzy <options>
--derp Derp derp derp
--durp Durp durp durp
-h, --help This usage
_END_
# The 'usage' subroutine is now installed
...
$options = parse_options( @ARGV ); # Not supplied by Usaginator
usage if $options{help}; # Print usage and exit with status 0
if ( ! $options{derp} ) {
# Print warning and usage and exit with status -1
usage "You should really derp";
}
if ( $options{durp} ) {
# Print warning and usage and exit with status 2
usage 2 => "--durp is not ready yet";
}
...
usage 3 # Print usage and exit with status 3
DESCRIPTION
Getopt::Usaginator is a tool for creating a handy usage subroutine for commandline applications
It does not do any option parsing, but is best paired with Getopt::Long or any of the other myriad of option parsers
USAGE
use Getopt::Usaginator <usage>
Install a "usage" subroutine configured with the <usage> text
$code = Getopt::Usaginator->usaginator( <usage> )
Return a subroutine configured with the <usage> text
...
More advanced usage is possible, peek under the hood for more information
perldoc -m Getopt::Usaginator
An example:
use Getopt::Usaginator
# Called with the error
error => sub { ... },
# Called when usage printing is needed
usage => sub { ... },
...
;
An example with Getopt::Long parsing
use Getopt::Usaginator ...
sub run {
my $self = shift;
my @arguments = @_;
usage 0 unless @arguments;
my ( $help );
{
local @ARGV = @arguments;
GetOptions(
'help|h|?' => $help,
);
}
usage 0 if $help;
...
}
AUTHOR
Robert Krimen <robertkrimen@gmail.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2010 by Robert Krimen.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
perl v5.10.1 2010-06-05 Getopt::Usaginator(3pm)