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