From nobody Wed Sep 25 14:09:08 2024 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4XDJW90dG2z5XWNV; Wed, 25 Sep 2024 14:09:09 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R11" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4XDJW85y3kz4BtD; Wed, 25 Sep 2024 14:09:08 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1727273348; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=FPAa8l3oORb0ali3i0vuc/8tdzVbb+FIi44zBOuMgGA=; b=b+2FEpJb2el5LL9Nfr1W5MKLkW6jUPe+gJnHsKnIqDlB3qTFHK5JWvBqflHCLRZmacV3fv ZRYC17D/8KdY8vfw3mkfRyGo/LusdkkebDEU6/T/fM7ihCHGtlzif0IXPVK+fIHRL1+mpf runibcW9yv0CQw+3+Unv/Vf8fy9fzPyjzY7Onv1Nz9PxFtSwSkPExNo50dAUiAEgCafMzh FxSYTf5vrPHBPdra69UrGxAR5b7ukn9WoHelUrFLDdeEkDOXr9y8SDbouFXWr4MvgRdngX f5pvsajndh40Nu5aoGyzOmoNgq5Cvc45qLmOJJkxRTiB3u9u0LvIfLpfstoxAg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1727273348; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=FPAa8l3oORb0ali3i0vuc/8tdzVbb+FIi44zBOuMgGA=; b=GmKPRLBdR4C65/XC32p5BEver/lhWSBRPQ/E/vuhPTtLE7GuiA1ugGRRWeNTWG+MqeWt+J 3qAvAAl8yAbyIW6VhpvJPIqwcKqBxvgwUt2PUnbeVVJ06XUj+tPcEuQq5X0/3PKS0Qi5rq cSSKOJEWymyixtXak1Fo2v7Bd0G6KDCxAoC6o59PKwcBR6KPn/vHSehxsmgaeWGlmu7LCP LZjz2H4LwB0UKIlQ0fVKN0Bd7gtL0iqJsLZYABFPZhaf3ExcwpTWDzTup0EY3EdSYer3CB UglTnX0IKSpaQW8iEp5mTVhIO0UKLaQfKmdSpjenKlFn1Cilockm5pz7nr9WoA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1727273348; a=rsa-sha256; cv=none; b=AxNbzmEmmtVlyrWTGahY30FhxHKBRc1BmkIzG0jAJwy+4qW18qLwhiWsGKl77Qd7BgffbZ xL0FLHZr85r0Bzu4El1DC1SJoWWAm+HKvckbEcuaECq9ZCM17iy0dDi46jLz0qzlDxjrwI 18nyX/AEegKtbrPdm17TsicU+cjt42x1fLfmx3Z6z9IBhapkCNDqZOmSJQm+Q6d/lxQhXK xaJHvY7jYawOnEhiMwJXoYtzlzDg3BFuMIW0pfk875SdBMAz7d5M+euU0ck4xqhFqaWJEv 5iuLSEeYfKaGGpSlb3UawSNbUL+xz53eBepn5/IQCr5VptaA9LWeLNxA8pfElg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4XDJW85Y7zzGGN; Wed, 25 Sep 2024 14:09:08 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 48PE98Qm025719; Wed, 25 Sep 2024 14:09:08 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 48PE98fW025716; Wed, 25 Sep 2024 14:09:08 GMT (envelope-from git) Date: Wed, 25 Sep 2024 14:09:08 GMT Message-Id: <202409251409.48PE98fW025716@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Cy Schubert Subject: git: c7a33fe37d76 - main - ntp: Improve descriptions in man pages List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: cy X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: c7a33fe37d7688cb21c743f68256680e003210ad Auto-Submitted: auto-generated The branch main has been updated by cy: URL: https://cgit.FreeBSD.org/src/commit/?id=c7a33fe37d7688cb21c743f68256680e003210ad commit c7a33fe37d7688cb21c743f68256680e003210ad Author: Alexander Ziaee AuthorDate: 2024-08-05 19:37:42 +0000 Commit: Cy Schubert 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 Reviewed by: Cy Schubert --- 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 = "[ ... ]"; #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 '; 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