mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-26 11:47:31 +00:00
86 lines
2.9 KiB
Groff
86 lines
2.9 KiB
Groff
.\" 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
|
|
.\" 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.
|
|
.\"
|
|
.\" @(#)time.3 8.1 (Berkeley) 6/4/93
|
|
.\"
|
|
.Dd June 4, 1993
|
|
.Dt TIME 3
|
|
.Os BSD 4
|
|
.Sh NAME
|
|
.Nm time
|
|
.Nd get time of day
|
|
.Sh SYNOPSIS
|
|
.Fd #include <sys/types.h>
|
|
.Ft time_t
|
|
.Fn time "time_t *tloc"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn time
|
|
function
|
|
returns the value of time in seconds since 0 hours, 0 minutes,
|
|
0 seconds, January 1, 1970, Coordinated Universal Time.
|
|
.Pp
|
|
A copy of the time value may be saved to the area indicated by the
|
|
pointer
|
|
.Fa tloc .
|
|
If
|
|
.Fa tloc
|
|
is a NULL pointer, no value is stored.
|
|
.Pp
|
|
Upon successful completion,
|
|
.Fn time
|
|
returns the value of time.
|
|
Otherwise a value of
|
|
.Po
|
|
.Po Fa time_t Pc \-1
|
|
.Pc
|
|
is returned and the global variable
|
|
.Va errno
|
|
is set to indicate the error.
|
|
.Sh ERRORS
|
|
The following error codes may be set in
|
|
.Va errno :
|
|
.Bl -tag -width [EFAULT]
|
|
.It Bq Er EFAULT
|
|
An argument address referenced invalid memory.
|
|
.Sh SEE ALSO
|
|
.Xr gettimeofday 2 ,
|
|
.Xr ctime 3
|
|
.Sh HISTORY
|
|
A
|
|
.Fn time
|
|
function appeared in
|
|
.At v6 .
|