Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Time::localtime.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::localtime 3pm"
61 .TH Time::localtime 3pm 2026-03-09 "perl v5.42.1" "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::localtime \- by\-name interface to Perl\*(Aqs built\-in localtime() function
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& use Time::localtime;
72 \& printf "Year is %d\en", localtime\->year() + 1900;
73 \&
74 \& $now = ctime();
75 \&
76 \& use Time::localtime;
77 \& use File::stat;
78 \& $date_string = ctime(stat($file)\->mtime);
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 This module\*(Aqs default exports override the core \fBlocaltime()\fR function,
83 replacing it with a version that returns "Time::tm" objects.
84 This object has methods that return the similarly named structure field
85 name from the C\*(Aqs tm structure from \fItime.h\fR; namely sec, min, hour,
86 mday, mon, year, wday, yday, and isdst.
87 .PP
88 You may also import all the structure fields directly into your namespace
89 as regular variables using the :FIELDS import tag. (Note that this still
90 overrides your core functions.) Access these fields as
91 variables named with a preceding \f(CW\*(C`tm_\*(C'\fR in front their method names.
92 Thus, \f(CW\*(C`$tm_obj\->mday()\*(C'\fR corresponds to \f(CW$tm_mday\fR if you import
93 the fields.
94 .PP
95 The \fBctime()\fR function provides a way of getting at the
96 scalar sense of the original \fBCORE::localtime()\fR function.
97 .PP
98 To access this functionality without the core overrides,
99 pass the \f(CW\*(C`use\*(C'\fR an empty import list, and then access
100 function functions with their full qualified names.
101 On the other hand, the built\-ins are still available
102 via the \f(CW\*(C`CORE::\*(C'\fR pseudo\-package.
103 .SH NOTE
104 .IX Header "NOTE"
105 While this class is currently implemented using the Class::Struct
106 module to build a struct\-like class, you shouldn\*(Aqt rely upon this.
107 .SH AUTHOR
108 .IX Header "AUTHOR"
109 Tom Christiansen