TaskForest::Options - Get options from command line and/or environment
use TaskForest::Options; my $o = &TaskForest::Options::getOptions(); # the above command will die if required options are not present
If you're just looking to use the taskforest application, the only documentation you need to read is that for TaskForest. You can do this either of the two ways:
perldoc TaskForest
OR
man TaskForest
This is a convenience class that gets the required and optional command line parameters, and uses environment variables if command line parameters are not specified.
Usage : my $config = &TaskForest::Options::getConfig($file) Purpose : This method reads a config file Returns : A hash ref of the options specified in the config file Argument : The name of the config file Throws : Nothing
Usage : my $options = &TaskForest::Options::getOptions Purpose : This method returns a list of all the options passed in. Returns : A hash ref of the options Argument : None Throws : "The following required options are missing" Various exceptions if the parameters passed in are of the wrong format.
Usage : showHelp() Purpose : This method prints help text Returns : Nothing Argument : None Throws : Nothing
To install TaskForest, copy and paste the appropriate command in to your terminal.
cpanm
cpanm TaskForest
CPAN shell
perl -MCPAN -e shell install TaskForest
For more information on module installation, please visit the detailed CPAN module installation guide.