Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 |
2 | .\" | |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sh \" Subsection heading | |
6 | .br | |
7 | .if t .Sp | |
8 | .ne 5 | |
9 | .PP | |
10 | \fB\\$1\fR | |
11 | .PP | |
12 | .. | |
13 | .de Sp \" Vertical space (when we can't use .PP) | |
14 | .if t .sp .5v | |
15 | .if n .sp | |
16 | .. | |
17 | .de Vb \" Begin verbatim text | |
18 | .ft CW | |
19 | .nf | |
20 | .ne \\$1 | |
21 | .. | |
22 | .de Ve \" End verbatim text | |
23 | .ft R | |
24 | .fi | |
25 | .. | |
26 | .\" Set up some character translations and predefined strings. \*(-- will | |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to | |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' | |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. | |
32 | .tr \(*W-|\(bv\*(Tr | |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
34 | .ie n \{\ | |
35 | . ds -- \(*W- | |
36 | . ds PI pi | |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
39 | . ds L" "" | |
40 | . ds R" "" | |
41 | . ds C` "" | |
42 | . ds C' "" | |
43 | 'br\} | |
44 | .el\{\ | |
45 | . ds -- \|\(em\| | |
46 | . ds PI \(*p | |
47 | . ds L" `` | |
48 | . ds R" '' | |
49 | 'br\} | |
50 | .\" | |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
54 | .\" output yourself in some meaningful fashion. | |
55 | .if \nF \{\ | |
56 | . de IX | |
57 | . tm Index:\\$1\t\\n%\t"\\$2" | |
58 | .. | |
59 | . nr % 0 | |
60 | . rr F | |
61 | .\} | |
62 | .\" | |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
64 | .\" way too many mistakes in technical documents. | |
65 | .hy 0 | |
66 | .if n .na | |
67 | .\" | |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
70 | . \" fudge factors for nroff and troff | |
71 | .if n \{\ | |
72 | . ds #H 0 | |
73 | . ds #V .8m | |
74 | . ds #F .3m | |
75 | . ds #[ \f1 | |
76 | . ds #] \fP | |
77 | .\} | |
78 | .if t \{\ | |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
80 | . ds #V .6m | |
81 | . ds #F 0 | |
82 | . ds #[ \& | |
83 | . ds #] \& | |
84 | .\} | |
85 | . \" simple accents for nroff and troff | |
86 | .if n \{\ | |
87 | . ds ' \& | |
88 | . ds ` \& | |
89 | . ds ^ \& | |
90 | . ds , \& | |
91 | . ds ~ ~ | |
92 | . ds / | |
93 | .\} | |
94 | .if t \{\ | |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
101 | .\} | |
102 | . \" troff and (daisy-wheel) nroff accents | |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
110 | .ds ae a\h'-(\w'a'u*4/10)'e | |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
112 | . \" corrections for vroff | |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
115 | . \" for low resolution devices (crt and lpr) | |
116 | .if \n(.H>23 .if \n(.V>19 \ | |
117 | \{\ | |
118 | . ds : e | |
119 | . ds 8 ss | |
120 | . ds o a | |
121 | . ds d- d\h'-1'\(ga | |
122 | . ds D- D\h'-1'\(hy | |
123 | . ds th \o'bp' | |
124 | . ds Th \o'LP' | |
125 | . ds ae ae | |
126 | . ds Ae AE | |
127 | .\} | |
128 | .rm #[ #] #H #V #F C | |
129 | .\" ======================================================================== | |
130 | .\" | |
131 | .IX Title "Date::Format 3" | |
132 | .TH Date::Format 3 "2002-03-07" "perl v5.8.0" "User Contributed Perl Documentation" | |
133 | .SH "NAME" | |
134 | Date::Format \- Date formating subroutines | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | .Vb 1 | |
138 | \& use Date::Format; | |
139 | .Ve | |
140 | .PP | |
141 | .Vb 1 | |
142 | \& @lt = localtime(time); | |
143 | .Ve | |
144 | .PP | |
145 | .Vb 2 | |
146 | \& print time2str($template, time); | |
147 | \& print strftime($template, @lt); | |
148 | .Ve | |
149 | .PP | |
150 | .Vb 2 | |
151 | \& print time2str($template, time, $zone); | |
152 | \& print strftime($template, @lt, $zone); | |
153 | .Ve | |
154 | .PP | |
155 | .Vb 2 | |
156 | \& print ctime(time); | |
157 | \& print asctime(@lt); | |
158 | .Ve | |
159 | .PP | |
160 | .Vb 2 | |
161 | \& print ctime(time, $zone); | |
162 | \& print asctime(@lt, $zone); | |
163 | .Ve | |
164 | .SH "DESCRIPTION" | |
165 | .IX Header "DESCRIPTION" | |
166 | This module provides routines to format dates into \s-1ASCII\s0 strings. They | |
167 | correspond to the C library routines \f(CW\*(C`strftime\*(C'\fR and \f(CW\*(C`ctime\*(C'\fR. | |
168 | .IP "time2str(\s-1TEMPLATE\s0, \s-1TIME\s0 [, \s-1ZONE\s0])" 4 | |
169 | .IX Item "time2str(TEMPLATE, TIME [, ZONE])" | |
170 | \&\f(CW\*(C`time2str\*(C'\fR converts \f(CW\*(C`TIME\*(C'\fR into an \s-1ASCII\s0 string using the conversion | |
171 | specification given in \f(CW\*(C`TEMPLATE\*(C'\fR. \f(CW\*(C`ZONE\*(C'\fR if given specifies the zone | |
172 | which the output is required to be in, \f(CW\*(C`ZONE\*(C'\fR defaults to your current zone. | |
173 | .IP "strftime(\s-1TEMPLATE\s0, \s-1TIME\s0 [, \s-1ZONE\s0])" 4 | |
174 | .IX Item "strftime(TEMPLATE, TIME [, ZONE])" | |
175 | \&\f(CW\*(C`strftime\*(C'\fR is similar to \f(CW\*(C`time2str\*(C'\fR with the exception that the time is | |
176 | passed as an array, such as the array returned by \f(CW\*(C`localtime\*(C'\fR. | |
177 | .IP "ctime(\s-1TIME\s0 [, \s-1ZONE\s0])" 4 | |
178 | .IX Item "ctime(TIME [, ZONE])" | |
179 | \&\f(CW\*(C`ctime\*(C'\fR calls \f(CW\*(C`time2str\*(C'\fR with the given arguments using the | |
180 | conversion specification \f(CW"%a %b %e %T %Y\en"\fR | |
181 | .IP "asctime(\s-1TIME\s0 [, \s-1ZONE\s0])" 4 | |
182 | .IX Item "asctime(TIME [, ZONE])" | |
183 | \&\f(CW\*(C`asctime\*(C'\fR calls \f(CW\*(C`time2str\*(C'\fR with the given arguments using the | |
184 | conversion specification \f(CW"%a %b %e %T %Y\en"\fR | |
185 | .SH "MULTI-LANGUAGE SUPPORT" | |
186 | .IX Header "MULTI-LANGUAGE SUPPORT" | |
187 | Date::Format is capable of formating into several languages, these are | |
188 | English, French, German and Italian. Changing the language is done via | |
189 | a static method call, for example | |
190 | .PP | |
191 | .Vb 1 | |
192 | \& Date::Format->language('German'); | |
193 | .Ve | |
194 | .PP | |
195 | will change the language in which all subsequent dates are formatted. | |
196 | .PP | |
197 | This is only a first pass, I am considering changing this to be | |
198 | .PP | |
199 | .Vb 2 | |
200 | \& $lang = Date::Language->new('German'); | |
201 | \& $lang->time2str("%a %b %e %T %Y\en", time); | |
202 | .Ve | |
203 | .PP | |
204 | I am open to suggestions on this. | |
205 | .SH "CONVERSION SPECIFICATION" | |
206 | .IX Header "CONVERSION SPECIFICATION" | |
207 | Each conversion specification is replaced by appropriate | |
208 | characters as described in the following list. The | |
209 | appropriate characters are determined by the \s-1LC_TIME\s0 | |
210 | category of the program's locale. | |
211 | .PP | |
212 | .Vb 39 | |
213 | \& %% PERCENT | |
214 | \& %a day of the week abbr | |
215 | \& %A day of the week | |
216 | \& %b month abbr | |
217 | \& %B month | |
218 | \& %c MM/DD/YY HH:MM:SS | |
219 | \& %C ctime format: Sat Nov 19 21:05:57 1994 | |
220 | \& %d numeric day of the month, with leading zeros (eg 01..31) | |
221 | \& %e numeric day of the month, without leading zeros (eg 1..31) | |
222 | \& %D MM/DD/YY | |
223 | \& %h month abbr | |
224 | \& %H hour, 24 hour clock, leading 0's) | |
225 | \& %I hour, 12 hour clock, leading 0's) | |
226 | \& %j day of the year | |
227 | \& %k hour | |
228 | \& %l hour, 12 hour clock | |
229 | \& %L month number, starting with 1 | |
230 | \& %m month number, starting with 01 | |
231 | \& %M minute, leading 0's | |
232 | \& %n NEWLINE | |
233 | \& %o ornate day of month -- "1st", "2nd", "25th", etc. | |
234 | \& %p AM or PM | |
235 | \& %P am or pm (Yes %p and %P are backwards :) | |
236 | \& %q Quarter number, starting with 1 | |
237 | \& %r time format: 09:05:57 PM | |
238 | \& %R time format: 21:05 | |
239 | \& %s seconds since the Epoch, UCT | |
240 | \& %S seconds, leading 0's | |
241 | \& %t TAB | |
242 | \& %T time format: 21:05:57 | |
243 | \& %U week number, Sunday as first day of week | |
244 | \& %w day of the week, numerically, Sunday == 0 | |
245 | \& %W week number, Monday as first day of week | |
246 | \& %x date format: 11/19/94 | |
247 | \& %X time format: 21:05:57 | |
248 | \& %y year (2 digits) | |
249 | \& %Y year (4 digits) | |
250 | \& %Z timezone in ascii. eg: PST | |
251 | \& %z timezone in format -/+0000 | |
252 | .Ve | |
253 | .PP | |
254 | \&\f(CW%d\fR, \f(CW%e\fR, \f(CW%H\fR, \f(CW%I\fR, \f(CW%j\fR, \f(CW%k\fR, \f(CW%l\fR, \f(CW%m\fR, \f(CW%M\fR, \f(CW%q\fR, | |
255 | \&\f(CW%y\fR and \f(CW%Y\fR can be output in Roman numerals by prefixing the letter | |
256 | with \f(CW\*(C`O\*(C'\fR, e.g. \f(CW%OY\fR will output the year as roman numerals. | |
257 | .SH "AUTHOR" | |
258 | .IX Header "AUTHOR" | |
259 | Graham Barr <gbarr@pobox.com> | |
260 | .SH "COPYRIGHT" | |
261 | .IX Header "COPYRIGHT" | |
262 | Copyright (c) 1995\-1999 Graham Barr. All rights reserved. This program is free | |
263 | software; you can redistribute it and/or modify it under the same terms | |
264 | as Perl itself. |