diff --git a/doc/src/Makefile b/doc/src/Makefile index a6729e31387..a487707c094 100644 --- a/doc/src/Makefile +++ b/doc/src/Makefile @@ -1,39 +1,19 @@ # Postgres documentation makefile -# $Header: /cvsroot/pgsql/doc/src/Makefile,v 1.30 2002/11/30 00:22:39 tgl Exp $ +# $Header: /cvsroot/pgsql/doc/src/Makefile,v 1.31 2003/03/25 16:15:35 petere Exp $ subdir = doc/src top_builddir = ../.. include $(top_builddir)/src/Makefile.global -ZIPSUFFIX= gz - -BOOKS = admin developer reference programmer tutorial user postgres - -TARGETS= $(BOOKS:%=%.tar.$(ZIPSUFFIX)) - -.PRECIOUS: -.PHONY: install all sources clean distclean maintainer-clean - -install: all - cp -f *.$(ZIPSUFFIX) .. - clean distclean maintainer-clean: - rm -f *.tar *.$(ZIPSUFFIX) + rm -f *.tar *.gz $(MAKE) -C sgml $@ -all: $(TARGETS) - -sources: - $(MAKE) sources.tar.$(ZIPSUFFIX) - -sources.tar: - $(TAR) -cf $@ sgml graphics - # Build twice to resolve index entries -$(addsuffix .tar, $(BOOKS)): +postgres.tar: $(MAKE) -C sgml clean - $(MAKE) -C sgml $(basename $@).html - $(MAKE) -C sgml $(basename $@).html JADEFLAGS='-V html-manifest' + $(MAKE) -C sgml html + $(MAKE) -C sgml html JADEFLAGS='-V html-manifest' cd sgml && $(TAR) -cf ../$@ `cat HTML.manifest` `echo *.gif | grep -v '\*'` *.css man.tar: diff --git a/doc/src/sgml/Makefile b/doc/src/sgml/Makefile index 1bbf18b079a..e1ba2796c33 100644 --- a/doc/src/sgml/Makefile +++ b/doc/src/sgml/Makefile @@ -1,14 +1,8 @@ #---------------------------------------------------------------------------- # -# Makefile -# Postgres documentation makefile -# Thomas Lockhart +# PostgreSQL documentation makefile # -# Copyright (c) 1994, Regents of the University of California -# -# -# IDENTIFICATION -# $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.55 2003/01/14 23:19:34 petere Exp $ +# $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.56 2003/03/25 16:15:35 petere Exp $ # #---------------------------------------------------------------------------- @@ -26,7 +20,7 @@ endif ifndef JADE JADE = jade endif -SGMLINCLUDE = -D $(srcdir) -D $(srcdir)/ref +SGMLINCLUDE = -D $(srcdir) ifndef NSGMLS NSGMLS = nsgmls @@ -39,20 +33,11 @@ endif CONVERT = convert EPSTOPDF = epstopdf - # docbook2man generates man pages from docbook refentry source code. - -ifndef D2MDIR -# This is where the (patched) docbook2man perl scripts reside on hub.org. -D2MDIR= /home/users/t/thomas/d2x/docbook2man -endif D2MSCRIPT= $(D2MDIR)/docbook2man-spec.pl -vpath %.sgml ./ref -ALLBOOKS = admin developer programmer reference tutorial user - -GENERATED_SGML = bookindex.sgml setindex.sgml version.sgml \ +GENERATED_SGML = bookindex.sgml version.sgml \ features-supported.sgml features-unsupported.sgml ALLSGML := $(wildcard $(srcdir)/*.sgml $(srcdir)/ref/*.sgml) $(GENERATED_SGML) @@ -75,12 +60,10 @@ endif DEFAULTSECTION := $(sqlmansect_dummy) -man: $(ALLSGML) - $(NSGMLS) $(NSGMLS_FLAGS) $(srcdir)/book-decl.sgml $(srcdir)/reference.sgml \ - | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION) --date "`date '+%Y-%m-%d'`" +man: postgres.sgml $(ALLSGML) + $(NSGMLS) $(NSGMLS_FLAGS) $< | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION) --date "`date '+%Y-%m-%d'`" # One more time, to resolve cross-references - $(NSGMLS) $(NSGMLS_FLAGS) $(srcdir)/book-decl.sgml $(srcdir)/reference.sgml \ - | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION) --date "`date '+%Y-%m-%d'`" + $(NSGMLS) $(NSGMLS_FLAGS) $< | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION) --date "`date '+%Y-%m-%d'`" $(mkinstalldirs) man1 man$(DEFAULTSECTION) mv *.1 man1/ mv *.$(DEFAULTSECTION) man$(DEFAULTSECTION)/ @@ -90,36 +73,23 @@ man: $(ALLSGML) ## HTML ## -JADE.html = $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -i output-html -t sgml +all: html -postgres.html: postgres.sgml $(ALLSGML) stylesheet.dsl +.PHONY: html + +html: postgres.sgml $(ALLSGML) stylesheet.dsl catalogs.gif connections.gif @rm -f *.html - $(JADE.html) $< - ln -sf index.html $@ - -$(addsuffix .html, $(ALLBOOKS)): %.html: %.sgml $(ALLSGML) stylesheet.dsl - @rm -f *.html - $(JADE.html) book-decl.sgml $< - ln -sf index.html $@ - -programmer.html: catalogs.gif connections.gif -postgres.html: catalogs.gif connections.gif + $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -i output-html -t sgml $< -COLLATEINDEX := $(PERL) $(COLLATEINDEX) -f -g -t 'Index' +COLLATEINDEX := $(PERL) $(COLLATEINDEX) -f -g ifeq (,$(wildcard HTML.index)) bookindex.sgml: $(COLLATEINDEX) -o $@ -N - -setindex.sgml: - $(COLLATEINDEX) -x -o $@ -N else bookindex.sgml: HTML.index $(COLLATEINDEX) -i 'bookindex' -o $@ $< - -setindex.sgml: HTML.index - $(COLLATEINDEX) -i 'setindex' -x -o $@ $< endif version.sgml: $(top_builddir)/src/Makefile.global @@ -140,22 +110,25 @@ features-unsupported.sgml: $(top_srcdir)/src/backend/catalog/sql_feature_package ## # RTF to allow minor editing for hardcopy -$(addsuffix .rtf, $(ALLBOOKS)): %.rtf: %.sgml $(ALLSGML) stylesheet.dsl - $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t rtf -V rtf-backend -i output-print book-decl.sgml $< + +%.rtf: %.sgml $(ALLSGML) stylesheet.dsl + $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t rtf -V rtf-backend -i output-print $< + +postgres.rtf: catalogs.gif connections.gif # TeX # Regular TeX and pdfTeX have slightly differing requirements, so we # need to distinguish the path we're taking. -$(addsuffix .tex-ps, $(ALLBOOKS)): %.tex-ps: %.sgml $(ALLSGML) stylesheet.dsl - $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t tex -V tex-backend -i output-print -V texdvi-output -o $@ book-decl.sgml $< +%.tex-ps: %.sgml $(ALLSGML) stylesheet.dsl + $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t tex -V tex-backend -i output-print -V texdvi-output -o $@ $< -programmer.tex-ps: catalogs.eps connections.eps +postgres.tex-ps: catalogs.eps connections.eps -$(addsuffix .tex-pdf, $(ALLBOOKS)): %.tex-pdf: %.sgml $(ALLSGML) stylesheet.dsl - $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t tex -V tex-backend -i output-print -V texpdf-output -o $@ book-decl.sgml $< +%.tex-pdf: %.sgml $(ALLSGML) stylesheet.dsl + $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t tex -V tex-backend -i output-print -V texpdf-output -o $@ $< -programmer.tex-pdf: catalogs.pdf connections.pdf +postgres.tex-pdf: catalogs.pdf connections.pdf %.dvi: %.tex-ps @rm -f $*.aux $*.log @@ -177,8 +150,8 @@ programmer.tex-pdf: catalogs.pdf connections.pdf # This generates an XML version of the flow-object tree. It's useful # for debugging DSSSL code, and possibly to interface to some other # tools that can make use of this. -$(addsuffix .fot, $(ALLBOOKS)): %.fot: %.sgml $(ALLSGML) stylesheet.dsl - $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t fot -i output-print -o $@ book-decl.sgml $< +%.fot: %.sgml $(ALLSGML) stylesheet.dsl + $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t fot -i output-print -o $@ $< # Graphics @@ -224,13 +197,8 @@ regress_README.html: regress.sgml ## Check ## -check: $(addprefix check-, $(ALLBOOKS)) check-postgres - # Quick syntax check without style processing -$(addprefix check-, $(ALLBOOKS)): check-%: %.sgml $(ALLSGML) - $(NSGMLS) $(SGMLINCLUDE) -s book-decl.sgml $< - -check-postgres: postgres.sgml $(ALLSGML) +check: postgres.sgml $(ALLSGML) $(NSGMLS) $(SGMLINCLUDE) -s $< diff --git a/doc/src/sgml/admin.sgml b/doc/src/sgml/admin.sgml deleted file mode 100644 index fccd8c2b214..00000000000 --- a/doc/src/sgml/admin.sgml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - PostgreSQL &version; Administrator's Guide - - - The PostgreSQL Global Development Group - &legal; - - - - Preface - - - - - What's In This Book - - - This book covers topics that are of interest to a - PostgreSQL database administrator. This includes - installation of the software, set up and configuration of the - server, management of users and databases, and maintenance tasks. - Anyone who runs a PostgreSQL server, either for - personal use, but especially in production, should be familiar - with the topics covered in this book. - - - - The information in this book is arranged approximately in the - order in which a new user should read it. But the chapters are - self-contained and can be read individually as desired. The - information in this book is presented in a narrative fashion in - topical units. Readers looking for a complete description of a - particular command should look into the &cite-reference;. - - - - The first few chapters are written so that they can be understood - without prerequisite knowledge, so that new users who need to set - up their own server can begin their exploration with this book. - The rest of this book which is about tuning and management - presupposes that the reader is familiar with the general use of - the PostgreSQL database system. Readers are - encouraged to look at the &cite-tutorial; and the &cite-user; for - additional information. - - - - This book covers PostgreSQL &version; - only. For information on other versions, please read the - documentation that accompanies that release. - - - - - - - &installation; - &installw; - &runtime; - &user-manag; - &manage-ag; - &client-auth; - &charset; - &maintenance; - &backup; - &monitoring; - &diskusage; - &wal; - ®ress; - &release; - - - - - diff --git a/doc/src/sgml/advanced.sgml b/doc/src/sgml/advanced.sgml index 48957596cd1..d6d7881ef38 100644 --- a/doc/src/sgml/advanced.sgml +++ b/doc/src/sgml/advanced.sgml @@ -1,5 +1,5 @@ @@ -130,7 +130,7 @@ ERROR: <unnamed> referential integrity violation - key referenced from we The behavior of foreign keys can be finely tuned to your application. We will not go beyond this simple example in this - tutorial, but just refer you to the &cite-user; + tutorial, but just refer you to for more information. Making correct use of foreign keys will definitely improve the quality of your database applications, so you are strongly encouraged to learn about them. @@ -394,8 +394,8 @@ SELECT name, altitude PostgreSQL has many features not touched upon in this tutorial introduction, which has been oriented toward newer users of SQL. These - features are discussed in more detail in both the &cite-user; - and the &cite-programmer;. + features are discussed in more detail in the remainder of this + book. diff --git a/doc/src/sgml/arch-dev.sgml b/doc/src/sgml/arch-dev.sgml index d9619643e94..9e8483ad2e2 100644 --- a/doc/src/sgml/arch-dev.sgml +++ b/doc/src/sgml/arch-dev.sgml @@ -1,5 +1,5 @@ @@ -480,8 +480,7 @@ current context are performed. For information on the syntax and creation of rules in the - PostgreSQL system refer to the - &cite-user;. + PostgreSQL system refer to . diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml index ddac7b38420..3c0c30c939a 100644 --- a/doc/src/sgml/catalogs.sgml +++ b/doc/src/sgml/catalogs.sgml @@ -1,6 +1,6 @@ @@ -288,7 +288,7 @@ New aggregate functions are registered with the CREATE - AGGREGATE command. See the &cite-programmer; for more + AGGREGATE command. See for more information about writing aggregate functions and the meaning of the transition functions, etc. @@ -1452,8 +1452,8 @@ The pg_database catalog stores information about the available databases. Databases are created with the - CREATE DATABASE command. Consult the - &cite-admin; for details about the meaning of some of the + CREATE DATABASE command. Consult + for details about the meaning of some of the parameters. @@ -1798,7 +1798,7 @@ This catalog defines groups and stores what users belong to what groups. Groups are created with the CREATE - GROUP command. Consult the &cite-admin; for information + GROUP command. Consult for information about user permission management. @@ -2028,8 +2028,8 @@ pg_language registers call interfaces or languages in which you can write functions or stored procedures. - See under CREATE LANGUAGE and in the - &cite-programmer; for more information about language handlers. + See under CREATE LANGUAGE and in + for more information about language handlers. @@ -2304,7 +2304,7 @@ - Operator classes are described at length in the &cite-programmer;. + Operator classes are described at length in .
@@ -2392,7 +2392,7 @@ pg_operator - See CREATE OPERATOR and the &cite-programmer; + See CREATE OPERATOR and for details on these operator parameters. @@ -2562,8 +2562,8 @@ This catalog stores information about functions (or procedures). - The description of CREATE FUNCTION and the - &cite-programmer; contain more information about the meaning of + The description of CREATE FUNCTION and + contain more information about the meaning of some fields. @@ -2836,7 +2836,7 @@ - The &cite-admin; contains detailed information about user and + contains detailed information about user and permission management. diff --git a/doc/src/sgml/charset.sgml b/doc/src/sgml/charset.sgml index 5c2c2aee34c..f8816125ebb 100644 --- a/doc/src/sgml/charset.sgml +++ b/doc/src/sgml/charset.sgml @@ -1,4 +1,4 @@ - + Localization</> @@ -279,7 +279,7 @@ initdb --locale=sv_SE <productname>PostgreSQL</> speak their preferred language well. If messages in your language is currently not available or fully translated, your assistance would be appreciated. If you want to - help, refer to the &cite-developer; or write to the developers' + help, refer to the <xref linkend="nls"> or write to the developers' mailing list. </para> </sect2> diff --git a/doc/src/sgml/ddl.sgml b/doc/src/sgml/ddl.sgml index 417186cc3c1..e0d39654bbd 100644 --- a/doc/src/sgml/ddl.sgml +++ b/doc/src/sgml/ddl.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ddl.sgml,v 1.13 2003/03/13 01:30:28 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ddl.sgml,v 1.14 2003/03/25 16:15:35 petere Exp $ --> <chapter id="ddl"> <title>Data Definition @@ -13,7 +13,7 @@ schemas, and how privileges can be assigned to tables. Finally, we will briefly look at other features that affect the data storage, such as views, functions, and triggers. Detailed information on - these topics is found in the &cite-programmer;. + these topics is found in . @@ -274,7 +274,7 @@ DROP TABLE products; Transaction identifiers are also 32-bit quantities. In a long-lived database it is possible for transaction IDs to wrap around. This is not a fatal problem given appropriate maintenance procedures; - see the &cite-admin; for details. However, it is + see for details. However, it is unwise to depend on uniqueness of transaction IDs over the long term (more than one billion transactions). @@ -819,7 +819,7 @@ CREATE TABLE order_items ( If the foreign key references a unique constraint, there are some additional possibilities regarding how null values are matched. These are explained in the CREATE TABLE entry - in the &cite-reference;. + in . diff --git a/doc/src/sgml/developer.sgml b/doc/src/sgml/developer.sgml deleted file mode 100644 index d853a03ba2f..00000000000 --- a/doc/src/sgml/developer.sgml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - PostgreSQL &version; Developer's Guide - - - The PostgreSQL Global Development Group - &legal; - - - - This document contains assorted information that can be of use to - PostgreSQL developers. - - - - - &sources; - &arch-dev; - &catalogs; - &protocol; - &compiler; - &bki; - &page; - &geqo; - &gist; - &nls; - - &cvs; - &docguide; - - diff --git a/doc/src/sgml/dfunc.sgml b/doc/src/sgml/dfunc.sgml index 86758f83978..ae30dd1fa96 100644 --- a/doc/src/sgml/dfunc.sgml +++ b/doc/src/sgml/dfunc.sgml @@ -1,5 +1,5 @@ @@ -318,9 +318,6 @@ ld -H512 -T512 -o foo.so -e _nostart \e -bI:.../lib/postgres.exp -bE:foo.exp foo.o \e -lm -lc 2>/dev/null .fi -You should look at the &cite-user; for an explanation of -this procedure. - --> diff --git a/doc/src/sgml/dml.sgml b/doc/src/sgml/dml.sgml index 59fcd78b63b..655af76fe5b 100644 --- a/doc/src/sgml/dml.sgml +++ b/doc/src/sgml/dml.sgml @@ -1,4 +1,4 @@ - + Data Manipulation @@ -89,7 +89,7 @@ INSERT INTO products DEFAULT VALUES; To do bulk loads, that is, inserting a lot of data, take a look at the COPY command (see - &cite-reference;). It is not as flexible as the + ). It is not as flexible as the INSERT command, but more efficient. diff --git a/doc/src/sgml/ecpg.sgml b/doc/src/sgml/ecpg.sgml index 2ce4ae625b1..8cb4874912d 100644 --- a/doc/src/sgml/ecpg.sgml +++ b/doc/src/sgml/ecpg.sgml @@ -1,5 +1,5 @@ @@ -802,7 +802,7 @@ ECPG = ecpg The complete syntax of the ecpg command is - detailed in the &cite-reference;. + detailed in . diff --git a/doc/src/sgml/entities.sgml b/doc/src/sgml/entities.sgml deleted file mode 100644 index 66e4092cdb8..00000000000 --- a/doc/src/sgml/entities.sgml +++ /dev/null @@ -1,20 +0,0 @@ -PostgreSQL Administrator's Guide"> -PostgreSQL Developer's Guide"> -PostgreSQL Programmer's Guide"> -PostgreSQL Reference Manual"> -PostgreSQL Tutorial"> -PostgreSQL User's Guide"> - -]]> -"> -"> -"> -"> -"> -"> - -]]> diff --git a/doc/src/sgml/extend.sgml b/doc/src/sgml/extend.sgml index 22cf5a0ac7e..1367f16d784 100644 --- a/doc/src/sgml/extend.sgml +++ b/doc/src/sgml/extend.sgml @@ -1,5 +1,5 @@ @@ -214,7 +214,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.19 2003/01/19 00:13:28 momj - The &cite-developer; gives a more detailed explanation of these + gives a more detailed explanation of these catalogs and their columns. However, shows the major entities and their relationships diff --git a/doc/src/sgml/filelist.sgml b/doc/src/sgml/filelist.sgml index 1e3efd91320..01f09431454 100644 --- a/doc/src/sgml/filelist.sgml +++ b/doc/src/sgml/filelist.sgml @@ -1,4 +1,4 @@ - + @@ -8,7 +8,6 @@ - diff --git a/doc/src/sgml/func-ref.sgml b/doc/src/sgml/func-ref.sgml deleted file mode 100644 index 129a9d2473a..00000000000 --- a/doc/src/sgml/func-ref.sgml +++ /dev/null @@ -1,19 +0,0 @@ - -Functions - - - -Reference information for user-callable functions. - - - - - -This section needs to be written. Volunteers? - - - - - - - diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 926a82a353e..25db8b37c10 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -1,5 +1,5 @@ @@ -17,8 +17,8 @@ PostgreSQL documentation PostgreSQL provides a large number of functions and operators for the built-in data types. Users can also - define their own functions and operators, as described in the - &cite-programmer;. The + define their own functions and operators, as described in + . The psql commands \df and \do can be used to show the list of all actually available functions and operators, respectively. @@ -2680,8 +2680,8 @@ substring('foobar' from 'o(.)b') o The form of regular expressions accepted by PostgreSQL - can be chosen by setting the REGEX_FLAVOR run-time parameter - (described in the &cite-admin;). The usual setting is + can be chosen by setting the regex_flavor run-time parameter + (described in ). The usual setting is advanced, but one might choose extended for maximum backwards compatibility with pre-7.4 releases of PostgreSQL. @@ -6950,7 +6950,7 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); linkend="functions-aggregate-table"> shows the built-in aggregate functions. The special syntax considerations for aggregate functions are explained in . - Consult the &cite-tutorial; for additional introductory + Consult for additional introductory information. diff --git a/doc/src/sgml/indices.sgml b/doc/src/sgml/indices.sgml index 6bf10180698..d900b941fa9 100644 --- a/doc/src/sgml/indices.sgml +++ b/doc/src/sgml/indices.sgml @@ -1,4 +1,4 @@ - + Indexes @@ -715,7 +715,7 @@ CREATE UNIQUE INDEX tests_success_constraint ON tests (subject, target) When indexes are not used, it can be useful for testing to force their use. There are run-time parameters that can turn off - various plan types (described in the &cite-admin;). + various plan types (described in ). For instance, turning off sequential scans (enable_seqscan) and nested-loop joins (enable_nestloop), which are the most basic plans, @@ -745,7 +745,7 @@ CREATE UNIQUE INDEX tests_success_constraint ON tests (subject, target) again, two possibilities. The total cost is computed from the per-row costs of each plan node times the selectivity estimate of the plan node. The costs of the plan nodes can be tuned with - run-time parameters (described in the &cite-admin;). + run-time parameters (described in ). An inaccurate selectivity estimate is due to insufficient statistics. It may be possible to help this by tuning the statistics-gathering parameters (see ALTER diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml index fcd2a1a9f2d..4a606bcdfb0 100644 --- a/doc/src/sgml/installation.sgml +++ b/doc/src/sgml/installation.sgml @@ -1,4 +1,4 @@ - + <![%standalone-include[<productname>PostgreSQL</>]]> @@ -398,7 +398,7 @@ JAVACMD=$JAVA_HOME/bin/java <para> <command>pg_dumpall</command> does not save large objects. Check - <![%standalone-include[the <citetitle>Administrator's Guide</>]]> + <![%standalone-include[the documentation]]> <![%standalone-ignore[<xref linkend="backup-dump-caveats">]]> if you need to do this. </para> @@ -474,7 +474,7 @@ JAVACMD=$JAVA_HOME/bin/java <para> These topics are discussed at length in <![%standalone-include[the - <citetitle>Administrator's Guide</>,]]> <![%standalone-ignore[<xref + documentation,]]> <![%standalone-ignore[<xref linkend="migration">,]]> which you are encouraged to read in any case. </para> @@ -656,8 +656,8 @@ JAVACMD=$JAVA_HOME/bin/java internal header files and the server header files are installed into private directories under <varname>includedir</varname>. - See the &cite-programmer; for information about how to get at - the header files for each interface. + See the documentation of each interface for information about how to get at + the its header files. Finally, a private subdirectory will also be created, if appropriate, under <varname>libdir</varname> for dynamically loadable modules. </para> @@ -705,8 +705,7 @@ JAVACMD=$JAVA_HOME/bin/java <listitem> <para> Enables single-byte character set recode support. See - <![%standalone-include[the <citetitle>Administrator's - Guide</citetitle>]]> <![%standalone-ignore[<xref + <![%standalone-include[the documentation]]> <![%standalone-ignore[<xref linkend="recode">]]> about this feature. Note that a more general form of character set conversion is supported in the default configuration; this feature is obsolete. @@ -1029,7 +1028,7 @@ All of PostgreSQL is successfully made. Ready to install. message wording or floating point results. <![%standalone-include[The file <filename>src/test/regress/README</> and the - <citetitle>Administrator's Guide</citetitle> contain]]> + documentation contain]]> <![%standalone-ignore[<xref linkend="regress"> contains]]> detailed information about interpreting the test results. You can repeat this test at any later time by issuing the same command. @@ -1311,7 +1310,7 @@ export MANPATH <para> The following is a quick summary of how to get <productname>PostgreSQL</> up and - running once installed. The &cite-admin; contains more information. + running once installed. The main documentation contains more information. </para> <procedure> @@ -1417,10 +1416,11 @@ kill `cat /usr/local/pgsql/data/postmaster.pid` </para> <para> - The &cite-tutorial; should be your first reading if you are - completely new to <acronym>SQL</> databases. If you are - familiar with database concepts then you want to proceed with - the &cite-admin;, which contains information about how to set up + The first few chapters of the main documentation are the Tutorial, + which should be your first reading if you are completely new to + <acronym>SQL</> databases. If you are familiar with database + concepts then you want to proceed with part on server + administration, which contains information about how to set up the database server, database users, and authentication. </para> </listitem> @@ -1429,7 +1429,7 @@ kill `cat /usr/local/pgsql/data/postmaster.pid` <para> Usually, you will want to modify your computer so that it will automatically start the database server whenever it boots. Some - suggestions for this are in the &cite-admin;. + suggestions for this are in the documentation. </para> </listitem> @@ -1438,7 +1438,7 @@ kill `cat /usr/local/pgsql/data/postmaster.pid` Run the regression tests against the installed server (using the sequential test method). If you didn't run the tests before installation, you should definitely do it now. This is also - explained in the &cite-admin;. + explained in the documentation. </para> </listitem> @@ -1450,16 +1450,16 @@ kill `cat /usr/local/pgsql/data/postmaster.pid` <para> The documentation is also available in Postscript format. If you have a Postscript printer, or have your machine already set up to - accept Postscript files using a print filter, then to print, for - example the <citetitle>User's Guide</> simply type + accept Postscript files using a print filter, then to print, the + documentation simply type <programlisting> cd /usr/local/pgsql/doc -gunzip -c user.ps.gz | lpr +gunzip -c postgres.ps.gz | lpr </programlisting> Here is how you might do it if you have <productname>Ghostscript</> installed on your system and are writing to a Laserjet printer. <programlisting> -gunzip -c user.ps.gz \ +gunzip -c postgres.ps.gz \ | gs -sDEVICE=laserjet -r300 -q -dNOPAUSE -sOutputFile=- \ | lpr </programlisting> @@ -1774,7 +1774,7 @@ gunzip -c user.ps.gz \ Dave Page (<email>dpage@vale-housing.co.uk</email>)</entry> <entry> native is client-side only; -<![%standalone-include[see Administrator's Guide]]> +<![%standalone-include[see documentation]]> <![%standalone-ignore[see <xref linkend="install-win32">]]> </entry> </row> diff --git a/doc/src/sgml/jdbc.sgml b/doc/src/sgml/jdbc.sgml index 574e20225ae..817a0a7e2f6 100644 --- a/doc/src/sgml/jdbc.sgml +++ b/doc/src/sgml/jdbc.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.42 2003/01/19 00:13:28 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.43 2003/03/25 16:15:37 petere Exp $ --> <chapter id="jdbc"> @@ -124,7 +124,7 @@ java Finder <para> Also, the client authentication setup in the <filename>pg_hba.conf</filename> file may need to be configured. - Refer to the &cite-admin; for details. The + Refer to <xref linkend="client-authentication"> for details. The <acronym>JDBC</acronym> Driver supports the trust, ident, password, md5, and crypt authentication methods. </para> diff --git a/doc/src/sgml/legal.sgml b/doc/src/sgml/legal.sgml index 2bba7a6e78b..49b5bd8ecf6 100644 --- a/doc/src/sgml/legal.sgml +++ b/doc/src/sgml/legal.sgml @@ -1,13 +1,13 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/legal.sgml,v 1.14 2002/06/20 20:29:24 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/legal.sgml,v 1.15 2003/03/25 16:15:37 petere Exp $ --> <copyright> - <year>1996-2002</year> + <year>1996-2003</year> <holder>The PostgreSQL Global Development Group</holder> </copyright> -<legalnotice> +<legalnotice id="legalnotice"> <title>Legal Notice @@ -46,45 +46,6 @@ $Header: /cvsroot/pgsql/doc/src/sgml/legal.sgml,v 1.14 2002/06/20 20:29:24 momji UPDATES, ENHANCEMENTS, OR MODIFICATIONS. - - - @@ -1098,7 +1098,7 @@ unsigned char *PQescapeBytea(const unsigned char *from, three digit octal number equal to the octet value, and preceded by two backslashes. The single quote (') and backslash (\) characters have special alternative escape - sequences. See the &cite-user; for more + sequences. See for more information. PQescapeBytea performs this operation, escaping only the minimally required bytes. diff --git a/doc/src/sgml/maintenance.sgml b/doc/src/sgml/maintenance.sgml index a2fb9f35996..353b8cf2f36 100644 --- a/doc/src/sgml/maintenance.sgml +++ b/doc/src/sgml/maintenance.sgml @@ -1,5 +1,5 @@ @@ -99,7 +99,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/maintenance.sgml,v 1.21 2003/03/24 14:32:50 UPDATE or DELETE of a row does not immediately remove the old tuple (version of the row). This approach is necessary to gain the benefits of multiversion - concurrency control (see the &cite-user;): the tuple + concurrency control (see ): the tuple must not be deleted while it is still potentially visible to other transactions. But eventually, an outdated or deleted tuple is no longer of interest to any transaction. The space it occupies must be diff --git a/doc/src/sgml/manage-ag.sgml b/doc/src/sgml/manage-ag.sgml index 783aee1a629..dd0b390230c 100644 --- a/doc/src/sgml/manage-ag.sgml +++ b/doc/src/sgml/manage-ag.sgml @@ -1,5 +1,5 @@ @@ -49,7 +49,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.26 2003/03/18 22:19:46 p or users are interrelated and should be able to use each other's resources they should be put in the same databases but possibly into separate schemas. More information about managing schemas is - in the &cite-user;. + in . diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index 112cc5c35b4..231a099cd1a 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -1,5 +1,5 @@ @@ -19,7 +19,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/monitoring.sgml,v 1.18 2003/03/24 14:32:50 ps and top. Also, once one has identified a poorly-performing query, further investigation may be needed using PostgreSQL's EXPLAIN command. - The &cite-user; discusses EXPLAIN + discusses EXPLAIN and other methods for understanding the behavior of an individual query. @@ -624,7 +624,7 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS procpid, For more information on locking and managing concurrency with - PostgreSQL, refer to the &cite-user;. + PostgreSQL, refer to . @@ -727,7 +727,7 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS procpid, The mode of the requested or held lock on the lockable object. For more information on the different lock modes available in PostgreSQL, refer to - the &cite-user;. + . diff --git a/doc/src/sgml/mvcc.sgml b/doc/src/sgml/mvcc.sgml index 4e65a1944e0..b5cda133ef2 100644 --- a/doc/src/sgml/mvcc.sgml +++ b/doc/src/sgml/mvcc.sgml @@ -1,5 +1,5 @@ @@ -421,7 +421,7 @@ ERROR: Can't serialize access due to concurrent update To examine a list of the currently outstanding locks in a database server, use the pg_locks system view. For more information on monitoring the status of the lock manager - subsystem, refer to the &cite-admin;. + subsystem, refer to . diff --git a/doc/src/sgml/notation.sgml b/doc/src/sgml/notation.sgml index 8c995203501..263a2c27d4c 100644 --- a/doc/src/sgml/notation.sgml +++ b/doc/src/sgml/notation.sgml @@ -1,5 +1,5 @@ @@ -18,7 +18,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/notation.sgml,v 1.21 2003/01/19 00:13:28 mo We use /usr/local/pgsql/ as the root directory of the installation and /usr/local/pgsql/data as the directory with the database files. These directories may vary - on your site, details can be derived in the &cite-admin;. + on your site, details can be derived in . diff --git a/doc/src/sgml/perform.sgml b/doc/src/sgml/perform.sgml index dc4804d755a..326c7e6134a 100644 --- a/doc/src/sgml/perform.sgml +++ b/doc/src/sgml/perform.sgml @@ -1,5 +1,5 @@ @@ -65,8 +65,8 @@ $Header: /cvsroot/pgsql/doc/src/sgml/perform.sgml,v 1.27 2003/03/13 01:30:29 pet The costs are measured in units of disk page fetches. (CPU effort estimates are converted into disk-page units using some fairly arbitrary fudge factors. If you want to experiment with these - factors, see the list of run-time configuration parameters in the - &cite-admin;.) + factors, see the list of run-time configuration parameters in + .) @@ -572,7 +572,7 @@ SELECT * FROM a, b, c WHERE a.id = b.id AND b.ref = c.id; search to a genetic probabilistic search through a limited number of possibilities. (The switch-over threshold is set by the geqo_threshold run-time - parameter described in the &cite-admin;.) + parameter.) The genetic search takes less time, but it won't necessarily find the best possible plan. diff --git a/doc/src/sgml/plpgsql.sgml b/doc/src/sgml/plpgsql.sgml index dc394ffa4f5..84862b041d1 100644 --- a/doc/src/sgml/plpgsql.sgml +++ b/doc/src/sgml/plpgsql.sgml @@ -1,5 +1,5 @@ @@ -1931,7 +1931,7 @@ RAISE level ' for more information. diff --git a/doc/src/sgml/postgres.sgml b/doc/src/sgml/postgres.sgml index 9d2f14dbbbd..30849fb9e3c 100644 --- a/doc/src/sgml/postgres.sgml +++ b/doc/src/sgml/postgres.sgml @@ -1,61 +1,273 @@ - %version; %filelist; - - - - -%entities; - - - - - - ]> - + PostgreSQL &version; Documentation - + The PostgreSQL Global Development Group &legal; - + + + + Preface + + &intro; + &history; + ¬ation; + &problems; + + + + + Tutorial + + + + Welcome to PostgreSQL Tutorial. The + following few chapters are intended to give a simple introduction + to PostgreSQL, relational database + concepts, and the SQL language to those who are new to any one of + these aspects. We only assume some general knowledge about how to + use computers. No particular Unix or programming experience is + required. This part is mainly intended to give you a hands-on + experience with important aspects of the + PostgreSQL system. It makes no attempt + to be a complete or thorough treatment of the topics it covers. + + + + After you have worked through this tutorial you might want to move + on to reading to gain a more formal knowledge + of the SQL language, or for + information about developing applications for + PostgreSQL. Those who set up and + manage their own server should also read . + + + + &start; + &query; + &advanced; + + + + + The SQL Language + + + + This part describes the use of the SQL language + in PostgreSQL. We start with + describing the general syntax of SQL, then + explain how to create the structures to hold data, how to populate + the database, and how to query it. The middle part lists the + available data types and functions for use in + SQL data commands. The rest treats several + aspects that are important for tuning a database for optimal + performance. + + + + The information in this part is arranged so that a novice user can + follow it start to end to gain a full understanding of the topics + without having to refer forward too many times. The chapters are + intended to be self-contained, so that advanced users can read the + chapters individually as they choose. The information in this + part is presented in a narrative fashion in topical units. + Readers looking for a complete description of a particular command + should look into . + + + + Readers of this book should know how to connect to a + PostgreSQL database and issue + SQL commands. Readers that are unfamiliar with + these issues are encouraged to read + first. SQL commands are typically entered + using the PostgreSQL interactive terminal + psql, but other programs that have + similar functionality can be used as well. + + + + &syntax; + &ddl; + &dml; + &queries; + &datatype; + &func; + &typeconv; + &indices; + &mvcc; + &perform; + + + + + Server Administration + + + + This part covers topics that are of interest to a + PostgreSQL database administrator. This includes + installation of the software, set up and configuration of the + server, management of users and databases, and maintenance tasks. + Anyone who runs a PostgreSQL server, either for + personal use, but especially in production, should be familiar + with the topics covered in this part. + + + + The information in this part is arranged approximately in the + order in which a new user should read it. But the chapters are + self-contained and can be read individually as desired. The + information in this part is presented in a narrative fashion in + topical units. Readers looking for a complete description of a + particular command should look into . + + + + The first few chapters are written so that they can be understood + without prerequisite knowledge, so that new users who need to set + up their own server can begin their exploration with this part. + The rest of this part which is about tuning and management + presupposes that the reader is familiar with the general use of + the PostgreSQL database system. Readers are + encouraged to look at and for additional information. + + + + &installation; + &installw; + &runtime; + &user-manag; + &manage-ag; + &client-auth; + &charset; + &maintenance; + &backup; + &monitoring; + &diskusage; + &wal; + ®ress; + + + + + Client Interfaces + + + + This part describes the client programming interfaces distributed + with PostgreSQL. Each of these chapters can be + read independently. Note that there are many other programming + interfaces for client programs that are distributed separately and + contain their own documentation. Readers of this part should be + familiar with using SQL commands to manipulate + and query the database (see ) and of course + with the programming language that the interface uses. + + + + &libpq; + &lobj; + &libpgtcl; + &ecpg; + &jdbc; + &pygresql; + + + + + Server Programming + + + + This part is about extending the server functionality with + user-defined functions, data types, triggers, etc. These are + advanced topics which should probably be approached only after all + the other user documentation about PostgreSQL has + been understood. This part also describes the server-side + programming languages available in the + PostgreSQL distribution as well as + general issues concerning server-side programming languages. This + information is only useful to readers that have read at least the + first few chapters of this part. + + + + &arch-pg; + &extend; + &xfunc; + &xtypes; + &xoper; + &xaggr; + &rules; + &xindex; + &indexcost; + &trigger; + &spi; + + &xplang; + &plsql; + &pltcl; + &plperl; + &plpython; + + - &tutorial; - &user; - &admin; - &programmer; &reference; - &developer; - &setindex; - + + Internals - + + + This part contains assorted information that can be of use to + PostgreSQL developers. + + + + &sources; + &arch-dev; + &catalogs; + &protocol; + &compiler; + &bki; + &page; + &geqo; + &gist; + &nls; + + + + + Appendixes + + &datetime; + &keywords; + &features; + &release; + &cvs; + &docguide; + + + + &biblio; + &bookindex; + + diff --git a/doc/src/sgml/programmer.sgml b/doc/src/sgml/programmer.sgml deleted file mode 100644 index b872bc371a6..00000000000 --- a/doc/src/sgml/programmer.sgml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - PostgreSQL &version; Programmer's Guide - - The PostgreSQL Global Development Group - &legal; - - - - Preface - - - - - What's In This Book - - - This book is for PostgreSQL application - programmers. It is divided into three parts. - - - - The first part of this book describes the client programming - interfaces distributed with PostgreSQL. Each of - these chapters can be read independently. Note that there are - many other programming interfaces for client programs that are - distributed separately and contain their own documentation. - Readers of the first part should be familiar with using - SQL commands to manipulate and query the - database (see the &cite-user;) and of course with the programming - language that the interface uses. - - - - The second part of this book is about extending the server - functionality with user-defined functions, data types, triggers, - etc. These are advanced topics which should probably be - approached only after all the other user documentation about - PostgreSQL has been understood. - - - - The third part of this book described the available server-side - programming languages. This information is related to the second - part and is only useful to readers that have read at least the - first few chapters thereof. - - - - This book covers PostgreSQL &version; - only. For information on other versions, please read the - documentation that accompanies that release. - - - - - - - - Client Interfaces - - - - This part of the manual is the description of the client-side - programming interfaces and support libraries for various - languages. - - - - &libpq; - &lobj; - &libpgtcl; - &ecpg; - &jdbc; - &pygresql; - - - - Server Programming - - - - This second part of the manual explains the - PostgreSQL approach to extensibility - and describe how users can extend - PostgreSQL by adding user-defined - types, operators, aggregates, and both query language and - programming language functions. After a discussion of the - PostgreSQL rule system, we discuss the - trigger and SPI interfaces. - - - - &arch-pg; - &extend; - &xfunc; - &xtypes; - &xoper; - &xaggr; - &rules; - &xindex; - &indexcost; - &trigger; - &spi; - - - - Procedural Languages - - - - This part documents the procedural languages available in the - PostgreSQL distribution as well as - general issues concerning procedural languages. - - - - &xplang; - &plsql; - &pltcl; - &plperl; - &plpython; - - - - - - - diff --git a/doc/src/sgml/query.sgml b/doc/src/sgml/query.sgml index 575b2db9d50..fe3490fb419 100644 --- a/doc/src/sgml/query.sgml +++ b/doc/src/sgml/query.sgml @@ -1,5 +1,5 @@ @@ -259,7 +259,7 @@ COPY weather FROM '/home/user/weather.txt'; where the file name for the source file must be available to the backend server machine, not the client, since the backend server reads the file directly. You can read more about the - COPY command in the &cite-reference;. + COPY command in . @@ -692,7 +692,7 @@ SELECT city, max(temp_lo) The LIKE operator does pattern matching and - is explained in the &cite-user;. + is explained in . diff --git a/doc/src/sgml/ref/alter_database.sgml b/doc/src/sgml/ref/alter_database.sgml index 2282b07a740..6118737176f 100644 --- a/doc/src/sgml/ref/alter_database.sgml +++ b/doc/src/sgml/ref/alter_database.sgml @@ -1,5 +1,5 @@ @@ -70,8 +70,8 @@ ALTER DATABASE name RESET - See and the - &cite-admin; for more information about allowed variable names + See and + for more information about allowed variable names and values. diff --git a/doc/src/sgml/ref/alter_table.sgml b/doc/src/sgml/ref/alter_table.sgml index 06c9653e226..578dcf59d68 100644 --- a/doc/src/sgml/ref/alter_table.sgml +++ b/doc/src/sgml/ref/alter_table.sgml @@ -1,5 +1,5 @@ @@ -437,7 +437,7 @@ VACUUM FULL table; Refer to CREATE TABLE for a further description - of valid arguments. The &cite-user; has further information on + of valid arguments. has further information on inheritance. diff --git a/doc/src/sgml/ref/alter_user.sgml b/doc/src/sgml/ref/alter_user.sgml index a37424cd26d..f67292517bf 100644 --- a/doc/src/sgml/ref/alter_user.sgml +++ b/doc/src/sgml/ref/alter_user.sgml @@ -1,5 +1,5 @@ @@ -145,8 +145,8 @@ ALTER USER username RESET - See and the - &cite-admin; for more information about allowed variable names + See and + for more information about allowed variable names and values. diff --git a/doc/src/sgml/ref/analyze.sgml b/doc/src/sgml/ref/analyze.sgml index 03b026e5215..fdfc0f18bf2 100644 --- a/doc/src/sgml/ref/analyze.sgml +++ b/doc/src/sgml/ref/analyze.sgml @@ -1,5 +1,5 @@ @@ -152,7 +152,7 @@ ANALYZE [ VERBOSE ] [ table [ (ANALYZE deems them uninteresting (for example, in a unique-key column, there are no common values) or if the column data type does not support the appropriate operators. There is more - information about the statistics in the &cite-user;. + information about the statistics in . diff --git a/doc/src/sgml/ref/begin.sgml b/doc/src/sgml/ref/begin.sgml index d8d28389e85..921792a386f 100644 --- a/doc/src/sgml/ref/begin.sgml +++ b/doc/src/sgml/ref/begin.sgml @@ -1,5 +1,5 @@ @@ -121,7 +121,7 @@ WARNING: BEGIN: already a transaction in progress SET TRANSACTION ISOLATION LEVEL SERIALIZABLE just after BEGIN if you need more rigorous transaction isolation. (Alternatively, you can change the default transaction - isolation level; see the &cite-admin; for details.) + isolation level; see for details.) In SERIALIZABLE mode queries will see only changes committed before the entire transaction began (actually, before execution of the first DML statement diff --git a/doc/src/sgml/ref/checkpoint.sgml b/doc/src/sgml/ref/checkpoint.sgml index 9023b899982..badcaa4dacf 100644 --- a/doc/src/sgml/ref/checkpoint.sgml +++ b/doc/src/sgml/ref/checkpoint.sgml @@ -1,4 +1,4 @@ - + @@ -34,7 +34,7 @@ CHECKPOINT A checkpoint is a point in the transaction log sequence at which all data files have been updated to reflect the information in the log. All data files will be flushed to disk. Refer to the - &cite-admin; for more information about the WAL system. + for more information about the WAL system. @@ -43,14 +43,6 @@ CHECKPOINT - - See Also - - - &cite-admin; - - - Compatibility diff --git a/doc/src/sgml/ref/cluster.sgml b/doc/src/sgml/ref/cluster.sgml index 1c3874c8d1a..52a895b12bc 100644 --- a/doc/src/sgml/ref/cluster.sgml +++ b/doc/src/sgml/ref/cluster.sgml @@ -1,5 +1,5 @@ @@ -126,8 +126,8 @@ CLUSTER When a table is being clustered, an ACCESS EXCLUSIVE lock is acquired on it. This prevents any other database operations (both reads and writes) from preceding on the - table until the CLUSTER is finished. See the - &cite-user; for more information on database locking. + table until the CLUSTER is finished. See + for more information on database locking. diff --git a/doc/src/sgml/ref/create_aggregate.sgml b/doc/src/sgml/ref/create_aggregate.sgml index c5ae96850c2..d53daa45ddd 100644 --- a/doc/src/sgml/ref/create_aggregate.sgml +++ b/doc/src/sgml/ref/create_aggregate.sgml @@ -1,5 +1,5 @@ @@ -267,12 +267,10 @@ CREATE AGGREGATE - - Usage - + Examples + - Refer to the chapter on aggregate functions in the - &cite-programmer; for complete examples of usage. + See . diff --git a/doc/src/sgml/ref/create_cast.sgml b/doc/src/sgml/ref/create_cast.sgml index bc3894ab1c4..a76a417671e 100644 --- a/doc/src/sgml/ref/create_cast.sgml +++ b/doc/src/sgml/ref/create_cast.sgml @@ -1,4 +1,4 @@ - + @@ -240,8 +240,7 @@ CREATE CAST (text AS int4) WITH FUNCTION int4(text); , , - , - &cite-programmer; + diff --git a/doc/src/sgml/ref/create_conversion.sgml b/doc/src/sgml/ref/create_conversion.sgml index 1ced20a3d14..f0706585084 100644 --- a/doc/src/sgml/ref/create_conversion.sgml +++ b/doc/src/sgml/ref/create_conversion.sgml @@ -1,4 +1,4 @@ - + @@ -157,8 +157,7 @@ CREATE CONVERSION myconv FOR 'UNICODE' TO 'LATIN1' FROM myfunc; , - , - &cite-programmer; + diff --git a/doc/src/sgml/ref/create_database.sgml b/doc/src/sgml/ref/create_database.sgml index 86114a1a079..29e49d850e1 100644 --- a/doc/src/sgml/ref/create_database.sgml +++ b/doc/src/sgml/ref/create_database.sgml @@ -1,5 +1,5 @@ @@ -259,7 +259,7 @@ CREATE DATABASE name specified with absolute path names, and by default only an environment variable known to the backend may be specified for an alternate location. - See the Administrator's Guide for more information. + See for more information. @@ -58,8 +58,6 @@ where constraint is: The underlying data type of the domain. This may include array specifiers. - Refer to the &cite-user; for further - information about data types and arrays. @@ -224,7 +222,6 @@ CREATE TABLE countrylist (id INT4, country country_code); - &cite-programmer; diff --git a/doc/src/sgml/ref/create_function.sgml b/doc/src/sgml/ref/create_function.sgml index 2a6ca11c4b9..5db8f8efb1d 100644 --- a/doc/src/sgml/ref/create_function.sgml +++ b/doc/src/sgml/ref/create_function.sgml @@ -1,5 +1,5 @@ @@ -289,10 +289,8 @@ CREATE [ OR REPLACE ] FUNCTION name Notes - Refer to the chapter in the &cite-programmer; - on the topic of extending - PostgreSQL via functions - for further information on writing external functions. + Refer to for further information on writing + external functions. @@ -476,8 +474,7 @@ Point * complex_to_point (Complex *z) , , , - , - &cite-programmer; + diff --git a/doc/src/sgml/ref/create_group.sgml b/doc/src/sgml/ref/create_group.sgml index 539e2c60540..4be903241f0 100644 --- a/doc/src/sgml/ref/create_group.sgml +++ b/doc/src/sgml/ref/create_group.sgml @@ -1,5 +1,5 @@ @@ -108,8 +108,7 @@ where option can be: CREATE GROUP will create a new group in the - database installation. Refer to the &cite-admin; for information - about using groups for authentication. You must be a database + database installation. You must be a database superuser to use this command. diff --git a/doc/src/sgml/ref/create_language.sgml b/doc/src/sgml/ref/create_language.sgml index ffb615ae5d4..ba90f38bb2e 100644 --- a/doc/src/sgml/ref/create_language.sgml +++ b/doc/src/sgml/ref/create_language.sgml @@ -1,5 +1,5 @@ @@ -37,7 +37,7 @@ CREATE [ TRUSTED ] [ PROCEDURAL ] LANGUAGE langna CREATE LANGUAGE effectively associates the language name with a call handler that is responsible for executing - functions written in the language. Refer to the &cite-programmer; + functions written in the language. Refer to for more information about language call handlers. @@ -300,7 +300,6 @@ CREATE LANGUAGE plsample - &cite-programmer; diff --git a/doc/src/sgml/ref/create_opclass.sgml b/doc/src/sgml/ref/create_opclass.sgml index 04d2c2d2f91..dcf8259d4be 100644 --- a/doc/src/sgml/ref/create_opclass.sgml +++ b/doc/src/sgml/ref/create_opclass.sgml @@ -1,5 +1,5 @@ @@ -223,8 +223,7 @@ CREATE OPERATOR CLASS - Refer to the chapter on interfacing extensions to indexes in the - &cite-programmer; for further information. + Refer to for further information. diff --git a/doc/src/sgml/ref/create_operator.sgml b/doc/src/sgml/ref/create_operator.sgml index 69c8a420337..b3c4d00405c 100644 --- a/doc/src/sgml/ref/create_operator.sgml +++ b/doc/src/sgml/ref/create_operator.sgml @@ -1,5 +1,5 @@ @@ -436,9 +436,8 @@ MYBOXES.description === box '((0,0), (1,1))' Notes - Refer to the chapter on operators in the &cite-user; - for further information. - Refer to DROP OPERATOR to delete + Refer to for further information. + Use DROP OPERATOR to delete user-defined operators from a database. diff --git a/doc/src/sgml/ref/create_sequence.sgml b/doc/src/sgml/ref/create_sequence.sgml index 550605447fb..8e5ca32962c 100644 --- a/doc/src/sgml/ref/create_sequence.sgml +++ b/doc/src/sgml/ref/create_sequence.sgml @@ -1,5 +1,5 @@ @@ -260,7 +260,7 @@ ERROR: DefineSequence: MINVALUE (mincurrval and setval to operate on the sequence. These functions are documented in - the &cite-user;. + . diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml index 3c0a9fc3a8b..c693c0ae6f5 100644 --- a/doc/src/sgml/ref/create_table.sgml +++ b/doc/src/sgml/ref/create_table.sgml @@ -1,5 +1,5 @@ @@ -147,8 +147,6 @@ and table_constraint is: The data type of the column. This may include array specifiers. - Refer to the &cite-user; for further information about data - types and arrays. diff --git a/doc/src/sgml/ref/create_trigger.sgml b/doc/src/sgml/ref/create_trigger.sgml index 0c69b90da8e..a671e6c430e 100644 --- a/doc/src/sgml/ref/create_trigger.sgml +++ b/doc/src/sgml/ref/create_trigger.sgml @@ -1,5 +1,5 @@ @@ -202,8 +202,7 @@ CREATE TRIGGER - Refer to the chapters on SPI and Triggers in the &cite-programmer; - for more information. + Refer to for more information. @@ -348,7 +347,6 @@ CREATE TABLE distributors ( - &cite-programmer; diff --git a/doc/src/sgml/ref/create_type.sgml b/doc/src/sgml/ref/create_type.sgml index a8e8c592917..6d6d8e30bcd 100644 --- a/doc/src/sgml/ref/create_type.sgml +++ b/doc/src/sgml/ref/create_type.sgml @@ -1,5 +1,5 @@ @@ -469,7 +469,6 @@ CREATE FUNCTION getfoo() RETURNS SETOF compfoo AS 'SELECT fooid, fooname FROM fo - &cite-programmer; diff --git a/doc/src/sgml/ref/create_user.sgml b/doc/src/sgml/ref/create_user.sgml index 856abbf830d..522ea5acfbc 100644 --- a/doc/src/sgml/ref/create_user.sgml +++ b/doc/src/sgml/ref/create_user.sgml @@ -1,5 +1,5 @@ @@ -34,7 +34,7 @@ where option can be: CREATE USER will add a new user to an instance - of PostgreSQL. Refer to the &cite-admin; + of PostgreSQL. Refer to for information about managing users and authentication. You must be a database superuser to use this command. @@ -101,7 +101,7 @@ where option can be: - See the chapter on client authentication in the &cite-admin; + See for details on how to set up authentication mechanisms. Note that older clients may lack support for the MD5 authentication mechanism that is needed to work with passwords that are diff --git a/doc/src/sgml/ref/drop_aggregate.sgml b/doc/src/sgml/ref/drop_aggregate.sgml index fb95a3c605c..b671fa5c145 100644 --- a/doc/src/sgml/ref/drop_aggregate.sgml +++ b/doc/src/sgml/ref/drop_aggregate.sgml @@ -1,5 +1,5 @@ @@ -47,7 +47,6 @@ DROP AGGREGATE name ( The input data type of the aggregate function, or * if the function accepts any input type. - (Refer to the &cite-user; for further information about data types.) diff --git a/doc/src/sgml/ref/ecpg-ref.sgml b/doc/src/sgml/ref/ecpg-ref.sgml index 995fe88aca0..ffb5ed41945 100644 --- a/doc/src/sgml/ref/ecpg-ref.sgml +++ b/doc/src/sgml/ref/ecpg-ref.sgml @@ -1,5 +1,5 @@ @@ -49,7 +49,7 @@ PostgreSQL documentation This reference page does not describe the embedded SQL language. - See the &cite-programmer; for more information on that topic. + See for more information on that topic. @@ -191,16 +191,6 @@ cc -o prog1 prog1.o -L/usr/local/pgsql/lib -lecpg - - - See Also - - - &cite-programmer; for a more detailed description of the embedded - SQL interface - - - @@ -188,7 +188,7 @@ ROLLBACK; There is only sparse documentation on the optimizer's use of cost information in PostgreSQL. - Refer to the &cite-user; and &cite-programmer; for more information. + Refer to for more information. diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index 5009fa1ff9e..ccab2e94422 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -1,5 +1,5 @@ @@ -251,7 +251,6 @@ PostgreSQL documentation - &cite-admin; diff --git a/doc/src/sgml/ref/initlocation.sgml b/doc/src/sgml/ref/initlocation.sgml index 1b62aeeba05..8211e635cd2 100644 --- a/doc/src/sgml/ref/initlocation.sgml +++ b/doc/src/sgml/ref/initlocation.sgml @@ -1,5 +1,5 @@ @@ -65,14 +65,6 @@ PostgreSQL documentation - - See Also - - - &cite-admin; - - - @@ -216,8 +216,7 @@ INSERT INTO films SELECT * FROM tmp; - Insert into arrays (refer to the &cite-user; for further - information about arrays): + Insert into arrays: -- Create an empty 3x3 gameboard for noughts-and-crosses diff --git a/doc/src/sgml/ref/load.sgml b/doc/src/sgml/ref/load.sgml index 895f071e167..0c80e0f0245 100644 --- a/doc/src/sgml/ref/load.sgml +++ b/doc/src/sgml/ref/load.sgml @@ -1,5 +1,5 @@ @@ -37,7 +37,7 @@ LOAD 'filename' The file name is specified in the same way as for shared library names in ; in particular, one may rely on a search path and automatic addition of the system's standard - shared library file name extension. See the &cite-programmer; for + shared library file name extension. See for more information on this topic. @@ -56,8 +56,7 @@ LOAD 'filename' See Also - , - &cite-programmer; + diff --git a/doc/src/sgml/ref/pg_config-ref.sgml b/doc/src/sgml/ref/pg_config-ref.sgml index 755faa429c5..084d78b95d0 100644 --- a/doc/src/sgml/ref/pg_config-ref.sgml +++ b/doc/src/sgml/ref/pg_config-ref.sgml @@ -1,4 +1,4 @@ - + @@ -154,15 +154,6 @@ PostgreSQL 7.1. - - - - See Also - - - &cite-programmer; - - @@ -437,7 +437,7 @@ Command line was: See Also - , &cite-admin; + diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 0c279db427c..b8c9694ea5b 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -1,5 +1,5 @@ @@ -713,7 +713,6 @@ CREATE DATABASE foo WITH TEMPLATE template0; - &cite-admin; diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index f1b90871d19..ffc019b3e55 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -1,4 +1,4 @@ - + @@ -654,7 +654,6 @@ CREATE DATABASE foo WITH TEMPLATE template0; - &cite-admin; diff --git a/doc/src/sgml/ref/pgtclsh.sgml b/doc/src/sgml/ref/pgtclsh.sgml index d915ffe00de..2a32d6305e0 100644 --- a/doc/src/sgml/ref/pgtclsh.sgml +++ b/doc/src/sgml/ref/pgtclsh.sgml @@ -1,5 +1,5 @@ @@ -55,7 +55,7 @@ PostgreSQL documentation - &cite-programmer; (description of libpgtcl) + (description of libpgtcl) tclsh 1 diff --git a/doc/src/sgml/ref/pgtksh.sgml b/doc/src/sgml/ref/pgtksh.sgml index 5d2513afbaf..bcc052bfdbf 100644 --- a/doc/src/sgml/ref/pgtksh.sgml +++ b/doc/src/sgml/ref/pgtksh.sgml @@ -1,5 +1,5 @@ @@ -55,7 +55,7 @@ PostgreSQL documentation - &cite-programmer; (description of libpgtcl) + (description of libpgtcl) tclsh 1 diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml index 8d1bc512ebf..6532cc1c894 100644 --- a/doc/src/sgml/ref/postgres-ref.sgml +++ b/doc/src/sgml/ref/postgres-ref.sgml @@ -1,5 +1,5 @@ @@ -123,7 +123,7 @@ PostgreSQL documentation You can avoid having to type these options by setting up a - configuration file. See the &cite-admin; for details. Some + configuration file. See for details. Some (safe) options can also be set from the connecting client in an application-dependent way. For example, if the environment variable PGOPTIONS is set, then @@ -153,7 +153,7 @@ PostgreSQL documentation means that the day before month (rather than month before day) rule is used to interpret ambiguous date input, and that the day is printed before the month in certain - date output formats. See the &cite-user; for more information. + date output formats. See for more information. diff --git a/doc/src/sgml/ref/postmaster.sgml b/doc/src/sgml/ref/postmaster.sgml index 36bd38f8c1f..ed431c6b54b 100644 --- a/doc/src/sgml/ref/postmaster.sgml +++ b/doc/src/sgml/ref/postmaster.sgml @@ -1,5 +1,5 @@ @@ -80,7 +80,7 @@ PostgreSQL documentation postmaster accepts the following command line arguments. For a detailed discussion of the options - consult the &cite-admin;. You can also save typing most of these + consult . You can also save typing most of these options by setting up a configuration file. @@ -110,7 +110,7 @@ PostgreSQL documentation - Sets a named run-time parameter. Consult the &cite-admin; for + Sets a named run-time parameter. Consult for a list and descriptions. Most of the other command line options are in fact short forms of such a parameter assignment. is required to be at least twice - . See the &cite-admin; for a discussion of + . See for a discussion of system resource requirements for large numbers of client connections.) @@ -404,7 +404,7 @@ PostgreSQL documentation Other environment variables may be used to designate alternative - data storage locations. See the &cite-admin; for more + data storage locations. See for more information. @@ -423,7 +423,7 @@ PostgreSQL documentation If you see this message, you probably need to configure - your kernel for shared memory and semaphores as described in the &cite-admin;. + your kernel for shared memory and semaphores as described in . If you run multiple instances of postmaster on a single host, or have a kernel with particularly small shared memory diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index b00038fed51..49e4f998da0 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -1,5 +1,5 @@ @@ -2489,16 +2489,6 @@ Field separator is "oo". Examples - - - This section only shows a few examples specific to - psql. If you want to learn - SQL or get familiar with - PostgreSQL, you might wish to read the - &cite-tutorial;. - - - The first example shows how to spread a command over several lines of input. Notice the changing prompt: diff --git a/doc/src/sgml/ref/reindex.sgml b/doc/src/sgml/ref/reindex.sgml index e146fe53928..cd666c82162 100644 --- a/doc/src/sgml/ref/reindex.sgml +++ b/doc/src/sgml/ref/reindex.sgml @@ -1,5 +1,5 @@ @@ -139,8 +139,7 @@ REINDEX under certain access patterns. REINDEX provides a way to reduce the space consumption of the index by writing a new version of the index without the dead pages. See - the Routine Reindexing section in the - &cite-admin; for more information. The rest of this section + for more information. The rest of this reference page mostly discusses how to use REINDEX to recover from index corruption. diff --git a/doc/src/sgml/ref/reset.sgml b/doc/src/sgml/ref/reset.sgml index 97234134237..bb6860657d2 100644 --- a/doc/src/sgml/ref/reset.sgml +++ b/doc/src/sgml/ref/reset.sgml @@ -1,5 +1,5 @@ @@ -63,8 +63,8 @@ SET variable TO DEFAULT have had, had no SET ever been issued for it in the current session. The actual source of this value might be a compiled-in default, the postmaster's configuration file or command-line - switches, or per-database or per-user default settings. See the - &cite-admin; for details. + switches, or per-database or per-user default settings. See + for details. diff --git a/doc/src/sgml/ref/select.sgml b/doc/src/sgml/ref/select.sgml index 42281e5cf00..6362840ec03 100644 --- a/doc/src/sgml/ref/select.sgml +++ b/doc/src/sgml/ref/select.sgml @@ -1,5 +1,5 @@ @@ -885,8 +885,7 @@ SELECT name FROM distributors ORDER BY code; already locked a selected row or rows, SELECT FOR UPDATE will wait for the other transaction to complete, and will then lock and return the updated row (or no row, if the - row was deleted). For further discussion see the concurrency - chapter of the &cite-user;. + row was deleted). For further discussion see . diff --git a/doc/src/sgml/ref/set.sgml b/doc/src/sgml/ref/set.sgml index abf913614d4..23b77dff5c5 100644 --- a/doc/src/sgml/ref/set.sgml +++ b/doc/src/sgml/ref/set.sgml @@ -1,5 +1,5 @@ @@ -80,7 +80,7 @@ SET [ SESSION | LOCAL ] TIME ZONE { timezone The SET command changes run-time configuration parameters. Many of the run-time parameters listed in the - &cite-admin; can be changed on-the-fly with SET. + can be changed on-the-fly with SET. (But some require superuser privileges to change, and others cannot be changed after server or session start.) Note that SET only affects the value used by the current @@ -111,7 +111,7 @@ SET [ SESSION | LOCAL ] TIME ZONE { timezone Even with autocommit set to off, SET does not start a new transaction block. See the - autocommit section of the &cite-admin; for details. + autocommit section in for details. @@ -443,6 +443,14 @@ SELECT setseed(value); + + Notes + + + The function set_config provides the equivalent + capability. See . + + Examples @@ -513,12 +521,6 @@ SELECT CURRENT_TIMESTAMP AS today; , - - - The function set_config provides the equivalent - capability. See Miscellaneous Functions in - the &cite-user;. - diff --git a/doc/src/sgml/ref/set_transaction.sgml b/doc/src/sgml/ref/set_transaction.sgml index d88274d3ad5..f43802d2e01 100644 --- a/doc/src/sgml/ref/set_transaction.sgml +++ b/doc/src/sgml/ref/set_transaction.sgml @@ -1,4 +1,4 @@ - + 2000-11-24 @@ -109,7 +109,7 @@ SET SESSION CHARACTERISTICS AS TRANSACTION SET default_transaction_isolation = 'value' - and in the configuration file. Consult the &cite-admin; for more + and in the configuration file. Consult for more information. @@ -126,7 +126,7 @@ SET default_transaction_isolation = 'value' not provide the isolation levels and . Because of multiversion concurrency control, the level is not - truly serializable. See the &cite-user; for details. + truly serializable. See for details. diff --git a/doc/src/sgml/ref/show.sgml b/doc/src/sgml/ref/show.sgml index c97c2a04c53..832c4392cbf 100644 --- a/doc/src/sgml/ref/show.sgml +++ b/doc/src/sgml/ref/show.sgml @@ -1,5 +1,5 @@ @@ -64,7 +64,7 @@ SHOW ALL Even with autocommit set to off, SHOW does not start a new transaction block. See the - autocommit section of the &cite-admin; for details. + autocommit section in for details. @@ -87,6 +87,15 @@ SHOW ALL + + Notes + + + The function current_setting produces + equivalent output. See . + + + Examples @@ -141,16 +150,6 @@ SHOW ALL; PostgreSQL extension. - - - See Also - - - The function current_setting produces equivalent - output. See Miscellaneous Functions in the - &cite-user;. - - @@ -206,7 +206,7 @@ INFO: Index index: Pages 28; intended usage is in connection with preparation of user-defined template databases, or other databases that are completely read-only and will not receive routine maintenance VACUUM operations. - See the &cite-admin; for details. + See for details. diff --git a/doc/src/sgml/reference.sgml b/doc/src/sgml/reference.sgml index 84221dc2157..9799489b77e 100644 --- a/doc/src/sgml/reference.sgml +++ b/doc/src/sgml/reference.sgml @@ -1,35 +1,27 @@ - - - PostgreSQL &version; Reference Manual - - The PostgreSQL Global Development Group - &legal; - - - - Preface + + Reference + - The entries in this Reference Manual are - meant to provide in reasonable length an authoritative, complete, and - formal summary about their respective subjects. More information - about the use of PostgreSQL, in - narrative, tutorial, or example form, may be found in other parts - of the PostgreSQL documentation set. - See the cross-references listed on each reference page. + The entries in this Reference are meant to provide in reasonable + length an authoritative, complete, and formal summary about their + respective subjects. More information about the use of + PostgreSQL, in narrative, tutorial, or + example form, may be found in other parts of this book. See the + cross-references listed on each reference page. - The Reference Manual entries are also - available as traditional man pages. + The reference entries are also available as traditional + man pages. - + SQL Commands @@ -192,7 +184,7 @@ PostgreSQL Reference Manual - + @@ -144,7 +144,7 @@ postgres$ initdb -D /usr/local/pgsql/data The database cluster will be initialized with locale de_DE. This locale setting will prevent the use of indexes for pattern matching operations. If that is a concern, rerun initdb with the collation order -set to "C". For more information see the Administrator's Guide. +set to "C". For more information see the documentation. This is intended to warn you that the currently selected locale will cause indexes to be sorted in an order that prevents them from @@ -1180,7 +1180,7 @@ SET ENABLE_SEQSCAN TO OFF; visible to the superuser, so it should not represent a security risk. This data can be accessed via the pg_stat_activity system view; refer - to the &cite-admin; for more information. + to for more information. @@ -1195,7 +1195,7 @@ SET ENABLE_SEQSCAN TO OFF; default. This data can be accessed via the pg_stat and pg_statio family of system views; - refer to the &cite-admin; for more information. + refer to for more information. @@ -1470,8 +1470,7 @@ SET ENABLE_SEQSCAN TO OFF; - Consult the &cite-user; and - the command SET TRANSACTION for more + Consult and for more information. @@ -1894,7 +1893,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' - For more information on schema handling, see the &cite-user;. + For more information on schema handling, see . @@ -1978,8 +1977,8 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' not included in versions prior to 7.1. If you need the old behavior you can set this variable to off, but in the long run you are encouraged to change your applications to use the - ONLY key word to exclude subtables. See the - SQL language reference and the &cite-user; for more information about inheritance. + ONLY key word to exclude subtables. See + for more information about inheritance. @@ -2083,7 +2082,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' - Refer to the &cite-user; for related information. + Refer to for related information. diff --git a/doc/src/sgml/standalone-install.sgml b/doc/src/sgml/standalone-install.sgml index 2e657acb93a..349e5d2972d 100644 --- a/doc/src/sgml/standalone-install.sgml +++ b/doc/src/sgml/standalone-install.sgml @@ -1,4 +1,4 @@ - + ]> diff --git a/doc/src/sgml/start.sgml b/doc/src/sgml/start.sgml index 89abd3cf854..88a53f0efbe 100644 --- a/doc/src/sgml/start.sgml +++ b/doc/src/sgml/start.sgml @@ -1,5 +1,5 @@ @@ -31,7 +31,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/start.sgml,v 1.28 2003/02/19 04:06:28 momji If you are installing PostgreSQL - yourself, then refer to the &cite-admin; + yourself, then refer to for instructions on installation, and return to this guide when the installation is complete. Be sure to follow closely the section about setting up the appropriate environment @@ -292,7 +292,7 @@ createdb: database creation failed Writing a custom application, using one of the several available language bindings. These possibilities are discussed - further in the &cite-programmer;. + further in . @@ -391,7 +391,7 @@ mydb=# command shell. (For more internal commands, type \? at the psql prompt.) The full capabilities of psql are documented in - the &cite-reference;. If PostgreSQL is + . If PostgreSQL is installed correctly you can also type man psql at the operating system shell prompt to see the documentation. In this tutorial we will not use these features explicitly, but you diff --git a/doc/src/sgml/stylesheet.dsl b/doc/src/sgml/stylesheet.dsl index 55a97078f96..52e43edc781 100644 --- a/doc/src/sgml/stylesheet.dsl +++ b/doc/src/sgml/stylesheet.dsl @@ -1,4 +1,4 @@ - + @@ -147,7 +147,7 @@ ;; Returns the depth of auto TOC that should be made at the nd-level (define (toc-depth nd) - (cond ((string=? (gi nd) (normalize "book")) 3) + (cond ((string=? (gi nd) (normalize "book")) 2) ((string=? (gi nd) (normalize "set")) 2) ((string=? (gi nd) (normalize "part")) 2) ((string=? (gi nd) (normalize "chapter")) 2) diff --git a/doc/src/sgml/syntax.sgml b/doc/src/sgml/syntax.sgml index c17bba1ac41..b6ebb1cc434 100644 --- a/doc/src/sgml/syntax.sgml +++ b/doc/src/sgml/syntax.sgml @@ -1,5 +1,5 @@ @@ -73,8 +73,7 @@ INSERT INTO MY_TABLE VALUES (3, 'hi there'); a SET token to appear in a certain position, and this particular variation of INSERT also requires a VALUES in order to be complete. The - precise syntax rules for each command are described in the - &cite-reference;. + precise syntax rules for each command are described in . diff --git a/doc/src/sgml/trigger.sgml b/doc/src/sgml/trigger.sgml index b24663aa7a0..c2f952aaa92 100644 --- a/doc/src/sgml/trigger.sgml +++ b/doc/src/sgml/trigger.sgml @@ -1,5 +1,5 @@ @@ -38,7 +38,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/trigger.sgml,v 1.26 2002/11/23 03:59:06 mom - The syntax for creating triggers is described in &cite-reference;. + The syntax for creating triggers is described in . diff --git a/doc/src/sgml/tutorial.sgml b/doc/src/sgml/tutorial.sgml deleted file mode 100644 index 7e2b87c28ce..00000000000 --- a/doc/src/sgml/tutorial.sgml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - PostgreSQL &version; Tutorial - - The PostgreSQL Global Development Group - &legal; - - - - Preface - - - - - What's In This Book - - - Welcome to PostgreSQL and the - PostgreSQL Tutorial. The following few - chapters are intended to give a simple introduction to - PostgreSQL, relational database - concepts, and the SQL language to those who are new to any one of - these aspects. We only assume some general knowledge about how to - use computers. No particular Unix or programming experience is - required. This book is mainly intended to give you a hands-on - experience with important aspects of the - PostgreSQL system. It makes no attempt - to be a complete or thorough treatment of the topics it covers. - - - - After you have worked through this tutorial you might want to move - on to reading the &cite-user; to gain a more formal knowledge of - the SQL language, or the &cite-programmer; for information about - developing applications for PostgreSQL. - Those who set up and manage their own server should also read the - &cite-admin;. - - - - - - - &start; - &query; - &advanced; - - - - - diff --git a/doc/src/sgml/typeconv.sgml b/doc/src/sgml/typeconv.sgml index 3aaffdc05dc..0a85ea1230f 100644 --- a/doc/src/sgml/typeconv.sgml +++ b/doc/src/sgml/typeconv.sgml @@ -1,5 +1,5 @@ @@ -29,11 +29,6 @@ for more information on specific data types and allowed functions and operators. - -The &cite-programmer; has more details on the exact algorithms used for -implicit type conversion and conversion. - - Overview diff --git a/doc/src/sgml/user-manag.sgml b/doc/src/sgml/user-manag.sgml index 3e236fcba4f..5f8f13a86d9 100644 --- a/doc/src/sgml/user-manag.sgml +++ b/doc/src/sgml/user-manag.sgml @@ -1,5 +1,5 @@ @@ -16,8 +16,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/user-manag.sgml,v 1.19 2003/03/13 01:30:29 This chapter describes how to create and manage users and introduces the privilege system. More information about the various types of - database objects and the effects of privileges can be found in the - &cite-user;. + database objects and the effects of privileges can be found in . @@ -185,7 +184,7 @@ ALTER GROUP name DROP USER uname1 Privileges - Being moved to User's Guide. Will eventually disappear here. + Being moved to the DDL chapter. Will eventually disappear here. When a database object is created, it is assigned an owner. The @@ -205,7 +204,7 @@ ALTER GROUP name DROP USER uname1USAGE, and ALL PRIVILEGES. For more information on the different types of privileges support by PostgreSQL, refer to the - GRANT page in the &cite-reference;. The right to modify or + GRANT page in . The right to modify or destroy an object is always the privilege of the owner only. To assign privileges, the GRANT command is used. So, if joe is an existing user, and diff --git a/doc/src/sgml/user.sgml b/doc/src/sgml/user.sgml deleted file mode 100644 index 14fb80aa2ea..00000000000 --- a/doc/src/sgml/user.sgml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - PostgreSQL &version; User's Guide - - - The PostgreSQL Global Development Group - &legal; - - - - Preface - - &intro; - &history; - - - What's In This Book - - - This book describes the use of the SQL language - in PostgreSQL. We start with - describing the general syntax of SQL, then - explain how to create the structures to hold data, how to populate - the database, and how to query it. The middle part lists the - available data types and functions for use in - SQL data commands. The rest of the book treats - several aspects that are important for tuning a database for - optimal performance. - - - - The information in this book is arranged so that a novice user can - follow it start to end to gain a full understanding of the topics - without having to refer forward too many times. The chapters are - intended to be self-contained, so that advanced users can read the - chapters individually as they choose. The information in this - book is presented in a narrative fashion in topical units. - Readers looking for a complete description of a particular command - should look into the &cite-reference;. - - - - Readers of this book should know how to connect to a PostgreSQL - database and issue SQL commands. Readers that are unfamiliar with - these issues are encouraged to read the &cite-tutorial; first. SQL - commands are typically entered using the PostgreSQL interactive - terminal psql, but other programs that - have similar functionality can be used as well. - - - - This book covers PostgreSQL &version; - only. For information on other versions, please read the - documentation that accompanies that release. - - - - &info; - ¬ation; - &problems; - - - &syntax; - &ddl; - &dml; - &queries; - &datatype; - &func; - &typeconv; - &indices; - &mvcc; - &perform; - - - - &datetime; - &keywords; - &features; - - &biblio; - - - - - - diff --git a/doc/src/sgml/xaggr.sgml b/doc/src/sgml/xaggr.sgml index 8494eaa504d..33bfd962299 100644 --- a/doc/src/sgml/xaggr.sgml +++ b/doc/src/sgml/xaggr.sgml @@ -1,5 +1,5 @@ @@ -114,7 +114,7 @@ CREATE AGGREGATE avg ( For further details see the description of the CREATE - AGGREGATE command in the &cite-reference;. + AGGREGATE command in . diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml index 0ae9531f56a..5398df7ad92 100644 --- a/doc/src/sgml/xfunc.sgml +++ b/doc/src/sgml/xfunc.sgml @@ -1,5 +1,5 @@ @@ -2051,7 +2051,7 @@ CREATE FUNCTION test(smallint, double precision) RETURNS ... it is not immediately clear which function would be called with some trivial input like test(1, 1.5). The currently implemented resolution rules are described in the - &cite-user;, but it is unwise to design a system that subtly + , but it is unwise to design a system that subtly relies on this behavior. diff --git a/src/backend/port/sysv_sema.c b/src/backend/port/sysv_sema.c index cef6cc06468..a555a22a82f 100644 --- a/src/backend/port/sysv_sema.c +++ b/src/backend/port/sysv_sema.c @@ -8,7 +8,7 @@ * Portions Copyright (c) 1994, Regents of the University of California * * IDENTIFICATION - * $Header: /cvsroot/pgsql/src/backend/port/sysv_sema.c,v 1.4 2002/09/04 20:31:24 momjian Exp $ + * $Header: /cvsroot/pgsql/src/backend/port/sysv_sema.c,v 1.5 2003/03/25 16:15:44 petere Exp $ * *------------------------------------------------------------------------- */ @@ -128,7 +128,7 @@ InternalIpcSemaphoreCreate(IpcSemaphoreKey semKey, int numSems) "consumption of semaphores by reducing its max_connections parameter\n" "(currently %d).\n" "\n" - "The PostgreSQL Administrator's Guide contains more information about\n" + "The PostgreSQL documentation contains more information about\n" "configuring your system for PostgreSQL.\n\n", MaxBackends); diff --git a/src/backend/port/sysv_shmem.c b/src/backend/port/sysv_shmem.c index 60e5d0b478b..fc5c6e83c19 100644 --- a/src/backend/port/sysv_shmem.c +++ b/src/backend/port/sysv_shmem.c @@ -10,7 +10,7 @@ * Portions Copyright (c) 1994, Regents of the University of California * * IDENTIFICATION - * $Header: /cvsroot/pgsql/src/backend/port/sysv_shmem.c,v 1.4 2002/09/04 20:31:24 momjian Exp $ + * $Header: /cvsroot/pgsql/src/backend/port/sysv_shmem.c,v 1.5 2003/03/25 16:15:44 petere Exp $ * *------------------------------------------------------------------------- */ @@ -96,7 +96,7 @@ InternalIpcMemoryCreate(IpcMemoryKey memKey, uint32 size) "\nThis error usually means that PostgreSQL's request for a shared memory\n" "segment exceeded your kernel's SHMMAX parameter. You can either\n" "reduce the request size or reconfigure the kernel with larger SHMMAX.\n" - "To reduce the request size (currently %u bytes), reduce\n" + "To reduce the request size (currently %u bytes), reduce\n" "PostgreSQL's shared_buffers parameter (currently %d) and/or\n" "its max_connections parameter (currently %d).\n" "\n" @@ -104,20 +104,20 @@ InternalIpcMemoryCreate(IpcMemoryKey memKey, uint32 size) "your kernel's SHMMIN parameter, in which case raising the request size or\n" "reconfiguring SHMMIN is called for.\n" "\n" - "The PostgreSQL Administrator's Guide contains more information about\n" - "shared memory configuration.\n\n", + "The PostgreSQL documentation contains more information about shared\n" + "memory configuration.\n\n", size, NBuffers, MaxBackends); else if (errno == ENOMEM) fprintf(stderr, "\nThis error usually means that PostgreSQL's request for a shared\n" - "memory segment exceeded available memory or swap space.\n" - "To reduce the request size (currently %u bytes), reduce\n" + "memory segment exceeded available memory or swap space.\n" + "To reduce the request size (currently %u bytes), reduce\n" "PostgreSQL's shared_buffers parameter (currently %d) and/or\n" "its max_connections parameter (currently %d).\n" "\n" - "The PostgreSQL Administrator's Guide contains more information about\n" - "shared memory configuration.\n\n", + "The PostgreSQL documentation contains more information about shared\n" + "memory configuration.\n\n", size, NBuffers, MaxBackends); else if (errno == ENOSPC) @@ -132,8 +132,8 @@ InternalIpcMemoryCreate(IpcMemoryKey memKey, uint32 size) "by reducing its shared_buffers parameter (currently %d) and/or\n" "its max_connections parameter (currently %d).\n" "\n" - "The PostgreSQL Administrator's Guide contains more information about\n" - "shared memory configuration.\n\n", + "The PostgreSQL documentation contains more information about shared\n" + "memory configuration.\n\n", size, NBuffers, MaxBackends); proc_exit(1); diff --git a/src/bin/initdb/initdb.sh b/src/bin/initdb/initdb.sh index 646b941cfa5..473b2786cf1 100644 --- a/src/bin/initdb/initdb.sh +++ b/src/bin/initdb/initdb.sh @@ -27,7 +27,7 @@ # Portions Copyright (c) 1996-2002, PostgreSQL Global Development Group # Portions Copyright (c) 1994, Regents of the University of California # -# $Header: /cvsroot/pgsql/src/bin/initdb/Attic/initdb.sh,v 1.186 2003/03/20 03:34:56 momjian Exp $ +# $Header: /cvsroot/pgsql/src/bin/initdb/Attic/initdb.sh,v 1.187 2003/03/25 16:15:44 petere Exp $ # #------------------------------------------------------------------------- @@ -483,7 +483,7 @@ fi if test x`pg_getlocale COLLATE` != xC && test x`pg_getlocale COLLATE` != xPOSIX; then echo "This locale setting will prevent the use of indexes for pattern matching" echo "operations. If that is a concern, rerun $CMDNAME with the collation order" - echo "set to \"C\". For more information see the Administrator's Guide." + echo "set to \"C\". For more information see the documentation." fi echo