| blob | 62a6bec5bd59878ad40872170c3b9a273883092e |
1 '\" te
2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright 1989 AT&T
4 .\" Portions Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
6 .\" http://www.opengroup.org/bookstore/.
7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
8 .\" This notice shall appear on any product containing this material.
9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
12 .TH GETDATE 3C "Nov 1, 2003"
13 .SH NAME
14 getdate \- convert user format date and time
15 .SH SYNOPSIS
16 .LP
17 .nf
18 #include <time.h>
20 \fBstruct tm *\fR\fBgetdate\fR(\fBconst char *\fR\fIstring\fR);
21 extern int getdate_err;
22 .fi
24 .SH DESCRIPTION
25 .sp
26 .LP
27 The \fBgetdate()\fR function converts user-definable date and/or time
28 specifications pointed to by \fIstring\fR to a \fBtm\fR structure. The \fBtm\fR
29 structure is defined in the <\fBtime.h\fR> header.
30 .sp
31 .LP
32 User-supplied templates are used to parse and interpret the input string. The
33 templates are text files created by the user and identified via the
34 environment variable \fBDATEMSK\fR. Each line in the template represents an
35 acceptable date and/or time specification using conversion specifications
36 similar to those used by \fBstrftime\fR(3C) and \fBstrptime\fR(3C). Dates
37 before 1902 and after 2037 are illegal. The first line in the template that
38 matches the input specification is used for interpretation and conversion into
39 the internal time format.
40 .SS "Conversion Specifications"
41 .sp
42 .LP
43 The following conversion specifications are supported:
44 .sp
45 .ne 2
46 .na
47 \fB\fB%%\fR\fR
48 .ad
49 .RS 6n
50 Same as \fB%\fR.
51 .RE
53 .sp
54 .ne 2
55 .na
56 \fB\fB%a\fR\fR
57 .ad
58 .RS 6n
59 Locale's abbreviated weekday name.
60 .RE
62 .sp
63 .ne 2
64 .na
65 \fB\fB%A\fR\fR
66 .ad
67 .RS 6n
68 Locale's full weekday name.
69 .RE
71 .sp
72 .ne 2
73 .na
74 \fB\fB%b\fR\fR
75 .ad
76 .RS 6n
77 Locale's abbreviated month name.
78 .RE
80 .sp
81 .ne 2
82 .na
83 \fB\fB%B\fR\fR
84 .ad
85 .RS 6n
86 Locale's full month name.
87 .RE
89 .sp
90 .ne 2
91 .na
92 \fB\fB%c\fR\fR
93 .ad
94 .RS 6n
95 Locale's appropriate date and time representation.
96 .RE
98 .sp
99 .ne 2
100 .na
101 \fB\fB%C\fR\fR
102 .ad
103 .RS 6n
104 Century number (the year divided by 100 and truncated to an integer as a
105 decimal number [1,99]); single digits are preceded by 0; see
106 \fBstandards\fR(5). If used without the \fB%y\fR specifier, this format
107 specifier will assume the current year offset in whichever century is
108 specified. The only valid years are between 1902-2037.
109 .RE
111 .sp
112 .ne 2
113 .na
114 \fB\fB%d\fR\fR
115 .ad
116 .RS 6n
117 day of month [01,31]; leading zero is permitted but not required.
118 .RE
120 .sp
121 .ne 2
122 .na
123 \fB\fB%D\fR\fR
124 .ad
125 .RS 6n
126 Date as \fB%m\fR/\fB%d\fR/\fB%y\fR.
127 .RE
129 .sp
130 .ne 2
131 .na
132 \fB\fB%e\fR\fR
133 .ad
134 .RS 6n
135 Same as \fB%d\fR.
136 .RE
138 .sp
139 .ne 2
140 .na
141 \fB\fB%h\fR\fR
142 .ad
143 .RS 6n
144 Locale's abbreviated month name.
145 .RE
147 .sp
148 .ne 2
149 .na
150 \fB\fB%H\fR\fR
151 .ad
152 .RS 6n
153 Hour (24-hour clock) [0,23]; leading zero is permitted but not required.
154 .RE
156 .sp
157 .ne 2
158 .na
159 \fB\fB%I\fR\fR
160 .ad
161 .RS 6n
162 Hour (12-hour clock) [1,12]; leading zero is permitted but not required.
163 .RE
165 .sp
166 .ne 2
167 .na
168 \fB\fB%j\fR\fR
169 .ad
170 .RS 6n
171 Day number of the year [1,366]; leading zeros are permitted but not required.
172 .RE
174 .sp
175 .ne 2
176 .na
177 \fB\fB%m\fR\fR
178 .ad
179 .RS 6n
180 Month number [1,12]; leading zero is permitted but not required.
181 .RE
183 .sp
184 .ne 2
185 .na
186 \fB\fB%M\fR\fR
187 .ad
188 .RS 6n
189 Minute [0,59]; leading zero is permitted but not required.
190 .RE
192 .sp
193 .ne 2
194 .na
195 \fB\fB%n\fR\fR
196 .ad
197 .RS 6n
198 Any white space.
199 .RE
201 .sp
202 .ne 2
203 .na
204 \fB\fB%p\fR\fR
205 .ad
206 .RS 6n
207 Locale's equivalent of either a.m. or p.m.
208 .RE
210 .sp
211 .ne 2
212 .na
213 \fB\fB%r\fR\fR
214 .ad
215 .RS 6n
216 Appropriate time representation in the 12-hour clock format with \fB%p\fR.
217 .RE
219 .sp
220 .ne 2
221 .na
222 \fB\fB%R\fR\fR
223 .ad
224 .RS 6n
225 Time as \fB%H\fR:\fB%M\fR.
226 .RE
228 .SS "SUSv3"
229 .sp
230 .ne 2
231 .na
232 \fB\fB%S\fR\fR
233 .ad
234 .RS 6n
235 Seconds [0,60]; leading zero is permitted but not required. The range of values
236 is [00,60] rather than [00,59] to allow for the occasional leap second.
237 .RE
239 .SS "Default and other standards"
240 .sp
241 .ne 2
242 .na
243 \fB\fB%S\fR\fR
244 .ad
245 .RS 6n
246 Seconds [0,61]; leading zero is permitted but not required. The range of values
247 is [00,61] rather than [00,59] to allow for the occasional leap second and even
248 more occasional double leap second.
249 .RE
251 .sp
252 .ne 2
253 .na
254 \fB\fB%t\fR\fR
255 .ad
256 .RS 6n
257 Any white space.
258 .RE
260 .sp
261 .ne 2
262 .na
263 \fB\fB%T\fR\fR
264 .ad
265 .RS 6n
266 Time as \fB%H\fR:\fB%M\fR:\fB%S\fR.
267 .RE
269 .sp
270 .ne 2
271 .na
272 \fB\fB%U\fR\fR
273 .ad
274 .RS 6n
275 Week number of the year as a decimal number [0,53], with Sunday as the first
276 day of the week; leading zero is permitted but not required.
277 .RE
279 .sp
280 .ne 2
281 .na
282 \fB\fB%w\fR\fR
283 .ad
284 .RS 6n
285 Weekday as a decimal number [0,6], with 0 representing Sunday.
286 .RE
288 .sp
289 .ne 2
290 .na
291 \fB\fB%W\fR\fR
292 .ad
293 .RS 6n
294 Week number of the year as a decimal number [0,53], with Monday as the first
295 day of the week; leading zero is permitted but not required.
296 .RE
298 .sp
299 .ne 2
300 .na
301 \fB\fB%x\fR\fR
302 .ad
303 .RS 6n
304 Locale's appropriate date representation.
305 .RE
307 .sp
308 .ne 2
309 .na
310 \fB\fB%X\fR\fR
311 .ad
312 .RS 6n
313 Locale's appropriate time representation.
314 .RE
316 .sp
317 .ne 2
318 .na
319 \fB\fB%y\fR\fR
320 .ad
321 .RS 6n
322 Year within century. When a century is not otherwise specified, values in the
323 range 69-99 refer to years in the twentieth century (1969 to 1999 inclusive);
324 values in the range 00-68 refer to years in the twenty-first century (2000 to
325 2068 inclusive).
326 .RE
328 .sp
329 .ne 2
330 .na
331 \fB\fB%Y\fR\fR
332 .ad
333 .RS 6n
334 Year, including the century (for example, 1993).
335 .RE
337 .sp
338 .ne 2
339 .na
340 \fB\fB%Z\fR\fR
341 .ad
342 .RS 6n
343 Time zone name or no characters if no time zone exists.
344 .RE
346 .SS "Modified Conversion Specifications"
347 .sp
348 .LP
349 Some conversion specifications can be modified by the \fBE\fR and \fBO\fR
350 modifier characters to indicate that an alternative format or specification
351 should be used rather than the one normally used by the unmodified
352 specification. If the alternative format or specification does not exist in the
353 current locale, the behavior be as if the unmodified conversion specification
354 were used.
355 .sp
356 .ne 2
357 .na
358 \fB\fB%Ec\fR\fR
359 .ad
360 .RS 7n
361 Locale's alternative appropriate date and time representation.
362 .RE
364 .sp
365 .ne 2
366 .na
367 \fB\fB%EC\fR\fR
368 .ad
369 .RS 7n
370 Name of the base year (period) in the locale's alternative representation.
371 .RE
373 .sp
374 .ne 2
375 .na
376 \fB\fB%Ex\fR\fR
377 .ad
378 .RS 7n
379 Locale's alternative date representation.
380 .RE
382 .sp
383 .ne 2
384 .na
385 \fB\fB%EX\fR\fR
386 .ad
387 .RS 7n
388 Locale's alternative time representation.
389 .RE
391 .sp
392 .ne 2
393 .na
394 \fB\fB%Ey\fR\fR
395 .ad
396 .RS 7n
397 Offset from \fB%EC\fR (year only) in the locale's alternative representation.
398 .RE
400 .sp
401 .ne 2
402 .na
403 \fB\fB%EY\fR\fR
404 .ad
405 .RS 7n
406 Full alternative year representation.
407 .RE
409 .sp
410 .ne 2
411 .na
412 \fB\fB%Od\fR\fR
413 .ad
414 .RS 7n
415 Day of the month using the locale's alternative numeric symbols; leading zeros
416 are permitted but not required.
417 .RE
419 .sp
420 .ne 2
421 .na
422 \fB\fB%Oe\fR\fR
423 .ad
424 .RS 7n
425 Same as \fB%Od\fR.
426 .RE
428 .sp
429 .ne 2
430 .na
431 \fB\fB%OH\fR\fR
432 .ad
433 .RS 7n
434 Hour (24-hour clock) using the locale's alternative numeric symbols.
435 .RE
437 .sp
438 .ne 2
439 .na
440 \fB\fB%OI\fR\fR
441 .ad
442 .RS 7n
443 Hour (12-hour clock) using the locale's alternative numeric symbols.
444 .RE
446 .sp
447 .ne 2
448 .na
449 \fB\fB%Om\fR\fR
450 .ad
451 .RS 7n
452 Month using the locale's alternative numeric symbols.
453 .RE
455 .sp
456 .ne 2
457 .na
458 \fB\fB%OM\fR\fR
459 .ad
460 .RS 7n
461 Minutes using the locale's alternative numeric symbols.
462 .RE
464 .sp
465 .ne 2
466 .na
467 \fB\fB%OS\fR\fR
468 .ad
469 .RS 7n
470 Seconds using the locale's alternative numeric symbols.
471 .RE
473 .sp
474 .ne 2
475 .na
476 \fB\fB%OU\fR\fR
477 .ad
478 .RS 7n
479 Week number of the year (Sunday as the first day of the week) using the
480 locale's alternative numeric symbols.
481 .RE
483 .sp
484 .ne 2
485 .na
486 \fB\fB%Ow\fR\fR
487 .ad
488 .RS 7n
489 Number of the weekday (Sunday=0) using the locale's alternative numeric
490 symbols.
491 .RE
493 .sp
494 .ne 2
495 .na
496 \fB\fB%OW\fR\fR
497 .ad
498 .RS 7n
499 Week number of the year (Monday as the first day of the week) using the
500 locale's alternative numeric symbols.
501 .RE
503 .sp
504 .ne 2
505 .na
506 \fB\fB%Oy\fR\fR
507 .ad
508 .RS 7n
509 Year (offset from \fB%C\fR) in the locale's alternative representation and
510 using the locale's alternative numeric symbols.
511 .RE
513 .SS "Internal Format Conversion"
514 .sp
515 .LP
516 The following rules are applied for converting the input specification into the
517 internal format:
518 .RS +4
519 .TP
520 .ie t \(bu
521 .el o
522 If only the weekday is given, today is assumed if the given day is equal to the
523 current day and next week if it is less.
524 .RE
525 .RS +4
526 .TP
527 .ie t \(bu
528 .el o
529 If only the month is given, the current month is assumed if the given month is
530 equal to the current month and next year if it is less and no year is given.
531 (The first day of month is assumed if no day is given.)
532 .RE
533 .RS +4
534 .TP
535 .ie t \(bu
536 .el o
537 If only the year is given, the values of the \fBtm_mon\fR, \fBtm_mday\fR,
538 \fBtm_yday\fR, \fBtm_wday\fR, and \fBtm_isds\fRt members of the returned
539 \fBtm\fR structure are not specified.
540 .RE
541 .RS +4
542 .TP
543 .ie t \(bu
544 .el o
545 If the century is given, but the year within the century is not given, the
546 current year within the century is assumed.
547 .RE
548 .RS +4
549 .TP
550 .ie t \(bu
551 .el o
552 If no hour, minute, and second are given, the current hour, minute, and second
553 are assumed.
554 .RE
555 .RS +4
556 .TP
557 .ie t \(bu
558 .el o
559 If no date is given, today is assumed if the given hour is greater than the
560 current hour and tomorrow is assumed if it is less.
561 .RE
562 .SS "General Specifications"
563 .sp
564 .LP
565 A conversion specification that is an ordinary character is executed by
566 scanning the next character from the buffer. If the character scanned from the
567 buffer differs from the one comprising the conversion specification, the
568 specification fails, and the differing and subsequent characters remain
569 unscanned.
570 .sp
571 .LP
572 A series of conversion specifications composed of \fB%n\fR, \fB%t\fR, white
573 space characters, or any combination is executed by scanning up to the first
574 character that is not white space (which remains unscanned), or until no more
575 characters can be scanned.
576 .sp
577 .LP
578 Any other conversion specification is executed by scanning characters until a
579 character matching the next conversion specification is scanned, or until no
580 more characters can be scanned. These characters, except the one matching the
581 next conversion specification, are then compared to the locale values
582 associated with the conversion specifier. If a match is found, values for the
583 appropriate \fItm\fR structure members are set to values corresponding to the
584 locale information. If no match is found, \fBgetdate()\fR fails and no more
585 characters are scanned.
586 .sp
587 .LP
588 The month names, weekday names, era names, and alternative numeric symbols can
589 consist of any combination of upper and lower case letters. The user can
590 request that the input date or time specification be in a specific language by
591 setting the \fBLC_TIME\fR category using \fBsetlocale\fR(3C).
592 .SH RETURN VALUES
593 .sp
594 .LP
595 If successful, \fBgetdate()\fR returns a pointer to a \fBtm\fR structure;
596 otherwise, it returns \fINULL\fR and sets the global variable \fBgetdate_err\fR
597 to indicate the error. Subsequent calls to \fBgetdate()\fR alter the contents
598 of \fBgetdate_err\fR.
599 .sp
600 .LP
601 The following is a complete list of the \fBgetdate_err\fR settings and their
602 meanings:
603 .sp
604 .ne 2
605 .na
606 \fB\fB1\fR\fR
607 .ad
608 .RS 5n
609 The \fBDATEMSK\fR environment variable is null or undefined.
610 .RE
612 .sp
613 .ne 2
614 .na
615 \fB\fB2\fR\fR
616 .ad
617 .RS 5n
618 The template file cannot be opened for reading.
619 .RE
621 .sp
622 .ne 2
623 .na
624 \fB\fB3\fR\fR
625 .ad
626 .RS 5n
627 Failed to get file status information.
628 .RE
630 .sp
631 .ne 2
632 .na
633 \fB\fB4\fR\fR
634 .ad
635 .RS 5n
636 The template file is not a regular file.
637 .RE
639 .sp
640 .ne 2
641 .na
642 \fB\fB5\fR\fR
643 .ad
644 .RS 5n
645 An error is encountered while reading the template file.
646 .RE
648 .sp
649 .ne 2
650 .na
651 \fB\fB6\fR\fR
652 .ad
653 .RS 5n
654 The \fBmalloc()\fR function failed (not enough memory is available).
655 .RE
657 .sp
658 .ne 2
659 .na
660 \fB\fB7\fR\fR
661 .ad
662 .RS 5n
663 There is no line in the template that matches the input.
664 .RE
666 .sp
667 .ne 2
668 .na
669 \fB\fB8\fR\fR
670 .ad
671 .RS 5n
672 The input specification is invalid (for example, \fBFebruary 31\fR).
673 .RE
675 .SH USAGE
676 .sp
677 .LP
678 The \fBgetdate()\fR function makes explicit use of macros described on the
679 \fBctype\fR(3C) manual page.
680 .SH EXAMPLES
681 .LP
682 \fBExample 1 \fRExamples of the \fBgetdate()\fR function.
683 .sp
684 .LP
685 The following example shows the possible contents of a template:
687 .sp
688 .in +2
689 .nf
690 %m
691 %A %B %d %Y, %H:%M:%S
692 %A
693 %B
694 %m/%d/%y %I %p
695 %d,%m,%Y %H:%M
696 at %A the %dst of %B in %Y
697 run job at %I %p,%B %dnd
698 %A den %d. %B %Y %H.%M Uhr
699 .fi
700 .in -2
702 .sp
703 .LP
704 The following are examples of valid input specifications for the above
705 template:
707 .sp
708 .in +2
709 .nf
710 getdate("10/1/87 4 PM")
711 getdate("Friday")
712 getdate("Friday September 19 1987, 10:30:30")
713 getdate("24,9,1986 10:30")
714 getdate("at monday the 1st of december in 1986")
715 getdate("run job at 3 PM, december 2nd")
716 .fi
717 .in -2
719 .sp
720 .LP
721 If the \fBLANG\fR environment variable is set to \fBde\fR (German), the
722 following is valid:
724 .sp
725 .in +2
726 .nf
727 getdate("freitag den 10. oktober 1986 10.30 Uhr")
728 .fi
729 .in -2
731 .sp
732 .LP
733 Local time and date specification are also supported. The following examples
734 show how local date and time specification can be defined in the template.
736 .sp
738 .sp
739 .TS
740 box;
741 l | l
742 l | l .
743 Invocation Line in Template
744 _
745 getdate("11/27/86") %m/%d/%y
746 getdate("27.11.86") %d.%m.%y
747 getdate("86-11-27") %y-%m-%d
748 getdate("Friday 12:00:00") %A %H:%M:%S
749 .TE
751 .sp
752 .LP
753 The following examples illustrate the Internal Format Conversion rules. Assume
754 that the current date is Mon Sep 22 12:19:47 EDT 1986 and the \fBLANG\fR
755 environment variable is not set.
757 .sp
759 .sp
760 .TS
761 box;
762 l | l | l
763 l | l | l .
764 Input Template Line Date
765 _
766 \fBMon\fR \fB%a\fR Mon Sep 22 12:19:48 EDT 1986
767 \fBSun\fR \fB%a\fR Sun Sep 28 12:19:49 EDT 1986
768 \fBFri\fR \fB%a\fR Fri Sep 26 12:19:49 EDT 1986
769 \fBSeptember\fR \fB%B\fR Mon Sep 1 12:19:49 EDT 1986
770 \fBJanuary\fR \fB%B\fR Thu Jan 1 12:19:49 EST 1987
771 \fBDecember\fR \fB%B\fR Mon Dec 1 12:19:49 EDT 1986
772 \fBSep Mon\fR \fB%b %a\fR Mon Sep 1 12:19:50 EDT 1986
773 \fBJan Fri\fR \fB%b %a\fR Fri Jan 2 12:19:50 EST 1987
774 \fBDec Mon\fR \fB%b %a\fR Mon Dec 1 12:19:50 EST 1986
775 \fBJan Wed 1989\fR \fB%b\fR \fB%a\fR \fB%Y\fR Wed Jan 4 12:19:51 EST 1989
776 \fBFri 9\fR \fB%a %H\fR Fri Sep 26 09:00:00 EDT 1986
777 \fBFeb 10:30\fR \fB%b %H:%S\fR Sun Feb 1 10:00:30 EST 1987
778 \fB10:30\fR \fB%H:%M\fR Tue Sep 23 10:30:00 EDT 1986
779 \fB13:30\fR \fB%H:%M\fR Mon Sep 22 13:30:00 EDT 1986
780 .TE
782 .SH ATTRIBUTES
783 .sp
784 .LP
785 See \fBattributes\fR(5) for descriptions of the following attributes:
786 .sp
788 .sp
789 .TS
790 box;
791 l | l
792 l | l .
793 ATTRIBUTE TYPE ATTRIBUTE VALUE
794 _
795 CSI Enabled
796 _
797 Interface Stability Standard
798 _
799 MT-Level MT-Safe
800 .TE
802 .SH SEE ALSO
803 .sp
804 .LP
805 \fBctype\fR(3C), \fBmktime\fR(3C), \fBsetlocale\fR(3C), \fBstrftime\fR(3C),
806 \fBstrptime\fR(3C), \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)