lib/libc/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 .\" $FreeBSD: src/lib/libc/stdtime/ctime.3,v 1.11.2.7 2003/05/23 23:53:40 keramida Exp $
  35 .\"
  36 .Dd October 19, 2008
  37 .Dt CTIME 3
  38 .Os
  39 .Sh NAME
  40 .Nm asctime ,
  41 .Nm asctime_r ,
  42 .Nm ctime ,
  43 .Nm ctime_r ,
  44 .Nm difftime ,
  45 .Nm gmtime ,
  46 .Nm gmtime_r ,
  47 .Nm localtime ,
  48 .Nm localtime_r ,
  49 .Nm mktime ,
  50 .Nm timegm
  51 .Nd transform binary date and time values
  52 .Sh LIBRARY
  53 .Lb libc
  54 .Sh SYNOPSIS
  55 .In time.h
  56 .Vt extern char *tzname[2] ;
  57 .Ft char *
  58 .Fn ctime "const time_t *clock"
  59 .Ft double
  60 .Fn difftime "time_t time1" "time_t time0"
  61 .Ft char *
  62 .Fn asctime "const struct tm *tm"
  63 .Ft struct tm *
  64 .Fn localtime "const time_t *clock"
  65 .Ft struct tm *
  66 .Fn gmtime "const time_t *clock"
  67 .Ft time_t
  68 .Fn mktime "struct tm *tm"
  69 .Ft time_t
  70 .Fn timegm "struct tm *tm"
  71 .Ft char *
  72 .Fn ctime_r "const time_t *clock" "char *buf"
  73 .Ft struct tm *
  74 .Fn localtime_r "const time_t *clock" "struct tm *result"
  75 .Ft struct tm *
  76 .Fn gmtime_r "const time_t *clock" "struct tm *result"
  77 .Ft char *
  78 .Fn asctime_r "const struct tm *tm" "char *buf"
  79 .Sh DESCRIPTION
  80 The functions
  81 .Fn ctime ,
  82 .Fn gmtime
  83 and
  84 .Fn localtime
  85 all take as an argument a time value representing the time in seconds since
  86 the Epoch (00:00:00
  87 .Tn UTC ,
  88 1970-01-01; see
  89 .Xr time 3 ) .
  90 .Pp
  91 The function
  92 .Fn localtime
  93 converts the time value pointed at by
  94 .Fa clock ,
  95 and returns a pointer to a
  96 .Dq Fa struct tm
  97 (described below) which contains
  98 the broken-out time information for the value after adjusting for the current
  99 time zone and any time zone adjustments.
 100 Time zone adjustments are performed as specified by the
 101 .Ev TZ
 102 environment variable (see
 103 .Xr tzset 3 ) .
 104 .Pp
 105 After filling in the tm structure,
 106 .Fn localtime
 107 sets the
 108 .Fa tm_isdst Ns 'th
 109 element of
 110 .Fa tzname
 111 to a pointer to an
 112 .Tn ASCII
 113 string that's the time zone abbreviation to be
 114 used with
 115 .Fn localtime Ns 's
 116 return value.
 117 .Pp
 118 The function
 119 .Fn gmtime
 120 similarly converts the time value, but without any time zone adjustment,
 121 and returns a pointer to a tm structure (described below).
 122 .Pp
 123 The
 124 .Fn ctime
 125 function
 126 adjusts the time value for the current time zone in the same manner as
 127 .Fn localtime ,
 128 and returns a pointer to a string of the form:
 129 .Bd -literal -offset indent
 130 Thu Nov 24 18:22:48 1986\en\e0
 131 .Ed
 132 .Pp
 133 Years requiring fewer than four characters are padded with leading zeroes.
 134 For years longer than four characters, the string is of the form
 135 .Bd -literal -offset indent
 136 Thu Nov 24 18:22:48     81986\en\e0
 137 .Ed
 138 .Pp
 139 with five spaces before the year.
 140 These unusual formats are designed to make it less likely that older
 141 software that expects exactly 26 bytes of output will mistakenly output
 142 misleading values for out-of-range years.
 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; in this case it does not use a consistent
 234 rule and may give a different answer when later
 235 presented with the same argument.
 236 The
 237 .Fa tm_isdst
 238 and
 239 .Fa tm_gmtoff
 240 members are forced to zero by
 241 .Fn timegm . )
 242 .Pp
 243 On successful completion, the values of the
 244 .Fa tm_wday
 245 and
 246 .Fa tm_yday
 247 components of the structure are set appropriately, and the other components
 248 are set to represent the specified calendar time, but with their values
 249 forced to their normal ranges; the final value of
 250 .Fa tm_mday
 251 is not set until
 252 .Fa tm_mon
 253 and
 254 .Fa tm_year
 255 are determined.
 256 The
 257 .Fn mktime
 258 function
 259 returns the specified calendar time; if the calendar time cannot be
 260 represented, it returns \-1;
 261 .Pp
 262 The
 263 .Fn difftime
 264 function
 265 returns the difference between two calendar times,
 266 .Pf ( Fa time1
 267 -
 268 .Fa time0 ) ,
 269 expressed in seconds.
 270 .Pp
 271 External declarations as well as the tm structure definition are in the
 272 .In time.h
 273 include file.
 274 The tm structure includes at least the following fields:
 275 .Bd -literal -offset indent
 276 int tm_sec;     /\(** seconds (0 - 60) \(**/
 277 int tm_min;     /\(** minutes (0 - 59) \(**/
 278 int tm_hour;    /\(** hours (0 - 23) \(**/
 279 int tm_mday;    /\(** day of month (1 - 31) \(**/
 280 int tm_mon;     /\(** month of year (0 - 11) \(**/
 281 int tm_year;    /\(** year \- 1900 \(**/
 282 int tm_wday;    /\(** day of week (Sunday = 0) \(**/
 283 int tm_yday;    /\(** day of year (0 - 365) \(**/
 284 int tm_isdst;   /\(** is summer time in effect? \(**/
 285 char \(**tm_zone;       /\(** abbreviation of timezone name \(**/
 286 long tm_gmtoff; /\(** offset from UTC in seconds \(**/
 287 .Ed
 288 .Pp
 289 The
 290 field
 291 .Fa tm_isdst
 292 is non-zero if summer time is in effect.
 293 .Pp
 294 The field
 295 .Fa tm_gmtoff
 296 is the offset (in seconds) of the time represented from
 297 .Tn UTC ,
 298 with positive
 299 values indicating east of the Prime Meridian.
 300 .Sh COMPATIBILITY
 301 The
 302 .Fn asctime
 303 and
 304 .Fn ctime
 305 functions
 306 behave strangely for years before 1000 or after 9999.
 307 The 1989 and 1999 editions of the C Standard say
 308 that years from -99 through 999 are converted without
 309 extra spaces, but this conflicts with longstanding
 310 tradition and with this implementation.
 311 Traditional implementations of these two functions are
 312 restricted to years in the range 1900 through 2099.
 313 To avoid this portability mess, new programs should use
 314 .Xr strftime 3
 315 instead.
 316 .Sh SEE ALSO
 317 .Xr date 1 ,
 318 .Xr gettimeofday 2 ,
 319 .Xr getenv 3 ,
 320 .Xr strftime 3 ,
 321 .Xr time 3 ,
 322 .Xr tzset 3 ,
 323 .Xr tzfile 5
 324 .Sh STANDARDS
 325 The
 326 .Fn asctime ,
 327 .Fn ctime ,
 328 .Fn difftime ,
 329 .Fn gmtime ,
 330 .Fn localtime ,
 331 and
 332 .Fn mktime
 333 functions conform to
 334 .St -isoC ,
 335 and conform to
 336 .St -p1003.1-96
 337 provided the selected local timezone does not contain a leap-second table
 338 (see
 339 .Xr zic 8 ) .
 340 .Pp
 341 The
 342 .Fn asctime_r ,
 343 .Fn ctime_r ,
 344 .Fn gmtime_r ,
 345 and
 346 .Fn localtime_r
 347 functions are expected to conform to
 348 .St -p1003.1-96
 349 (again provided the selected local timezone does not contain a leap-second
 350 table).
 351 .Pp
 352 The
 353 .Fn timegm
 354 function is not specified by any standard; its function cannot be
 355 completely emulated using the standard functions described above.
 356 .Sh HISTORY
 357 This manual page is derived from
 358 the time package contributed to Berkeley by
 359 .An Arthur Olson
 360 and which appeared in
 361 .Bx 4.3 .
 362 .Sh BUGS
 363 Except for
 364 .Fn difftime ,
 365 .Fn mktime ,
 366 and the
 367 .Fn \&_r
 368 variants of the other functions,
 369 these functions leaves their result in an internal static object and return
 370 a pointer to that object.
 371 Subsequent calls to these
 372 function will modify the same object.
 373 .Pp
 374 The C Standard provides no mechanism for a program to modify its current
 375 local timezone setting, and the
 376 .Tn POSIX Ns No \&-standard
 377 method is not reentrant.  (However, thread-safe implementations are provided
 378 in the
 379 .Tn POSIX
 380 threaded environment.)
 381 .Pp
 382 The
 383 .Va tm_zone
 384 field of a returned
 385 .Vt tm
 386 structure points to a static array of characters,
 387 which will also be overwritten by any subsequent calls (as well as by
 388 subsequent calls to
 389 .Xr tzset 3
 390 and
 391 .Xr tzsetwall 3 ) .
 392 .Pp
 393 Use of the external variable
 394 .Fa tzname
 395 is discouraged; the
 396 .Fa tm_zone
 397 entry in the tm structure is preferred.