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 .\" 4. 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 .\" $DragonFly: src/lib/libc/sys/adjtime.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  31 .\"
  32 .Dd June 4, 1993
  33 .Dt ADJTIME 2
  34 .Os
  35 .Sh NAME
  36 .Nm adjtime
  37 .Nd "correct the time to allow synchronization of the system clock"
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/time.h
  42 .Ft int
  43 .Fn adjtime "const struct timeval *delta" "struct timeval *olddelta"
  44 .Sh DESCRIPTION
  45 .Fn Adjtime
  46 makes small adjustments to the system time, as returned by
  47 .Xr gettimeofday 2 ,
  48 advancing or retarding it
  49 by the time specified by the timeval
  50 .Fa delta .
  51 If
  52 .Fa delta
  53 is negative, the clock is
  54 slowed down by incrementing it more slowly than normal until
  55 the correction is complete.
  56 If
  57 .Fa delta
  58 is positive, a larger increment than normal
  59 is used.
  60 The skew used to perform the correction is generally a fraction of one percent.
  61 Thus, the time is always
  62 a monotonically increasing function.
  63 A time correction from an earlier call to
  64 .Fn adjtime
  65 may not be finished when
  66 .Fn adjtime
  67 is called again.
  68 If
  69 .Fa olddelta
  70 is non-nil,
  71 the structure pointed to will contain, upon return, the
  72 number of microseconds still to be corrected
  73 from the earlier call.
  74 .Pp
  75 This call may be used by time servers that synchronize the clocks
  76 of computers in a local area network.
  77 Such time servers would slow down the clocks of some machines
  78 and speed up the clocks of others to bring them to the average network time.
  79 .Pp
  80 The call
  81 .Fn adjtime
  82 is restricted to the super-user.
  83 .Sh RETURN VALUES
  84 .Rv -std adjtime
  85 .Sh ERRORS
  86 .Fn Adjtime
  87 will fail if:
  88 .Bl -tag -width Er
  89 .It Bq Er EFAULT
  90 An argument points outside the process's allocated address space.
  91 .It Bq Er EPERM
  92 The process's effective user ID is not that of the super-user.
  93 .El
  94 .Sh SEE ALSO
  95 .Xr date 1 ,
  96 .Xr gettimeofday 2 ,
  97 .Xr timed 8 ,
  98 .Xr timedc 8
  99 .Rs
 100 .%T "TSP: The Time Synchronization Protocol for UNIX 4.3BSD"
 101 .%A R. Gusella
 102 .%A S. Zatti
 103 .Re
 104 .Sh HISTORY
 105 The
 106 .Fn adjtime
 107 function call appeared in
 108 .Bx 4.3 .