Unix and Linux Discussions Tagged with usage |
|
Thread / Thread Starter |
Last Post |
Replies |
Views |
Forum |
|
|
|
5 |
10,936 |
UNIX for Advanced & Expert Users |
|
|
|
6 |
9,033 |
UNIX for Advanced & Expert Users |
|
|
|
3 |
14,188 |
UNIX for Advanced & Expert Users |
|
|
|
2 |
5,129 |
UNIX for Beginners Questions & Answers |
|
|
|
7 |
6,122 |
Shell Programming and Scripting |
|
|
|
0 |
2,203 |
UNIX for Beginners Questions & Answers |
|
|
|
2 |
2,873 |
Programming |
|
|
|
10 |
8,207 |
Ubuntu |
|
|
|
5 |
1,208 |
Shell Programming and Scripting |
|
|
|
8 |
14,589 |
Shell Programming and Scripting |
|
|
|
4 |
1,654 |
UNIX for Beginners Questions & Answers |
|
|
|
3 |
1,173 |
UNIX for Beginners Questions & Answers |
|
|
|
5 |
2,576 |
UNIX for Advanced & Expert Users |
|
|
|
2 |
6,972 |
UNIX for Advanced & Expert Users |
|
|
|
7 |
15,902 |
UNIX for Dummies Questions & Answers |
|
|
|
2 |
2,219 |
Red Hat |
|
|
|
1 |
7,095 |
UNIX for Dummies Questions & Answers |
|
|
|
2 |
5,777 |
Filesystems, Disks and Memory |
|
|
|
0 |
2,087 |
OS X Support RSS |
|
|
|
6 |
7,799 |
Shell Programming and Scripting |
|
|
|
4 |
14,278 |
HP-UX |
|
|
|
0 |
2,910 |
UNIX and Linux RSS News |
|
|
|
3 |
6,505 |
AIX |
|
|
|
2 |
5,238 |
Programming |
|
|
|
2 |
2,197 |
UNIX for Dummies Questions & Answers |
|
|
|
4 |
2,222 |
Shell Programming and Scripting |
|
|
|
8 |
5,741 |
Shell Programming and Scripting |
|
|
|
2 |
3,425 |
UNIX and Linux Applications |
|
|
|
2 |
5,736 |
UNIX for Dummies Questions & Answers |
|
|
|
0 |
2,228 |
Solaris BigAdmin RSS |
|
|
|
5 |
3,221 |
UNIX for Dummies Questions & Answers |
|
|
|
6 |
1,918 |
Shell Programming and Scripting |
|
|
|
28 |
9,530 |
UNIX for Dummies Questions & Answers |
|
|
|
5 |
2,850 |
Shell Programming and Scripting |
|
|
|
7 |
39,860 |
UNIX for Advanced & Expert Users |
|
|
|
7 |
20,405 |
Shell Programming and Scripting |
|
|
|
6 |
3,977 |
UNIX for Advanced & Expert Users |
|
|
|
14 |
31,744 |
Gentoo |
|
|
|
3 |
4,533 |
UNIX for Advanced & Expert Users |
|
|
|
8 |
5,550 |
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)