| 1 |
README for the Perl Module Time::Period |
| 2 |
|
| 3 |
|
| 4 |
Copyright (c) 1997 Patrick Ryan. All rights reserved. |
| 5 |
|
| 6 |
This Perl module uses the conditions given by Perl. This module may only |
| 7 |
be distributed and or modified under the conditions given by Perl. |
| 8 |
|
| 9 |
|
| 10 |
----------------- |
| 11 |
Document Contents |
| 12 |
----------------- |
| 13 |
|
| 14 |
- Document Contents |
| 15 |
- Overview |
| 16 |
- Getting the Distribution |
| 17 |
- Installation of the Module |
| 18 |
- Using the Module |
| 19 |
- Contacting the Author |
| 20 |
- Removing the Module |
| 21 |
|
| 22 |
|
| 23 |
-------- |
| 24 |
Overview |
| 25 |
-------- |
| 26 |
|
| 27 |
Period.pm is a Perl module that contains code to deal with time periods. |
| 28 |
Currently, there is only a function in this module. That function is |
| 29 |
called inPeriod(). |
| 30 |
|
| 31 |
inPeriod() determines if a given time is within a given time period. |
| 32 |
It will return 1 if it is, 0 if not, and -1 if either the time or the |
| 33 |
period passed to it were malformed. The time is specified in non-leap |
| 34 |
year seconds past January 1, 1970, as per the time() function. The period |
| 35 |
is a string which is of the form described in Period's man page. |
| 36 |
|
| 37 |
|
| 38 |
------------------------ |
| 39 |
Getting the Distribution |
| 40 |
------------------------ |
| 41 |
|
| 42 |
This distribution can be retrieved at from CPAN at |
| 43 |
<URL=http://www.perl.com/CPAN/modules/by-module/Time/>. |
| 44 |
|
| 45 |
|
| 46 |
-------------------------- |
| 47 |
Installation of the Module |
| 48 |
-------------------------- |
| 49 |
|
| 50 |
Make sure the user executing this has sufficient permissions to add and |
| 51 |
modify files in the global perl installation. The user should use this |
| 52 |
sequence to install this module. |
| 53 |
|
| 54 |
perl Makefile.PL |
| 55 |
make |
| 56 |
make install |
| 57 |
make realclean |
| 58 |
|
| 59 |
|
| 60 |
---------------- |
| 61 |
Using the Module |
| 62 |
---------------- |
| 63 |
|
| 64 |
The module is simple to use. It is fully documented with pod |
| 65 |
documentation. To read it, execute |
| 66 |
|
| 67 |
perldoc Time::Period |
| 68 |
|
| 69 |
after the module is installed. |
| 70 |
|
| 71 |
A HTML version of the pod documentation is included in the distribution. |
| 72 |
It was created with pod2html, which comes with Perl. |
| 73 |
|
| 74 |
|
| 75 |
--------------------- |
| 76 |
Contacting the Author |
| 77 |
--------------------- |
| 78 |
|
| 79 |
I welcome any feedback on this module. If you have comments, questions, |
| 80 |
or ideas, feel free to send them to me, Patrick Ryan, [email protected]. |
| 81 |
|
| 82 |
|
| 83 |
------------------- |
| 84 |
Removing the Module |
| 85 |
------------------- |
| 86 |
|
| 87 |
Under a user with sufficient permissions and from the Period distribution |
| 88 |
directory, execute |
| 89 |
|
| 90 |
perl Makefile.PL |
| 91 |
|
| 92 |
if there isn't a file called Makefile. Then execute |
| 93 |
|
| 94 |
make uninstall |
| 95 |
|