[PATCH:xdm] Install xdm man pages under admin section (8), not user programs (1)

Alan Coopersmith alan.coopersmith at oracle.com
Tue Jan 17 00:26:08 UTC 2017


As best I can tell, it was historically under section 1 mainly because
the old X Consortium Imake configs only supporting installing program
man pages there, and didn't have an option for using other sections.

Signed-off-by: Alan Coopersmith <alan.coopersmith at oracle.com>
---

I'm sending this out not just for review that I made the right changes,
but to see if there's general agreement this change is right.  It was
pointed out by one of our users who thought it odd that gdm's man page
is in section 8, but xdm's is in section 1.

 man/Makefile.am  | 20 ++++++++++----------
 man/xdm.man      |  4 ++--
 man/xdmshell.man |  6 +++---
 3 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/man/Makefile.am b/man/Makefile.am
index b71409c..2a42d89 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -21,22 +21,22 @@
 # DEALINGS IN THE SOFTWARE.
 #
 
-appmandir = $(APP_MAN_DIR)
-appman_PRE = xdm.man
-appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))
+adminmandir = $(ADMIN_MAN_DIR)
+adminman_PRE = xdm.man
+adminman_DATA = $(adminman_PRE:man=$(ADMIN_MAN_SUFFIX))
 
-xdmlmandir = $(APP_MAN_DIR)
+xdmlmandir = $(ADMIN_MAN_DIR)
 xdmlman_PRE = xdmshell.man
 
 if INSTALL_XDMSHELL
-xdmlman_DATA = $(xdmlman_PRE:man=$(APP_MAN_SUFFIX))
+xdmlman_DATA = $(xdmlman_PRE:man=$(ADMIN_MAN_SUFFIX))
 else
-noinst_DATA = $(xdmlman_PRE:man=$(APP_MAN_SUFFIX))
+noinst_DATA = $(xdmlman_PRE:man=$(ADMIN_MAN_SUFFIX))
 endif
 
-EXTRA_DIST = $(appman_PRE) $(xdmlman_PRE)
-CLEANFILES = $(appman_DATA) $(xdmlman_DATA) $(noinst_DATA)
-SUFFIXES = .$(APP_MAN_SUFFIX) .man
+EXTRA_DIST = $(adminman_PRE) $(xdmlman_PRE)
+CLEANFILES = $(adminman_DATA) $(xdmlman_DATA) $(noinst_DATA)
+SUFFIXES = .$(ADMIN_MAN_SUFFIX) .man
 
 # String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure
 MAN_SUBSTS +=	-e 's|CHOOSERPATH|$(XDMLIBDIR)/chooser|g' \
@@ -51,5 +51,5 @@ MAN_SUBSTS +=	-e 's|CHOOSERPATH|$(XDMLIBDIR)/chooser|g' \
 		-e 's|DEV_RANDOM|$(DEV_RANDOM)|g' \
 		-e 's|ARC4_RANDOM|$(HAVE_ARC4RANDOM)|g'
 
-.man.$(APP_MAN_SUFFIX):
+.man.$(ADMIN_MAN_SUFFIX):
 	$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
diff --git a/man/xdm.man b/man/xdm.man
index 0648d71..ef57d8c 100644
--- a/man/xdm.man
+++ b/man/xdm.man
@@ -23,7 +23,7 @@
 .\" from The Open Group.
 .\"
 .\"
-.TH XDM 1 __xorgversion__
+.TH XDM __adminmansuffix__ __xorgversion__
 .SH NAME
 xdm \- X Display Manager with support for XDMCP, host chooser
 .SH SYNOPSIS
@@ -1454,7 +1454,7 @@ Kerberos credentials cache
 .IR sessreg (__appmansuffix__),
 .IR Xserver (__appmansuffix__),
 .\" .IR chooser (__appmansuffix__), \" except that there isn't a manual for it yet
-.IR xdmshell (__appmansuffix__),
+.IR xdmshell (__adminmansuffix__),
 .IR fonts.conf (__filemansuffix__).
 .br
 .I "X Display Manager Control Protocol"
diff --git a/man/xdmshell.man b/man/xdmshell.man
index 8f27193..7bd683f 100644
--- a/man/xdmshell.man
+++ b/man/xdmshell.man
@@ -44,7 +44,7 @@
 .\" DEALINGS IN THE SOFTWARE.
 .\"
 .\"
-.TH XDMSHELL __appmansuffix__ __xorgversion__
+.TH XDMSHELL __adminmansuffix__ __xorgversion__
 .SH NAME
 xdmshell \- shell for starting xdm on login
 .SH SYNOPSIS
@@ -66,7 +66,7 @@ disable logins on that line until somebody types the following as root:
 .RE
 .LP
 On some platforms, one alternative is to disable logins on the console
-and always run \fIxdm\fP(__appmansuffix__) from \fI/etc/inittab\fP.
+and always run \fIxdm\fP(__adminmansuffix__) from \fI/etc/inittab\fP.
 .LP
 Another approach is to set up an account whose shell is the \fIxdmshell\fP
 program found in the xdm distribution.  This program is not installed by
@@ -104,5 +104,5 @@ login to the console directly.  Whether or not this is desirable depends on
 the particular site.
 .SH "SEE ALSO"
 .IR X (__miscmansuffix__),
-.IR xdm (__appmansuffix__),
+.IR xdm (__adminmansuffix__),
 .IR xinit (__appmansuffix__)
-- 
2.7.4



More information about the xorg-devel mailing list