xref: /original-bsd/lib/libc/sys/adjtime.2 (revision 1a56dd2c)
Copyright (c) 1980 Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that this notice is preserved and that due credit is given
to the University of California at Berkeley. The name of the University
may not be used to endorse or promote products derived from this
software without specific prior written permission. This software
is provided ``as is'' without express or implied warranty.

@(#)adjtime.2 1.4 (Berkeley) 12/23/87

ADJTIME 2 ""
C 6
NAME
adjtime - correct the time to allow synchronization of the system clock
SYNOPSIS
#include <sys/time.h>

adjtime(delta, olddelta) struct timeval *delta; struct timeval *olddelta;

DESCRIPTION
Adjtime makes small adjustments to the system time, as returned by gettimeofday (2), advancing or retarding it by the time specified by the timeval delta. If delta is negative, the clock is slowed down by incrementing it more slowly than normal until the correction is complete. If 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. A time correction from an earlier call to adjtime may not be finished when adjtime is called again. If olddelta is non-zero, then the structure pointed to will contain, upon return, the number of microseconds still to be corrected from the earlier call.

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.

The call adjtime (2) is restricted to the super-user.

"RETURN VALUE
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 errno.
"ERRORS
The following error codes may be set in errno:

15 [EFAULT] An argument points outside the process's allocated address space.

15 [EPERM] The process's effective user ID is not that of the super-user.

"SEE ALSO"
date(1), gettimeofday(2), timed(8), timedc(8),

TSP: The Time Synchronization Protocol for UNIX 4.3BSD, R. Gusella and S. Zatti