contrib/ntp/ntpd/ntpd.texi

   1 \input texinfo    @c -*-texinfo-*-
   2 @c %**start of header
   3 @setfilename ntpd.info
   4 @settitle ntpd: Network Time Protocol (NTP) Daemon User's Manual
   5 @include ../sntp/include/version.texi
   6 @paragraphindent 2
   7 @c %**end of header
   8
   9 @ifinfo
  10 This file documents the use of the NTP Project's ntpd, a program for
  11 controlling ntpd.
  12 @end ifinfo
  13
  14 @direntry
  15 * ntpd: (ntpd).                               NTP Daemon program
  16 @end direntry
  17
  18 @titlepage
  19 @title ntpd: Network Time Protocol (NTP) Daemon User's Manual
  20 @subtitle ntpd, version @value{VERSION}, @value{UPDATED}
  21 @c @author Max @email{foo@ntp.org}
  22 @end titlepage
  23
  24 @c @page
  25 @c @vskip 0pt plus 1filll
  26
  27 @node Top, ntpd Description, (dir), (dir)
  28 @top ntpd: Network Time Protocol (NTP) Daemon User Manual
  29
  30 The @code{ntpd} program is an operating system daemon that synchronizes the
  31 system clock to remote NTP time servers or local reference clocks.
  32 It is a complete implementation of NTP version 4 defined by RFC-5905, but
  33 also retains compatible with version 3 defined by RFC-1305 and versions
  34 1 and 2, defined by RFC-1059 and RFC-1119, respectively.
  35 The program can operate in any of several modes, including client/server,
  36 symmetric and broadcast modes, and with both symmetric-key and public-key
  37 cryptography.
  38
  39 This document applies to version @value{VERSION} of @code{ntpd}.
  40
  41 @shortcontents
  42
  43 @menu
  44 * ntpd Description::            Description
  45 * ntpd Invocation::             Invoking ntpd
  46 * Usage::                       Usage
  47 @end menu
  48
  49 @node ntpd Description
  50 @comment  node-name,  next,  previous,  up
  51 @section Description
  52
  53 The @code{ntpd} program ordinarily requires
  54 a configuration file described at @ref{ntp.conf}.
  55 This configuration file contains configuration commands described on
  56 the pages listed above.
  57 However a client can discover remote servers and configure them
  58 automatically.
  59 This makes it possible to deploy a fleet of workstations without
  60 specifying configuration details specific to the local environment.
  61
  62 The @code{ntpd} program normally operates continuously while adjusting the
  63 system time and frequency, but in some cases this might not be
  64 practical.
  65 With the @code{-q} option @code{ntpd} operates as in continuous mode, but
  66 exits just after setting the clock for the first time.
  67 Most applications will probably want to specify the @code{iburst}
  68 option with the @code{server} command.
  69 With this option an initial volley of messages is exchanged to
  70 groom the data and set the clock in about ten seconds' time.
  71 If nothing is heard after a few minutes' time,
  72 the daemon times out and exits without setting the clock.
  73
  74 @include invoke-ntpd.texi
  75
  76 @node Usage
  77 @comment  node-name,  next,  previous,  up
  78 @section Usage
  79
  80 @multitable @columnfractions .23 .23 .05 .15
  81 @headitem What @tab Default @tab Flag @tab Option
  82 @item configuration file
  83 @tab @code{/etc/ntp.conf}
  84 @tab @code{-c}
  85 @tab @code{conffile}
  86 @item frequency file
  87 @tab none
  88 @tab @code{-f}
  89 @tab @code{driftfile}
  90 @item leapseconds file
  91 @tab none
  92 @tab
  93 @tab @code{leapfile}
  94 @item process ID file
  95 @tab none
  96 @tab @code{-p}
  97 @tab @code{pidfile}
  98 @item log file
  99 @tab system log
 100 @tab @code{-l}
 101 @tab @code{logfile}
 102 @item include file
 103 @tab none
 104 @tab none
 105 @tab @code{includefile}
 106 @item statistics path
 107 @tab @code{/var/NTP}
 108 @tab @code{-s}
 109 @tab @code{statsdir}
 110 @item keys path
 111 @tab @code{/usr/local/etc}
 112 @tab @code{-k}
 113 @tab @code{keysdir}