faraphel/chrony
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: improve chronyd man page

Browse source
This commit is contained in:
Miroslav Lichvar 2019-07-04 17:37:54 +02:00
parent 70fa3a6905
commit 8e74655b03
1 changed files with 13 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
doc/chronyd.adoc
View file

@ -41,7 +41,7 @@ If no configuration directives are specified on the command line, *chronyd*
will read them from a configuration file. The compiled-in default location of will read them from a configuration file. The compiled-in default location of
the file is _@SYSCONFDIR@/chrony.conf_. the file is _@SYSCONFDIR@/chrony.conf_.
Information messages and warnings will be logged to syslog. Informational messages, warnings, and errors will be logged to syslog.
== OPTIONS == OPTIONS
@ -55,20 +55,20 @@ IPv6 sockets will be created.
*-f* _file_:: *-f* _file_::
This option can be used to specify an alternate location for the configuration This option can be used to specify an alternate location for the configuration
file (default _@SYSCONFDIR@/chrony.conf_). file. The default value is _@SYSCONFDIR@/chrony.conf_.
*-n*:: *-n*::
When run in this mode, the program will not detach itself from the terminal. When run in this mode, the program will not detach itself from the terminal.
*-d*:: *-d*::
When run in this mode, the program will not detach itself from the terminal, When run in this mode, the program will not detach itself from the terminal,
and all messages will be written to the terminal instead of syslog. When and all messages will be written to the terminal instead of syslog. If
*chronyd* was compiled with debugging support, this option can be used twice to *chronyd* was compiled with enabled support for debugging, this option can be
print also debugging messages. used twice to enable debug messages.
*-l* _file_:: *-l* _file_::
This option specifies a file which should be used for logging instead of syslog This option enables writing of log messages to a file instead of syslog or the
or terminal. terminal.
*-L* _level_:: *-L* _level_::
This option specifies the minimum severity level of messages to be written to This option specifies the minimum severity level of messages to be written to
@ -131,7 +131,8 @@ running, but still allow it to adjust the frequency of the system clock.
*-u* _user_:: *-u* _user_::
This option sets the name of the system user to which *chronyd* will switch This option sets the name of the system user to which *chronyd* will switch
after start in order to drop root privileges. It overrides the after start in order to drop root privileges. It overrides the
<<chrony.conf.adoc#user,*user*>> directive (default _@DEFAULT_USER@_). <<chrony.conf.adoc#user,*user*>> directive. The default value is
_@DEFAULT_USER@_.
+ +
On Linux, *chronyd* needs to be compiled with support for the *libcap* library. On Linux, *chronyd* needs to be compiled with support for the *libcap* library.
On macOS, FreeBSD, NetBSD and Solaris *chronyd* forks into two processes. On macOS, FreeBSD, NetBSD and Solaris *chronyd* forks into two processes.
@ -142,7 +143,8 @@ range of privileged system calls on behalf of the parent.
This option configures a system call filter when *chronyd* is compiled with This option configures a system call filter when *chronyd* is compiled with
support for the Linux secure computing (seccomp) facility. In level 1 the support for the Linux secure computing (seccomp) facility. In level 1 the
process is killed when a forbidden system call is made, in level -1 the SIGSYS process is killed when a forbidden system call is made, in level -1 the SIGSYS
signal is thrown instead and in level 0 the filter is disabled (default 0). signal is thrown instead and in level 0 the filter is disabled. The default
value is 0.
+ +
It's recommended to enable the filter only when it's known to work on the It's recommended to enable the filter only when it's known to work on the
version of the system where *chrony* is installed as the filter needs to allow version of the system where *chrony* is installed as the filter needs to allow
@ -154,9 +156,9 @@ killed even in normal operation.
*-P* _priority_:: *-P* _priority_::
On Linux, this option will select the SCHED_FIFO real-time scheduler at the On Linux, this option will select the SCHED_FIFO real-time scheduler at the
specified priority (which must be between 0 and 100). On macOS, this option specified priority (which must be between 0 and 100). On macOS, this option
must have either a value of 0 (the default) to disable the thread time must have either a value of 0 to disable the thread time
constraint policy or 1 for the policy to be enabled. Other systems do not constraint policy or 1 for the policy to be enabled. Other systems do not
support this option. support this option. The default value is 0.
*-m*:: *-m*::
This option will lock *chronyd* into RAM so that it will never be paged out. This option will lock *chronyd* into RAM so that it will never be paged out.