ctime.3 and tzset.3 manpages have been moved to libc/time.
This commit is contained in:
jtc
parent
20d50456cc
commit
016bb710d9
@ -1,259 +0,0 @@
|
||||
.\" $NetBSD: ctime.3,v 1.4 1995/02/25 15:39:18 cgd Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 1989, 1991, 1993
|
||||
.\" The Regents of the University of California. All rights reserved.
|
||||
.\"
|
||||
.\" This code is derived from software contributed to Berkeley by
|
||||
.\" Arthur Olson.
|
||||
.\" 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.
|
||||
.\"
|
||||
.\" @(#)ctime.3 8.1 (Berkeley) 6/4/93
|
||||
.\"
|
||||
.Dd June 4, 1993
|
||||
.Dt CTIME 3
|
||||
.Os BSD 4.3
|
||||
.Sh NAME
|
||||
.Nm asctime ,
|
||||
.Nm ctime ,
|
||||
.Nm difftime ,
|
||||
.Nm gmtime ,
|
||||
.Nm localtime ,
|
||||
.Nm mktime
|
||||
.Nd transform binary date and time value to
|
||||
.Tn ASCII
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <time.h>
|
||||
.Vt extern char *tzname[2];
|
||||
.Ft char *
|
||||
.Fn ctime "const time_t *clock"
|
||||
.Ft double
|
||||
.Fn difftime "time_t time1" "time_t time0"
|
||||
.Ft char *
|
||||
.Fn asctime "const struct tm *tm"
|
||||
.Ft struct tm *
|
||||
.Fn localtime "const time_t *clock"
|
||||
.Ft struct tm *
|
||||
.Fn gmtime "const time_t *clock"
|
||||
.Ft time_t
|
||||
.Fn mktime "struct tm *tm"
|
||||
.Sh DESCRIPTION
|
||||
The functions
|
||||
.Fn ctime ,
|
||||
.Fn gmtime
|
||||
and
|
||||
.Fn localtime
|
||||
all take as an argument a time value representing the time in seconds since
|
||||
the Epoch (00:00:00
|
||||
.Tn UTC ,
|
||||
January 1, 1970; see
|
||||
.Xr time 3 ) .
|
||||
.Pp
|
||||
The function
|
||||
.Fn localtime
|
||||
converts the time value pointed at by
|
||||
.Fa clock ,
|
||||
and returns a pointer to a
|
||||
.Dq Fa struct tm
|
||||
(described below) which contains
|
||||
the broken-out time information for the value after adjusting for the current
|
||||
time zone (and any other factors such as Daylight Saving Time).
|
||||
Time zone adjustments are performed as specified by the
|
||||
.Ev TZ
|
||||
environmental variable (see
|
||||
.Xr tzset 3 ) .
|
||||
The function
|
||||
.Fn localtime
|
||||
uses
|
||||
.Xr tzset
|
||||
to initialize time conversion information if
|
||||
.Xr tzset
|
||||
has not already been called by the process.
|
||||
.Pp
|
||||
After filling in the tm structure,
|
||||
.Fn localtime
|
||||
sets the
|
||||
.Fa tm_isdst Ns 'th
|
||||
element of
|
||||
.Fa tzname
|
||||
to a pointer to an
|
||||
.Tn ASCII
|
||||
string that's the time zone abbreviation to be
|
||||
used with
|
||||
.Fn localtime Ns 's
|
||||
return value.
|
||||
.Pp
|
||||
The function
|
||||
.Fn gmtime
|
||||
similarly converts the time value, but without any time zone adjustment,
|
||||
and returns a pointer to a tm structure (described below).
|
||||
.Pp
|
||||
The
|
||||
.Fn ctime
|
||||
function
|
||||
adjusts the time value for the current time zone in the same manner as
|
||||
.Fn localtime ,
|
||||
and returns a pointer to a 26-character string of the form:
|
||||
.Bd -literal -offset indent
|
||||
Thu Nov 24 18:22:48 1986\en\e0
|
||||
.Ed
|
||||
.Pp
|
||||
All the fields have constant width.
|
||||
.Pp
|
||||
The
|
||||
.Fn asctime
|
||||
function
|
||||
converts the broken down time in the structure
|
||||
.Fa tm
|
||||
pointed at by
|
||||
.Fa *tm
|
||||
to the form
|
||||
shown in the example above.
|
||||
.Pp
|
||||
The function
|
||||
.Fn mktime
|
||||
converts the broken-down time, expressed as local time, in the structure
|
||||
pointed to by tm into a time value with the same encoding as that of the
|
||||
values returned by the
|
||||
.Xr time 3
|
||||
function, that is, seconds from the Epoch,
|
||||
.Tn UTC .
|
||||
.Pp
|
||||
The original values of the
|
||||
.Fa tm_wday
|
||||
and
|
||||
.Fa tm_yday
|
||||
components of the structure are ignored, and the original values of the
|
||||
other components are not restricted to their normal ranges.
|
||||
(A positive or zero value for
|
||||
.Fa tm_isdst
|
||||
causes
|
||||
.Fn mktime
|
||||
to presume initially that summer time (for example, Daylight Saving Time)
|
||||
is or is not in effect for the specified time, respectively.
|
||||
A negative value for
|
||||
.Fa tm_isdst
|
||||
causes the
|
||||
.Fn mktime
|
||||
function to attempt to divine whether summer time is in effect for the
|
||||
specified time.)
|
||||
.Pp
|
||||
On successful completion, the values of the
|
||||
.Fa tm_wday
|
||||
and
|
||||
.Fa tm_yday
|
||||
components of the structure are set appropriately, and the other components
|
||||
are set to represent the specified calendar time, but with their values
|
||||
forced to their normal ranges; the final value of
|
||||
.Fa tm_mday
|
||||
is not set until
|
||||
.Fa tm_mon
|
||||
and
|
||||
.Fa tm_year
|
||||
are determined.
|
||||
.Fn Mktime
|
||||
returns the specified calendar time; if the calendar time cannot be
|
||||
represented, it returns \-1;
|
||||
.Pp
|
||||
The
|
||||
.Fn difftime
|
||||
function
|
||||
returns the difference between two calendar times,
|
||||
.Pf ( Fa time1
|
||||
-
|
||||
.Fa time0 ) ,
|
||||
expressed in seconds.
|
||||
.Pp
|
||||
External declarations as well as the tm structure definition are in the
|
||||
.Aq Pa time.h
|
||||
include file.
|
||||
The tm structure includes at least the following fields:
|
||||
.Bd -literal -offset indent
|
||||
int tm_sec; /\(** seconds (0 - 60) \(**/
|
||||
int tm_min; /\(** minutes (0 - 59) \(**/
|
||||
int tm_hour; /\(** hours (0 - 23) \(**/
|
||||
int tm_mday; /\(** day of month (1 - 31) \(**/
|
||||
int tm_mon; /\(** month of year (0 - 11) \(**/
|
||||
int tm_year; /\(** year \- 1900 \(**/
|
||||
int tm_wday; /\(** day of week (Sunday = 0) \(**/
|
||||
int tm_yday; /\(** day of year (0 - 365) \(**/
|
||||
int tm_isdst; /\(** is summer time in effect? \(**/
|
||||
char \(**tm_zone; /\(** abbreviation of timezone name \(**/
|
||||
long tm_gmtoff; /\(** offset from UTC in seconds \(**/
|
||||
.Ed
|
||||
.Pp
|
||||
The
|
||||
field
|
||||
.Fa tm_isdst
|
||||
is non-zero if summer time is in effect.
|
||||
.Pp
|
||||
The field
|
||||
.Fa tm_gmtoff
|
||||
is the offset (in seconds) of the time represented from
|
||||
.Tn UTC ,
|
||||
with positive
|
||||
values indicating east of the Prime Meridian.
|
||||
.Sh SEE ALSO
|
||||
.Xr date 1 ,
|
||||
.Xr gettimeofday 2 ,
|
||||
.Xr getenv 3 ,
|
||||
.Xr time 3 ,
|
||||
.Xr tzset 3 ,
|
||||
.Xr tzfile 5
|
||||
.Sh HISTORY
|
||||
This manual page is derived from
|
||||
the time package contributed to Berkeley by
|
||||
Arthur Olsen and which appeared in
|
||||
.Bx 4.3 .
|
||||
.Sh BUGS
|
||||
Except for
|
||||
.Fn difftime
|
||||
and
|
||||
.Fn mktime ,
|
||||
these functions leaves their result in an internal static object and return
|
||||
a pointer to that object. Subsequent calls to these
|
||||
function will modify the same object.
|
||||
.Pp
|
||||
The
|
||||
.Fa tm_zone
|
||||
field of a returned tm structure points to a static array of characters,
|
||||
which will also be overwritten by any subsequent calls (as well as by
|
||||
subsequent calls to
|
||||
.Xr tzset 3
|
||||
and
|
||||
.Xr tzsetwall 3 ) .
|
||||
.Pp
|
||||
Use of the external variable
|
||||
.Fa tzname
|
||||
is discouraged; the
|
||||
.Fa tm_zone
|
||||
entry in the tm structure is preferred.
|
||||
.Pp
|
||||
Avoid using out-of-range values with
|
||||
.Fn mktime
|
||||
when setting up lunch with promptness sticklers in Riyadh.
|
||||
@ -1,326 +0,0 @@
|
||||
.\" $NetBSD: tzset.3,v 1.3 1995/02/27 05:55:10 cgd Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 1989, 1991, 1993
|
||||
.\" The Regents of the University of California. All rights reserved.
|
||||
.\"
|
||||
.\" This code is derived from software contributed to Berkeley by
|
||||
.\" Arthur Olson.
|
||||
.\"
|
||||
.\" 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.
|
||||
.\"
|
||||
.\" @(#)tzset.3 8.2 (Berkeley) 11/17/93
|
||||
.\"
|
||||
.Dd November 17, 1993
|
||||
.Dt TZSET 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm tzset ,
|
||||
.Nm tzsetwall
|
||||
.Nd initialize time conversion information
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <time.h>
|
||||
.Ft void
|
||||
.Fn tzset void
|
||||
.Ft void
|
||||
.Fn tzsetwall void
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn tzset
|
||||
function
|
||||
initializes time conversion information used by the library routine
|
||||
.Xr localtime 3 .
|
||||
The environment variable
|
||||
.Ev TZ
|
||||
specifies how this is done.
|
||||
.Pp
|
||||
If
|
||||
.Ev TZ
|
||||
does not appear in the environment, the best available approximation to
|
||||
local wall clock time, as specified by the
|
||||
.Xr tzfile 5 Ns -format
|
||||
file
|
||||
.Pa /etc/localtime
|
||||
is used.
|
||||
.Pp
|
||||
If
|
||||
.Ev TZ
|
||||
appears in the environment but its value is a null string, Coordinated
|
||||
Universal Time
|
||||
.Pq Tn UTC
|
||||
is used (without leap second correction).
|
||||
.Pp
|
||||
If
|
||||
.Ev TZ
|
||||
appears in the environment and its value begins with a colon
|
||||
.Pq Ql \: ,
|
||||
the rest of its value is used as a pathname of a
|
||||
.Xr tzfile 5 Ns -format
|
||||
file from which to read the time conversion information.
|
||||
If the first character of the pathname is a slash
|
||||
.Pq Ql /
|
||||
it is used as
|
||||
an absolute pathname; otherwise, it is used as a pathname relative to
|
||||
the system time conversion information directory.
|
||||
.Pp
|
||||
If its value does not begin with a colon, it is first used as the pathname
|
||||
of a file (as described above) from which to read the time conversion
|
||||
information.
|
||||
If that file cannot be read, the value is then interpreted as a direct
|
||||
specification (the format is described below) of the time conversion
|
||||
information.
|
||||
.Pp
|
||||
If the
|
||||
.Ev TZ
|
||||
environment variable does not specify a
|
||||
.Xr tzfile 5 Ns -format
|
||||
file and cannot be interpreted as a direct specification,
|
||||
.Tn UTC
|
||||
is used.
|
||||
.Pp
|
||||
The
|
||||
.Fn tzsetwall
|
||||
function
|
||||
sets things up so that
|
||||
.Xr localtime
|
||||
returns the best available approximation of local wall clock time.
|
||||
.Sh SPECIFICATION FORMAT
|
||||
When
|
||||
.Ev TZ
|
||||
is used directly as a specification of the time conversion information,
|
||||
it must have the following syntax (spaces inserted for clarity):
|
||||
.Bd -filled -offset indent
|
||||
.Em std offset Bo
|
||||
.Em dst Bo
|
||||
.Em offset
|
||||
.Bc
|
||||
.Bo
|
||||
.No , Em rule
|
||||
.Bc
|
||||
.Bc
|
||||
.Ed
|
||||
.Pp
|
||||
Where:
|
||||
.Bl -tag -width std_and_dst -offset indent
|
||||
.It Em std No and Em dst
|
||||
Three or more bytes that are the designation for the standard
|
||||
.Pq Em std
|
||||
or summer
|
||||
.Pq Em dst
|
||||
time zone. Only
|
||||
.Em std
|
||||
is required; if
|
||||
.Em dst
|
||||
is missing, then summer time does not apply in this locale.
|
||||
Upper and lowercase letters are explicitly allowed. Any characters
|
||||
except a leading colon
|
||||
.Pq Ql : ,
|
||||
digits, comma
|
||||
.Pq Ql \&, ,
|
||||
minus
|
||||
.Pq Ql \- ,
|
||||
plus
|
||||
.Pq Ql + ,
|
||||
and
|
||||
.Tn ASCII
|
||||
.Dv NUL
|
||||
are allowed.
|
||||
.It Em offset
|
||||
Indicates the value one must add to the local time to arrive at
|
||||
Coordinated Universal Time. The
|
||||
.Em offset
|
||||
has the form:
|
||||
.Bd -unfilled -offset indent
|
||||
.Em hh Bo
|
||||
.Pf \&: Em mm
|
||||
.Bo
|
||||
.Pf \&: Em ss
|
||||
.Bc
|
||||
.Bc
|
||||
.Ed
|
||||
.Pp
|
||||
The minutes
|
||||
.Pq Em mm
|
||||
and seconds
|
||||
.Pq Em ss
|
||||
are optional. The hour
|
||||
.Pq Em hh
|
||||
is required and may be a single digit. The
|
||||
.Em offset
|
||||
following
|
||||
.Em std
|
||||
is required. If no
|
||||
.Em offset
|
||||
follows
|
||||
.Em dst ,
|
||||
summer time is assumed to be one hour ahead of standard time. One or
|
||||
more digits may be used; the value is always interpreted as a decimal
|
||||
number. The hour must be between zero and 24, and the minutes (and
|
||||
seconds) \(em if present \(em between zero and 59. If preceded by a
|
||||
.Pq Ql \-
|
||||
the time zone shall be east of the Prime Meridian; otherwise it shall be
|
||||
west (which may be indicated by an optional preceding
|
||||
.Pq Ql + ) .
|
||||
.It Em rule
|
||||
Indicates when to change to and back from summer time. The
|
||||
.Em rule
|
||||
has the form:
|
||||
.Bd -filled -offset indent
|
||||
.Em date/time,date/time
|
||||
.Ed
|
||||
.Pp
|
||||
where the first
|
||||
.Em date
|
||||
describes when the change from standard to summer time occurs and the
|
||||
second
|
||||
.Em date
|
||||
describes when the change back happens. Each
|
||||
.Em time
|
||||
field describes when, in current local time, the change to the other
|
||||
time is made.
|
||||
.Pp
|
||||
The format of
|
||||
.Em date
|
||||
is one of the following:
|
||||
.Bl -tag -width "M.m.n.d"
|
||||
.It Sy J Em n
|
||||
The Julian day
|
||||
.Em n
|
||||
(1 \*(Le
|
||||
.Em n
|
||||
\*(Le 365).
|
||||
Leap days are not counted; that is, in all years \(em including leap
|
||||
years \(em February 28 is day 59 and March 1 is day 60. It is
|
||||
impossible to explicitly refer to the occasional February 29.
|
||||
.It Em n
|
||||
The zero-based Julian day
|
||||
(0 \*(Le
|
||||
.Em n
|
||||
\*(Le 365 ) .
|
||||
Leap days are counted, and it is possible to refer to February 29.
|
||||
.It Sy M Em m.n.d
|
||||
The
|
||||
.Em d Ns 'th
|
||||
day (0 \*(Le
|
||||
.Em d
|
||||
\*(Le 6 )
|
||||
of week
|
||||
.Em n
|
||||
of month
|
||||
.Em m
|
||||
of the year
|
||||
(1 \*(Le
|
||||
.Em n
|
||||
\*(Le 5),
|
||||
(1 \*(Le
|
||||
.Em m
|
||||
\*(Le 12),
|
||||
where week 5 means
|
||||
.Do
|
||||
the last
|
||||
.Em d
|
||||
day in month
|
||||
.Em m
|
||||
.Dc
|
||||
which may occur in either the fourth or the fifth week). Week 1 is the
|
||||
first week in which the
|
||||
.Em d Ns 'th
|
||||
day occurs. Day zero is Sunday.
|
||||
.Pp
|
||||
The
|
||||
.Em time
|
||||
has the same format as
|
||||
.Em offset
|
||||
except that no leading sign
|
||||
.Pq Ql \-
|
||||
or
|
||||
.Pq Ql +
|
||||
is allowed. The default, if
|
||||
.Em time
|
||||
is not given, is
|
||||
.Sy 02:00:00 .
|
||||
.El
|
||||
.Pp
|
||||
If no
|
||||
.Em rule
|
||||
is present in the
|
||||
.Ev TZ
|
||||
specification, the rules specified
|
||||
by the
|
||||
.Xr tzfile 5 Ns -format
|
||||
file
|
||||
.Em posixrules
|
||||
in the system time conversion information directory are used, with the
|
||||
standard and summer time offsets from
|
||||
.Tn UTC
|
||||
replaced by those specified by
|
||||
the
|
||||
.Em offset
|
||||
values in
|
||||
.Ev TZ .
|
||||
.El
|
||||
.Pp
|
||||
For compatibility with System V Release 3.1, a semicolon
|
||||
.Pq Ql ;
|
||||
may be used to separate the
|
||||
.Em rule
|
||||
from the rest of the specification.
|
||||
.Sh FILES
|
||||
.Bl -tag -width /usr/share/zoneinfo/posixrules -compact
|
||||
.It Pa /etc/localtime
|
||||
local time zone file
|
||||
.It Pa /usr/share/zoneinfo
|
||||
time zone directory
|
||||
.It Pa /usr/share/zoneinfo/posixrules
|
||||
rules for
|
||||
.Tn POSIX Ns -style
|
||||
.Tn TZ Ns 's
|
||||
.It Pa /usr/share/zoneinfo/GMT for
|
||||
.Tn UTC
|
||||
leap seconds
|
||||
.El
|
||||
.Pp
|
||||
If the file
|
||||
.Pa /usr/share/zoneinfo/GMT
|
||||
does not exist,
|
||||
.Tn UTC
|
||||
leap seconds are loaded from
|
||||
.Pa /usr/share/zoneinfo/posixrules .
|
||||
.Sh SEE ALSO
|
||||
.Xr date 1 ,
|
||||
.Xr gettimeofday 2 ,
|
||||
.Xr ctime 3 ,
|
||||
.Xr getenv 3 ,
|
||||
.Xr time 3 ,
|
||||
.Xr tzfile 5
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm tzset
|
||||
and
|
||||
.Nm tzsetwall
|
||||
functions first appeared in 4.4BSD.
|
||||
Loading…
Reference in New Issue
Block a user