diff options
| author | Ludovic Courtès <ludo@gnu.org> | 2018-10-19 22:46:23 +0200 |
|---|---|---|
| committer | Ludovic Courtès <ludo@gnu.org> | 2018-10-19 23:39:41 +0200 |
| commit | 64791eb7e1dceb0940cc881e84820f0170298b34 (patch) | |
| tree | 55d99db1dcaccba3bc94e0a969639be8057cfb5d /doc/guix.texi | |
| parent | bc83b2e22f39c00ab3d0072c9c8f13285f7967d6 (diff) | |
| download | gnu-guix-64791eb7e1dceb0940cc881e84820f0170298b34.tar gnu-guix-64791eb7e1dceb0940cc881e84820f0170298b34.tar.gz | |
services: ntp: Document 'ntp-service-type' and 'ntp-configuration'.
* gnu/services/networking.scm (<ntp-configuration>)[servers]: Add
default value.
(ntp-service-type)[default-value]: New field.
(ntp-service): Mark as deprecated.
* gnu/services/desktop.scm (%desktop-services): Use (service
ntp-service-type) instead of calling 'ntp-service'.
* doc/guix.texi (Networking Services): Document 'ntp-service-type' and
'ntp-configuration'.
Diffstat (limited to 'doc/guix.texi')
| -rw-r--r-- | doc/guix.texi | 39 |
1 files changed, 28 insertions, 11 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index f4f19949f1..12346c4b8e 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -11817,20 +11817,37 @@ objects}). @end table @end deftp -@cindex NTP +@cindex NTP (Network Time Protocol), service @cindex real time clock -@deffn {Scheme Procedure} ntp-service [#:ntp @var{ntp}] @ - [#:servers @var{%ntp-servers}] @ - [#:allow-large-adjustment? #f] -Return a service that runs the daemon from @var{ntp}, the -@uref{http://www.ntp.org, Network Time Protocol package}. The daemon will -keep the system clock synchronized with that of @var{servers}. -@var{allow-large-adjustment?} determines whether @command{ntpd} is allowed to -make an initial adjustment of more than 1,000 seconds. -@end deffn +@defvr {Scheme Variable} ntp-service-type +This is the type of the service running the the @uref{http://www.ntp.org, +Network Time Protocol (NTP)} daemon, @command{ntpd}. The daemon will keep the +system clock synchronized with that of the specified NTP servers. + +The value of this service is an @code{ntpd-configuration} object, as described +below. +@end defvr + +@deftp {Data Type} ntp-configuration +This is the data type for the NTP service configuration. + +@table @asis +@item @code{servers} (default: @code{%ntp-servers}) +This is the list of servers (host names) with which @command{ntpd} will be +synchronized. + +@item @code{allow-large-adjustment?} (default: @code{#f}) +This determines whether @command{ntpd} is allowed to make an initial +adjustment of more than 1,000 seconds. + +@item @code{ntp} (default: @code{ntp}) +The NTP package to use. +@end table +@end deftp @defvr {Scheme Variable} %ntp-servers -List of host names used as the default NTP servers. +List of host names used as the default NTP servers. These are servers of the +@uref{https://www.ntppool.org/en/, NTP Pool Project}. @end defvr @cindex OpenNTPD |