Seth Woolley's Man Viewer

ctime(3) - asctime, asctime_r, ctime, ctime_r, gmtime, gmtime_r, localtime, localtime_r, mktime, asctime, asctime_r, ctime, ctime_r, gmtime, gmtime_r, localtime, localtime_r, mktime - transform date and time to broken-down time or ASCII - man 3 ctime

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

CTIME(3)                   Linux Programmer's Manual                  CTIME(3)



NAME
       asctime,   ctime,   gmtime,   localtime,  mktime,  asctime_r,  ctime_r,
       gmtime_r, localtime_r - transform date and time(1,2,n) to broken-down time(1,2,n)  or
       ASCII

SYNOPSIS
       #include <time.h>

       char *asctime(const struct tm *tm);
       char *asctime_r(const struct tm *tm, char *buf);

       char *ctime(const time_t *timep);
       char *ctime_r(const time_t *timep, char *buf);

       struct tm *gmtime(const time_t *timep);
       struct tm *gmtime_r(const time_t *timep, struct tm *result);

       struct tm *localtime(const time_t *timep);
       struct tm *localtime_r(const time_t *timep, struct tm *result);

       time_t mktime(struct tm *tm);

DESCRIPTION
       The ctime(), gmtime() and localtime() functions all take an argument of
       data type time_t which represents calendar time.  When  interpreted  as
       an  absolute  time(1,2,n)  value,  it represents the number of seconds elapsed
       since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC).

       The asctime() and mktime() functions both take an argument representing
       broken-down  time(1,2,n) which is a representation separated into year, month,
       day, etc.

       Broken-down time(1,2,n) is stored in(1,8) the structure  tm  which  is  defined  in(1,8)
       <time.h> as follows:

              struct tm {
                      int     tm_sec;         /* seconds */
                      int     tm_min;         /* minutes */
                      int     tm_hour;        /* hours */
                      int     tm_mday;        /* day of the month */
                      int     tm_mon;         /* month */
                      int     tm_year;        /* year */
                      int     tm_wday;        /* day of the week */
                      int     tm_yday;        /* day in(1,8) the year */
                      int     tm_isdst;       /* daylight saving time(1,2,n) */
              };

       The members of the tm structure are:

       tm_sec The  number of seconds after the minute, normally in(1,8) the range 0
              to 59, but can be up to 61 to allow for leap seconds.

       tm_min The number of minutes after the hour, in(1,8) the range 0 to 59.

       tm_hour
              The number of hours past midnight, in(1,8) the range 0 to 23.

       tm_mday
              The day of the month, in(1,8) the range 1 to 31.

       tm_mon The number of months since January, in(1,8) the range 0 to 11.

       tm_year
              The number of years since 1900.

       tm_wday
              The number of days since Sunday, in(1,8) the range 0 to 6.

       tm_yday
              The number of days since January 1, in(1,8) the range 0 to 365.

       tm_isdst
              A flag that indicates whether daylight saving time(1,2,n) is in(1,8)  effect
              at the time(1,2,n) described.  The value is positive if(3,n) daylight saving
              time(1,2,n) is in(1,8) effect, zero if(3,n) it is not, and negative if(3,n) the infor-
              mation is not available.

       The  call ctime(t) is equivalent to asctime(localtime(t)).  It converts
       the calendar time(1,2,n) t into a string(3,n) of the form

              "Wed Jun 30 21:49:08 1993\n"

       The abbreviations for the days of the week  are  `Sun',  `Mon',  `Tue',
       `Wed',  `Thu',  `Fri', and `Sat'.  The abbreviations for the months are
       `Jan', `Feb', `Mar', `Apr', `May', `Jun', `Jul', `Aug',  `Sep',  `Oct',
       `Nov',  and  `Dec'.   The return value points to a statically allocated
       string(3,n) which might be overwritten by subsequent calls  to  any  of  the
       date  and time(1,2,n) functions.  The function also sets the external variable
       tzname (see tzset(3)) with information about  the  current  time(1,2,n)  zone.
       The  re-entrant  version(1,3,5) ctime_r() does the same, but stores the string(3,n)
       in(1,8) a user-supplied buffer of length  at  least  26.  It  need  not  set(7,n,1 builtins)
       tzname.

       The  gmtime()  function converts the calendar time(1,2,n) timep to broken-down
       time(1,2,n) representation, expressed in(1,8) Coordinated Universal Time (UTC).  It
       may return NULL when the year does not fit into an integer.  The return
       value points to a statically allocated struct which might be  overwrit-
       ten  by  subsequent  calls  to any of the date and time(1,2,n) functions.  The
       gmtime_r() function does the same, but stores the data in(1,8)  a  user-sup-
       plied struct.

       The  localtime()  function  converts the calendar time(1,2,n) timep to broken-
       time(1,2,n) representation, expressed relative to the  user's  specified  time(1,2,n)
       zone.    The function acts as if(3,n) it called tzset(3) and sets the exter-
       nal variables tzname with information  about  the  current  time(1,2,n)  zone,
       timezone  with  the difference between Coordinated Universal Time (UTC)
       and local standard time(1,2,n) in(1,8) seconds, and daylight to a non-zero value if(3,n)
       daylight  savings  time(1,2,n)  rules apply during some part of the year.  The
       return value points to a statically allocated  struct  which  might  be
       overwritten  by subsequent calls to any of the date and time(1,2,n) functions.
       The localtime_r() function does the same, but  stores  the  data  in(1,8)  a
       user-supplied struct. It need not set(7,n,1 builtins) tzname.

       The  asctime()  function  converts the broken-down time(1,2,n) value tm into a
       string(3,n) with the same format as ctime().  The return value points  to  a
       statically  allocated  string(3,n)  which might be overwritten by subsequent
       calls to any of the date and time(1,2,n) functions.  The asctime_r()  function
       does  the  same,  but  stores  the  string(3,n) in(1,8) a user-supplied buffer of
       length at least 26.

       The mktime() function converts a broken-down time(1,2,n) structure,  expressed
       as  local  time(1,2,n), to calendar time(1,2,n) representation.  The function ignores
       the specified contents of the structure members tm_wday and tm_yday and
       recomputes  them  from  the  other  information in(1,8) the broken-down time(1,2,n)
       structure.  If structure members are outside their legal interval, they
       will  be normalized (so that, e.g., 40 October is changed into 9 Novem-
       ber).  Calling mktime() also sets the  external  variable  tzname  with
       information  about the current time(1,2,n) zone.  If the specified broken-down
       time(1,2,n) cannot be represented as calendar time(1,2,n) (seconds since the  epoch),
       mktime() returns a value of (time_t)(-1) and does not alter the tm_wday
       and tm_yday members of the broken-down time(1,2,n) structure.

RETURN VALUE
       Each of these functions returns the value described,  or  NULL  (-1  in(1,8)
       case of mktime()) in(1,8) case an error(8,n) was detected.

NOTES
       The  four functions asctime(), ctime(), gmtime() and localtime() return
       a pointer to static data and hence are  not  thread-safe.   Thread-safe
       versions asctime_r(), ctime_r(), gmtime_r() and localtime_r() are spec-
       ified by SUSv2, and available since libc 5.2.5.

       The glibc version(1,3,5) of struct tm has additional fields

              long tm_gmtoff;           /* Seconds east of UTC */
              const char *tm_zone;      /* Timezone abbreviation */

       defined when _BSD_SOURCE was set(7,n,1 builtins) before including <time.h>.  This is  a
       BSD extension, present in(1,8) 4.3BSD-Reno.

CONFORMING TO
       SVID 3, POSIX, BSD 4.3, ISO 9899

SEE ALSO
       date(1),  gettimeofday(2),  time(1,2,n)(2),  utime(2),  clock(3,n)(3), difftime(3),
       newctime(3), strftime(3), strptime(3), tzset(3)



                                  2001-12-13                          CTIME(3)

References for this manual (incoming links)