Merge from vendor branch LIBARCHIVE:
[dragonfly.git] / lib / libc / sys / adjtime.2
1 .\" Copyright (c) 1980, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)adjtime.2   8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: src/lib/libc/sys/adjtime.2,v 1.6.2.4 2001/12/14 18:34:00 ru Exp $
34 .\" $DragonFly: src/lib/libc/sys/adjtime.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
35 .\"
36 .Dd June 4, 1993
37 .Dt ADJTIME 2
38 .Os
39 .Sh NAME
40 .Nm adjtime
41 .Nd "correct the time to allow synchronization of the system clock"
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In sys/time.h
46 .Ft int
47 .Fn adjtime "const struct timeval *delta" "struct timeval *olddelta"
48 .Sh DESCRIPTION
49 .Fn Adjtime
50 makes small adjustments to the system time, as returned by
51 .Xr gettimeofday 2 ,
52 advancing or retarding it
53 by the time specified by the timeval
54 .Fa delta .
55 If
56 .Fa delta
57 is negative, the clock is
58 slowed down by incrementing it more slowly than normal until
59 the correction is complete.
60 If
61 .Fa delta
62 is positive, a larger increment than normal
63 is used.
64 The skew used to perform the correction is generally a fraction of one percent.
65 Thus, the time is always
66 a monotonically increasing function.
67 A time correction from an earlier call to
68 .Fn adjtime
69 may not be finished when
70 .Fn adjtime
71 is called again.
72 If
73 .Fa olddelta
74 is non-nil,
75 the structure pointed to will contain, upon return, the
76 number of microseconds still to be corrected
77 from the earlier call.
78 .Pp
79 This call may be used by time servers that synchronize the clocks
80 of computers in a local area network.
81 Such time servers would slow down the clocks of some machines
82 and speed up the clocks of others to bring them to the average network time.
83 .Pp
84 The call
85 .Fn adjtime
86 is restricted to the super-user.
87 .Sh RETURN VALUES
88 .Rv -std adjtime
89 .Sh ERRORS
90 .Fn Adjtime
91 will fail if:
92 .Bl -tag -width Er
93 .It Bq Er EFAULT
94 An argument points outside the process's allocated address space.
95 .It Bq Er EPERM
96 The process's effective user ID is not that of the super-user.
97 .El
98 .Sh SEE ALSO
99 .Xr date 1 ,
100 .Xr gettimeofday 2 ,
101 .Xr timed 8 ,
102 .Xr timedc 8
103 .Rs
104 .%T "TSP: The Time Synchronization Protocol for UNIX 4.3BSD"
105 .%A R. Gusella
106 .%A S. Zatti
107 .Re
108 .Sh HISTORY
109 The
110 .Fn adjtime
111 function call appeared in
112 .Bx 4.3 .