Install the SQL command man pages into a section appropriate for each

system.  Some systems did not understand the 'l' section, and in general
it wasn't entirely appropriate.

On SCO OpenServer, the man pages won't be installed at all until someone
figures out their man system.

29 files changed, 110 insertions, 66 deletions

diff --git a/doc/FAQ_SCO b/doc/FAQ_SCO
index 56a46f1044..6f7d2670a9 100644
--- a/doc/FAQ_SCO
+++ b/doc/FAQ_SCO
@@ -1,9 +1,9 @@
 ============================================================
-Frequently Asked Questions (FAQ) for PostgreSQL  V7.1
+Frequently Asked Questions (FAQ) for PostgreSQL 7.2
 SCO UnixWare and OpenServer specific
 to be read in conjunction with the installation instructions
 ============================================================
-last updated:           $Date: 2001/03/13 20:52:04 $
+last updated:           $Date: 2001/08/29 19:14:39 $
 
 current maintainer:     Billy G. Allie ([email protected])
 original author:        Andrew Merrill ([email protected])
@@ -21,7 +21,7 @@ Topics:
 *) Readline
 *) Using the UDK on OpenServer
 *) Compiling PostgreSQL using the UDK
-*) Reading the PostgreSQL man pages on UnixWare
+*) Reading the PostgreSQL man pages
 
 
 ***************************************************************************
@@ -125,52 +125,15 @@ This compiler bug seems to be fixed at least in
 
 
 ***************************************************************************
-*) Reading the PostgreSQL man pages on UnixWare
+*) Reading the PostgreSQL man pages
 
-By default, the PostgreSQL man pages are installed into /usr/local/pgsql/man.
-By default, UnixWare does not look there for man pages, so you will not be
-able to read them.
-
-You need to make the following changes to access the PostgreSQL man pages
-from UnixWare.
-
-1) You need to modify the MANPATH variable in /etc/default/man.  I use:
+By default, the PostgreSQL man pages are installed into
+/usr/local/pgsql/man.  By default, UnixWare does not look there for
+man pages.  To be able to read them you need to modify the MANPATH
+variable in /etc/default/man.  I use:
 
 	MANPATH=/usr/lib/scohelp/%L/man:/usr/dt/man:/usr/man:/usr/share/man:scohelp:/usr/local/man:/usr/local/pgsql/man
 
-2) Add a line that says '1sql' to /etc/default/manSection.
-
-3) The man pages for SQL commands are, by default, placed in section 'l'
-   (normally used for "l"ocal pages).  UnixWare does not support the 'l'
-   section.
-
-The solution I use is to move all these pages from section 'l' to a section
-named '1sql'.  To following KSH script will perform the move and change the
-section names in the man page:
-
-------------------------------8< CUT HERE >8------------------------------
-#!/bin/ksh
-cd /usr/local/pgsql/man
-mv man1 man.1
-mkdir man.1sql
-
-cd /usr/local/pgsql/man/manl
-for i in *.l
-do
-	sed -e '/^\.TH/s/"l"/"1sql"/'	\
-		-e 's/\\fR(l)/\\fR(1sql)/' $i >../man.1sql/${i%.l}.1sql
-done
-cd /usr/local/pgsql/man
-rm -rf manl
-/usr/ucb/catman -M /usr/local/pgsql/man 1
-/usr/ucb/catman -M /usr/local/pgsql/man 1sql
-------------------------------8< CUT HERE >8------------------------------
-
-After running this script, you can view the man pages using the 'man'
-command.  They will not be usable from the scohelp system.
-
-I am working on integrating the man pages into the scohelp system.  When I
-generate a PostgreSQL package for UnixWare 7.x, the man pages will be
-integrated into the scohelp system.
-
-I have not tried using the PostgreSQL man pages on OpenServer.  Volunteers??
+On OpenServer, some extra research needs to be invested to make the
+man pages usable, because the man system is a bit different from other
+platforms.  Currently, PostgreSQL will not install them at all.
diff --git a/doc/Makefile b/doc/Makefile
index 6b71896b78..8f843780a3 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -8,12 +8,13 @@
 #
 #----------------------------------------------------------------------------
 
