BSD 4_3_Net_2 release

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

diff --git a/usr/src/lib/libc/sys/adjtime.2 b/usr/src/lib/libc/sys/adjtime.2
index 79b0a52..2eae905 100644 (file)
--- a/usr/src/lib/libc/sys/adjtime.2
+++ b/usr/src/lib/libc/sys/adjtime.2
@@ -1,80 +1,111 @@
-.\" Copyright (c) 1980 Regents of the University of California.
+.\" Copyright (c) 1980, 1991 Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" 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 ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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.

 .\"
 .\"

-.\"    @(#)adjtime.2   1.6 (Berkeley) 6/23/90
+.\" 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.

 .\"
 .\"

-.TH ADJTIME 2 "June 23, 1990"
-.UC 6
-.SH NAME
-adjtime \- correct the time to allow synchronization of the system clock
-.SH SYNOPSIS
-.nf
-.ft B
-#include <sys/time.h>
-.PP
-.ft B
-adjtime(delta, olddelta)
-struct timeval *delta; 
-struct timeval *olddelta;
-.fi
-.SH DESCRIPTION
-.I Adjtime
+.\"     @(#)adjtime.2  1.7 (Berkeley) 3/10/91
+.\"
+.Dd March 10, 1991
+.Dt ADJTIME 2
+.Os BSD 4.3
+.Sh NAME
+.Nm adjtime
+.Nd "correct the time to allow synchronization of the system clock"
+.Sh SYNOPSIS
+.Fd #include <sys/time.h>
+.Ft int
+.Fn adjtime "struct timeval *delta" "struct timeval *olddelta"
+.Sh DESCRIPTION
+.Fn Adjtime

 makes small adjustments to the system time, as returned by
 makes small adjustments to the system time, as returned by

-.IR gettimeofday (2),
+.Xr gettimeofday 2 ,

 advancing or retarding it
 by the time specified by the timeval
 advancing or retarding it
 by the time specified by the timeval

-\fIdelta\fP.
-If \fIdelta\fP is negative, the clock is
+.Fa delta .
+If
+.Fa delta
+is negative, the clock is

 slowed down by incrementing it more slowly than normal until
 the correction is complete.
 slowed down by incrementing it more slowly than normal until
 the correction is complete.

-If \fIdelta\fP is positive, a larger increment than normal
+If
+.Fa delta
+is positive, a larger increment than normal

 is used.
 The skew used to perform the correction is generally a fraction of one percent.
 Thus, the time is always
 a monotonically increasing function.
 is used.
 The skew used to perform the correction is generally a fraction of one percent.
 Thus, the time is always
 a monotonically increasing function.

-A time correction from an earlier call to \fIadjtime\fP
-may not be finished when \fIadjtime\fP is called again.
-If \fIolddelta\fP is non-zero,
-then the structure pointed to will contain, upon return, the
+A time correction from an earlier call to
+.Fn adjtime
+may not be finished when
+.Fn adjtime
+is called again.
+If
+.Fa olddelta
+is non-nil,
+the structure pointed to will contain, upon return, the

 number of microseconds still to be corrected
 from the earlier call.
 number of microseconds still to be corrected
 from the earlier call.

-.PP
+.Pp

 This call may be used by time servers that synchronize the clocks
 of computers in a local area network.
 Such time servers would slow down the clocks of some machines
 and speed up the clocks of others to bring them to the average network time.
 This call may be used by time servers that synchronize the clocks
 of computers in a local area network.
 Such time servers would slow down the clocks of some machines
 and speed up the clocks of others to bring them to the average network time.

-.PP
+.Pp

 The call 
 The call 

-.IR adjtime (2)
+.Fn adjtime

 is restricted to the super-user.
 is restricted to the super-user.

-.SH "RETURN VALUE
+.Sh RETURN VALUES

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

-A return value of \-1 indicates that an error occurred, and in this
-case an error code is stored in the global variable \fIerrno\fP.
-.SH "ERRORS
-The following error codes may be set in \fIerrno\fP:
-.TP 15
-[EFAULT]
+A return value of -1 indicates that an error occurred, and in this
+case an error code is stored in the global variable
+.Va errno .
+.Sh ERRORS
+.Fn Adjtime
+will fail if:
+.Bl -tag -width Er
+.It Bq Er EFAULT

 An argument points outside the process's allocated address space.
 An argument points outside the process's allocated address space.

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

 The process's effective user ID is not that of the super-user.
 The process's effective user ID is not that of the super-user.

-.SH "SEE ALSO"
-date(1), gettimeofday(2), timed(8), timedc(8),
-.br
-\fITSP: The Time Synchronization Protocol for UNIX 4.3BSD\fP, 
-R. Gusella and S. Zatti
+.El
+.Sh SEE ALSO
+.Xr date 1 ,
+.Xr gettimeofday 2 ,
+.Xr timed 8 ,
+.Xr timedc 8 ,
+.Rs
+.%T "TSP: The Time Synchronization Protocol for UNIX 4.3BSD"
+.%A R. Gusella
+.%A S. Zatti
+.Re
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.3 .