Date: Wed, 25 Sep 2024 14:09:08 GMT From: Cy Schubert <cy@FreeBSD.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org Subject: git: c7a33fe37d76 - main - ntp: Improve descriptions in man pages Message-ID: <202409251409.48PE98fW025716@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch main has been updated by cy: URL: https://cgit.FreeBSD.org/src/commit/?id=c7a33fe37d7688cb21c743f68256680e003210ad commit c7a33fe37d7688cb21c743f68256680e003210ad Author: Alexander Ziaee <concussious@runbox.com> AuthorDate: 2024-08-05 19:37:42 +0000 Commit: Cy Schubert <cy@FreeBSD.org> CommitDate: 2024-09-25 12:40:17 +0000 ntp: Improve descriptions in man pages + ntpd added to ntp.conf(5) description (search keywords) + expand NTP so these pages are shown when `apropos time` + "standard" => "reference" for increased consistency - removed redundant or duplicated search keywords ntp.org bug: https://bugs.ntp.org/show_bug.cgi?id=3936 MFC after: 3 days Reviewed by: Harlan Stenn <stenn@nwtime.org> Reviewed by: Cy Schubert <cy@nwtime.org> --- contrib/ntp/ntpd/ntp.conf.def | 2 +- contrib/ntp/ntpd/ntp.keys.def | 2 +- contrib/ntp/ntpd/ntpd-opts.def | 2 +- contrib/ntp/ntpq/ntpq-opts.def | 2 +- contrib/ntp/sntp/sntp-opts.def | 2 +- contrib/ntp/util/ntp-keygen-opts.def | 2 +- usr.sbin/ntp/doc/ntp-keygen.8 | 2 +- usr.sbin/ntp/doc/ntp.conf.5 | 2 +- usr.sbin/ntp/doc/ntp.keys.5 | 2 +- usr.sbin/ntp/doc/ntpd.8 | 2 +- usr.sbin/ntp/doc/ntpq.8 | 2 +- usr.sbin/ntp/doc/sntp.8 | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/contrib/ntp/ntpd/ntp.conf.def b/contrib/ntp/ntpd/ntp.conf.def index 444e3b35e351..aba3c25ab464 100644 --- a/contrib/ntp/ntpd/ntp.conf.def +++ b/contrib/ntp/ntpd/ntp.conf.def @@ -9,7 +9,7 @@ autogen definitions options; // file name. prog-name = "ntp.conf"; file-path = "/etc/ntp.conf"; -prog-title = "Network Time Protocol (NTP) daemon configuration file format"; +prog-title = "Network Time Protocol daemon (ntpd) configuration format"; /* explain: Additional information whenever the usage routine is invoked */ explain = <<- _END_EXPLAIN diff --git a/contrib/ntp/ntpd/ntp.keys.def b/contrib/ntp/ntpd/ntp.keys.def index e73ce4d06a1b..b0c9717e5906 100644 --- a/contrib/ntp/ntpd/ntp.keys.def +++ b/contrib/ntp/ntpd/ntp.keys.def @@ -10,7 +10,7 @@ autogen definitions options; // file name. prog-name = "ntp.keys"; file-path = "/etc/ntp.keys"; -prog-title = "NTP symmetric key file format"; +prog-title = "Network Time Protocol symmetric key format"; /* explain: Additional information whenever the usage routine is invoked */ explain = <<- _END_EXPLAIN diff --git a/contrib/ntp/ntpd/ntpd-opts.def b/contrib/ntp/ntpd/ntpd-opts.def index 00d35115dc43..6d4952a637c2 100644 --- a/contrib/ntp/ntpd/ntpd-opts.def +++ b/contrib/ntp/ntpd/ntpd-opts.def @@ -5,7 +5,7 @@ autogen definitions options; #include copyright.def prog-name = "ntpd"; -prog-title = "NTP daemon program"; +prog-title = "set clock via Network Time Protocol daemon"; argument = "[ <server1> ... <serverN> ]"; #include ntpdbase-opts.def diff --git a/contrib/ntp/ntpq/ntpq-opts.def b/contrib/ntp/ntpq/ntpq-opts.def index 85655a9d66cc..1189e81efe40 100644 --- a/contrib/ntp/ntpq/ntpq-opts.def +++ b/contrib/ntp/ntpq/ntpq-opts.def @@ -7,7 +7,7 @@ autogen definitions options; #include autogen-version.def prog-name = "ntpq"; -prog-title = "standard NTP query program"; +prog-title = "query Network Time Protocol servers"; argument = '[ host ...]'; flag = { diff --git a/contrib/ntp/sntp/sntp-opts.def b/contrib/ntp/sntp/sntp-opts.def index 7664b1bf08b9..d468b6ef8bf5 100644 --- a/contrib/ntp/sntp/sntp-opts.def +++ b/contrib/ntp/sntp/sntp-opts.def @@ -6,7 +6,7 @@ autogen definitions options; #include copyright.def prog-name = "sntp"; -prog-title = "standard Simple Network Time Protocol client program"; +prog-title = "reference Simple Network Time Protocol client"; argument = '[ hostname-or-IP ...]'; #include homerc.def diff --git a/contrib/ntp/util/ntp-keygen-opts.def b/contrib/ntp/util/ntp-keygen-opts.def index 632dbbec778d..5c06bded15fd 100644 --- a/contrib/ntp/util/ntp-keygen-opts.def +++ b/contrib/ntp/util/ntp-keygen-opts.def @@ -7,7 +7,7 @@ autogen definitions options; #include autogen-version.def prog-name = "ntp-keygen"; -prog-title = "Create a NTP host key"; +prog-title = "create a Network Time Protocol host key"; package = ntp; include = '#include <stdlib.h>'; diff --git a/usr.sbin/ntp/doc/ntp-keygen.8 b/usr.sbin/ntp/doc/ntp-keygen.8 index ad7b844d27de..3e8ffd9dbf58 100644 --- a/usr.sbin/ntp/doc/ntp-keygen.8 +++ b/usr.sbin/ntp/doc/ntp-keygen.8 @@ -8,7 +8,7 @@ .\" and the template file agmdoc-cmd.tpl .Sh NAME .Nm ntp-keygen -.Nd Create a NTP host key +.Nd create a Network Time Protocol host key .Sh SYNOPSIS .Nm .\" Mixture of short (flag) options and long options diff --git a/usr.sbin/ntp/doc/ntp.conf.5 b/usr.sbin/ntp/doc/ntp.conf.5 index 9e23a2294c48..71fb7c668db2 100644 --- a/usr.sbin/ntp/doc/ntp.conf.5 +++ b/usr.sbin/ntp/doc/ntp.conf.5 @@ -8,7 +8,7 @@ .\" and the template file agmdoc-cmd.tpl .Sh NAME .Nm ntp.conf -.Nd Network Time Protocol (NTP) daemon configuration file format +.Nd Network Time Protocol daemon (ntpd) configuration format .Sh SYNOPSIS .Nm .Op Fl \-option\-name diff --git a/usr.sbin/ntp/doc/ntp.keys.5 b/usr.sbin/ntp/doc/ntp.keys.5 index d235f3b5f7dd..6bec2880163e 100644 --- a/usr.sbin/ntp/doc/ntp.keys.5 +++ b/usr.sbin/ntp/doc/ntp.keys.5 @@ -12,7 +12,7 @@ .Sh NAME .Nm ntp.keys -.Nd NTP symmetric key file format +.Nd Network Time Protocol symmetric key format .Sh SYNOPSIS .Nm .Op Fl \-option\-name diff --git a/usr.sbin/ntp/doc/ntpd.8 b/usr.sbin/ntp/doc/ntpd.8 index 74bc07793048..83beac3632a9 100644 --- a/usr.sbin/ntp/doc/ntpd.8 +++ b/usr.sbin/ntp/doc/ntpd.8 @@ -8,7 +8,7 @@ .\" and the template file agmdoc-cmd.tpl .Sh NAME .Nm ntpd -.Nd NTP daemon program +.Nd set clock via Network Time Protocol daemon .Sh SYNOPSIS .Nm .\" Mixture of short (flag) options and long options diff --git a/usr.sbin/ntp/doc/ntpq.8 b/usr.sbin/ntp/doc/ntpq.8 index e6c66ed71d97..21f15926a0ab 100644 --- a/usr.sbin/ntp/doc/ntpq.8 +++ b/usr.sbin/ntp/doc/ntpq.8 @@ -8,7 +8,7 @@ .\" and the template file agmdoc-cmd.tpl .Sh NAME .Nm ntpq -.Nd standard NTP query program +.Nd query Network Time Protocol servers .Sh SYNOPSIS .Nm .\" Mixture of short (flag) options and long options diff --git a/usr.sbin/ntp/doc/sntp.8 b/usr.sbin/ntp/doc/sntp.8 index 94c3c2816035..4509b6efa222 100644 --- a/usr.sbin/ntp/doc/sntp.8 +++ b/usr.sbin/ntp/doc/sntp.8 @@ -8,7 +8,7 @@ .\" and the template file agmdoc-cmd.tpl .Sh NAME .Nm sntp -.Nd standard Simple Network Time Protocol client program +.Nd reference Simple Network Time Protocol client .Sh SYNOPSIS .Nm .\" Mixture of short (flag) options and long options
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202409251409.48PE98fW025716>