lib/libc/stdtime/strptime.3

   1 .\"
   2 .\" Copyright (c) 1997 Joerg Wunsch
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\" "
  28 .Dd October 2, 2014
  29 .Dt STRPTIME 3
  30 .Os
  31 .Sh NAME
  32 .Nm strptime
  33 .Nd parse date and time string
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In time.h
  38 .Ft char *
  39 .Fo strptime
  40 .Fa "const char * restrict buf"
  41 .Fa "const char * restrict format"
  42 .Fa "struct tm * restrict timeptr"
  43 .Fc
  44 .In time.h
  45 .In xlocale.h
  46 .Ft char *
  47 .Fn strptime_l "const char * restrict buf" "const char * restrict format" "struct tm * restrict timeptr" "locale_t loc"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn strptime
  51 function parses the string in the buffer
  52 .Fa buf
  53 according to the string pointed to by
  54 .Fa format ,
  55 and fills in the elements of the structure pointed to by
  56 .Fa timeptr .
  57 The resulting values will be relative to the local time zone.
  58 Thus, it can be considered the reverse operation of
  59 .Xr strftime 3 .
  60 The
  61 .Fn strptime_l
  62 function does the same as
  63 .Fn strptime ,
  64 but takes an explicit locale rather than using the current locale.
  65 .Pp
  66 The
  67 .Fa format
  68 string consists of zero or more conversion specifications and
  69 ordinary characters.
  70 All ordinary characters are matched exactly with the buffer, where
  71 white space in the format string will match any amount of white space
  72 in the buffer.
  73 All conversion specifications are identical to those described in
  74 .Xr strftime 3 .
  75 .Pp
  76 Two-digit year values, including formats
  77 .Fa %y
  78 and
  79 .Fa \&%D ,
  80 are now interpreted as beginning at 1969 per POSIX requirements.
  81 Years 69-00 are interpreted in the 20th century (1969-2000), years
  82 01-68 in the 21st century (2001-2068).
  83 The
  84 .Fa \&%U
  85 and
  86 .Fa %W
  87 format specifiers accept any value within the range 00 to 53.
  88 .Pp
  89 If the
  90 .Fa format
  91 string does not contain enough conversion specifications to completely
  92 specify the resulting
  93 .Vt struct tm ,
  94 the unspecified members of
  95 .Va timeptr
  96 are left untouched.
  97 For example, if
  98 .Fa format
  99 is
 100 .Dq Li "%H:%M:%S" ,
 101 only
 102 .Va tm_hour ,
 103 .Va tm_sec
 104 and
 105 .Va tm_min
 106 will be modified.
 107 If time relative to today is desired, initialize the
 108 .Fa timeptr
 109 structure with today's date before passing it to
 110 .Fn strptime .
 111 .Sh RETURN VALUES
 112 Upon successful completion,
 113 .Fn strptime
 114 returns the pointer to the first character in
 115 .Fa buf
 116 that has not been required to satisfy the specified conversions in
 117 .Fa format .
 118 It returns
 119 .Dv NULL
 120 if one of the conversions failed.
 121 .Fn strptime_l
 122 returns the same values as
 123 .Fn strptime .
 124 .Sh SEE ALSO
 125 .Xr date 1 ,
 126 .Xr scanf 3 ,
 127 .Xr strftime 3
 128 .Sh HISTORY
 129 The
 130 .Fn strptime
 131 function appeared in
 132 .Fx 3.0 .
 133 .Sh AUTHORS
 134 The
 135 .Fn strptime
 136 function has been contributed by Powerdog Industries.
 137 .Pp
 138 This man page was written by
 139 .An J\(:org Wunsch .
 140 .Sh BUGS
 141 Both the
 142 .Fa %e
 143 and
 144 .Fa %l
 145 format specifiers may incorrectly scan one too many digits
 146 if the intended values comprise only a single digit
 147 and that digit is followed immediately by another digit.
 148 Both specifiers accept zero-padded values,
 149 even though they are both defined as taking unpadded values.
 150 .Pp
 151 The
 152 .Fa %p
 153 format specifier has no effect unless it is parsed
 154 .Em after
 155 hour-related specifiers.
 156 Specifying
 157 .Fa %l
 158 without
 159 .Fa %p
 160 will produce undefined results.
 161 Note that 12AM
 162 (ante meridiem)
 163 is taken as midnight
 164 and 12PM
 165 (post meridiem)
 166 is taken as noon.
 167 .Pp
 168 The
 169 .Fa %Z
 170 format specifier only accepts time zone abbreviations of the local time zone,
 171 or the value "GMT".
 172 This limitation is because of ambiguity due to of the over loading of time
 173 zone abbreviations.
 174 One such example is
 175 .Fa EST
 176 which is both Eastern Standard Time and Eastern Australia Summer Time.
 177 .Pp
 178 The
 179 .Fn strptime
 180 function does not correctly handle multibyte characters in the
 181 .Fa format
 182 argument.