Debian Codegraph @

upstream/debian-unstable/man3/Time::Seconds.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "Time::Seconds 3perl"
58 .TH Time::Seconds 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Time::Seconds \- a simple API to convert seconds to other date values
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 2
68 \& use Time::Piece;
69 \& use Time::Seconds;
70 \&
71 \& my $t = localtime;
72 \& $t += ONE_DAY;
73 \&
74 \& my $t2 = localtime;
75 \& my $s = $t \- $t2;
76 \&
77 \& print "Difference is: ", $s\->days, "\en";
78 .Ve
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 This module is part of the Time::Piece distribution. It allows the user
82 to find out the number of minutes, hours, days, weeks or years in a given
83 number of seconds. It is returned by Time::Piece when you delta two
84 Time::Piece objects.
85 .PP
86 Time::Seconds also exports the following constants:
87 .PP
88 .Vb 9
89 \& ONE_DAY
90 \& ONE_WEEK
91 \& ONE_HOUR
92 \& ONE_MINUTE
93 \& ONE_MONTH
94 \& ONE_YEAR
95 \& ONE_FINANCIAL_MONTH
96 \& LEAP_YEAR
97 \& NON_LEAP_YEAR
98 .Ve
99 .PP
100 Since perl does not (yet?) support constant objects, these constants are in
101 seconds only, so you cannot, for example, do this: \f(CW\*(C`print ONE_WEEK\->minutes;\*(C'\fR
102 .SH METHODS
103 .IX Header "METHODS"
104 The following methods are available:
105 .PP
106 .Vb 10
107 \& my $val = Time::Seconds\->new(SECONDS)
108 \& $val\->seconds;
109 \& $val\->minutes;
110 \& $val\->hours;
111 \& $val\->days;
112 \& $val\->weeks;
113 \& $val\->months;
114 \& $val\->financial_months; # 30 days
115 \& $val\->years;
116 \& $val\->pretty; # gives English representation of the delta
117 .Ve
118 .PP
119 The usual arithmetic (+,\-,+=,\-=) is also available on the objects.
120 .PP
121 The methods make the assumption that there are 24 hours in a day, 7 days in
122 a week, 365.24225 days in a year and 12 months in a year.
123 (from The Calendar FAQ at http://www.tondering.dk/claus/calendar.html)
124 .SH AUTHOR
125 .IX Header "AUTHOR"
126 Matt Sergeant, [email protected]
127 .PP
128 Tobias Brox, [email protected]
129 .PP
130 Balázs Szabó (dLux), [email protected]
131 .SH "COPYRIGHT AND LICENSE"
132 .IX Header "COPYRIGHT AND LICENSE"
133 Copyright 2001, Larry Wall.
134 .PP
135 This module is free software, you may distribute it under the same terms
136 as Perl.
137 .SH Bugs
138 .IX Header "Bugs"
139 Currently the methods aren't as efficient as they could be, for reasons of
140 clarity. This is probably a bad idea.