debian man page for file::policy::default

File::Policy::Default(3pm)				User Contributed Perl Documentation				File::Policy::Default(3pm)

NAME
       File::Policy::Default - Default policy for file I/O functions

SYNOPSIS
	       use File::Policy;
	       use File::Policy qw/check_safe/;   # to import a specific subroutine
	       use File::Policy qw/:all/;	  # to import all subroutines

	       #Checking I/O policy
	       check_safe($filename, 'r');
	       check_safe($filename, 'w');

	       #Portable directory locations
	       $logdir = get_log_dir();
	       $tmpdir = get_temp_dir();

DESCRIPTION
       This defines the default (unrestricted) policy for file I/O with modules such as File::Slurp::WithinPolicy.  You may replace this default
       policy with one for your organisation.

FUNCTIONS
       check_safe
		   check_safe( FILENAME , MODE );

	   Checks a filename is safe - dies if not.  MODE is r (read) or w (write).  Default is no restrictions on file I/O.

       get_temp_dir
		   $temporary_directory = get_temp_dir();

	   Returns the path to temporary directory from the TEMP environment variable or File::Spec::Functions::tmpdir().  Note that any return
	   value will have been cleared of a trailing slash.

       get_log_dir
		   $log_directory = get_log_dir();

	   Returns the path to log directory from the LOGDIR environment variable or the current directory.  Note that any return value will have
	   been cleared of a trailing slash.

VERSION
       $Revision: 1.6 $ on $Date: 2005/05/18 15:57:28 $ by $Author: johna $

AUTHOR
       John Alden <cpan _at_ bbc _dot_ co _dot_ uk>

COPYRIGHT
       (c) BBC 2005. This program is free software; you can redistribute it and/or modify it under the GNU GPL.

       See the file COPYING in this distribution, or http://www.gnu.org/licenses/gpl.txt

perl v5.8.8							    2005-06-15						File::Policy::Default(3pm)