docs/libcurl/curl_getdate.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at http://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .TH curl_getdate 3 "12 Aug 2005" "libcurl 7.0" "libcurl Manual"
  23 .SH NAME
  24 curl_getdate - Convert a date string to number of seconds
  25 .SH SYNOPSIS
  26 .B #include <curl/curl.h>
  27 .sp
  28 .BI "time_t curl_getdate(char *" datestring ", time_t *"now " );"
  29 .ad
  30 .SH DESCRIPTION
  31 \fIcurl_getdate(3)\fP returns the number of seconds since the Epoch, January
  32 1st 1970 00:00:00 in the UTC time zone, for the date and time that the
  33 \fIdatestring\fP parameter specifies. The \fInow\fP parameter is not used,
  34 pass a NULL there.
  35 .SH PARSING DATES AND TIMES
  36 A "date" is a string containing several items separated by whitespace. The
  37 order of the items is immaterial.  A date string may contain many flavors of
  38 items:
  39 .TP 0.8i
  40 .B calendar date items
  41 Can be specified several ways. Month names can only be three-letter english
  42 abbreviations, numbers can be zero-prefixed and the year may use 2 or 4 digits.
  43 Examples: 06 Nov 1994, 06-Nov-94 and Nov-94 6.
  44 .TP
  45 .B time of the day items
  46 This string specifies the time on a given day. You must specify it with 6
  47 digits with two colons: HH:MM:SS. To not include the time in a date string,
  48 will make the function assume 00:00:00. Example: 18:19:21.
  49 .TP
  50 .B time zone items
  51 Specifies international time zone. There are a few acronyms supported, but in
  52 general you should instead use the specific relative time compared to
  53 UTC. Supported formats include: -1200, MST, +0100.
  54 .TP
  55 .B day of the week items
  56 Specifies a day of the week. Days of the week may be spelled out in full
  57 (using english): `Sunday', `Monday', etc or they may be abbreviated to their
  58 first three letters. This is usually not info that adds anything.
  59 .TP
  60 .B pure numbers
  61 If a decimal number of the form YYYYMMDD appears, then YYYY is read as the
  62 year, MM as the month number and DD as the day of the month, for the specified
  63 calendar date.
  64 .PP
  65 .SH EXAMPLES
  66 .nf
  67 Sun, 06 Nov 1994 08:49:37 GMT
  68 Sunday, 06-Nov-94 08:49:37 GMT
  69 Sun Nov  6 08:49:37 1994
  70 06 Nov 1994 08:49:37 GMT
  71 06-Nov-94 08:49:37 GMT
  72 Nov  6 08:49:37 1994
  73 06 Nov 1994 08:49:37
  74 06-Nov-94 08:49:37
  75 1994 Nov 6 08:49:37
  76 GMT 08:49:37 06-Nov-94 Sunday
  77 94 6 Nov 08:49:37
  78 1994 Nov 6
  79 06-Nov-94
  80 Sun Nov 6 94
  81 1994.Nov.6
  82 Sun/Nov/6/94/GMT
  83 Sun, 06 Nov 1994 08:49:37 CET
  84 06 Nov 1994 08:49:37 EST
  85 Sun, 12 Sep 2004 15:05:58 -0700
  86 Sat, 11 Sep 2004 21:32:11 +0200
  87 20040912 15:05:58 -0700
  88 20040911 +0200
  89 .fi
  90 .SH STANDARDS
  91 This parser was written to handle date formats specified in RFC 822 (including
  92 the update in RFC 1123) using time zone name or time zone delta and RFC 850
  93 (obsoleted by RFC 1036) and ANSI C's asctime() format. These formats are the
  94 only ones RFC2616 says HTTP applications may use.
  95 .SH RETURN VALUE
  96 This function returns -1 when it fails to parse the date string. Otherwise it
  97 returns the number of seconds as described.
  98
  99 If the year is larger than 2037 on systems with 32 bit time_t, this function
 100 will return 0x7fffffff (since that is the largest possible signed 32 bit
 101 number).
 102
 103 Having a 64 bit time_t is not a guarantee that dates beyond 03:14:07 UTC,
 104 January 19, 2038 will work fine. On systems with a 64 bit time_t but with a
 105 crippled mktime(), \fIcurl_getdate(3)\fP will return -1 in this case.
 106 .SH "SEE ALSO"
 107 .BR curl_easy_escape "(3), " curl_easy_unescape "(3), "
 108 .BR CURLOPT_TIMECONDITION "(3), " CURLOPT_TIMEVALUE "(3) "