date and time created 91/04/12 13:40:31 by bostic

[unix-history] / usr / src / lib / libc / sys / gettimeofday.2

diff --git a/usr/src/lib/libc/sys/gettimeofday.2 b/usr/src/lib/libc/sys/gettimeofday.2
index ecc0ead..136cc11 100644 (file)
--- a/usr/src/lib/libc/sys/gettimeofday.2
+++ b/usr/src/lib/libc/sys/gettimeofday.2
@@ -1,83 +1,93 @@
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1980, 1991 The Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)gettimeofday.2      6.5 (Berkeley) %G%
+.\" %sccs.include.redist.man%

 .\"
 .\"

-.TH GETTIMEOFDAY 2 ""
-.UC 4
-.SH NAME
-gettimeofday, settimeofday \- get/set date and time
-.SH SYNOPSIS
-.nf
-.ft B
-#include <sys/time.h>
-.PP
-.ft B
-gettimeofday(tp, tzp)
-struct timeval *tp;
-struct timezone *tzp;
-.PP
-.ft B
-settimeofday(tp, tzp)
-struct timeval *tp;
-struct timezone *tzp;
-.fi
-.SH DESCRIPTION
-.I Gettimeofday
-returns the system's notion of the current Greenwich time and
-the current time zone.  Time returned is expressed relative
-in seconds and microseconds since midnight January 1, 1970.
-If
-.I tzp
-is NULL, the time zone information will not be returned or set.
-.PP
+.\"     @(#)gettimeofday.2     6.11 (Berkeley) %G%
+.\"
+.Dd 
+.Dt GETTIMEOFDAY 2
+.Os BSD 4
+.Sh NAME
+.Nm gettimeofday ,
+.Nm settimeofday
+.Nd get/set date and time
+.Sh SYNOPSIS
+.Fd #include <sys/time.h>
+.Ft int
+.Fn gettimeofday "struct timeval *tp" "struct timezone *tzp"
+.Ft int
+.Fn settimeofday "struct timeval *tp" "struct timezone *tzp"
+.Sh DESCRIPTION
+.Bf -symbolic
+Note: timezone is no longer used; this information is kept outside
+the kernel.
+.Ef
+The system's notion of the current Greenwich time and the current time
+zone is obtained with the
+.Fn gettimeofday
+call, and set with the
+.Fn settimeofday
+call.  The time is expressed in seconds and microseconds
+since midnight (0 hour), January 1, 1970.  The resolution of the system
+clock is hardware dependent, and the time may be updated continuously or
+in ``ticks.''  If
+.Fa tp
+or
+.Fa tzp
+is NULL, the associated time
+information will not be returned or set.
+.Pp

 The structures pointed to by
 The structures pointed to by

-.I tp
+.Fa tp

 and
 and

-.I tzp
+.Fa tzp

 are defined in 
 are defined in 

-.I <sys/time.h>
+.Ao Pa sys/time.h Ac

 as:
 as:

-.PP
-.nf
-.RS
-.DT
+.Pp
+.Bd -literal

 struct timeval {
 struct timeval {

-       u_long  tv_sec;         /* seconds since Jan. 1, 1970 */
-       long    tv_usec;                /* and microseconds */
+       long    tv_sec;         /* seconds since Jan. 1, 1970 */
+       long    tv_usec;        /* and microseconds */

 };
 };

-.sp 1
+

 struct timezone {
 struct timezone {

-       int     tz_minuteswest; /* of Greenwich */
+       int     tz_minuteswest; /* of Greenwich */

        int     tz_dsttime;     /* type of dst correction to apply */
 };
        int     tz_dsttime;     /* type of dst correction to apply */
 };

-.RE
-.fi
-.PP
+.Ed
+.Pp

 The 
 The 

-.I timezone
+.Fa timezone

 structure indicates the local time zone
 (measured in minutes of time westward from Greenwich),
 and a flag that, if nonzero, indicates that
 Daylight Saving time applies locally during
 the appropriate part of the year.
 structure indicates the local time zone
 (measured in minutes of time westward from Greenwich),
 and a flag that, if nonzero, indicates that
 Daylight Saving time applies locally during
 the appropriate part of the year.

-.PP
-Only the super-user may set the time of day.
-.SH RETURN
+.Pp
+Only the super-user may set the time of day or time zone.
+.Sh RETURN

 A 0 return value indicates that the call succeeded.
 A 0 return value indicates that the call succeeded.

-A \-1 return value indicates an error occurred, and in this
-case an error code is stored into the global variable \fIerrno\fP.
-.SH "ERRORS
-The following error codes may be set in \fIerrno\fP:
-.TP 15
-[EFAULT]
+A -1 return value indicates an error occurred, and in this
+case an error code is stored into the global variable
+.Va errno .
+.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.
 An argument address referenced invalid memory.

-.TP 15
-[EPERM]
+.It Bq Er EPERM

 A user other than the super-user attempted to set the time.
 A user other than the super-user attempted to set the time.

-.SH "SEE ALSO"
-date(1), ctime(3)
-.SH BUGS
-Time is never correct enough to believe the microsecond
-values.
+.El
+.Sh SEE ALSO
+.Xr date 1 ,
+.Xr adjtime 2 ,
+.Xr ctime 3 ,
+.Xr timed 8
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .