aboutsummaryrefslogtreecommitdiffstats
path: root/missing/strftime.3
blob: b61ed029363e9fa1fafc6a42aea3d4d13dbca698 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
STRFTIME(3)                          Library Functions Manual                         STRFTIME(3)

NAME
       strftime - generate formatted time information

SYNOPSIS
       #include <sys/types.h>
       #include <time.h>

       size_t strftime(char *s, size_t maxsize, const char *format,
            const struct tm *timeptr);

DESCRIPTION
       The following description is transcribed verbatim from the December 7, 1988 draft standard
       for ANSI C.  This draft is essentially identical in technical content to the final version
       of the standard.

       The  strftime  function  places characters into the array pointed to by s as controlled by
       the string pointed to by format.  The format shall be a multibyte character sequence,  be-
       ginning and ending in its initial shift state.  The format string consists of zero or more
       conversion specifiers and ordinary multibyte characters.  A conversion specifier  consists
       of  a  %  character followed by a character that determines the behavior of the conversion
       specifier.  All ordinary multibyte characters (including the terminating  null  character)
       are  copied unchanged into the array.  If copying takes place between objects that overlap
       the behavior is undefined.  No more than maxsize characters are  placed  into  the  array.
       Each  conversion  specifier is replaced by appropriate characters as described in the fol-
       lowing list.  The appropriate characters are determined by the  LC_TIME  category  of  the
       current locale and by the values contained in the structure pointed to by timeptr.

       %a     is replaced by the locale's abbreviated weekday name.

       %A     is replaced by the locale's full weekday name.

       %b     is replaced by the locale's abbreviated month name.

       %B     is replaced by the locale's full month name.

       %c     is replaced by the locale's appropriate date and time representation.

       %d     is replaced by the day of the month as a decimal number (01-31).

       %H     is replaced by the hour (24-hour clock) as a decimal number (00-23).

       %I     is replaced by the hour (12-hour clock) as a decimal number (01-12).

       %j     is replaced by the day of the year as a decimal number (001-366).

       %m     is replaced by the month as a decimal number (01-12).

       %M     is replaced by the minute as a decimal number (00-59).

       %p     is  replaced by the locale's equivalent of the AM/PM designations associated with a
              12-hour clock.

       %S     is replaced by the second as a decimal number (00-61).

       %U     is replaced by the week number of the year (the first Sunday as the  first  day  of
              week 1) as a decimal number (00-53).

       %w     is replaced by the weekday as a decimal number [0 (Sunday)-6].

       %W     is  replaced  by  the week number of the year (the first Monday as the first day of
              week 1) as a decimal number (00-53).

       %x     is replaced by the locale's appropriate date representation.

       %X     is replaced by the locale's appropriate time representation.

       %y     is replaced by the year without century as a decimal number (00-99).

       %Y     is replaced by the year with century as a decimal number.

       %Z     is replaced by the time zone name or abbreviation, or by no characters if  no  time
              zone is determinable.

       %%     is replaced by %.

       If a conversion specifier is not one of the above, the behavior is undefined.

RETURNS
       If  the  total  number of resulting characters including the terminating null character is
       not more than maxsize, the strftime function returns the number of characters placed  into
       the  array  pointed to by s not including the terminating null character.  Otherwise, zero
       is returned and the contents of the array are indeterminate.

NON-ANSI EXTENSIONS
       If SYSV_EXT is defined when the routine is compiled, then the following additional conver-
       sions  will  be available.  These are borrowed from the System V cftime(3) and ascftime(3)
       routines.

       %D     is equivalent to specifying %m/%d/%y.

       %e     is replaced by the day of the month, padded with a blank if it is only one digit.

       %h     is equivalent to %b, above.

       %n     is replaced with a newline character (ASCII LF).

       %r     is equivalent to specifying %I:%M:%S %p.

       %R     is equivalent to specifying %H:%M.

       %T     is equivalent to specifying %H:%M:%S.

       %t     is replaced with a TAB character.

POSIX 1003.2 EXTENSIONS
       If POSIX2_DATE is defined, then all of the conversions available with SYSV_EXT are  avail-
       able, as well as the following additional conversions:

       %C     The century, as a number between 00 and 99.

       In  additon,  the  alternate  representations %Ec, %EC, %Ex, %Ey, %EY, %Od, %Oe, %OH, %OI,
       %Om, %OM, %OS, %OU, %Ow, %OW, and %Oy are recognized, but their normal representations are
       used.

VMS EXTENSIONS
       If VMS_EXT is defined, then the following additional conversion is available:

       %V     The date in VMS format (e.g. 20-JUN-1991).

SEE ALSO
       time(2), ctime(3), localtime(3)

BUGS
       This  version  does not handle multibyte characters or pay attention to the setting of the
       LC_TIME environment variable.

       It is not clear what is ``appropriate'' for the C locale; the values returned are  a  best
       guess on the author's part.

CAVEATS
       This  implementation  calls  tzset(3)  exactly  once.   If  the TZ environment variable is
       changed after strftime has been called, then tzset(3) must be called again, explicitly, in
       order for the correct timezone information to be available.

AUTHOR
       Arnold Robbins
       AudioFAX, Inc.
       Suite 200
       2000 Powers Ferry Road
       Marietta, GA. 30067
       U.S.A.
       INTERNET: arnold@audiofax.com
       UUCP:     emory!audfax!arnold
       Phone:    +1 404 618 4281
       Fax-box:  +1 404 618 4581

ACKNOWLEDGEMENTS
       Thanks to Geoff Clare <gwc@root.co.uk> for helping debug earlier versions of this routine.
       Additional thanks to Arthur David Olsen <ado@elsie.nci.nih.gov>  for  some  code  improve-
       ments.

                                                                                      STRFTIME(3)