Debian Codegraph @

upstream/mageia-cauldron/man3pm/Time::Seconds.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Time::Seconds 3pm"
61 .TH Time::Seconds 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Time::Seconds \- a simple API to convert seconds to other date values
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& use Time::Piece;
72 \& use Time::Seconds;
73 \&
74 \& my $t = localtime;
75 \& $t += ONE_DAY;
76 \&
77 \& my $t2 = localtime;
78 \& my $s = $t \- $t2;
79 \&
80 \& print "Difference is: ", $s\->days, "\en";
81 .Ve
82 .SH DESCRIPTION
83 .IX Header "DESCRIPTION"
84 This module is part of the Time::Piece distribution. It allows the user
85 to find out the number of minutes, hours, days, weeks or years in a given
86 number of seconds. It is returned by Time::Piece when you delta two
87 Time::Piece objects.
88 .PP
89 Time::Seconds also exports the following constants:
90 .PP
91 .Vb 9
92 \& ONE_DAY
93 \& ONE_WEEK
94 \& ONE_HOUR
95 \& ONE_MINUTE
96 \& ONE_MONTH
97 \& ONE_YEAR
98 \& ONE_FINANCIAL_MONTH
99 \& LEAP_YEAR
100 \& NON_LEAP_YEAR
101 .Ve
102 .PP
103 Since perl does not (yet?) support constant objects, these constants are in
104 seconds only, so you cannot, for example, do this: \f(CW\*(C`print ONE_WEEK\->minutes;\*(C'\fR
105 .SH METHODS
106 .IX Header "METHODS"
107 The following methods are available:
108 .PP
109 .Vb 10
110 \& my $val = Time::Seconds\->new(SECONDS)
111 \& $val\->seconds;
112 \& $val\->minutes;
113 \& $val\->hours;
114 \& $val\->days;
115 \& $val\->weeks;
116 \& $val\->months;
117 \& $val\->financial_months; # 30 days
118 \& $val\->years;
119 \& $val\->pretty; # gives English representation of the delta
120 .Ve
121 .PP
122 The usual arithmetic (+,\-,+=,\-=) is also available on the objects.
123 .PP
124 The methods make the assumption that there are 24 hours in a day, 7 days in
125 a week, 365.24225 days in a year and 12 months in a year.
126 (from The Calendar FAQ at http://www.tondering.dk/claus/calendar.html)
127 .SH AUTHOR
128 .IX Header "AUTHOR"
129 Matt Sergeant, [email protected]
130 .PP
131 Tobias Brox, [email protected]
132 .PP
133 Balázs Szabó (dLux), [email protected]
134 .SH "COPYRIGHT AND LICENSE"
135 .IX Header "COPYRIGHT AND LICENSE"
136 Copyright 2001, Larry Wall.
137 .PP
138 This module is free software, you may distribute it under the same terms
139 as Perl.
140 .SH Bugs
141 .IX Header "Bugs"
142 Currently the methods aren\*(Aqt as efficient as they could be, for reasons of
143 clarity. This is probably a bad idea.