f39c59560fbd87dfa5be09200ad545d9b806587c
[dragonfly.git] / lib / libc / gen / time.3
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 .\" $FreeBSD: src/lib/libc/gen/time.3,v 1.5.2.5 2001/12/14 18:33:51 ru Exp $
38 .\" $DragonFly: src/lib/libc/gen/time.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
39 .\"
40 .Dd June 4, 1993
41 .Dt TIME 3
42 .Os
43 .Sh NAME
44 .Nm time
45 .Nd get time of day
46 .Sh LIBRARY
47 .Lb libc
48 .Sh SYNOPSIS
49 .In time.h
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
64 is a NULL pointer, no value is stored.
65 .Pp
66 Upon successful completion,
67 .Fn time
68 returns the value of time.
69 Otherwise a value of
70 .Pq Po Vt time_t Pc \-1
71 is returned and the global variable
72 .Va errno
73 is set to indicate the error.
74 .Sh ERRORS
75 The following error codes may be set in
76 .Va errno :
77 .Bl -tag -width Er
78 .It Bq Er EFAULT
79 An argument address referenced invalid memory.
80 .El
81 .Sh SEE ALSO
82 .Xr gettimeofday 2 ,
83 .Xr ctime 3
84 .Sh HISTORY
85 A
86 .Fn time
87 function appeared in
88 .At v6 .