xref: /freebsd/lib/libc/gen/time.3 (revision afe61c15161c324a7af299a9b8457aba5afc92db)
1.\" Copyright (c) 1989, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the American National Standards Committee X3, on Information
6.\" Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)time.3	8.1 (Berkeley) 6/4/93
37.\"
38.Dd June 4, 1993
39.Dt TIME 3
40.Os BSD 4
41.Sh NAME
42.Nm time
43.Nd get time of day
44.Sh SYNOPSIS
45.Fd #include <sys/types.h>
46.Ft time_t
47.Fn time "time_t *tloc"
48.Sh DESCRIPTION
49The
50.Fn time
51function
52returns the value of time in seconds since 0 hours, 0 minutes,
530 seconds, January 1, 1970, Coordinated Universal Time.
54.Pp
55A copy of the time value may be saved to the area indicated by the
56pointer
57.Fa tloc .
58If
59.Fa tloc
60is a NULL pointer, no value is stored.
61.Pp
62Upon successful completion,
63.Fn time
64returns the value of time.
65Otherwise a value of
66.Po
67.Po Fa time_t Pc \-1
68.Pc
69is returned and the global variable
70.Va errno
71is set to indicate the error.
72.Sh ERRORS
73The following error codes may be set in
74.Va errno :
75.Bl -tag -width [EFAULT]
76.It Bq Er EFAULT
77An argument address referenced invalid memory.
78.Sh SEE ALSO
79.Xr gettimeofday 2 ,
80.Xr ctime 3
81.Sh HISTORY
82A
83.Fn time
84function appeared in
85.At v6 .
86