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