diff --git a/doc/src/Makefile b/doc/src/Makefile index f4289a5fa3..feed8d646e 100644 --- a/doc/src/Makefile +++ b/doc/src/Makefile @@ -1,16 +1,16 @@ # Postgres documentation makefile -# $Header: /cvsroot/pgsql/doc/src/Makefile,v 1.14 2000/10/08 13:24:08 petere Exp $ +# $Header: /cvsroot/pgsql/doc/src/Makefile,v 1.15 2000/11/24 17:44:21 petere Exp $ subdir = doc/src top_builddir = ../.. --include $(top_builddir)/src/Makefile.global +include $(top_builddir)/src/Makefile.global TAR= tar ZIP= gzip ZIPSUFFIX= gz TAREXCLUDE= --exclude=Makefile --exclude='*.sgml' --exclude=ref -SRC= admin postgres programmer tutorial user developer +SRC= admin developer reference programmer tutorial user postgres TARGETS= $(SRC:%=%.tar.$(ZIPSUFFIX)) @@ -35,14 +35,9 @@ sources: sources.tar: $(TAR) -cf $@ sgml graphics -admin.tar: +admin.tar developer.tar reference.tar user.tar: $(MAKE) -C sgml clean - $(MAKE) -C sgml admin.html - cd sgml && $(TAR) -cf ../$@ $(TAREXCLUDE) *.html *.htm - -developer.tar: - $(MAKE) -C sgml clean - $(MAKE) -C sgml developer.html + $(MAKE) -C sgml $(basename $@).html cd sgml && $(TAR) -cf ../$@ $(TAREXCLUDE) *.html *.htm programmer.tar: @@ -55,11 +50,6 @@ tutorial.tar: $(MAKE) -C sgml tutorial.html cd sgml && $(TAR) -cf ../$@ $(TAREXCLUDE) *.html *.htm -C ../graphics clientserver.gif -user.tar: - $(MAKE) -C sgml clean - $(MAKE) -C sgml user.html - cd sgml && $(TAR) -cf ../$@ $(TAREXCLUDE) *.html *.htm - postgres.tar: $(MAKE) -C sgml clean $(MAKE) -C sgml postgres.html diff --git a/doc/src/sgml/Makefile b/doc/src/sgml/Makefile index ff314b94a0..acf6afb14a 100644 --- a/doc/src/sgml/Makefile +++ b/doc/src/sgml/Makefile @@ -8,7 +8,7 @@ # # # IDENTIFICATION -# $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.25 2000/11/05 21:04:06 petere Exp $ +# $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.26 2000/11/24 17:44:21 petere Exp $ # #---------------------------------------------------------------------------- @@ -55,7 +55,7 @@ D2MSCRIPT= $(D2MDIR)/docbook2man-spec.pl vpath %.sgml ./ref -ALLDOCUMENTS = admin user programmer developer tutorial postgres +ALLBOOKS = admin developer programmer reference tutorial user ALLSGML := $(wildcard $(srcdir)/*.sgml $(srcdir)/ref/*.sgml) @@ -155,10 +155,18 @@ manl: $(SQLTARGETS) manpage.refs ## HTML ## -%.html: %.sgml $(ALLSGML) +JADE.html = $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) -d $(HDSL) -V %use-id-as-filename% -t sgml + +postgres.html: postgres.sgml $(ALLSGML) @rm -f *.htm - $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) -d $(HDSL) -V %use-id-as-filename% -t sgml $< + $(JADE.html) $< # Include some softlinks to the generic default file names + ln -sf postgres.htm index.html + ln -sf postgres.htm postgres.html + +$(addsuffix .html, $(ALLBOOKS)): %.html: %.sgml $(ALLSGML) + @rm -f *.htm + $(JADE.html) book-decl.sgml $< ln -sf $*.htm index.html ln -sf $*.htm $*.html @@ -168,12 +176,12 @@ manl: $(SQLTARGETS) manpage.refs ## # RTF to allow minor editing for hardcopy -%.rtf: %.sgml - $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) -d $(PDSL) -t rtf $< +$(addsuffix .rtf, $(ALLBOOKS)): %.rtf: %.sgml $(ALLSGML) + $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) -d $(PDSL) -t rtf book-decl.sgml $< # TeX and DVI -%.tex: %.sgml - $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) -d $(PDSL) -t tex $< +$(addsuffix .tex, $(ALLBOOKS)): %.tex: %.sgml $(ALLSGML) + $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) -d $(PDSL) -t tex book-decl.sgml $< %.dvi: %.tex jadetex $< @@ -222,10 +230,13 @@ tempfile_HISTORY.sgml: release.sgml ## Check ## -check: $(addprefix check-, $(ALLDOCUMENTS)) +check: $(addprefix check-, $(ALLBOOKS)) check-postgres # Quick syntax check without style processing -check-%: %.sgml +$(addprefix check-, $(ALLBOOKS)): check-%: %.sgml + $(NSGMLS) $(SGMLINCLUDE) -s book-decl.sgml $< + +check-postgres: postgres.sgml $(NSGMLS) $(SGMLINCLUDE) -s $< diff --git a/doc/src/sgml/about.sgml b/doc/src/sgml/about.sgml index bf79ab78b5..1d562fab7a 100644 --- a/doc/src/sgml/about.sgml +++ b/doc/src/sgml/about.sgml @@ -3,7 +3,7 @@ PostgreSQL is available without cost. This manual - describes version 7.0 of PostgreSQL. + describes version &version; of PostgreSQL. diff --git a/doc/src/sgml/admin.sgml b/doc/src/sgml/admin.sgml index de2a85ab61..304580eb81 100644 --- a/doc/src/sgml/admin.sgml +++ b/doc/src/sgml/admin.sgml @@ -1,75 +1,22 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -]> - - PostgreSQL Administrator's Guide + <![%single-book;[PostgreSQL &version;]]> Administrator's Guide - Covering v7.0 for general release - - - The PostgreSQL Development Team - - - - Thomas - Lockhart - - Caltech/JPL - - - - - + The PostgreSQL Global Development Group - (last updated 2000-05-01) - + + Thomas + Lockhart + + Caltech/JPL + + @@ -80,7 +27,7 @@ Derived from postgres.sgml. - + Summary @@ -95,7 +42,14 @@ Derived from postgres.sgml. + + &installation; &installw; &runtime; @@ -107,16 +61,9 @@ Derived from postgres.sgml. &recovery; ®ress; &release; - + - ---> - +]]> + - - - - - - - - - - - - - - - - - - - - - -]> - - <productname>PostgreSQL Developer's Guide</></> + <title><![%single-book;[PostgreSQL &version;]]> Developer's Guide @@ -37,7 +12,7 @@ - The PostgreSQL Global Development Group + The PostgreSQL Global Development Group &sources; @@ -53,8 +28,9 @@ &compiler; &bki; &page; + &cvs; &docguide; diff --git a/doc/src/sgml/filelist.sgml b/doc/src/sgml/filelist.sgml new file mode 100644 index 0000000000..051a432d9f --- /dev/null +++ b/doc/src/sgml/filelist.sgml @@ -0,0 +1,103 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +%allfiles; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/src/sgml/indices.sgml b/doc/src/sgml/indices.sgml index 66a8a415f5..63db6fc852 100644 --- a/doc/src/sgml/indices.sgml +++ b/doc/src/sgml/indices.sgml @@ -150,9 +150,7 @@ SELECT am.amname AS acc_name, - Use - to remove an index. + Use DROP INDEX to remove an index. diff --git a/doc/src/sgml/postgres.sgml b/doc/src/sgml/postgres.sgml index 0787a4d80f..28532e6252 100644 --- a/doc/src/sgml/postgres.sgml +++ b/doc/src/sgml/postgres.sgml @@ -1,282 +1,39 @@ - + +%version; + +%filelist; - - - - - - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -%allfiles; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + ]> - - PostgreSQL Documentation + PostgreSQL &version; Documentation - - User's Guide + + The PostgreSQL Global Development Group + - - - - Information for Users - - - - - &intro; - &syntax; - &datatype; - &oper; - &func; - &typeconv; - &indices; - &array; - &inherit; - &plsql; - &pltcl; - &plperl; - &mvcc; - &environ; - &manage; - &storage; - &plan; - &populate; - &commands; - - &datetime; - - &biblio; - - - - Administrator's Guide - - - - - Information for Administrators - - - - - - &installation; - &installw; - &runtime; - &client-auth; - &charset; - &manage-ag; - &user-manag; - &backup; - &recovery; - ®ress; - &release; - - - - Programmer's Guide - - - - - Information on client and server programming - - - - - - - Server Programming - &arch-pg; - &extend; - &xfunc; - &xtypes; - &xoper; - &xaggr; - &rules; - &xindex; - &indexcost; - &gist; - &dfunc; - &trigger; - &spi; - &xplang; - - - - Client Interfaces - &func-ref; - &lobj; - &ecpg; - &libpq; - &libpqpp; - &libpgtcl; - &libpgeasy; - &odbc; - &jdbc; - &lisp; - - - - - Developer's Guide - - - - Information for Postgres developers - - - - - &sources; - &arch-dev; - &geqo; - - &protocol; - &compiler; - &bki; - &page; - &cvs; - &docguide; - - - - Tutorial - &sql; - &arch; - &start; - &query; - &advanced; - - - - + &tutorial; + &user; + &admin; + &programmer; + &reference; + &developer; diff --git a/doc/src/sgml/programmer.sgml b/doc/src/sgml/programmer.sgml index 85fc376184..9bfd580177 100644 --- a/doc/src/sgml/programmer.sgml +++ b/doc/src/sgml/programmer.sgml @@ -1,78 +1,22 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -]> - - - - PostgreSQL Programmer's Guide + <![%single-book;[PostgreSQL &version;]]> Programmer's Guide - Covering v7.0 for general release - - - The PostgreSQL Development Team - - - - Thomas - Lockhart - - Caltech/JPL - - - - - + The PostgreSQL Global Development Group - (last updated 2000-05-01) - + + Thomas + Lockhart + + Caltech/JPL + + @@ -83,20 +27,7 @@ Postgres Programmer's Guide. - - - - - + Summary @@ -111,9 +42,25 @@ Your name here... + - Server Programming</> +]]> + + <part id="programmer-client"> + <title>Client Interfaces + &libpq; + &lobj; + &libpqpp; + &libpgtcl; + &libpgeasy; + &ecpg; + &odbc; + &jdbc; + &lisp; + + + + Server Programming &arch-pg; &extend; &xfunc; @@ -139,27 +86,10 @@ Disable it until we put in some info. &trigger; &spi; - - Client Interfaces</> - &lobj; - &libpq; - &libpqpp; - &libpgtcl; - &libpgeasy; - &ecpg; - &odbc; - &jdbc; - &lisp; - </part> -<!-- -&contacts; ---> - &biblio; -<!-- -<index id="index"> -</index> ---> +<![%single-book;[ + &biblio; +]]> </book> diff --git a/doc/src/sgml/ref/allfiles.sgml b/doc/src/sgml/ref/allfiles.sgml index bdd78d1f28..3463b02777 100644 --- a/doc/src/sgml/ref/allfiles.sgml +++ b/doc/src/sgml/ref/allfiles.sgml @@ -1,12 +1,9 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/allfiles.sgml,v 1.24 2000/10/16 03:34:47 pjw Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/allfiles.sgml,v 1.25 2000/11/24 17:44:22 petere Exp $ Postgres documentation Complete list of usable sgml source files in this directory. --> -<!entity intro-ref system "intro-ref.sgml"> -<!entity commands system "commands.sgml"> - <!-- these will go into the "operators" reference chapter --> <!entity all system "all.sgml"> <!entity any system "any.sgml"> @@ -38,7 +35,7 @@ Complete list of usable sgml source files in this directory. <!entity trim system "trim.sgml"> <!entity upper system "upper.sgml"> -<!-- these are in the "commands" reference chapter --> +<!-- SQL commands --> <!entity abort system "abort.sgml"> <!entity alterGroup system "alter_group.sgml"> <!entity alterTable system "alter_table.sgml"> @@ -107,7 +104,7 @@ Complete list of usable sgml source files in this directory. <!entity update system "update.sgml"> <!entity vacuum system "vacuum.sgml"> -<!-- these are in the "utilities" reference chapter --> +<!-- applications and utilities --> <!entity createdb system "createdb.sgml"> <!entity createlang system "createlang.sgml"> <!entity createuser system "createuser.sgml"> diff --git a/doc/src/sgml/ref/commands.sgml b/doc/src/sgml/ref/commands.sgml deleted file mode 100644 index d1c55cdc7e..0000000000 --- a/doc/src/sgml/ref/commands.sgml +++ /dev/null @@ -1,175 +0,0 @@ -<!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/commands.sgml,v 1.29 2000/10/18 13:29:23 pjw Exp $ -Postgres documentation ---> - - <chapter id="sql-commands"> - <Title>SQL Commands - - - - This is reference information for the SQL - commands supported by Postgres. - - - - &abort; - &alterGroup; - &alterTable; - &alterUser; - &begin; - &close; - &cluster; - &commentOn; - &commit; - ©Table; - &createAggregate; - &createConstraint; - &createDatabase; - &createFunction; - &createGroup; - &createIndex; - &createLanguage; - &createOperator; - &createRule; - &createSequence; - &createTable; - &createTableAs; - &createTrigger; - &createType; - &createUser; - &createView; - &declare; - &delete; - &dropAggregate; - &dropDatabase; - &dropFunction; - &dropGroup; - &dropIndex; - &dropLanguage; - &dropOperator; - &dropRule; - &dropSequence; - &dropTable; - &dropTrigger; - &dropType - &dropUser; - &dropView; - &end; - &explain; - &fetch; - &grant; - &insert; - &listen; - &load; - &lock; - &move; - ¬ify; - &reindex; - &reset; - &revoke; - &rollback; - &select; - &selectInto; - &set; - &setConstraints; - &setSession; - &setTransaction; - &show; - &truncate; - &unlisten; - &update; - &vacuum; - - - - - - - Applications - - - - This is reference information for - Postgres applications - and support utilities. - - - - &createdb; - &createlang; - &createuser; - &dropdb; - &droplang; - &dropuser; - &ecpgRef; - &pgAccess; - &pgAdmin; - &pgConfig; - &pgCtl; - &pgDump; - &pgDumpall; - &pgRestore; - &psqlRef; - &pgTclSh; - &pgTkSh; - &vacuumdb; - - - - - System Applications - - - - This is reference information for - Postgres - servers and support utilities. - - - - &initdb; - &initlocation; - &ipcclean; - &pgPasswd; - &pgUpgrade; - &postgres; - &postmaster; - - - - diff --git a/doc/src/sgml/reference.sgml b/doc/src/sgml/reference.sgml index 1bf3544a1a..349a11b914 100644 --- a/doc/src/sgml/reference.sgml +++ b/doc/src/sgml/reference.sgml @@ -1,65 +1,14 @@ - - - -%allfiles; - - - -]> - - - - PostgreSQL Reference Manual + <![%single-book;[PostgreSQL &version;]]> Reference Manual - Covering v6.5 for general release - - - - Jose - Soares Da Silva - - - Oliver - Elphick - - - - - - - Oliver - Elphick - - - - (last updated 2000-05-01) - + The PostgreSQL Global Development Group @@ -67,53 +16,161 @@ Postgres User's Reference documentation. by PostgreSQL Inc. - - + + SQL Commands + + + + This is reference information for the SQL + commands supported by Postgres. + + + + &abort; + &alterGroup; + &alterTable; + &alterUser; + &begin; + &close; + &cluster; + &commentOn; + &commit; + ©Table; + &createAggregate; + &createConstraint; + &createDatabase; + &createFunction; + &createGroup; + &createIndex; + &createLanguage; + &createOperator; + &createRule; + &createSequence; + &createTable; + &createTableAs; + &createTrigger; + &createType; + &createUser; + &createView; + &declare; + &delete; + &dropAggregate; + &dropDatabase; + &dropFunction; + &dropGroup; + &dropIndex; + &dropLanguage; + &dropOperator; + &dropRule; + &dropSequence; + &dropTable; + &dropTrigger; + &dropType + &dropUser; + &dropView; + &end; + &explain; + &fetch; + &grant; + &insert; + &listen; + &load; + &lock; + &move; + ¬ify; + &reindex; + &reset; + &revoke; + &rollback; + &select; + &selectInto; + &set; + &setConstraints; + &setSession; + &setTransaction; + &show; + &truncate; + &unlisten; + &update; + &vacuum; + + - - Summary + + Client Applications - - Postgres, - developed originally in the UC Berkeley Computer Science Department, - pioneered many of the object-relational concepts - now becoming available in some commercial databases. - It provides SQL92/SQL3 language support, - transaction integrity, and type extensibility. - PostgreSQL is a public-domain, open source descendant - of this original Berkeley code. - - + + + This is reference information for + Postgres client applications and + utilities. + + - + &createdb; + &createuser; + &dropdb; + &dropuser; + &ecpgRef; + &pgAccess; + &pgAdmin; + &pgConfig; + &pgDump; + &pgDumpall; + &pgRestore; + &psqlRef; + &pgTclSh; + &pgTkSh; + &vacuumdb; - &commands; + - + + Server Applications and Utilities - &biblio; + + + This is reference information for + Postgres + server applications and support utilities. + + - + &createlang; + &droplang; + &initdb; + &initlocation; + &ipcclean; + &pgCtl; + &pgPasswd; + &pgUpgrade; + &postgres; + &postmaster; + + diff --git a/doc/src/sgml/tutorial.sgml b/doc/src/sgml/tutorial.sgml index 81f860ab4c..f4acddfa2f 100644 --- a/doc/src/sgml/tutorial.sgml +++ b/doc/src/sgml/tutorial.sgml @@ -1,60 +1,20 @@ - - - - - - - - - - - - - - - -]> - - - - PostgreSQL Tutorial + <![%single-book;[PostgreSQL &version;]]> Tutorial - Covering v7.0 for general release - - - The PostgreSQL Development Team - - - - Thomas - Lockhart - - Caltech/JPL - - - - - + The PostgreSQL Global Development Group - (last updated 2000-05-01) - + + Thomas + Lockhart + + Caltech/JPL + + @@ -65,20 +25,7 @@ thomas 1998-02-23 - - - - - + Summary @@ -93,18 +40,17 @@ Your name here... + &sql; &arch; &start; &query; &advanced; - + ---> +]]> diff --git a/doc/src/sgml/user.sgml b/doc/src/sgml/user.sgml index 80a29554a1..e4aa8267a4 100644 --- a/doc/src/sgml/user.sgml +++ b/doc/src/sgml/user.sgml @@ -1,75 +1,22 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -%allfiles; -]> - - PostgreSQL User's Guide + <![%single-book;[PostgreSQL &version;]]> User's Guide - Covering v7.0 for general release - - - The PostgreSQL Development Team - - - - Thomas - Lockhart - - Caltech/JPL - - - - - + The PostgreSQL Development Team - (last updated 2000-05-01) - + + Thomas + Lockhart + + Caltech/JPL + + @@ -80,20 +27,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/Attic/user.sgml,v 1.19 2000/05/02 20:01:53 - - - - - + Summary @@ -126,22 +60,13 @@ Your name here... &storage; &plan; &populate - &commands; &datetime; - &biblio; - - + + +