home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / bbs / gnu / ixemul-39.47-env-bin.lha / man / cat3 / ctime.0 < prev    next >
Encoding:
Text File  |  1993-12-07  |  6.6 KB  |  199 lines
  1.  
  2. CTIME(3)                   UNIX Programmer's Manual                   CTIME(3)
  3.  
  4. NNAAMMEE
  5.      aassccttiimmee, ccttiimmee, ddiiffffttiimmee, ggmmttiimmee, llooccaallttiimmee, mmkkttiimmee - transform binary
  6.      date and time value to ASCII
  7.  
  8. SSYYNNOOPPSSIISS
  9.      ##iinncclluuddee <<ssyyss//ttyyppeess..hh>>
  10.  
  11.      _e_x_t_e_r_n _c_h_a_r _*_t_z_n_a_m_e_[_2_]_;
  12.  
  13.      _c_h_a_r _*
  14.      ccttiimmee(_c_o_n_s_t _t_i_m_e___t _*_c_l_o_c_k)
  15.  
  16.      _d_o_u_b_l_e
  17.      ddiiffffttiimmee(_t_i_m_e___t _t_i_m_e_1, _t_i_m_e___t _t_i_m_e_0)
  18.  
  19.      ##iinncclluuddee <<ttiimmee..hh>>
  20.  
  21.      _c_h_a_r _*
  22.      aassccttiimmee(_c_o_n_s_t _s_t_r_u_c_t _t_m _*_t_m)
  23.  
  24.      _s_t_r_u_c_t _t_m _*
  25.      llooccaallttiimmee(_c_o_n_s_t _t_i_m_e___t _*_c_l_o_c_k)
  26.  
  27.      _s_t_r_u_c_t _t_m _*
  28.      ggmmttiimmee(_c_o_n_s_t _t_i_m_e___t _*_c_l_o_c_k)
  29.  
  30.      _t_i_m_e___t
  31.      mmkkttiimmee(_s_t_r_u_c_t _t_m _*_t_m)
  32.  
  33. DDEESSCCRRIIPPTTIIOONN
  34.      The functions ccttiimmee(), ggmmttiimmee() and llooccaallttiimmee() all take as an argument a
  35.      time value representing the time in seconds since the Epoch (00:00:00
  36.      UTC, January 1, 1970; see time(3)).
  37.  
  38.      The function llooccaallttiimmee() converts the time value pointed at by _c_l_o_c_k, and
  39.      returns a pointer to a ``_s_t_r_u_c_t _t_m'' (described below) which contains the
  40.      broken­out time information for the value after adjusting for the current
  41.      time zone (and any other factors such as Daylight Saving Time).  Time
  42.      zone adjustments are performed as specified by the TZ environmental vari­
  43.      able (see tzset(3)).  The function llooccaallttiimmee() uses tzset to initialize
  44.      time conversion information if tzset has not already been called by the
  45.      process.
  46.  
  47.      After filling in the tm structure, llooccaallttiimmee() sets the _t_m___i_s_d_s_t'th ele­
  48.      ment of _t_z_n_a_m_e to a pointer to an ASCII string that's the time zone ab­
  49.      breviation to be used with llooccaallttiimmee()'s return value.
  50.  
  51.      The function ggmmttiimmee() similarly converts the time value, but without any
  52.      time zone adjustment, and returns a pointer to a tm structure (described
  53.      below).
  54.  
  55.      The ccttiimmee() function adjusts the time value for the current time zone in
  56.      the same manner as llooccaallttiimmee(), and returns a pointer to a 26­character
  57.      string of the form:
  58.  
  59.            Thu Nov 24 18:22:48 1986\n\0
  60.  
  61.      All the fields have constant width.
  62.  
  63.      The aassccttiimmee() function converts the broken down time in the structure _t_m
  64.      pointed at by _*_t_m to the form shown in the example above.
  65.  
  66.  
  67.      The function mmkkttiimmee() converts the broken­down time, expressed as local
  68.      time, in the structure pointed to by tm into a time value with the same
  69.      encoding as that of the values returned by the time(3) function, that is,
  70.      seconds from the Epoch, UTC.
  71.  
  72.      The original values of the _t_m___w_d_a_y and _t_m___y_d_a_y components of the struc­
  73.      ture are ignored, and the original values of the other components are not
  74.      restricted to their normal ranges.  (A positive or zero value for
  75.      _t_m___i_s_d_s_t causes mmkkttiimmee() to presume initially that summer time (for exam­
  76.      ple, Daylight Saving Time) is or is not in effect for the specified time,
  77.      respectively.  A negative value for _t_m___i_s_d_s_t causes the mmkkttiimmee() function
  78.      to attempt to divine whether summer time is in effect for the specified
  79.      time.)
  80.  
  81.      On successful completion, the values of the _t_m___w_d_a_y and _t_m___y_d_a_y compo­
  82.      nents of the structure are set appropriately, and the other components
  83.      are set to represent the specified calendar time, but with their values
  84.      forced to their normal ranges; the final value of _t_m___m_d_a_y is not set un­
  85.      til _t_m___m_o_n and _t_m___y_e_a_r are determined.  MMkkttiimmee() returns the specified
  86.      calendar time; if the calendar time cannot be represented, it returns -1;
  87.  
  88.      The ddiiffffttiimmee() function returns the difference between two calendar
  89.      times, (_t_i_m_e_1 ­ _t_i_m_e_0), expressed in seconds.
  90.  
  91.      External declarations as well as the tm structure definition are in the
  92.      <_t_i_m_e_._h> include file.  The tm structure includes at least the following
  93.      fields:
  94.  
  95.            int tm_sec;     /* seconds (0 ­ 60) */
  96.            int tm_min;     /* minutes (0 ­ 59) */
  97.            int tm_hour;    /* hours (0 ­ 23) */
  98.            int tm_mday;    /* day of month (1 ­ 31) */
  99.            int tm_mon;     /* month of year (0 ­ 11) */
  100.            int tm_year;    /* year - 1900 */
  101.            int tm_wday;    /* day of week (Sunday = 0) */
  102.            int tm_yday;    /* day of year (0 ­ 365) */
  103.            int tm_isdst;   /* is summer time in effect? */
  104.            char *tm_zone;  /* abbreviation of timezone name */
  105.            long tm_gmtoff; /* offset from UTC in seconds */
  106.  
  107.      The field _t_m___i_s_d_s_t is non­zero if summer time is in effect.
  108.  
  109.      The field _t_m___g_m_t_o_f_f is the offset (in seconds) of the time represented
  110.      from UTC, with positive values indicating east of the Prime Meridian.
  111.  
  112. SSEEEE AALLSSOO
  113.      date(1),  gettimeofday(2),  getenv(3),  time(3),  tzset(3),  tzfile(5)
  114.  
  115. HHIISSTTOORRYY
  116.      This manual page is derived from the time package contributed to Berkeley
  117.      by Arthur Olsen and which appeared in 4.3BSD.
  118.  
  119. BBUUGGSS
  120.      Except for ddiiffffttiimmee() and mmkkttiimmee(), these functions leaves their result
  121.      in an internal static object and return a pointer to that object. Subse­
  122.      quent calls to these function will modify the same object.
  123.  
  124.      The _t_m___z_o_n_e field of a returned tm structure points to a static array of
  125.      characters, which will also be overwritten by any subsequent calls (as
  126.      well as by subsequent calls to tzset(3) and tzsetwall(3)).
  127.  
  128.      Use of the external variable _t_z_n_a_m_e is discouraged; the _t_m___z_o_n_e entry in
  129.      the tm structure is preferred.
  130.  
  131.  
  132.      Avoid using out­of­range values with mmkkttiimmee() when setting up lunch with
  133.      promptness sticklers in Riyadh.
  134.  
  135. 4.3 Berkeley Distribution       April 19, 1991                               3
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.