source: networking/netprogs/ntp.xml

trunk
Last change on this file was 7d5228e3, checked in by Bruce Dubbs <bdubbs@…>, 7 days ago

sed commands only need one -i

  • Property mode set to 100644
File size: 15.8 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY ntp-download-http "https://www.eecis.udel.edu/~ntp/ntp_spool/ntp4/ntp-4.2/ntp-&ntp-version;.tar.gz">
8 <!ENTITY ntp-download-ftp " ">
9 <!ENTITY ntp-md5sum "516bdabd94ab7c824e9771390761a46c">
10 <!ENTITY ntp-size "6.8 MB">
11 <!ENTITY ntp-buildsize "99 MB (with tests)">
12 <!ENTITY ntp-time "0.8 SBU (With tests; both using parallelism=4)">
13]>
14
15<sect1 id="ntp" xreflabel="ntp-&ntp-version;">
16 <?dbhtml filename="ntp.html"?>
17
18
19 <title>ntp-&ntp-version;</title>
20
21 <indexterm zone="ntp">
22 <primary sortas="a-ntp">ntp</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to ntp</title>
27
28 <para>
29 The <application>ntp</application> package contains a client and server
30 to keep the time synchronized between various computers over
31 a network. This package is the official reference implementation of the
32 NTP protocol.
33 </para>
34
35 &lfs121_checked;
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>
41 Download (HTTP): <ulink url="&ntp-download-http;"/>
42 </para>
43 </listitem>
44 <listitem>
45 <para>
46 Download (FTP): <ulink url="&ntp-download-ftp;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download MD5 sum: &ntp-md5sum;
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download size: &ntp-size;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Estimated disk space required: &ntp-buildsize;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated build time: &ntp-time;
67 </para>
68 </listitem>
69 </itemizedlist>
70
71 <bridgehead renderas="sect3">ntp Dependencies</bridgehead>
72
73 <bridgehead renderas="sect4">Required</bridgehead>
74 <para role="required">
75 <xref linkend="perl-io-socket-ssl"/>
76 </para>
77
78<!-- Tested 4.2.8p11 with neither wget nor lynx on system: Not required.
79 <bridgehead renderas="sect4">Recommended</bridgehead>
80 <para role="recommended">
81 <xref role="runtime" linkend="wget"/> (runtime, for
82 <command>update-leap</command>)
83<!- - The download code for update-leap uses the File::Fetch perl module,
84 which may use wget, or lynx, or some core perl modules, so maybe move
85 to optional - ->
86 </para>
87-->
88 <bridgehead renderas="sect4">Optional</bridgehead>
89 <para role="optional">
90 <xref linkend="libcap-pam"/>,
91 <xref linkend="libevent"/>,
92 <ulink url="https://www.thrysoee.dk/editline/">libedit</ulink>, and
93 <ulink url="https://www.gnu.org/software/autogen/">libopts from AutoGen</ulink>
94 </para>
95
96 <para condition="html" role="usernotes">Editor Notes:
97 <ulink url="&blfs-wiki;/ntp"/></para>
98
99 </sect2>
100
101 <sect2 role="installation">
102 <title>Installation of ntp</title>
103
104 <para>
105 There should be a dedicated user and group to take control
106 of the <command>ntpd</command> daemon after it is
107 started. Issue the following commands as the
108 <systemitem class="username">root</systemitem> user:
109 </para>
110
111<screen role="root"><userinput>groupadd -g 87 ntp &amp;&amp;
112useradd -c "Network Time Protocol" -d /var/lib/ntp -u 87 \
113 -g ntp -s /bin/false ntp</userinput></screen>
114
115<!-- At least one of the issues has been reported upstream. The next para
116 is valid for 4.8.2p10.
117
118 Leap secongs have been deprecated as of November 2022.
119 https://en.wikipedia.org/wiki/Leap_second
120
121 <para>
122 The <command>update-leap</command> command needs to be fixed in order
123 to run properly:
124 </para>
125
126<screen><userinput>sed -e 's/"(\\S+)"/"?([^\\s"]+)"?/' \
127 -i scripts/update-leap/update-leap.in</userinput></screen>
128-->
129
130 <para>
131 Fix an type issue by executing
132 </para>
133
134<screen><userinput>sed -e "s;pthread_detach(NULL);pthread_detach(0);" \
135 -i configure \
136 sntp/configure</userinput></screen>
137
138 <para>
139 Install <application>ntp</application> by running
140 the following commands:
141 </para>
142
143<screen><userinput>./configure --prefix=/usr \
144 --bindir=/usr/sbin \
145 --sysconfdir=/etc \
146 --enable-linuxcaps \
147 --with-lineeditlibs=readline \
148 --docdir=/usr/share/doc/ntp-&ntp-version; &amp;&amp;
149make</userinput></screen>
150
151 <para>
152 To test the results, issue: <command>make check</command>.
153 </para>
154
155 <para>
156 Now, as the <systemitem class="username">root</systemitem> user:
157 </para>
158
159<screen role="root"><userinput>make install &amp;&amp;
160install -v -o ntp -g ntp -d /var/lib/ntp</userinput></screen>
161
162 </sect2>
163
164 <sect2 role="commands">
165 <title>Command Explanations</title>
166
167 <para>
168 <parameter>--bindir=/usr/sbin</parameter>: This parameter places
169 the administrative programs in <filename
170 class="directory">/usr/sbin</filename>.
171 </para>
172
173 <para>
174 <parameter>--enable-linuxcaps</parameter>: ntpd is run as user
175 ntp, so use Linux capabilities for non-root clock control.
176 </para>
177
178 <para>
179 <parameter>--with-lineeditlibs=readline</parameter>: This switch
180 enables <application>Readline</application> support for
181 <command>ntpdc</command> and <command>ntpq</command> programs. If omitted,
182 <application>libedit</application> will be used if installed, otherwise no
183 readline capabilities will be compiled.
184 </para>
185
186 </sect2>
187
188 <sect2 role="configuration">
189 <title>Configuring ntp</title>
190
191 <sect3 id="ntp-config">
192 <title>Config Files</title>
193
194 <para>
195 <filename>/etc/ntp.conf</filename>
196 </para>
197
198 <indexterm zone="ntp ntp-config">
199 <primary sortas="e-etc-ntp.conf">/etc/ntp.conf</primary>
200 </indexterm>
201
202 </sect3>
203
204 <sect3>
205 <title>Configuration Information</title>
206
207 <para>
208 The following configuration file first defines various ntp
209 servers with open access from different continents. Second, it
210 creates a drift file where <command>ntpd</command> stores the
211 frequency offset and a pid file to store the
212 <command>ntpd</command> process ID. <!--Third, it defines the location
213 for the leap-second definition file
214 <filename>/etc/ntp.leapseconds</filename>, that the
215 <command>update-leap</command> script checks and updates, when
216 necessary. This script can be run as a cron job and the
217 <application>ntp</application> developers recommend a frequency of
218 about three weeks for the updates.--> Since the documentation included
219 with the package is sparse, visit the ntp website at
220 <ulink url="https://www.ntp.org/"/> and
221 <ulink url="https://www.ntppool.org/"/> for more information.
222 </para>
223
224<screen role="root"><userinput>cat &gt; /etc/ntp.conf &lt;&lt; "EOF"
225<literal># Asia
226server 0.asia.pool.ntp.org
227
228# Australia
229server 0.oceania.pool.ntp.org
230
231# Europe
232server 0.europe.pool.ntp.org
233
234# North America
235server 0.north-america.pool.ntp.org
236
237# South America
238server 2.south-america.pool.ntp.org
239
240driftfile /var/lib/ntp/ntp.drift
241pidfile /run/ntpd.pid</literal>
242EOF</userinput></screen>
243
244 <para>
245 You may wish to add a <quote>Security session</quote>. For
246 explanations, see <ulink url=
247 "https://www.eecis.udel.edu/~mills/ntp/html/accopt.html#restrict"/>.
248 </para>
249
250<screen role="root"><userinput>cat &gt;&gt; /etc/ntp.conf &lt;&lt; "EOF"
251<literal># Security session
252restrict default limited kod nomodify notrap nopeer noquery
253restrict -6 default limited kod nomodify notrap nopeer noquery
254
255restrict 127.0.0.1
256restrict ::1</literal>
257EOF</userinput></screen>
258
259 </sect3>
260
261 <sect3 id="ntp-init">
262 <title>Synchronizing the Time</title>
263
264 <para>
265 There are two options. Option one is to run <command>ntpd</command>
266 continuously and allow it to synchronize the time in a gradual manner.
267 The other option is to run <command>ntpd</command> periodically (using
268 cron) and update the time each time <command>ntpd</command> is
269 scheduled.
270 </para>
271
272 <para>
273 If you choose Option one, then install the
274 <phrase revision="sysv"><filename>/etc/rc.d/init.d/ntp</filename>
275 init script</phrase>
276 <phrase revision="systemd"><filename>ntpd.service</filename>
277 unit</phrase>
278 included in the
279 <xref linkend="bootscripts" revision="sysv"/>
280 <xref linkend="systemd-units" revision="systemd"/> package.
281 </para>
282
283 <indexterm zone="ntp ntp-init" revision="sysv">
284 <primary sortas="f-ntp">ntp</primary>
285 </indexterm>
286
287 <indexterm zone="ntp ntp-init" revision="systemd">
288 <primary sortas="f-ntpd">ntpd.service</primary>
289 </indexterm>
290
291<screen role="root"><userinput>make install-ntpd</userinput></screen>
292
293 <para>
294 If you prefer to run <command>ntpd</command> periodically, add the
295 following command to <systemitem class="username">root</systemitem>'s
296 <filename>crontab</filename>:
297 </para>
298
299<screen><literal>ntpd -q</literal></screen>
300
301 <para revision="sysv">
302 Execute the following command if you would like to set the hardware
303 clock to the current system time at shutdown and reboot:
304 </para>
305
306<screen role="root" revision="sysv"><userinput>ln -v -sf ../init.d/setclock /etc/rc.d/rc0.d/K46setclock &amp;&amp;
307ln -v -sf ../init.d/setclock /etc/rc.d/rc6.d/K46setclock</userinput></screen>
308
309 <para revision="sysv">
310 The other way around is already set up by LFS.
311 </para>
312
313 </sect3>
314
315 </sect2>
316
317 <sect2 role="content">
318 <title>Contents</title>
319
320 <segmentedlist>
321 <segtitle>Installed Programs</segtitle>
322 <segtitle>Installed Libraries</segtitle>
323 <segtitle>Installed Directories</segtitle>
324
325 <seglistitem>
326 <seg>calc_tickadj, ntp-keygen, ntp-wait, ntpd, ntpdate, ntpdc, ntpq,
327 ntptime, ntptrace, sntp, tickadj, and update-leap</seg>
328 <seg>None</seg>
329 <seg>/usr/share/ntp,
330 /usr/share/doc/ntp-4.2.8 and
331 /var/lib/ntp</seg>
332 </seglistitem>
333 </segmentedlist>
334
335 <variablelist>
336 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
337 <?dbfo list-presentation="list"?>
338 <?dbhtml list-presentation="table"?>
339
340 <varlistentry id="calc_tickadj">
341 <term><command>calc_tickadj</command></term>
342 <listitem>
343 <para>
344 calculates optimal value for tick given ntp drift file
345 </para>
346 <indexterm zone="ntp calc_tickadj">
347 <primary sortas="b-calc_tickadj">calc_tickadj</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="ntp-keygen">
353 <term><command>ntp-keygen</command></term>
354 <listitem>
355 <para>
356 generates cryptographic data files used by the NTPv4 authentication
357 and identification schemes
358 </para>
359 <indexterm zone="ntp ntp-keygen">
360 <primary sortas="b-ntp-keygen">ntp-keygen</primary>
361 </indexterm>
362 </listitem>
363 </varlistentry>
364
365 <varlistentry id="ntp-wait">
366 <term><command>ntp-wait</command></term>
367 <listitem>
368 <para>
369 is useful at boot time, to delay the boot sequence until
370 <command>ntpd</command> has set the time
371 </para>
372 <indexterm zone="ntp ntp-wait">
373 <primary sortas="b-ntp-wait">ntp-wait</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="ntpd">
379 <term><command>ntpd</command></term>
380 <listitem>
381 <para>
382 is a ntp daemon that runs in the background and keeps
383 the date and time synchronized based on response from configured
384 ntp servers. It also functions as a ntp server
385 </para>
386 <indexterm zone="ntp ntpd">
387 <primary sortas="b-ntpd">ntpd</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry id="ntpdate">
393 <term><command>ntpdate</command></term>
394 <listitem>
395 <para>
396 is a client program that sets the date and time based on
397 the response from an ntp server. This command is deprecated
398 </para>
399 <indexterm zone="ntp ntpdate">
400 <primary sortas="b-ntpdate">ntpdate</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404
405 <varlistentry id="ntpdc">
406 <term><command>ntpdc</command></term>
407 <listitem>
408 <para>
409 is used to query the ntp daemon about its current state
410 and to request changes in that state
411 </para>
412 <indexterm zone="ntp ntpdc">
413 <primary sortas="b-ntpdc">ntpdc</primary>
414 </indexterm>
415 </listitem>
416 </varlistentry>
417
418 <varlistentry id="ntpq">
419 <term><command>ntpq</command></term>
420 <listitem>
421 <para>
422 is a utility program used to monitor <command>ntpd</command>
423 operations and determine performance
424 </para>
425 <indexterm zone="ntp ntpq">
426 <primary sortas="b-ntpq">ntpq</primary>
427 </indexterm>
428 </listitem>
429 </varlistentry>
430
431 <varlistentry id="ntptime">
432 <term><command>ntptime</command></term>
433 <listitem>
434 <para>
435 reads and displays time-related kernel variables
436 </para>
437 <indexterm zone="ntp ntptime">
438 <primary sortas="b-ntptime">ntptime</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="ntptrace">
444 <term><command>ntptrace</command></term>
445 <listitem>
446 <para>
447 traces a chain of ntp servers back to the primary source
448 </para>
449 <indexterm zone="ntp ntptrace">
450 <primary sortas="b-ntptrace">ntptrace</primary>
451 </indexterm>
452 </listitem>
453 </varlistentry>
454
455 <varlistentry id="sntp">
456 <term><command>sntp</command></term>
457 <listitem>
458 <para>
459 is a Simple Network Time Protocol (SNTP) client
460 </para>
461 <indexterm zone="ntp sntp">
462 <primary sortas="b-sntp">sntp</primary>
463 </indexterm>
464 </listitem>
465 </varlistentry>
466
467 <varlistentry id="tickadj">
468 <term><command>tickadj</command></term>
469 <listitem>
470 <para>
471 reads, and optionally modifies, several timekeeping-related
472 variables in older kernels that do not have support for precision
473 timekeeping
474 </para>
475 <indexterm zone="ntp tickadj">
476 <primary sortas="b-tickadj">tickadj</primary>
477 </indexterm>
478 </listitem>
479 </varlistentry>
480
481 <varlistentry id="update-leap">
482 <term><command>update-leap</command></term>
483 <listitem>
484 <para>
485 is a script to verify and, if necessary, update the leap-second
486 definition file.
487
488 <note>
489 <para>
490 In November 2022, at the 27th General Conference on Weights and
491 Measures, it was decided to abandon the leap second. In addition
492 this script hardcodes a URL for an update file that no longer
493 exists. The last time a leap second was declared was January 2017.
494 This script will probably be removed in a future release.
495 </para>
496 </note>
497 </para>
498 <indexterm zone="ntp update-leap">
499 <primary sortas="b-update-leap">update-leap</primary>
500 </indexterm>
501 </listitem>
502 </varlistentry>
503
504 </variablelist>
505
506 </sect2>
507
508</sect1>
Note: See TracBrowser for help on using the repository browser.