| 1 |
README for Scriptalicious |
| 2 |
~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 3 |
This is a simple little module that contains a few of the things that |
| 4 |
I just wished Perl came with for writing SysAdmin scripts. |
| 5 |
|
| 6 |
Using this module, it is very easy to write programs which more or |
| 7 |
less adhere to the GNU program conventions for well behaved programs. |
| 8 |
Things like printing the name of your program before all messages. |
| 9 |
|
| 10 |
It is suggested that you try the example in the manual page, and see |
| 11 |
how it responds to `-v', '-h', unknown switches, etc. |
| 12 |
|
| 13 |
Required Modules |
| 14 |
^^^^^^^^^^^^^^^^ |
| 15 |
Module::Build is required to build and install the module. |
| 16 |
Test::Simple is required to run the test suite. |
| 17 |
|
| 18 |
Other than this, there should be no `hard' dependancies, other than |
| 19 |
modules that come with 5.6.1. However, scripts that use this module |
| 20 |
don't show help messages without Pod::Constants. |
| 21 |
|
| 22 |
Recommended Modules |
| 23 |
^^^^^^^^^^^^^^^^^^^ |
| 24 |
If you want the scripts that use this module to display their help |
| 25 |
messages, you need to install Pod::Constants, which requires |
| 26 |
Pod::Parser (which should be standard with recent Perls). |
| 27 |
|
| 28 |
If you don't, you can still use `perldoc foo.pl' on the installed |
| 29 |
scripts, so it's still better than nothing. |
| 30 |
|
| 31 |
You will need the YAML module for the nifty new getopt-style YAML |
| 32 |
config file processor. |
| 33 |
|
| 34 |
Optional Modules |
| 35 |
^^^^^^^^^^^^^^^^ |
| 36 |
If you want your help screens to look nice with all terminal sizes, |
| 37 |
you will need Term::ReadKey. |
| 38 |
|
| 39 |
If you want accurate timing information about how long programs take |
| 40 |
to execute when you use `-v', you will need Time::HiRes installed. |
| 41 |
|
| 42 |
Installation instructions |
| 43 |
^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 44 |
Once you have satisfied yourself that you have installed Module::Build and and the recommended and |
| 45 |
enough to satisfy your hunger for modules, you should To install this |
| 46 |
module. |
| 47 |
|
| 48 |
perl Build.PL |
| 49 |
./Build test |
| 50 |
./Build install |
| 51 |
|