| 1 |
File::Policy v1.005 |
| 2 |
|
| 3 |
(c) BBC 2004. This program is free software; you can redistribute it and/or modify it under the GNU GPL. |
| 4 |
|
| 5 |
See the file COPYING in this distribution, or http://www.gnu.org/licenses/gpl.txt |
| 6 |
|
| 7 |
QUICK START: |
| 8 |
|
| 9 |
Install File::Policy by unpacking the tarball and running the following |
| 10 |
commands in the source directory: |
| 11 |
|
| 12 |
perl Makefile.PL |
| 13 |
make |
| 14 |
make test |
| 15 |
make install |
| 16 |
Then delete the source directory tree since it's no longer needed. |
| 17 |
|
| 18 |
By using File::Policy (or File::Slurp::WithinPolicy) in your code you get File::Policy::Default by, erm, default. |
| 19 |
This imposes no restrictions on filepaths, but does provide reasonable default temp and log dirs for you. |
| 20 |
See the POD for File::Policy::Default to see how these paths are determined. |
| 21 |
|
| 22 |
To implement your own custom policy |
| 23 |
cp File/Policy/Default.pm File/Policy/YourPolicy.pm |
| 24 |
and modify YourPolicy accordingly. |
| 25 |
|
| 26 |
Then, create a file File/Policy/Config.pm with: |
| 27 |
|
| 28 |
use constant IMPLEMENTATION => 'YourPolicy'; |
| 29 |
|
| 30 |
run 'perldoc File::Policy' to read the full documentation. |
| 31 |
|
| 32 |
SAMPLE: |
| 33 |
|
| 34 |
See samples/lib/File/Policy/Simple.pm for an example of a custom policy. |
| 35 |
|
| 36 |
DEPENDENCIES: |
| 37 |
|
| 38 |
Pod::Test and Pod::Test::Coverage are used by two of the unit tests if present |
| 39 |
- otherwise these 2 tests should skip gracefully. Tests require Test::Assertions and Log::Trace |
| 40 |
which is why these are listed in the PREREQ_PM in Makefile.PL. |