[PATCH v2 xserver] config: build Xserver man pages using XORG_MANPAGE_SECTIONS

Wed Nov 24 16:53:03 PST 2010

Nothing requires the use of a C preprocessor
Using standard file exentions (.man) means no need for .gitignore
Use standard directory and makefile
Fix man page whitespace issues

Reviewed-by: Matt Dew <matt at osource.org>
Signed-off-by: Gaetan Nadon <memsize at videotron.ca>
---

	Second edition fixes 18 whitespace issues.

 configure.ac                             |    1 +
 doc/.gitignore                           |    2 -
 doc/Makefile.am                          |   27 +--------------------
 doc/man/Makefile.am                      |   20 ++++++++++++++++
 doc/{Xserver.man.pre => man/Xserver.man} |   36 +++++++++++++++---------------
 5 files changed, 41 insertions(+), 45 deletions(-)
 delete mode 100644 doc/.gitignore
 create mode 100644 doc/man/Makefile.am
 rename doc/{Xserver.man.pre => man/Xserver.man} (98%)

diff --git a/configure.ac b/configure.ac
index bd027cd..2774024 100644
--- a/configure.ac
+++ b/configure.ac
@@ -2183,6 +2183,7 @@ damageext/Makefile
 dbe/Makefile
 dix/Makefile
 doc/Makefile
+doc/man/Makefile
 doc/xml/Makefile
 doc/xml/dtrace/Makefile
 doc/xml/xserver.ent
diff --git a/doc/.gitignore b/doc/.gitignore
deleted file mode 100644
index 952f528..0000000
--- a/doc/.gitignore
+++ /dev/null
@@ -1,2 +0,0 @@
-#		Add & Override for this directory and it's subdirectories
-Xserver.man
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 43606a3..4c08b6f 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,26 +1,3 @@
+SUBDIRS = man xml
 
-# Xserver.man covers options generic to all X servers built in this tree
-# (i.e. those handled in the os/utils.c options processing instead of in
-#  the DDX-level options processing)
-appmandir = $(APP_MAN_DIR)
-appman_PRE = Xserver.man.pre
-
-appman_PROCESSED = $(appman_PRE:man.pre=man)
-appman_DATA = $(appman_PRE:man.pre=@APP_MAN_SUFFIX@)
-
-BUILT_SOURCES = $(appman_PROCESSED)
-CLEANFILES = $(appman_PROCESSED) $(appman_DATA)
-
-include $(top_srcdir)/cpprules.in
-
-.man.$(APP_MAN_SUFFIX):
-	$(AM_V_at)cp $< $@
-
-EXTRAMANDEFS = -D__default_font_path__="`echo $(COMPILEDDEFAULTFONTPATH) | $(SED) -e 's/,/, /g'`"
-
-# Docs about X server internals that we ship with source but don't install
-DEVEL_DOCS = smartsched
-
-EXTRA_DIST = $(DEVEL_DOCS) $(appman_PRE) $(fileman_PRE)
-
-SUBDIRS = xml
+dist_noinst_DATA = smartsched
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
new file mode 100644
index 0000000..dd08512
--- /dev/null
+++ b/doc/man/Makefile.am
@@ -0,0 +1,20 @@
+# Xserver.man covers options generic to all X servers built in this tree
+# (i.e. those handled in the os/utils.c options processing instead of in
+#  the DDX-level options processing)
+
+appmandir = $(APP_MAN_DIR)
+appman_PRE = Xserver.man
+appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))
+
+EXTRA_DIST = $(appman_PRE)
+CLEANFILES = $(appman_DATA)
+SUFFIXES = .$(APP_MAN_SUFFIX) .man
+
+# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure
+# 's|/,|/, |g' will add a space to help font path formatting
+MAN_SUBSTS += 	-e 's|__datadir__|$(datadir)|g' \
+		-e 's|__default_font_path__|$(COMPILEDDEFAULTFONTPATH)|g' \
+		-e '\|$(COMPILEDDEFAULTFONTPATH)| s|/,|/, |g'
+
+.man.$(APP_MAN_SUFFIX):
+	$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
diff --git a/doc/Xserver.man.pre b/doc/man/Xserver.man
similarity index 98%
rename from doc/Xserver.man.pre
rename to doc/man/Xserver.man
index 240f05c..b725949 100644
--- a/doc/Xserver.man.pre
+++ b/doc/man/Xserver.man
@@ -38,7 +38,7 @@ is the generic name for the X Window System display server.  It is
 frequently a link or a copy of the appropriate server binary for
 driving the most frequently used server on a given machine.
 .SH "STARTING THE SERVER"
-The X server is usually started from the X Display Manager program 
+The X server is usually started from the X Display Manager program
 \fIxdm\fP(1) or a similar display manager program.
 This utility is run from the system boot files and takes care of keeping
 the server running, prompting for usernames and passwords, and starting up
