mingw/share/man/man3/curl_getdate.3

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