man5-editing-pass-20051213
[openafs.git] / src / man / runntp.1
1 runntp                     AFS Commands                  runntp
2
3
4 NAME
5
6    runntp -- initialize Network Time Protocol Daemon.
7
8
9    /usr/afs/bin/runntp  [-localclock]  [-precision <small
10    negative integer>]
11                                          +
12    [-logfile <pathname>]  [<machine name> ]
13
14 DESCRIPTION
15
16    Initializes  the  Network  Time  Protocol Daemon and related
17    programs on the local  machine.    It  also  constructs  the
18    ntp.conf configuration file.
19
20    This  command  is  intended as a convenient interface to the
21    standard ntpd  program,  to  be  used  on  AFS  file  server
22    machines.
23
24 WARNING
25
26    A cell in which the NTPD was running before the introduction
27    of AFS does not need to use runntp.  It is an error  to  run
28    two NTPDs on one machine.
29
30    This  command  is  not  normally issued at the command shell
31    prompt, but rather  placed  into  a  file  server  machine's
32    /usr/afs/local/BosConfig with the bos create command.
33
34    This  command does not use the syntax conventions of the AFS
35    command suites, so the command  and  switch  names  must  be
36    typed in full.
37
38 ARGUMENTS
39
40    -localclock
41              tells NTPD to use  the  local  machine's  internal
42              clock  as a possible source of the correct time in
43              case a network  partition  separates  the  machine
44              from   the   specified  machine  name(s).    Cells
45              connected to the Internet should not normally  use
46              this  flag.    In  cells  that experience frequent
47              separations  from  the   network   (voluntary   or
48              otherwise),  it  should be used only on the system
49              control machine.
50
51    -precision
52              specifies  the precision of the local clock.  This
53              argument  is  not  normally  provided.    As  ntpd
54              initializes,  it  determines  the precision of the
55              local clock on  its  own.    If  the  argument  is
56              provided, it should be a small integer preceded by
57              a hyphen to show that it is negative.   The  value
58              is  used  as  an exponent on the number 2, and the
59              result interpreted as the frequency, in  fractions
60              of  a  second,  at  which  the  local  clock  tics
61              (advances).
62
63              For example, a value of -6,  which  translates  to
64
65
66
67               -6
68              2    or 1/64, means that the local clock tics once
69              every 1/64th of a second, or has  a  precision  of
70              about   60  tics  per  second.    A  value  of  -7
71              translates to about 100 tics per second.  A  value
72              of -10 translates to about 1000 tics per second (a
73              millisecond clock).
74
75    -logfile  indicates the pathname of the  file  in  which  to
76              store  log  output from NTPD.  Indicate a location
77              on the file server machine's local  disk,  not  in
78              AFS;     a     suitable    location    might    be
79              /usr/afs/logs/ntp.log.       The    log    records
80              information  about  which  machines are serving as
81              time sources and peers, what adjustments have been
82              made  to  reduce  drift,  and  so  on.  Use ntpd's
83              debugging  mechanism  to  control  the  amount  of
84              information   produced.     If  this  argument  is
85              omitted, the information is discarded.
86
87    machine name
88              is  the  complete Internet-style host name of each
89              machine the local machine should consult  for  the
90              correct time.  Preferably the machines are outside
91              the cell.
92
93              In general, this argument is necessary only on the
94              system  control  machine.  If the issuer omits it,
95              then    the    local    machine    consults    its
96              /usr/afs/etc/CellServDB file and uses the machines
97              listed there as time sources.
98
99              See the AFS  Installation  Guide  or  consult  AFS
100              Product   Support   at   Transarc  for  advice  on
101              selecting appropriate time sources.
102
103 PRIVILEGE REQUIRED
104
105    Issuer must be listed in /usr/afs/etc/UserList to place this
106    command  in  /usr/afs/local/BosConfig,  because  that is the
107    privilege required to issue bos create.
108
109 MORE INFORMATION
110
111    bos create
112
113    UNIX manual page for ntp
114
115    UNIX manual page for ntpd
116
117    UNIX manual page for ntpdc