Aijaz Ansari > TaskForest-1.33 > TaskForest::LogDir

Download:
TaskForest/TaskForest-1.33.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
Report a bug
Module Version: 1.30   Source  

NAME ^

TaskForest::LogDir - Functions related to today's log directory

SYNOPSIS ^

 use TaskForest::LogDir;

 my $log_dir = &TaskForest::LogDir::getLogDir("/var/logs/taskforest");
 # $log_dir is created if it does not exist

DOCUMENTATION ^

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

DESCRIPTION ^

This is a simple package that provides a location for the getLogDir function that's used in a few places.

METHODS ^

getLogDir()
 Usage     : my $log_dir = TaskForest::LogDir::getLogDir($root)
 Purpose   : This method creates a dated subdirectory of its first
             parameter, if that directory doesn't already exist.  
 Returns   : The dated directory
 Argument  : $root -   the parent directory of the dated directory
             $tz -     the timezone of the family, that determines the date
             $reload - If this is true, and we have a cached value,
                       return the cached value
 Throws    : "mkdir $log_dir failed" if the log directory cannot be
             created