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