-# This directory doesn't build anything, it is only responsible for
-# installing the documenation. It is invoked automatically by the
-# top-level makefile. The files to be installed are prepared specially
-# and are placed in this directory during distribution bundling. In
-# CVS-based trees these files don't exist, so we skip the installation
-# in that case.
+# This makefile is responsible for installing the documentation. The
+# files to be installed are prepared specially and are placed in this
+# directory during distribution bundling. In CVS-based trees these
+# files don't exist, so we skip the installation in that case.
+#
+# Before we install the man pages, we massage the section numbers to
+# follow the local conventions.
 #
 # To actually build the documenation, look into the src/ and src/sgml
 # subdirectories.
@@ -22,17 +23,47 @@ subdir = doc
 top_builddir = ..
 include $(top_builddir)/src/Makefile.global
 
+.NOTPARALLEL:
 
 ifneq ($(wildcard $(srcdir)/postgres.tar.gz),)
 found_html := yes
 endif
 
 ifneq ($(wildcard $(srcdir)/man.tar.gz),)
+# SCO OpenServer's man system is sufficiently different to not bother.
+ifneq ($(PORTNAME), sco)
 found_man := yes
 endif
+endif
+
+
+ifdef found_man
+ifndef sqlmansect
+sqlmansect = 7
+endif
+sqlmansectnum = $(shell expr X'$(sqlmansect)' : X'\([0-9]\)')
+
+all: man1/.timestamp man$(sqlmansectnum)/.timestamp
 
