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

doc: document long options

Browse source 
Document the --version and --help options in chronyd and chronyc man
page.
This commit is contained in:
Miroslav Lichvar 2020-09-22 17:01:29 +02:00
parent 455b8e4b44
commit 068cd3c311
4 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
client.c
View file

@ -3506,7 +3506,7 @@ main(int argc, char **argv)
int opt, ret = 1, multi = 0, family = IPADDR_UNSPEC; int opt, ret = 1, multi = 0, family = IPADDR_UNSPEC;
int port = DEFAULT_CANDM_PORT; int port = DEFAULT_CANDM_PORT;
/* Parse (undocumented) long command-line options */ /* Parse long command-line options */
for (optind = 1; optind < argc; optind++) { for (optind = 1; optind < argc; optind++) {
if (!strcmp("--help", argv[optind])) { if (!strcmp("--help", argv[optind])) {
print_help(progname); print_help(progname);

6
doc/chronyc.adoc
View file

@ -118,10 +118,14 @@ This option is ignored and is provided only for compatibility.
*-a*:: *-a*::
This option is ignored and is provided only for compatibility. This option is ignored and is provided only for compatibility.
*-v*:: *-v*, *--version*::
With this option *chronyc* displays its version number on the terminal and With this option *chronyc* displays its version number on the terminal and
exits. exits.
*--help*::
With this option *chronyc* displays a help message on the terminal and
exits.
== COMMANDS == COMMANDS
This section describes each of the commands available within the *chronyc* This section describes each of the commands available within the *chronyc*

5
doc/chronyd.adoc
View file

@ -187,9 +187,12 @@ still track its offset and frequency relative to the estimated true time. This
option allows *chronyd* to be started without the capability to adjust or set option allows *chronyd* to be started without the capability to adjust or set
the system clock (e.g. in some containers) to operate as an NTP server. the system clock (e.g. in some containers) to operate as an NTP server.
*-v*:: *-v*, *--version*::
With this option *chronyd* will print version number to the terminal and exit. With this option *chronyd* will print version number to the terminal and exit.
*-h*, *--help*::
With this option *chronyd* will print a help message to the terminal and exit.
== FILES == FILES
_@SYSCONFDIR@/chrony.conf_ _@SYSCONFDIR@/chrony.conf_

2
main.c
View file

@ -417,7 +417,7 @@ int main
LOG_Initialise(); LOG_Initialise();
/* Parse (undocumented) long command-line options */ /* Parse long command-line options */
for (optind = 1; optind < argc; optind++) { for (optind = 1; optind < argc; optind++) {
if (!strcmp("--help", argv[optind])) { if (!strcmp("--help", argv[optind])) {
print_help(progname); print_help(progname);