[lib/Xxf86vm manpage cleanup]

Use sed to fill in variables in man page Add shadow man pages for man pages
    that document multiple functions.

diff --git a/ChangeLog b/ChangeLog
index 96df0af..02487ee 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2005-10-12  Alan Coopersmith  <alan.coopersmith@sun.com>
+
+       * man/Makefile.am:
+       * configure.ac:
+       Use sed to fill in variables in man page
+       Add shadow man pages for man pages that document multiple functions.
+
 2005-07-08  Keith Packard  <keithp@keithp.com>
 
        * .cvsignore:

diff --git a/configure.ac b/configure.ac
index 4975de2..6a2bd98 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -13,6 +13,7 @@ AC_PROG_LIBTOOL
 # Checks for pkg-config packages
 PKG_CHECK_MODULES(XXF86VM, xproto x11 xextproto xext xf86vidmodeproto)
 
+XORG_MANPAGE_SECTIONS
 XORG_RELEASE_VERSION
 
 AC_OUTPUT([Makefile

diff --git a/man/Makefile.am b/man/Makefile.am
index ec541f1..c34da80 100644 (file)
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,3 +1,89 @@
-man_MANS = XF86VM.3
+# $Id$
+#
+# Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
+# 
+# Permission to use, copy, modify, distribute, and sell this software and its
+# documentation for any purpose is hereby granted without fee, provided that
+# the above copyright notice appear in all copies and that both that
+# copyright notice and this permission notice appear in supporting
+# documentation.
+# 
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
+# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+# 
+# Except as contained in this notice, the name of the copyright holders shall
+# not be used in advertising or otherwise to promote the sale, use or
+# other dealings in this Software without prior written authorization
+# from the copyright holders.
+# 
 
-EXTRA_DIST = $(man_MANS)
+libmandir = $(mandir)/man$(LIB_MAN_SUFFIX)
+
+libman_SOURCES = XF86VM.man
+
+BUILT_SOURCES = .shadows.DONE
+
+EXTRA_DIST = $(libman_SOURCES)
+
+CLEANFILES = $(libman_DATA) $(BUILT_SOURCES)
+
+libman_DATA = $(libman_SOURCES:man=$(LIB_MAN_SUFFIX)) \
+             $(XF86VM_shadows:=.$(LIB_MAN_SUFFIX))
+
+SED = sed
+
+# Strings to replace in man pages
+XORGRELSTRING = @PACKAGE_STRING@
+  XORGMANNAME = X Version 11
+
+MAN_SUBSTS = \
+       -e 's/__vendorversion__/"$(XORGRELSTRING)" "$(XORGMANNAME)"/' \
+       -e 's/__xservername__/Xorg/g' \
+       -e 's/__xconfigfile__/xorg.conf/g' \
+       -e 's/__appmansuffix__/$(APP_MAN_SUFFIX)/g' \
+       -e 's/__libmansuffix__/$(LIB_MAN_SUFFIX)/g' \
+       -e 's/__filemansuffix__/$(FILE_MAN_SUFFIX)/g'
+
+SUFFIXES = .$(LIB_MAN_SUFFIX) .man
+
+.man.$(LIB_MAN_SUFFIX):
+       sed $(MAN_SUBSTS) < $< > $@
+
+# Generate man page shadow files (Replaces InstallManPageAliases from Imake)
+
+XF86VM_shadows =                            \
+    XF86VidModeQueryExtension               \
+    XF86VidModeQueryVersion                 \
+    XF86VidModeGetModeLine                  \
+    XF86VidModeGetAllModeLines              \
+    XF86VidModeDeleteModeLine               \
+    XF86VidModeModModeLine                  \
+    XF86VidModeSwitchMode                   \
+    XF86VidModeSwitchToMode                 \
+    XF86VidModeLockModeSwitch               \
+    XF86VidModeGetMonitor                   \
+    XF86VidModeGetViewPort                  \
+    XF86VidModeSetViewPort                  \
+    XF86VidModeValidateModeLine             \
+    XF86VidModeSetClientVersion             \
+    XF86VidModeGetDotClocks                 \
+    XF86VidModeGetGamma                     \
+    XF86VidModeSetGamma                     \
+    XF86VidModeSetGammaRamp                 \
+    XF86VidModeGetGammaRamp                 \
+    XF86VidModeGetGammaRampSize             \
+    XF86VidModeGetPermissions
+
+.shadows.DONE:
+       -rm -f $(XF86VM_shadows:=.$(LIB_MAN_SUFFIX))
+       (for i in $(XF86VM_shadows:=.$(LIB_MAN_SUFFIX)) ; do \
+        echo .so man$(LIB_MAN_SUFFIX)/XF86VM.$(LIB_MAN_SUFFIX) > $$i; \
+        done)