]> git.ipfire.org Git - thirdparty/chrony.git/commitdiff
doc: document long options
authorMiroslav Lichvar <mlichvar@redhat.com>
Tue, 22 Sep 2020 15:01:29 +0000 (17:01 +0200)
committerMiroslav Lichvar <mlichvar@redhat.com>
Wed, 23 Sep 2020 13:10:43 +0000 (15:10 +0200)
Document the --version and --help options in chronyd and chronyc man
page.

client.c
doc/chronyc.adoc
doc/chronyd.adoc
main.c

index 5f068fb09f72f24161cd75d5bd062a3964f6d0fa..8a70373d25083429936a5c836dd347c6c58f6301 100644 (file)
--- a/client.c
+++ b/client.c
@@ -3506,7 +3506,7 @@ main(int argc, char **argv)
   int opt, ret = 1, multi = 0, family = IPADDR_UNSPEC;
   int port = DEFAULT_CANDM_PORT;
 
-  /* Parse (undocumented) long command-line options */
+  /* Parse long command-line options */
   for (optind = 1; optind < argc; optind++) {
     if (!strcmp("--help", argv[optind])) {
       print_help(progname);
index bd4437a4656310d49f62c5f9e4d91a289345d338..e41694506cead60a8d536a47fe876c9c47859326 100644 (file)
@@ -118,10 +118,14 @@ This option is ignored and is provided only for compatibility.
 *-a*::
 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
 exits.
 
+*--help*::
+With this option *chronyc* displays a help message on the terminal and
+exits.
+
 == COMMANDS
 
 This section describes each of the commands available within the *chronyc*
index c3bd80d1caf217fe612c8d96a354bb766b7acaa0..f67eb29d4926fc31ae10e83962123e52a86dc85c 100644 (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
 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.
 
+*-h*, *--help*::
+With this option *chronyd* will print a help message to the terminal and exit.
+
 == FILES
 
 _@SYSCONFDIR@/chrony.conf_
diff --git a/main.c b/main.c
index 3690fd87c1c0a68feeb6d0303eb9280a26a66084..3399670ac87e0beca744e71e49923dc969e2c16c 100644 (file)
--- a/main.c
+++ b/main.c
@@ -417,7 +417,7 @@ int main
 
   LOG_Initialise();
 
-  /* Parse (undocumented) long command-line options */
+  /* Parse long command-line options */
   for (optind = 1; optind < argc; optind++) {
     if (!strcmp("--help", argv[optind])) {
       print_help(progname);