From c8cb5ebeee9a4676152972df6b13978cf3b7b76e Mon Sep 17 00:00:00 2001 From: Jim Klimov Date: Mon, 30 Dec 2024 17:22:08 +0000 Subject: [PATCH] common/common.c, scripts/upsdrvsvcctl/nut-driver-enumerator.sh.in, scripts/systemd/nut*.in, scripts/Solaris/*.xml.in: when suggesting man pages for further reading, refer to correct (configurable) section identifier [#722] Signed-off-by: Jim Klimov --- common/common.c | 10 ++++++++-- scripts/Solaris/nut-driver-enumerator.xml.in | 12 ++++++------ scripts/Solaris/nut-driver.xml.in | 6 +++--- scripts/Solaris/nut-monitor.xml.in | 6 +++--- scripts/Solaris/nut-server.xml.in | 10 +++++----- scripts/Solaris/nut.xml.in | 15 +++++---------- ...nut-driver-enumerator-daemon-activator.path.in | 8 ++++---- ...-driver-enumerator-daemon-activator.service.in | 8 ++++---- .../nut-driver-enumerator-daemon.service.in | 8 ++++---- scripts/systemd/nut-driver-enumerator.path.in | 8 ++++---- scripts/systemd/nut-driver-enumerator.service.in | 8 ++++---- scripts/systemd/nut-driver@.service.in | 6 +++--- scripts/systemd/nut-monitor.service.in | 6 +++--- scripts/systemd/nut-server.service.in | 10 +++++----- scripts/systemd/nut.target | 4 ++-- scripts/upsdrvsvcctl/nut-driver-enumerator.sh.in | 6 +++--- 16 files changed, 66 insertions(+), 65 deletions(-) diff --git a/common/common.c b/common/common.c index a71cb70f1d..eca17bd867 100644 --- a/common/common.c +++ b/common/common.c @@ -678,9 +678,15 @@ const char *suggest_doc_links(const char *progname, const char *progconf) { snprintf(buf, sizeof(buf), "For more information please "); #if defined(WITH_DOCS) && WITH_DOCS + /* FIXME: Currently all NUT tools and drivers are in same + * man page section for "System Management Programs". + * If this ever changes (e.g. clients like `upsc` can be + * a "User Program" just as well), we may need an extra + method argument here. + */ snprintfcat(buf, sizeof(buf), - "Read The Fine Manual ('man %s') and/or ", - buf2); + "Read The Fine Manual ('man %s %s') and/or ", + MAN_SECTION_CMD_SYS, buf2); #endif snprintfcat(buf, sizeof(buf), "see\n\t%s/docs/man/%s.html\n", diff --git a/scripts/Solaris/nut-driver-enumerator.xml.in b/scripts/Solaris/nut-driver-enumerator.xml.in index f192aee16f..a0579c2505 100644 --- a/scripts/Solaris/nut-driver-enumerator.xml.in +++ b/scripts/Solaris/nut-driver-enumerator.xml.in @@ -118,11 +118,11 @@ - + - + - + @@ -183,11 +183,11 @@ - + - + - + diff --git a/scripts/Solaris/nut-driver.xml.in b/scripts/Solaris/nut-driver.xml.in index d5276b7092..c22dbdb20a 100644 --- a/scripts/Solaris/nut-driver.xml.in +++ b/scripts/Solaris/nut-driver.xml.in @@ -128,11 +128,11 @@ - + - + - + diff --git a/scripts/Solaris/nut-monitor.xml.in b/scripts/Solaris/nut-monitor.xml.in index fd5bed956b..7553fe357c 100644 --- a/scripts/Solaris/nut-monitor.xml.in +++ b/scripts/Solaris/nut-monitor.xml.in @@ -117,11 +117,11 @@ - + - + - + diff --git a/scripts/Solaris/nut-server.xml.in b/scripts/Solaris/nut-server.xml.in index 2733293177..4a35db17c3 100644 --- a/scripts/Solaris/nut-server.xml.in +++ b/scripts/Solaris/nut-server.xml.in @@ -147,15 +147,15 @@ - + - + - + - + - + diff --git a/scripts/Solaris/nut.xml.in b/scripts/Solaris/nut.xml.in index 79b6f96e66..154ecc50dd 100644 --- a/scripts/Solaris/nut.xml.in +++ b/scripts/Solaris/nut.xml.in @@ -87,16 +87,11 @@ - - - - - + + + + + diff --git a/scripts/systemd/nut-driver-enumerator-daemon-activator.path.in b/scripts/systemd/nut-driver-enumerator-daemon-activator.path.in index 7917d343e5..568216b714 100644 --- a/scripts/systemd/nut-driver-enumerator-daemon-activator.path.in +++ b/scripts/systemd/nut-driver-enumerator-daemon-activator.path.in @@ -14,13 +14,13 @@ After=local-fs.target Before=nut-driver.target PartOf=nut.target -Documentation=man:nut-driver-enumerator(8) +Documentation=man:nut-driver-enumerator(@MAN_SECTION_CMD_SYS@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut-driver-enumerator.html -Documentation=man:ups.conf(5) +Documentation=man:ups.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/ups.conf.html -Documentation=man:upsdrvsvcctl(8) +Documentation=man:upsdrvsvcctl(@MAN_SECTION_CMD_SYS@) Documentation=@NUT_WEBSITE_BASE@/docs/man/upsdrvsvcctl.html -Documentation=man:nut.conf(5) +Documentation=man:nut.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut.conf.html [Path] diff --git a/scripts/systemd/nut-driver-enumerator-daemon-activator.service.in b/scripts/systemd/nut-driver-enumerator-daemon-activator.service.in index 33c190cf57..9a22a82f78 100644 --- a/scripts/systemd/nut-driver-enumerator-daemon-activator.service.in +++ b/scripts/systemd/nut-driver-enumerator-daemon-activator.service.in @@ -17,13 +17,13 @@ After=local-fs.target #Before=nut-driver.target #PartOf=nut.target -Documentation=man:nut-driver-enumerator(8) +Documentation=man:nut-driver-enumerator(@MAN_SECTION_CMD_SYS@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut-driver-enumerator.html -Documentation=man:ups.conf(5) +Documentation=man:ups.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/ups.conf.html -Documentation=man:upsdrvsvcctl(8) +Documentation=man:upsdrvsvcctl(@MAN_SECTION_CMD_SYS@) Documentation=@NUT_WEBSITE_BASE@/docs/man/upsdrvsvcctl.html -Documentation=man:nut.conf(5) +Documentation=man:nut.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut.conf.html [Service] diff --git a/scripts/systemd/nut-driver-enumerator-daemon.service.in b/scripts/systemd/nut-driver-enumerator-daemon.service.in index 6f5f4e0a78..25c972a18c 100644 --- a/scripts/systemd/nut-driver-enumerator-daemon.service.in +++ b/scripts/systemd/nut-driver-enumerator-daemon.service.in @@ -16,13 +16,13 @@ After=local-fs.target Before=nut-driver.target PartOf=nut.target -Documentation=man:nut-driver-enumerator(8) +Documentation=man:nut-driver-enumerator(@MAN_SECTION_CMD_SYS@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut-driver-enumerator.html -Documentation=man:ups.conf(5) +Documentation=man:ups.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/ups.conf.html -Documentation=man:upsdrvsvcctl(8) +Documentation=man:upsdrvsvcctl(@MAN_SECTION_CMD_SYS@) Documentation=@NUT_WEBSITE_BASE@/docs/man/upsdrvsvcctl.html -Documentation=man:nut.conf(5) +Documentation=man:nut.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut.conf.html [Service] diff --git a/scripts/systemd/nut-driver-enumerator.path.in b/scripts/systemd/nut-driver-enumerator.path.in index 826dccebc5..2e63437af8 100644 --- a/scripts/systemd/nut-driver-enumerator.path.in +++ b/scripts/systemd/nut-driver-enumerator.path.in @@ -12,13 +12,13 @@ After=local-fs.target Before=nut-driver.target PartOf=nut.target -Documentation=man:nut-driver-enumerator(8) +Documentation=man:nut-driver-enumerator(@MAN_SECTION_CMD_SYS@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut-driver-enumerator.html -Documentation=man:ups.conf(5) +Documentation=man:ups.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/ups.conf.html -Documentation=man:upsdrvsvcctl(8) +Documentation=man:upsdrvsvcctl(@MAN_SECTION_CMD_SYS@) Documentation=@NUT_WEBSITE_BASE@/docs/man/upsdrvsvcctl.html -Documentation=man:nut.conf(5) +Documentation=man:nut.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut.conf.html [Path] diff --git a/scripts/systemd/nut-driver-enumerator.service.in b/scripts/systemd/nut-driver-enumerator.service.in index c28bf18817..4a7930eef0 100644 --- a/scripts/systemd/nut-driver-enumerator.service.in +++ b/scripts/systemd/nut-driver-enumerator.service.in @@ -14,13 +14,13 @@ After=local-fs.target Before=nut-driver.target PartOf=nut.target -Documentation=man:nut-driver-enumerator(8) +Documentation=man:nut-driver-enumerator(@MAN_SECTION_CMD_SYS@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut-driver-enumerator.html -Documentation=man:ups.conf(5) +Documentation=man:ups.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/ups.conf.html -Documentation=man:upsdrvsvcctl(8) +Documentation=man:upsdrvsvcctl(@MAN_SECTION_CMD_SYS@) Documentation=@NUT_WEBSITE_BASE@/docs/man/upsdrvsvcctl.html -Documentation=man:nut.conf(5) +Documentation=man:nut.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut.conf.html [Service] diff --git a/scripts/systemd/nut-driver@.service.in b/scripts/systemd/nut-driver@.service.in index af94ae85bf..4a439f2100 100644 --- a/scripts/systemd/nut-driver@.service.in +++ b/scripts/systemd/nut-driver@.service.in @@ -21,11 +21,11 @@ After=local-fs.target # Propagate stopping of the target: PartOf=nut-driver.target -Documentation=man:upsdrvsvcctl(8) +Documentation=man:upsdrvsvcctl(@MAN_SECTION_CMD_SYS@) Documentation=@NUT_WEBSITE_BASE@/docs/man/upsdrvsvcctl.html -Documentation=man:ups.conf(5) +Documentation=man:ups.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/ups.conf.html -Documentation=man:nut.conf(5) +Documentation=man:nut.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut.conf.html # Note: The choice of "network.target" allows to schedule this unit diff --git a/scripts/systemd/nut-monitor.service.in b/scripts/systemd/nut-monitor.service.in index e378080698..fe615459f5 100644 --- a/scripts/systemd/nut-monitor.service.in +++ b/scripts/systemd/nut-monitor.service.in @@ -24,11 +24,11 @@ Wants=nut-server.service # After=network-online.target PartOf=nut.target -Documentation=man:upsmon(8) +Documentation=man:upsmon(@MAN_SECTION_CMD_SYS@) Documentation=@NUT_WEBSITE_BASE@/docs/man/upsmon.html -Documentation=man:upsmon.conf(5) +Documentation=man:upsmon.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/upsmon.conf.html -Documentation=man:nut.conf(5) +Documentation=man:nut.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut.conf.html [Service] diff --git a/scripts/systemd/nut-server.service.in b/scripts/systemd/nut-server.service.in index 8b964b077c..545f7312cf 100644 --- a/scripts/systemd/nut-server.service.in +++ b/scripts/systemd/nut-server.service.in @@ -25,15 +25,15 @@ Requires=network.target Before=nut-monitor.service PartOf=nut.target -Documentation=man:upsd(8) +Documentation=man:upsd(@MAN_SECTION_CMD_SYS@) Documentation=@NUT_WEBSITE_BASE@/docs/man/upsd.html -Documentation=man:ups.conf(5) +Documentation=man:ups.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/ups.conf.html -Documentation=man:upsd.conf(5) +Documentation=man:upsd.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/upsd.conf.html -Documentation=man:upsd.users(5) +Documentation=man:upsd.users(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/upsd.users.html -Documentation=man:nut.conf(5) +Documentation=man:nut.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut.conf.html [Service] diff --git a/scripts/systemd/nut.target b/scripts/systemd/nut.target index ed803e2ec0..f44ac4dd87 100644 --- a/scripts/systemd/nut.target +++ b/scripts/systemd/nut.target @@ -11,10 +11,10 @@ Wants=local-fs.target nut-driver.target nut-server.service nut-monitor.service # network.target # TODO: Dedicated man pages? -Documentation=man:ups.conf(5) +Documentation=man:ups.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/ups.conf.html -Documentation=man:nut.conf(5) +Documentation=man:nut.conf(@MAN_SECTION_CFG@) Documentation=@NUT_WEBSITE_BASE@/docs/man/nut.conf.html [Install] diff --git a/scripts/upsdrvsvcctl/nut-driver-enumerator.sh.in b/scripts/upsdrvsvcctl/nut-driver-enumerator.sh.in index cd5ce57c3b..db376a1c54 100644 --- a/scripts/upsdrvsvcctl/nut-driver-enumerator.sh.in +++ b/scripts/upsdrvsvcctl/nut-driver-enumerator.sh.in @@ -889,11 +889,11 @@ smf_setDocLink() { [ $? = 0 ] && echo "OK" || { echo "FAILED to stash the service property group '${__PG}' for online docs">&2 ; return 1 ; } # FIXME: Pass resolved $mandir if known - __PG="tm_man_${__DRV}8" + __PG="tm_man_${__DRV}@MAN_SECTION_CMD_SYS@" /usr/sbin/svccfg -s "${__TARGET_FMRI}" delprop "${__PG}" 2>/dev/null || true /usr/sbin/svccfg -s "${__TARGET_FMRI}" addpg "${__PG}" template && \ /usr/sbin/svccfg -s "${__TARGET_FMRI}" setprop "${__PG}/manpath" = "astring:" "/usr/share/man" && \ - /usr/sbin/svccfg -s "${__TARGET_FMRI}" setprop "${__PG}/section" = "astring:" "8" && \ + /usr/sbin/svccfg -s "${__TARGET_FMRI}" setprop "${__PG}/section" = "astring:" "@MAN_SECTION_CMD_SYS@" && \ /usr/sbin/svccfg -s "${__TARGET_FMRI}" setprop "${__PG}/title" = "astring:" "${__DRV}" [ $? = 0 ] && echo "OK" || { echo "FAILED to stash the service property group '${__PG}' for local docs">&2 ; return 1 ; } @@ -1051,7 +1051,7 @@ systemd_setDocLink() { __DRV="`upsconf_getDriver "$2"`" cat > "${PROPFILE}" << EOF [Unit] -Documentation=man:${__DRV}(8) +Documentation=man:${__DRV}(@MAN_SECTION_CMD_SYS@) Documentation=${NUT_WEBSITE_BASE}/docs/man/${__DRV}.html EOF unset __DRV