Debian Codegraph @

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