Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
NetBSD/lib/libc/time/strftime.3

204 lines
6.5 KiB
Groff
Raw Normal View History

initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.\" Copyright (c) 1989, 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the American National Standards Committee X3, on Information
.\" Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the University of
.\" California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
Add RCS indentifiers.
1993-08-01 11:42:49 +04:00
.\" from: @(#)strftime.3 5.12 (Berkeley) 6/29/91
Add a reference to the strptime(3) manual page.
1997-05-25 23:34:44 +04:00
.\" $Id: strftime.3,v 1.2 1997/05/25 19:34:44 kleink Exp $
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.\"
.Dd June 29, 1991
.Dt STRFTIME 3
.Os
.Sh NAME
.Nm strftime
.Nd format date and time
.Sh SYNOPSIS
.Fd #include <time.h>
.Ft size_t
.Fn strftime "char *buf" "size_t maxsize" "const char *format" "const struct tm *timeptr"
.Sh DESCRIPTION
The
.Fn strftime
function formats the information from
.Fa timeptr
into the buffer
.Fa buf
according to the string pointed to by
.Fa format .
.Pp
The
.Fa format
string consists of zero or more conversion specifications and
ordinary characters.
All ordinary characters are copied directly into the buffer.
A conversion specification consists of a percent sign
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
.Ql %
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
and one other character.
.Pp
No more than
.Fa maxsize
characters will be placed into the array.
If the total number of resulting characters, including the terminating
null character, is not more than
.Fa maxsize ,
.Fn strftime
returns the number of characters in the array, not counting the
terminating null.
Otherwise, zero is returned.
.Pp
Each conversion specification is replaced by the characters as
follows which are then copied into the buffer.
.Bl -tag -width "xxxx"
.It Cm \&%A
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
is replaced by the locale's full weekday name.
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.It Cm %a
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
is replaced by the locale's abbreviated weekday name.
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.It Cm \&%B
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
is replaced by the locale's full month name.
.It Cm \&%b No or Cm \&%h
is replaced by the locale's abbreviated month name.
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.It Cm \&%C
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
is replaced by the century (a year divided by 100 and truncated to an integer)
as a decimal number (00-99).
.It Cm \&%c
is replaced by the locale's appropriate date and time representation.
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.It Cm \&%D
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
is replaced by the date in the format
.Dq Li %m/%d/%y .
.It Cm \&%d
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
is replaced by the day of the month as a decimal number (01-31).
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
.It Cm \&%e
is replaced by the day of month as a decimal number (1-31);
single digits are preceded by a blank.
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.It Cm \&%H
is replaced by the hour (24-hour clock) as a decimal number (00-23).
.It Cm \&%I
is replaced by the hour (12-hour clock) as a decimal number (01-12).
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
.It Cm \&%j
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
is replaced by the day of the year as a decimal number (001-366).
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
.It Cm \&%k
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
is replaced by the hour (24-hour clock) as a decimal number (0-23);
single digits are preceded by a blank.
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
.It Cm \&%l
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
is replaced by the hour (12-hour clock) as a decimal number (1-12);
single digits are preceded by a blank.
.It Cm \&%M
is replaced by the minute as a decimal number (00-59).
.It Cm %m
is replaced by the month as a decimal number (01-12).
.It Cm %n
is replaced by a newline.
.It Cm %p
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
is replaced by the locale's equivalent of either
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.Dq Tn AM
or
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
.Dq Tn PM .
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.It Cm \&%R
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
is replaced by the time in the format
.Dq Li %H:%M .
.It Cm \&%r
is replaced by the locale's representation of 12-hour clock time
using AM/PM notation.
.It Cm \&%T
is replaced by the time in the format
.Dq Li %H:%M:%S .
.It Cm \&%t
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
is replaced by a tab.
.It Cm \&%S
is replaced by the second as a decimal number (00-60).
.It Cm %s
is replaced by the number of seconds since the Epoch, UCT (see
.Xr mktime 3 ) .
.It Cm \&%U
is replaced by the week number of the year (Sunday as the first day of
the week) as a decimal number (00-53).
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
.It Cm \&%u
is replaced by the weekday (Monday as the first day of the week)
as a decimal number (1-7).
.It Cm \&%V
is replaced by the week number of the year (Monday as the first day of
the week) as a decimal number (01-53). If the week containing January
1 has four or more days in the new year, then it is week 1; otherwise
it is week 53 of the previous year, and the next week is week 1.
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.It Cm \&%W
is replaced by the week number of the year (Monday as the first day of
the week) as a decimal number (00-53).
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
.It Cm \&%w
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
is replaced by the weekday (Sunday as the first day of the week)
as a decimal number (0-6).
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
.It Cm \&%X
is replaced by the locale's appropriate time representation.
Fix swapped description of %x and %X format specifiers
1996-02-29 18:03:20 +03:00
.It Cm \&%x
is replaced by the locale's appropriate date representation.
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.It Cm \&%Y
is replaced by the year with century as a decimal number.
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
.It Cm \&%y
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
is replaced by the year without century as a decimal number (00-99).
.It Cm \&%Z
is replaced by the time zone name.
.It Cm %%
is replaced by
.Ql % .
.El
.Sh SEE ALSO
.Xr date 1 ,
.Xr ctime 3 ,
Add a reference to the strptime(3) manual page.
1997-05-25 23:34:44 +04:00
.Xr strptime 3 ,
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.Xr printf 1 ,
.Xr printf 3
.Sh STANDARDS
The
.Fn strftime
function
conforms to
.St -ansiC .
The
Added the additional ``%'' format specifiers and the ``E'' and ``O'' format modifiers that are needed for a 1003.2 compliant date(1). The modifiers don't actually do anything at present and are not documented. It's too confusing to the user to describe localization features when they aren't implemented yet. It is safe to do this, as the modifiers fall back to the default behavior if the locale doesn't support alternate eras or numeric formats. But, in anticipation of _some_ locale support, all month and day names and abbrevs, certain time formats, am/pm, etc. are now accessed through variables.
1993-08-19 20:39:47 +04:00
.Ql \&%C ,
.Ql \&%D ,
.Ql \&%e ,
.Ql \&%h ,
.Ql \&%k ,
.Ql \&%l ,
.Ql \&%n ,
.Ql \&%r ,
.Ql \&%R ,
.Ql \&%s .
.Ql \&%t ,
.Ql \&%T ,
.Ql \&%u ,
and
.Ql \&%V
conversion specifications are extensions.
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.Sh BUGS
There is no conversion specification for the phase of the moon.