common/common.c, scripts/upsdrvsvcctl/nut-driver-enumerator.sh.in, sc…

…ripts/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 <[email protected]>
networkupstools · Dec 30, 2024 · c8cb5eb · c8cb5eb
1 parent 30d4aeb
commit c8cb5eb
Show file tree

Hide file tree

Showing 16 changed files with 66 additions and 65 deletions.
diff --git 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
@@ -118,11 +118,11 @@
 				</common_name>
 				<documentation>
 					<doc_link name='upsdrvsvcctl online'	uri='@NUT_WEBSITE_BASE@/docs/man/upsdrvsvcctl.html' />
-					<manpage title='upsdrvsvcctl'		section='8' manpath='/usr/share/man' />
+					<manpage title='upsdrvsvcctl'		section='@MAN_SECTION_CMD_SYS@' manpath='/usr/share/man' />
 					<doc_link name='ups.conf online'	uri='@NUT_WEBSITE_BASE@/docs/man/ups.conf.html' />
-					<manpage title='ups.conf'		section='5' manpath='/usr/share/man' />
+					<manpage title='ups.conf'		section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
 					<doc_link name='nut.conf online'	uri='@NUT_WEBSITE_BASE@/docs/man/nut.conf.html' />
-					<manpage title='nut.conf'		section='5' manpath='/usr/share/man' />
+					<manpage title='nut.conf'		section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
 				</documentation>
 			</template>
 		</instance>
@@ -183,11 +183,11 @@
 				</common_name>
 				<documentation>
 					<doc_link name='upsdrvsvcctl online'	uri='@NUT_WEBSITE_BASE@/docs/man/upsdrvsvcctl.html' />
-					<manpage title='upsdrvsvcctl'		section='8' manpath='/usr/share/man' />
+					<manpage title='upsdrvsvcctl'		section='@MAN_SECTION_CMD_SYS@' manpath='/usr/share/man' />
 					<doc_link name='ups.conf online'	uri='@NUT_WEBSITE_BASE@/docs/man/ups.conf.html' />
-					<manpage title='ups.conf'		section='5' manpath='/usr/share/man' />
+					<manpage title='ups.conf'		section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
 					<doc_link name='nut.conf online'	uri='@NUT_WEBSITE_BASE@/docs/man/nut.conf.html' />
-					<manpage title='nut.conf'		section='5' manpath='/usr/share/man' />
+					<manpage title='nut.conf'		section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
 				</documentation>
 			</template>
 		</instance>

diff --git a/scripts/Solaris/nut-driver.xml.in b/scripts/Solaris/nut-driver.xml.in
@@ -128,11 +128,11 @@
 			</common_name>
 			<documentation>
 				<doc_link name='upsdrvsvcctl online'	uri='@NUT_WEBSITE_BASE@/docs/man/upsdrvsvcctl.html' />
-				<manpage title='upsdrvsvcctl'		section='8' manpath='/usr/share/man' />
+				<manpage title='upsdrvsvcctl'		section='@MAN_SECTION_CMD_SYS@' manpath='/usr/share/man' />
 				<doc_link name='ups.conf online'	uri='@NUT_WEBSITE_BASE@/docs/man/ups.conf.html' />
-				<manpage title='ups.conf'		section='5' manpath='/usr/share/man' />
+				<manpage title='ups.conf'		section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
 				<doc_link name='nut.conf online'	uri='@NUT_WEBSITE_BASE@/docs/man/nut.conf.html' />
-				<manpage title='nut.conf'		section='5' manpath='/usr/share/man' />
+				<manpage title='nut.conf'		section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
 			</documentation>
 		</template>
 	</service>

diff --git a/scripts/Solaris/nut-monitor.xml.in b/scripts/Solaris/nut-monitor.xml.in
@@ -117,11 +117,11 @@
 			</common_name>
 			<documentation>
 				<doc_link name='upsmon online'		uri='@NUT_WEBSITE_BASE@/docs/man/upsmon.html' />
-				<manpage title='upsmon'			section='8' manpath='/usr/share/man' />
+				<manpage title='upsmon'			section='@MAN_SECTION_CMD_SYS@' manpath='/usr/share/man' />
 				<doc_link name='upsmon.conf online'	uri='@NUT_WEBSITE_BASE@/docs/man/upsmon.conf.html' />
-				<manpage title='upsmon.conf'		section='5' manpath='/usr/share/man' />
+				<manpage title='upsmon.conf'		section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
 				<doc_link name='nut.conf online'	uri='@NUT_WEBSITE_BASE@/docs/man/nut.conf.html' />
-				<manpage title='nut.conf'		section='5' manpath='/usr/share/man' />
+				<manpage title='nut.conf'		section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
 			</documentation>
 		</template>
 	</service>

diff --git a/scripts/Solaris/nut-server.xml.in b/scripts/Solaris/nut-server.xml.in
@@ -147,15 +147,15 @@
 			</common_name>
 			<documentation>
 				<doc_link name='upsd online'		uri='@NUT_WEBSITE_BASE@/docs/man/upsd.html' />
-				<manpage title='upsd'			section='8' manpath='/usr/share/man' />
+				<manpage title='upsd'			section='@MAN_SECTION_CMD_SYS@' manpath='/usr/share/man' />
 				<doc_link name='ups.conf online'	uri='@NUT_WEBSITE_BASE@/docs/man/ups.conf.html' />
-				<manpage title='ups.conf'		section='5' manpath='/usr/share/man' />
+				<manpage title='ups.conf'		section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
 				<doc_link name='upsd.conf online'	uri='@NUT_WEBSITE_BASE@/docs/man/upsd.conf.html' />
-				<manpage title='upsd.conf'		section='5' manpath='/usr/share/man' />
+				<manpage title='upsd.conf'		section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
 				<doc_link name='upsd.users online'	uri='@NUT_WEBSITE_BASE@/docs/man/upsd.users.html' />
-				<manpage title='upsd.users'		section='5' manpath='/usr/share/man' />
+				<manpage title='upsd.users'		section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
 				<doc_link name='nut.conf online'	uri='@NUT_WEBSITE_BASE@/docs/man/nut.conf.html' />
-				<manpage title='nut.conf'		section='5' manpath='/usr/share/man' />
+				<manpage title='nut.conf'		section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
 			</documentation>
 		</template>
 	</service>

diff --git a/scripts/Solaris/nut.xml.in b/scripts/Solaris/nut.xml.in
@@ -87,16 +87,11 @@
 				</loctext>
 			</common_name>
 			<documentation>
-				<manpage title='upsdrvctl' section='8'
-				manpath='/usr/share/man' />
-				<manpage title='upsd' section='8'
-				manpath='/usr/share/man' />
-				<manpage title='ups.conf' section='5'
-				manpath='/usr/share/man' />
-				<manpage title='upsd.conf' section='5'
-				manpath='/usr/share/man' />
-				<manpage title='upsd.users' section='5'
-				manpath='/usr/share/man' />
+				<manpage title='upsdrvctl'	section='@MAN_SECTION_CMD_SYS@' manpath='/usr/share/man' />
+				<manpage title='upsd'		section='@MAN_SECTION_CMD_SYS@' manpath='/usr/share/man' />
+				<manpage title='ups.conf'	section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
+				<manpage title='upsd.conf'	section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
+				<manpage title='upsd.users'	section='@MAN_SECTION_CFG@' manpath='/usr/share/man' />
 			</documentation>
 		</template>
 	</service>

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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/[email protected] b/scripts/systemd/[email protected]
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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