usr.sbin/ntp/doc/ntptime.8

   1 .\"
   2 .\" $FreeBSD: src/usr.sbin/ntp/doc/ntptime.8,v 1.1.2.4 2003/03/11 22:31:30 trhodes Exp $
   3 .\" $DragonFly: src/usr.sbin/ntp/doc/Attic/ntptime.8,v 1.2 2003/06/17 04:29:58 dillon Exp $
   4 .\"
   5 .Dd January 7, 2000
   6 .Dt NTPTIME 8
   7 .Os
   8 .Sh NAME
   9 .Nm ntptime
  10 .Nd read kernel time variables
  11 .Sh SYNOPSIS
  12 .Nm
  13 .Op Fl chr
  14 .Op Fl e Ar est_error
  15 .Op Fl f Ar frequency
  16 .Op Fl m Ar max_error
  17 .Op Fl o Ar offset
  18 .Op Fl s Ar status
  19 .Op Fl t Ar time_constant
  20 .Sh DESCRIPTION
  21 The
  22 .Nm
  23 utility is useful only with special kernels
  24 described in the
  25 .Qo
  26 A Kernel Model for Precision Timekeeping
  27 .Qc
  28 page
  29 (available as part of the HTML documentation
  30 provided in
  31 .Pa /usr/share/doc/ntp ) .
  32 It reads and displays time-related kernel variables
  33 using the
  34 .Fn gettime
  35 and
  36 .Xr adjtime 2
  37 system calls if available.
  38 A similar display can be obtained using the
  39 .Xr ntpdc 8
  40 program's
  41 .Ic kerninfo
  42 command.
  43 .Pp
  44 The following options are available:
  45 .Bl -tag -width indent
  46 .It Fl c
  47 Display the execution time of
  48 .Nm
  49 itself.
  50 .It Fl e Ar est_error
  51 Specify estimated error, in microseconds.
  52 .It Fl f Ar frequency
  53 Specify frequency offset, in parts per million.
  54 .It Fl h
  55 Display help information.
  56 .It Fl l
  57 Specify the leap bits as a code from 0 to 3.
  58 .It Fl m Ar max_error
  59 Specify max possible errors, in microseconds.
  60 .It Fl o Ar offset
  61 Specify clock offset, in microseconds.
  62 .It Fl r
  63 Display Unix and NTP times in raw format.
  64 .It Fl s Ar status
  65 .It Fl t Ar time_constant
  66 Specify time constant, an integer in the range 0-4.
  67 .El
  68 .Sh SEE ALSO
  69 .Xr adjtime 2 ,
  70 .Xr ntpdc 8