* Use id(1) instead of grep(1) to detect the presence of the smmsp
[dragonfly.git] / lib / libcr / stdtime / ctime.3
1 .\" Copyright (c) 1989, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Arthur Olson.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgement:
16 .\"     This product includes software developed by the University of
17 .\"     California, Berkeley and its contributors.
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\"    may be used to endorse or promote products derived from this software
20 .\"    without specific prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" SUCH DAMAGE.
33 .\"
34 .\"     From: @(#)ctime.3       8.1 (Berkeley) 6/4/93
35 .\" $FreeBSD: src/lib/libc/stdtime/ctime.3,v 1.11.2.7 2003/05/23 23:53:40 keramida Exp $
36 .\" $DragonFly: src/lib/libcr/stdtime/Attic/ctime.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
37 .\"
38 .Dd January 2, 1999
39 .Dt CTIME 3
40 .Os
41 .Sh NAME
42 .Nm asctime ,
43 .Nm asctime_r ,
44 .Nm ctime ,
45 .Nm ctime_r ,
46 .Nm difftime ,
47 .Nm gmtime ,
48 .Nm gmtime_r ,
49 .Nm localtime ,
50 .Nm localtime_r ,
51 .Nm mktime ,
52 .Nm timegm
53 .Nd transform binary date and time values
54 .Sh LIBRARY
55 .Lb libc
56 .Sh SYNOPSIS
57 .In time.h
58 .Vt extern char *tzname[2] ;
59 .Ft char *
60 .Fn ctime "const time_t *clock"
61 .Ft double
62 .Fn difftime "time_t time1" "time_t time0"
63 .Ft char *
64 .Fn asctime "const struct tm *tm"
65 .Ft struct tm *
66 .Fn localtime "const time_t *clock"
67 .Ft struct tm *
68 .Fn gmtime "const time_t *clock"
69 .Ft time_t
70 .Fn mktime "struct tm *tm"
71 .Ft time_t
72 .Fn timegm "struct tm *tm"
73 .Ft char *
74 .Fn ctime_r "const time_t *clock" "char *buf"
75 .Ft struct tm *
76 .Fn localtime_r "const time_t *clock" "struct tm *result"
77 .Ft struct tm *
78 .Fn gmtime_r "const time_t *clock" "struct tm *result"
79 .Ft char *
80 .Fn asctime_r "const struct tm *tm" "char *buf"
81 .Sh DESCRIPTION
82 The functions
83 .Fn ctime ,
84 .Fn gmtime
85 and
86 .Fn localtime
87 all take as an argument a time value representing the time in seconds since
88 the Epoch (00:00:00
89 .Tn UTC ,
90 January 1, 1970; see
91 .Xr time 3 ) .
92 .Pp
93 The function
94 .Fn localtime
95 converts the time value pointed at by
96 .Fa clock ,
97 and returns a pointer to a
98 .Dq Fa struct tm
99 (described below) which contains
100 the broken-out time information for the value after adjusting for the current
101 time zone (and any other factors such as Daylight Saving Time).
102 Time zone adjustments are performed as specified by the
103 .Ev TZ
104 environment variable (see
105 .Xr tzset 3 ) .
106 The function
107 .Fn localtime
108 uses
109 .Xr tzset 3
110 to initialize time conversion information if
111 .Xr tzset 3
112 has not already been called by the process.
113 .Pp
114 After filling in the tm structure,
115 .Fn localtime
116 sets the
117 .Fa tm_isdst Ns 'th
118 element of
119 .Fa tzname
120 to a pointer to an
121 .Tn ASCII
122 string that's the time zone abbreviation to be
123 used with
124 .Fn localtime Ns 's
125 return value.
126 .Pp
127 The function
128 .Fn gmtime
129 similarly converts the time value, but without any time zone adjustment,
130 and returns a pointer to a tm structure (described below).
131 .Pp
132 The
133 .Fn ctime
134 function
135 adjusts the time value for the current time zone in the same manner as
136 .Fn localtime ,
137 and returns a pointer to a 26-character string of the form:
138 .Bd -literal -offset indent
139 Thu Nov 24 18:22:48 1986\en\e0
140 .Ed
141 .Pp
142 All the fields have constant width.
143 .Pp
144 The
145 .Fn ctime_r
146 function
147 provides the same functionality as
148 .Fn ctime
149 except the caller must provide the output buffer
150 .Fa buf
151 to store the result, which must be at least 26 characters long.
152 The
153 .Fn localtime_r
154 and
155 .Fn gmtime_r
156 functions
157 provide the same functionality as
158 .Fn localtime
159 and
160 .Fn gmtime
161 respectively, except the caller must provide the output buffer
162 .Fa result .
163 .Pp
164 The
165 .Fn asctime
166 function
167 converts the broken down time in the structure
168 .Fa tm
169 pointed at by
170 .Fa *tm
171 to the form
172 shown in the example above.
173 .Pp
174 The
175 .Fn asctime_r
176 function
177 provides the same functionality as
178 .Fn asctime
179 except the caller provide the output buffer
180 .Fa buf
181 to store the result, which must be at least 26 characters long.
182 .Pp
183 The functions
184 .Fn mktime
185 and
186 .Fn timegm
187 convert the broken-down time in the structure
188 pointed to by tm into a time value with the same encoding as that of the
189 values returned by the
190 .Xr time 3
191 function (that is, seconds from the Epoch,
192 .Tn UTC ) .
193 The
194 .Fn mktime
195 function
196 interprets the input structure according to the current timezone setting
197 (see
198 .Xr tzset 3 ) .
199 The
200 .Fn timegm
201 function
202 interprets the input structure as representing Universal Coordinated Time
203 .Pq Tn UTC .
204 .Pp
205 The original values of the
206 .Fa tm_wday
207 and
208 .Fa tm_yday
209 components of the structure are ignored, and the original values of the
210 other components are not restricted to their normal ranges, and will be
211 normalized if needed.
212 For example,
213 October 40 is changed into November 9,
214 a
215 .Fa tm_hour
216 of \-1 means 1 hour before midnight,
217 .Fa tm_mday
218 of 0 means the day preceding the current month, and
219 .Fa tm_mon
220 of \-2 means 2 months before January of
221 .Fa tm_year .
222 (A positive or zero value for
223 .Fa tm_isdst
224 causes
225 .Fn mktime
226 to presume initially that summer time (for example, Daylight Saving Time)
227 is or is not in effect for the specified time, respectively.
228 A negative value for
229 .Fa tm_isdst
230 causes the
231 .Fn mktime
232 function to attempt to divine whether summer time is in effect for the
233 specified time.
234 The
235 .Fa tm_isdst
236 and
237 .Fa tm_gmtoff
238 members are forced to zero by
239 .Fn timegm . )
240 .Pp
241 On successful completion, the values of the
242 .Fa tm_wday
243 and
244 .Fa tm_yday
245 components of the structure are set appropriately, and the other components
246 are set to represent the specified calendar time, but with their values
247 forced to their normal ranges; the final value of
248 .Fa tm_mday
249 is not set until
250 .Fa tm_mon
251 and
252 .Fa tm_year
253 are determined.
254 The
255 .Fn mktime
256 function
257 returns the specified calendar time; if the calendar time cannot be
258 represented, it returns \-1;
259 .Pp
260 The
261 .Fn difftime
262 function
263 returns the difference between two calendar times,
264 .Pf ( Fa time1
265 -
266 .Fa time0 ) ,
267 expressed in seconds.
268 .Pp
269 External declarations as well as the tm structure definition are in the
270 .Aq Pa time.h
271 include file.
272 The tm structure includes at least the following fields:
273 .Bd -literal -offset indent
274 int tm_sec;     /\(** seconds (0 - 60) \(**/
275 int tm_min;     /\(** minutes (0 - 59) \(**/
276 int tm_hour;    /\(** hours (0 - 23) \(**/
277 int tm_mday;    /\(** day of month (1 - 31) \(**/
278 int tm_mon;     /\(** month of year (0 - 11) \(**/
279 int tm_year;    /\(** year \- 1900 \(**/
280 int tm_wday;    /\(** day of week (Sunday = 0) \(**/
281 int tm_yday;    /\(** day of year (0 - 365) \(**/
282 int tm_isdst;   /\(** is summer time in effect? \(**/
283 char \(**tm_zone;       /\(** abbreviation of timezone name \(**/
284 long tm_gmtoff; /\(** offset from UTC in seconds \(**/
285 .Ed
286 .Pp
287 The
288 field
289 .Fa tm_isdst
290 is non-zero if summer time is in effect.
291 .Pp
292 The field
293 .Fa tm_gmtoff
294 is the offset (in seconds) of the time represented from
295 .Tn UTC ,
296 with positive
297 values indicating east of the Prime Meridian.
298 .Sh SEE ALSO
299 .Xr date 1 ,
300 .Xr gettimeofday 2 ,
301 .Xr getenv 3 ,
302 .Xr time 3 ,
303 .Xr tzset 3 ,
304 .Xr tzfile 5
305 .Sh STANDARDS
306 The
307 .Fn asctime ,
308 .Fn ctime ,
309 .Fn difftime ,
310 .Fn gmtime ,
311 .Fn localtime ,
312 and
313 .Fn mktime
314 functions conform to
315 .St -isoC ,
316 and conform to
317 .St -p1003.1-96
318 provided the selected local timezone does not contain a leap-second table
319 (see
320 .Xr zic 8 ) .
321 .Pp
322 The
323 .Fn asctime_r ,
324 .Fn ctime_r ,
325 .Fn gmtime_r ,
326 and
327 .Fn localtime_r
328 functions are expected to conform to
329 .St -p1003.1-96
330 (again provided the selected local timezone does not contain a leap-second
331 table).
332 .Pp
333 The
334 .Fn timegm
335 function is not specified by any standard; its function cannot be
336 completely emulated using the standard functions described above.
337 .Sh HISTORY
338 This manual page is derived from
339 the time package contributed to Berkeley by
340 .An Arthur Olson
341 and which appeared in
342 .Bx 4.3 .
343 .Sh BUGS
344 Except for
345 .Fn difftime ,
346 .Fn mktime ,
347 and the
348 .Fn \&_r
349 variants of the other functions,
350 these functions leaves their result in an internal static object and return
351 a pointer to that object.
352 Subsequent calls to these
353 function will modify the same object.
354 .Pp
355 The C Standard provides no mechanism for a program to modify its current
356 local timezone setting, and the
357 .Tn POSIX Ns No \&-standard
358 method is not reentrant.  (However, thread-safe implementations are provided
359 in the
360 .Tn POSIX
361 threaded environment.)
362 .Pp
363 The
364 .Va tm_zone
365 field of a returned
366 .Vt tm
367 structure points to a static array of characters,
368 which will also be overwritten by any subsequent calls (as well as by
369 subsequent calls to
370 .Xr tzset 3
371 and
372 .Xr tzsetwall 3 ) .
373 .Pp
374 Use of the external variable
375 .Fa tzname
376 is discouraged; the
377 .Fa tm_zone
378 entry in the tm structure is preferred.