Linux Man Pages

Unix Manual Pages Home

Free Linux Documentation

Manual pages sections
Almost all UNIX operating systems have voluminous documentation known as manual pages. Every page is a document. If one wants to read a page then the command man at a shell prompt will show the manual, for example, "man ftp". Pages are referred by using the notation "name(manual-section)", for example time(1).


Man Page :: Unix Man Pages - adjtime
Browse Linux man pages by name. Choose the first letter of the name of the Linux command, function, or file you are interested in:
a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|_| All


NAME

adjtime - correct the time to synchronize the system clock

SYNOPSIS


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

Feature Test Macro Requirements for glibc (see feature_test_macros (7)):
Feature Test Macro Requirements for glibc (see feature_test_macros (7)):
adjtime (): _BSD_SOURCE

DESCRIPTION

The adjtime () function gradually adjusts the system clock (as returned by gettimeofday (2)). The amount of time by which the clock is to be adjusted is specified in the structure pointed to by delta . This structure has the following form:

The adjtime () function gradually adjusts the system clock (as returned by gettimeofday (2)). The amount of time by which the clock is to be adjusted is specified in the structure pointed to by delta . This structure has the following form:



struct timeval { time_t tv_sec; /* seconds */ suseconds_t tv_usec; /* microseconds */ };
struct timeval { time_t tv_sec; /* seconds */ suseconds_t tv_usec; /* microseconds */ }; If the adjustment in delta is positive, then the system clock is speeded up by some small percentage (i.e., by adding a small amount of time to the clock value in each second) until the adjustment has been completed. If the adjustment in delta is negative, then the clock is slowed down in a similar fashion.
If a clock adjustment from an earlier adjtime () call is already in progress at the time of a later adjtime () call, and delta is not NULL for the later call, then the earlier adjustment is stopped, but any already completed part of that adjustment is not undone.
If olddelta is not NULL, then the buffer that it points to is used to return the amount of time remaining from any previous adjustment that has not yet been completed.

RETURN VALUE

On success, adjtime () returns 0. On failure, -1 is returned, and errno is set to indicate the error.

ERRORS

EINVAL The adjustment in delta is outside the permitted range.

EPERM The caller does not have sufficient privilege to adjust the time. Under Linux the CAP_SYS_TIME capability is required.

CONFORMING TO

4.3BSD, System V.

NOTES

The adjustment that adjtime () makes to the clock is carried out in such a manner that the clock is always monotonically increasing. Using adjtime () to adjust the time prevents the problems that can be caused for certain applications (e.g., make (1)) by abrupt positive or negative jumps in the system time.

adjtime () is intended to be used to make small adjustments to the system time. Most systems impose a limit on the adjustment that can be specified in delta . In the glibc implementation, delta must be less than or equal to (INT_MAX / 1000000 - 2) and greater than or equal to (INT_MIN / 1000000 + 2) (respectively 2145 and -2145 seconds on i386).

BUGS

Currently, if delta is specified as NULL, no valid information about the outstanding clock adjustment is returned in olddelta . (In this circumstance, adjtime () should return the outstanding clock adjustment, without changing it.) This is the result of a kernel limitation.

SEE ALSO

adjtimex (2) gettimeofday (2) time (7)



Unix / Linux Man Pages
Copyright (C) 2008 istild.com. All Rights Reserved.

Unix / Linux Manual Pages Man Pages Man Pages Online Documentation - Valid CSS!