mingw/share/man/man3/curl_getdate.3

   1 .\" You can view this file with:
   2 .\" nroff -man [file]
   3 .\"
   4 .TH curl_getdate 3 "12 Aug 2005" "libcurl 7.0" "libcurl Manual"
   5 .SH NAME
   6 curl_getdate - Convert a date string to number of seconds since January 1,
   7 1970
   8 .SH SYNOPSIS
   9 .B #include <curl/curl.h>
  10 .sp
  11 .BI "time_t curl_getdate(char *" datestring ", time_t *"now " );"
  12 .ad
  13 .SH DESCRIPTION
  14 This function returns the number of seconds since January 1st 1970 in the UTC
  15 time zone, for the date and time that the \fIdatestring\fP parameter
  16 specifies. The \fInow\fP parameter is not used, pass a NULL there.
  17
  18 \fBNOTE:\fP This function was rewritten for the 7.12.2 release and this
  19 documentation covers the functionality of the new one. The new one is not
  20 feature-complete with the old one, but most of the formats supported by the
  21 new one was supported by the old too.
  22 .SH PARSING DATES AND TIMES
  23 A "date" is a string containing several items separated by whitespace. The
  24 order of the items is immaterial.  A date string may contain many flavors of
  25 items:
  26 .TP 0.8i
  27 .B calendar date items
  28 Can be specified several ways. Month names can only be three-letter english
  29 abbreviations, numbers can be zero-prefixed and the year may use 2 or 4 digits.
  30 Examples: 06 Nov 1994, 06-Nov-94 and Nov-94 6.
  31 .TP
  32 .B time of the day items
  33 This string specifies the time on a given day. You must specify it with 6
  34 digits with two colons: HH:MM:SS. To not include the time in a date string,
  35 will make the function assume 00:00:00. Example: 18:19:21.
  36 .TP
  37 .B time zone items
  38 Specifies international time zone. There are a few acronyms supported, but in
  39 general you should instead use the specific relative time compared to
  40 UTC. Supported formats include: -1200, MST, +0100.
  41 .TP
  42 .B day of the week items
  43 Specifies a day of the week. Days of the week may be spelled out in full
  44 (using english): `Sunday', `Monday', etc or they may be abbreviated to their
  45 first three letters. This is usually not info that adds anything.
  46 .TP
  47 .B pure numbers
  48 If a decimal number of the form YYYYMMDD appears, then YYYY is read as the
  49 year, MM as the month number and DD as the day of the month, for the specified
  50 calendar date.
  51 .PP
  52 .SH EXAMPLES
  53 .nf
  54 Sun, 06 Nov 1994 08:49:37 GMT
  55 Sunday, 06-Nov-94 08:49:37 GMT
  56 Sun Nov  6 08:49:37 1994
  57 06 Nov 1994 08:49:37 GMT
  58 06-Nov-94 08:49:37 GMT
  59 Nov  6 08:49:37 1994
  60 06 Nov 1994 08:49:37
  61 06-Nov-94 08:49:37
  62 1994 Nov 6 08:49:37
  63 GMT 08:49:37 06-Nov-94 Sunday
  64 94 6 Nov 08:49:37
  65 1994 Nov 6
  66 06-Nov-94
  67 Sun Nov 6 94
  68 1994.Nov.6
  69 Sun/Nov/6/94/GMT
  70 Sun, 06 Nov 1994 08:49:37 CET
  71 06 Nov 1994 08:49:37 EST
  72 Sun, 12 Sep 2004 15:05:58 -0700
  73 Sat, 11 Sep 2004 21:32:11 +0200
  74 20040912 15:05:58 -0700
  75 20040911 +0200
  76 .fi
  77 .SH STANDARDS
  78 This parser was written to handle date formats specified in RFC 822 (including
  79 the update in RFC 1123) using time zone name or time zone delta and RFC 850
  80 (obsoleted by RFC 1036) and ANSI C's asctime() format. These formats are the
  81 only ones RFC2616 says HTTP applications may use.
  82 .SH RETURN VALUE
  83 This function returns -1 when it fails to parse the date string. Otherwise it
  84 returns the number of seconds as described.
  85
  86 If the year is larger than 2037 on systems with 32 bit time_t, this function
  87 will return 0x7fffffff (since that is the largest possible signed 32 bit
  88 number).
  89
  90 Having a 64 bit time_t is not a guarantee that dates beyond 03:14:07 UTC,
  91 January 19, 2038 will work fine. On systems with a 64 bit time_t but with a
  92 crippled mktime(), \fIcurl_getdate\fP will return -1 in this case.
  93 .SH REWRITE
  94 The former version of this function was built with yacc and was not only very
  95 large, it was also never quite understood and it wasn't possible to build with
  96 non-GNU tools since only GNU Bison could make it thread-safe!
  97
  98 The rewrite was done for 7.12.2. The new one is much smaller and uses simpler
  99 code.