@@ -97,7 +97,7 @@ Audit lines are sent as standard error output.
 .TP 8
 .B \-auth \fIauthorization-file\fP
 specifies a file which contains a collection of authorization records used
-to authenticate access.  See also the \fIxdm\fP(1) and 
+to authenticate access.  See also the \fIxdm\fP(1) and
 \fIXsecurity\fP(__miscmansuffix__) manual pages.
 .TP 8
 .B \-br
@@ -285,19 +285,19 @@ sets the stack space limit of the server to the specified number of kilobytes.
 A value of zero makes the stack size as large as possible.  The default value
 of \-1 leaves the stack space limit unchanged.
 .TP 8
-.B \-render 
+.B \-render
 .BR default | mono | gray | color
 sets the color allocation policy that will be used by the render extension.
 .RS 8
 .TP 8
 .I default
 selects the default policy defined for the display depth of the X
-server. 
+server.
 .TP 8
 .I mono
-don't use any color cell. 
+don't use any color cell.
 .TP 8
-.I gray 
+.I gray
 use a gray map of 13 color cells for the X render extension.
 .TP 8
 .I color
@@ -325,13 +325,13 @@ enable XDMCP and broadcasts BroadcastQuery packets to the network.  The
 first responding display manager will be chosen for the session.
 .TP 8
 .B \-multicast [\fIaddress\fP [\fIhop count\fP]]
-Enable XDMCP and multicast BroadcastQuery packets to the  network.   
-The first responding display manager is chosen for the session.  If an 
-address is specified, the multicast is sent to that address.  If no 
-address is specified, the multicast is sent to the default XDMCP IPv6 
-multicast group.  If a hop count is specified, it is used as the maximum 
-hop count for the multicast.  If no hop count is specified, the multicast 
-is set to a maximum of 1 hop, to prevent the multicast from being routed 
+Enable XDMCP and multicast BroadcastQuery packets to the  network.
+The first responding display manager is chosen for the session.  If an
+address is specified, the multicast is sent to that address.  If no
+address is specified, the multicast is sent to the default XDMCP IPv6
+multicast group.  If a hop count is specified, it is used as the maximum
+hop count for the multicast.  If no hop count is specified, the multicast
+is set to a maximum of 1 hop, to prevent the multicast from being routed
 beyond the local network.
 .TP 8
 .B \-indirect \fIhostname\fP
@@ -368,7 +368,7 @@ Yet another XDMCP specific value, this one allows the display manager to
 identify each display so that it can locate the shared key.
 .SH XKEYBOARD OPTIONS
 X servers that support the XKEYBOARD (a.k.a. \*qXKB\*q) extension accept the
-following options.  All layout files specified on the command line must be 
+following options.  All layout files specified on the command line must be
 located in the XKB base directory or a subdirectory, and specified as the
 relative path from the XKB base directory.  The default XKB base directory is
 .IR __projectroot__/lib/X11/xkb .
@@ -400,8 +400,8 @@ specify which transport type clients should try to use.
 .SH GRANTING ACCESS
 The X server implements a platform-dependent subset of the following
 authorization protocols: MIT-MAGIC-COOKIE-1, XDM-AUTHORIZATION-1,
-XDM-AUTHORIZATION-2, SUN-DES-1, and MIT-KERBEROS-5.  See the 
-\fIXsecurity\fP(__miscmansuffix__) manual page for information on the 
+XDM-AUTHORIZATION-2, SUN-DES-1, and MIT-KERBEROS-5.  See the
+\fIXsecurity\fP(__miscmansuffix__) manual page for information on the
 operation of these protocols.
 .PP
 Authorization data required by the above protocols is passed to the
@@ -486,7 +486,7 @@ is possible.
 The X server can obtain fonts from directories and/or from font servers.
 The list of directories and font servers
 the X server uses when trying to open a font is controlled
-by the \fIfont path\fP.  
+by the \fIfont path\fP.
 .LP
 The default font path is
 __default_font_path__ .
@@ -561,7 +561,7 @@ Fonts: \fIbdftopcf\fP(1), \fImkfontdir\fP(1), \fImkfontscale\fP(1),
 \fIxfs\fP(1), \fIxlsfonts\fP(1), \fIxfontsel\fP(1), \fIxfd\fP(1),
 .I "X Logical Font Description Conventions"
 .PP
-Security: \fIXsecurity\fP(__miscmansuffix__), \fIxauth\fP(1), \fIXau\fP(1), 
+Security: \fIXsecurity\fP(__miscmansuffix__), \fIxauth\fP(1), \fIXau\fP(1),
 \fIxdm\fP(1), \fIxhost\fP(1), \fIxfwp\fP(1),
 .I "Security Extension Specification"
 .PP
-- 
1.6.0.4