+man1/.timestamp man$(sqlmansect_dummy)/.timestamp: man.tar.gz
+	gzip -d -c $< | $(TAR) xf -
+	for file in man1/*.1; do \
+	  mv $$file $$file.bak && \
+	  sed -e 's/\\fR($(sqlmansect_dummy))/\\fR($(sqlmansectnum))/' $$file.bak >$$file && \
+	  rm $$file.bak || exit; \
+	done
+	@echo timestamp >man1/.timestamp
+	@echo timestamp >man$(sqlmansect_dummy)/.timestamp
 
-all:
+man$(sqlmansectnum)/.timestamp: man$(sqlmansect_dummy)/.timestamp
+	$(mkinstalldirs) man$(sqlmansectnum)
+	for file in man$(sqlmansect_dummy)/*.$(sqlmansect_dummy); do \
+	  sed -e '/^\.TH/s/"$(sqlmansect_dummy)"/"$(sqlmansect)"/'   \
+              -e 's/\\fR($(sqlmansect_dummy))/\\fR($(sqlmansectnum))/' \
+	      $$file >man$(sqlmansectnum)/`basename $$file | sed 's/.$(sqlmansect_dummy)$$/.$(sqlmansect)/'` || exit; \
+	done
+	@echo timestamp >$@
+endif # found_man
 
 
 install: all installdirs
@@ -40,12 +71,19 @@ ifdef found_html
 	gzip -d -c postgres.tar.gz | ( cd $(DESTDIR)$(docdir)/html && $(TAR) xf - )
 endif
 ifdef found_man
-	gzip -d -c man.tar.gz | ( cd $(DESTDIR)$(mandir) && $(TAR) xf - )
+	for file in man1/*.1 man$(sqlmansectnum)/*.$(sqlmansect) ; do \
+	  $(INSTALL_DATA) $$file $(DESTDIR)$(mandir)/$$file || exit; \
+	done
 endif
 
 
 installdirs:
-	$(mkinstalldirs) $(DESTDIR)$(mandir) $(DESTDIR)$(docdir)/html
+ifdef found_html
+	$(mkinstalldirs) $(DESTDIR)$(docdir)/html
+endif
+ifdef found_man
+	$(mkinstalldirs) $(addprefix $(DESTDIR)$(mandir)/man, 1 $(sqlmansectnum))
+endif
 
 
 uninstall:
@@ -53,5 +91,11 @@ ifdef found_html
 	-rm -f $(addprefix $(DESTDIR)$(docdir)/html/, $(shell gunzip -c $(srcdir)/postgres.tar.gz | tar tf -))
 endif
 ifdef found_man
-	-rm -f $(addprefix $(DESTDIR)$(mandir)/, $(shell gunzip -c $(srcdir)/man.tar.gz | tar tf -))
+	-rm -f $(addprefix $(DESTDIR)$(mandir)/, $(shell gunzip -c $(srcdir)/man.tar.gz | tar tf - | sed -e 's,man$(sqlmansect_dummy)/,man$(sqlmansectnum)/,' -e 's/.$(sqlmansect_dummy)$$/.$(sqlmansect)/'))
 endif
+
+
+clean:
+	rm -rf man1/ man$(sqlmansectnum)/ man$(sqlmansect_dummy)/
+
+distclean maintainer-clean: clean
diff --git a/doc/src/Makefile b/doc/src/Makefile
index f404846499..6be84e4435 100644
--- a/doc/src/Makefile
+++ b/doc/src/Makefile
@@ -60,7 +60,7 @@ postgres.tar:
 
 man.tar:
 	$(MAKE) -C sgml man
-	$(TAR) -cf $@ -C sgml man1 manl
+	$(TAR) -cf $@ -C sgml man1 man$(sqlmansect_dummy)
 
 # Generic production rules
 
diff --git a/doc/src/sgml/Makefile b/doc/src/sgml/Makefile
index 1ae7a23947..13c5654d37 100644
--- a/doc/src/sgml/Makefile
+++ b/doc/src/sgml/Makefile
@@ -60,7 +60,7 @@ CATALOG = $(DOCBOOKSTYLE)/catalog
 
 .PHONY: man
 
-DEFAULTSECTION := l
+DEFAULTSECTION := $(sqlmansect_dummy)
 
 man: $(ALLSGML)
 	$(NSGMLS) $(NSGMLS_FLAGS) $(srcdir)/book-decl.sgml $(srcdir)/reference.sgml \
diff --git a/src/Makefile.global.in b/src/Makefile.global.in
index 93293fbbe5..d9916a3c3b 100644
--- a/src/Makefile.global.in
+++ b/src/Makefile.global.in
@@ -88,6 +88,7 @@ includedir_server = $(pkgincludedir)/server
 includedir_internal = $(pkgincludedir)/internal
 
 mandir := @mandir@
+sqlmansect_dummy = l
 
 docdir := @docdir@
 ifeq "$(findstring pgsql, $(docdir))" ""
diff --git a/src/backend/storage/lmgr/lock.c b/src/backend/storage/lmgr/lock.c
index 22ba3300ac..9139007594 100644
--- a/src/backend/storage/lmgr/lock.c
+++ b/src/backend/storage/lmgr/lock.c
@@ -65,8 +65,6 @@ static char *lock_mode_names[] =
 	"AccessExclusiveLock"
 };
 
-static char *DeadLockMessage = "Deadlock detected.\n\tSee the lock(l) manual page for a possible cause.";
-
 
 #ifdef LOCK_DEBUG
 
@@ -953,7 +951,7 @@ WaitOnLock(LOCKMETHOD lockmethod, LOCKMODE lockmode,
 		 */
 		LOCK_PRINT("WaitOnLock: aborting on lock", lock, lockmode);
 		SpinRelease(lockMethodTable->ctl->masterLock);
-		elog(ERROR, DeadLockMessage);
+		elog(ERROR, "deadlock detected");
 		/* not reached */
 	}
 
diff --git a/src/interfaces/jdbc/org/postgresql/jdbc1/DatabaseMetaData.java b/src/interfaces/jdbc/org/postgresql/jdbc1/DatabaseMetaData.java
index a87c34e771..e1187b3094 100644
--- a/src/interfaces/jdbc/org/postgresql/jdbc1/DatabaseMetaData.java
+++ b/src/interfaces/jdbc/org/postgresql/jdbc1/DatabaseMetaData.java
@@ -1196,7 +1196,7 @@ public class DatabaseMetaData implements java.sql.DatabaseMetaData
 
   /**
    * What is the maximum number of columns in a table? From the
-   * create_table(l) manual page...
+   * CREATE TABLE reference page...
    *
    * <p>"The new class is created as a heap with no initial data.  A
    * class can have no more than 1600 attributes (realistically,
diff --git a/src/interfaces/jdbc/org/postgresql/jdbc2/DatabaseMetaData.java b/src/interfaces/jdbc/org/postgresql/jdbc2/DatabaseMetaData.java
index bc47bbde9c..6acfec1421 100644
--- a/src/interfaces/jdbc/org/postgresql/jdbc2/DatabaseMetaData.java
+++ b/src/interfaces/jdbc/org/postgresql/jdbc2/DatabaseMetaData.java
@@ -1196,7 +1196,7 @@ public class DatabaseMetaData implements java.sql.DatabaseMetaData
 
   /**
    * What is the maximum number of columns in a table? From the
-   * create_table(l) manual page...
+   * CREATE TABLE reference page...
    *
    * <p>"The new class is created as a heap with no initial data.  A
    * class can have no more than 1600 attributes (realistically,
diff --git a/src/makefiles/Makefile.aix b/src/makefiles/Makefile.aix
index a9ba100305..f500a5f09b 100644
--- a/src/makefiles/Makefile.aix
+++ b/src/makefiles/Makefile.aix
@@ -43,3 +43,5 @@ endif
 %$(DLSUFFIX): %.o %$(EXPSUFF)
 	@echo Making shared library $@ from $*.o, $*$(EXPSUFF) and postgres.imp
 	$(CC) -Wl,-H512 -Wl,-bM:SRE -Wl,-bI:$(top_builddir)/src/backend/$(POSTGRES_IMP) -Wl,-bE:$*$(EXPSUFF) -o $@ $*.o $(LDFLAGS) $(LIBS) $(LDFLAGS_SL)
+
+sqlmansect = 7
diff --git a/src/makefiles/Makefile.beos b/src/makefiles/Makefile.beos
index fa26c99354..7c79bcecd9 100644
--- a/src/makefiles/Makefile.beos
+++ b/src/makefiles/Makefile.beos
@@ -11,3 +11,5 @@ CFLAGS_SL = -fpic -DPIC
 %.so: %.o
 	ln -fs $(top_srcdir)/src/backend/postgres _APP_
 	$(CC) -nostart -Xlinker -soname=$@ -o $@ _APP_ $<
+
+sqlmansect = 7
diff --git a/src/makefiles/Makefile.bsdi b/src/makefiles/Makefile.bsdi
index 901e210fbb..95eb123841 100644
--- a/src/makefiles/Makefile.bsdi
+++ b/src/makefiles/Makefile.bsdi
@@ -22,3 +22,5 @@ endif
 
 %.so: %.o
 	$(CC) -shared -o $@ $<
+
+sqlmansect = 7
diff --git a/src/makefiles/Makefile.darwin b/src/makefiles/Makefile.darwin
index cfeba7f922..b6619165b0 100644
--- a/src/makefiles/Makefile.darwin
+++ b/src/makefiles/Makefile.darwin
@@ -6,3 +6,5 @@ CFLAGS_SL = -bundle -undefined suppress
  
 %.so: %.o
 	$(CC) $(CFLAGS) $(CFLAGS_SL) -o $@ $<
+
+sqlmansect = 7
diff --git a/src/makefiles/Makefile.dgux b/src/makefiles/Makefile.dgux
index c88ee14e0e..f9519632a2 100644
--- a/src/makefiles/Makefile.dgux
+++ b/src/makefiles/Makefile.dgux
@@ -4,3 +4,5 @@ CFLAGS_SL = -fpic
 
 %.so: %.o
 	$(CC) -shared -o $@ $<
+
+sqlmansect = 5
diff --git a/src/makefiles/Makefile.freebsd b/src/makefiles/Makefile.freebsd
index 9f270c37fa..90543b7016 100644
--- a/src/makefiles/Makefile.freebsd
+++ b/src/makefiles/Makefile.freebsd
@@ -21,3 +21,5 @@ else
 	@rm -f $@
 	$(LD) -x -Bshareable -Bforcearchive -o $@ [email protected]
 endif
+
+sqlmansect = 7
diff --git a/src/makefiles/Makefile.hpux b/src/makefiles/Makefile.hpux
index 1ed5130af0..cfdbee114b 100644
--- a/src/makefiles/Makefile.hpux
+++ b/src/makefiles/Makefile.hpux
@@ -52,3 +52,5 @@ endif
 # shlib ... should go away, since this is not really enough knowledge)
 %.sl: %.o
 	$(LD) -b -o $@ $<
+
+sqlmansect = 5
diff --git a/src/makefiles/Makefile.irix5 b/src/makefiles/Makefile.irix5
index d90fcd9a6e..4062161d9e 100644
--- a/src/makefiles/Makefile.irix5
+++ b/src/makefiles/Makefile.irix5
@@ -16,3 +16,5 @@ ifneq ($(GCC), yes)
 CFLAGS += -woff 1164,1171,1185,1195,1552
 endif
 LDFLAGS += -Wl,-woff,15 -Wl,-woff,84
+
+sqlmansect = 5sql
diff --git a/src/makefiles/Makefile.linux b/src/makefiles/Makefile.linux
index 31277151c9..2b204f9d85 100644
--- a/src/makefiles/Makefile.linux
+++ b/src/makefiles/Makefile.linux
@@ -8,3 +8,5 @@ CFLAGS_SL = -fpic
 
 %.so: %.o
 	$(CC) -shared -o $@ $<
+
+sqlmansect = 7
diff --git a/src/makefiles/Makefile.netbsd b/src/makefiles/Makefile.netbsd
index bcba61732f..59ab7a791f 100644
--- a/src/makefiles/Makefile.netbsd
+++ b/src/makefiles/Makefile.netbsd
@@ -24,3 +24,5 @@ else
 	$(LD) -x -Bshareable -Bforcearchive \
 	  -o $@ [email protected]
 endif
+
+sqlmansect = 7
diff --git a/src/makefiles/Makefile.openbsd b/src/makefiles/Makefile.openbsd
index fbcc2e2e4b..3709d24bdc 100644
--- a/src/makefiles/Makefile.openbsd
+++ b/src/makefiles/Makefile.openbsd
@@ -22,3 +22,5 @@ else
 	$(LD) -x -Bshareable -Bforcearchive \
 	  -o $@ [email protected]
 endif
+
+sqlmansect = 7
diff --git a/src/makefiles/Makefile.osf b/src/makefiles/Makefile.osf
index 2bf0cfe249..4ee46ccd75 100644
--- a/src/makefiles/Makefile.osf
+++ b/src/makefiles/Makefile.osf
@@ -5,3 +5,5 @@ rpath = -rpath $(libdir)
 
 %.so: %.o
 	$(LD) -shared -expect_unresolved '*' -o $@ $<
+
+sqlmansect = 5
diff --git a/src/makefiles/Makefile.qnx4 b/src/makefiles/Makefile.qnx4
index 2fb9d7bd19..23364955ed 100644
--- a/src/makefiles/Makefile.qnx4
+++ b/src/makefiles/Makefile.qnx4
@@ -15,3 +15,5 @@ CFLAGS_SL =
 
 override CXXFLAGS +=-I/usr/local/include/g++
 override CFLAGS +=-I/usr/local/include
+
+sqlmansect = 7
diff --git a/src/makefiles/Makefile.sco b/src/makefiles/Makefile.sco
index a2fedb22f0..4cd2bcfe2f 100644
--- a/src/makefiles/Makefile.sco
+++ b/src/makefiles/Makefile.sco
@@ -16,3 +16,4 @@ endif
 
 %.so: %.o
 	$(LD) -G -Bdynamic -o $@ $<
+sqlmansect = 7
diff --git a/src/makefiles/Makefile.solaris b/src/makefiles/Makefile.solaris
index cc33534208..8d3efda986 100644
--- a/src/makefiles/Makefile.solaris
+++ b/src/makefiles/Makefile.solaris
@@ -24,3 +24,5 @@ endif
 
 %.so: %.o
 	$(LD) -G -Bdynamic -o $@ $<
+
+sqlmansect = 5sql
diff --git a/src/makefiles/Makefile.sunos4 b/src/makefiles/Makefile.sunos4
index c45f44d099..f9e9fc63d9 100644
--- a/src/makefiles/Makefile.sunos4
+++ b/src/makefiles/Makefile.sunos4
@@ -15,3 +15,4 @@ endif
 %.so: %.o
 	$(LD) -assert pure-text -Bdynamic -o $@ $<
 
+sqlmansect = 7
diff --git a/src/makefiles/Makefile.svr4 b/src/makefiles/Makefile.svr4
index 9704f1a1d6..7a01c5c944 100644
--- a/src/makefiles/Makefile.svr4
+++ b/src/makefiles/Makefile.svr4
@@ -10,3 +10,5 @@ CFLAGS_SL =
 
 %.so: %.o
 	$(LD) -G -Bdynamic -o $@ $<
+
+sqlmansect = 5
diff --git a/src/makefiles/Makefile.ultrix4 b/src/makefiles/Makefile.ultrix4
index 1c03737756..e9acbc8d46 100644
--- a/src/makefiles/Makefile.ultrix4
+++ b/src/makefiles/Makefile.ultrix4
@@ -8,3 +8,5 @@ CFLAGS_SL = -G 0
 
 %.so: %.c
 	$(CC) -c -G 0 $(CPPFLAGS) $(CFLAGS) -o $@ $<
+
+sqlmansect = 7
diff --git a/src/makefiles/Makefile.univel b/src/makefiles/Makefile.univel
index f91cf357e7..41e64616ef 100644
--- a/src/makefiles/Makefile.univel
+++ b/src/makefiles/Makefile.univel
@@ -6,4 +6,4 @@ CFLAGS_SL = -K PIC
 %.so: %.o
 	$(LD) -G -Bdynamic -o $@ $<
 
-INSTALL= /usr/ucb/install
+sqlmansect = 5
diff --git a/src/makefiles/Makefile.unixware b/src/makefiles/Makefile.unixware
index bc2ddcad36..0a437c9b0c 100644
--- a/src/makefiles/Makefile.unixware
+++ b/src/makefiles/Makefile.unixware
@@ -19,3 +19,5 @@ endif
 
 %.so: %.o
 	$(LD) -G -Bdynamic -o $@ $<
+
+sqlmansect = 5sql
diff --git a/src/makefiles/Makefile.win b/src/makefiles/Makefile.win
index ed95b44969..ab7c3d0636 100644
--- a/src/makefiles/Makefile.win
+++ b/src/makefiles/Makefile.win
@@ -33,3 +33,5 @@ override CPPFLAGS+= -DUSE_DL_IMPORT
 endif
 
 override javadir := '$(shell cygpath -w $(javadir))'
+
+sqlmansect = 7