aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref
diff options
context:
space:
mode:
authorBruce Momjian <bruce@momjian.us>2002-11-15 03:11:18 +0000
committerBruce Momjian <bruce@momjian.us>2002-11-15 03:11:18 +0000
commitda8149032a799cd6cca1adc2ccc4c7140281308b (patch)
tree5c3e1f9417c2395433b382778ae7e29f7e5a507c /doc/src/sgml/ref
parent8bc717cb8878ff2baee4e29553736fab57248436 (diff)
downloadpostgresql-da8149032a799cd6cca1adc2ccc4c7140281308b.tar.gz
postgresql-da8149032a799cd6cca1adc2ccc4c7140281308b.zip
SGML improvements.
Neil Conway
Diffstat (limited to 'doc/src/sgml/ref')
-rw-r--r--doc/src/sgml/ref/create_cast.sgml18
-rw-r--r--doc/src/sgml/ref/create_database.sgml4
-rw-r--r--doc/src/sgml/ref/ecpg-ref.sgml8
-rw-r--r--doc/src/sgml/ref/explain.sgml20
-rw-r--r--doc/src/sgml/ref/load.sgml17
-rw-r--r--doc/src/sgml/ref/pg_config-ref.sgml9
-rw-r--r--doc/src/sgml/ref/pg_dump.sgml14
-rw-r--r--doc/src/sgml/ref/pg_dumpall.sgml26
-rw-r--r--doc/src/sgml/ref/pg_restore.sgml27
9 files changed, 73 insertions, 70 deletions
diff --git a/doc/src/sgml/ref/create_cast.sgml b/doc/src/sgml/ref/create_cast.sgml
index 172b988a6af..98ed9c3a882 100644
--- a/doc/src/sgml/ref/create_cast.sgml
+++ b/doc/src/sgml/ref/create_cast.sgml
@@ -1,4 +1,4 @@
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_cast.sgml,v 1.6 2002/10/04 22:08:44 tgl Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_cast.sgml,v 1.7 2002/11/15 03:11:17 momjian Exp $ -->
<refentry id="SQL-CREATECAST">
<refmeta>
@@ -196,14 +196,14 @@ SELECT 'The time is ' || CAST(now() AS text);
</para>
<para>
- Prior to PostgreSQL 7.3, every function that had the same name as a
- data type, returned that data type, and took one argument of a
- different type was automatically a cast function. This convention has
- been abandoned in face of the introduction of schemas and to be
- able to represent binary compatible casts in the catalogs. (The built-in
- cast functions
- still follow this naming scheme, but they have to be shown as
- casts in <literal>pg_cast</> now.)
+ Prior to <productname>PostgreSQL</> 7.3, every function that had
+ the same name as a data type, returned that data type, and took one
+ argument of a different type was automatically a cast function.
+ This convention has been abandoned in face of the introduction of
+ schemas and to be able to represent binary compatible casts in the
+ catalogs. (The built-in cast functions still follow this naming
+ scheme, but they have to be shown as casts in <literal>pg_cast</>
+ now.)
</para>
</refsect1>
diff --git a/doc/src/sgml/ref/create_database.sgml b/doc/src/sgml/ref/create_database.sgml
index 990207b3fc9..f419a12966f 100644
--- a/doc/src/sgml/ref/create_database.sgml
+++ b/doc/src/sgml/ref/create_database.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_database.sgml,v 1.29 2002/09/21 18:32:54 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_database.sgml,v 1.30 2002/11/15 03:11:17 momjian Exp $
PostgreSQL documentation
-->
@@ -217,7 +217,7 @@ CREATE DATABASE <replaceable class="PARAMETER">name</replaceable>
<replaceable class="parameter">name</replaceable>. In particular,
by writing <literal>TEMPLATE = template0</>, you can create a virgin
database containing only the standard objects predefined by your
- version of <application>PostgreSQL</application>. This is useful
+ version of <productname>PostgreSQL</productname>. This is useful
if you wish to avoid copying
any installation-local objects that may have been added to
<literal>template1</>.
diff --git a/doc/src/sgml/ref/ecpg-ref.sgml b/doc/src/sgml/ref/ecpg-ref.sgml
index c2c8ec6eed7..2a5f0f6ac6d 100644
--- a/doc/src/sgml/ref/ecpg-ref.sgml
+++ b/doc/src/sgml/ref/ecpg-ref.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.22 2002/10/24 17:48:54 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.23 2002/11/15 03:11:18 momjian Exp $
PostgreSQL documentation
-->
@@ -157,9 +157,9 @@ PostgreSQL documentation
<para>
When compiling the preprocessed C code files, the compiler needs to
be able to find the <application>ECPG</> header files in the
- PostgreSQL include directory. Therefore, one might have to use the
- <option>-I</> option when invoking the compiler (e.g.,
- <literal>-I/usr/local/pgsql/include</literal>).
+ <productname>PostgreSQL</> include directory. Therefore, one might
+ have to use the <option>-I</> option when invoking the compiler
+ (e.g., <literal>-I/usr/local/pgsql/include</literal>).
</para>
<para>
diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml
index 6a5d1c037cf..cd9e1fba35c 100644
--- a/doc/src/sgml/ref/explain.sgml
+++ b/doc/src/sgml/ref/explain.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/explain.sgml,v 1.20 2002/04/21 19:02:39 thomas Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/explain.sgml,v 1.21 2002/11/15 03:11:18 momjian Exp $
PostgreSQL documentation
-->
@@ -87,7 +87,7 @@ EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="PARAMETER">query</replaceabl
<note>
<para>
- Prior to <application>PostgreSQL</application> 7.3, the query plan
+ Prior to <productname>PostgreSQL</productname> 7.3, the query plan
was emitted in the form of a NOTICE message. Now it appears as a
query result (formatted like a table with a single text column).
</para>
@@ -105,12 +105,12 @@ EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="PARAMETER">query</replaceabl
<para>
This command displays the execution plan that the
- <application>PostgreSQL</application> planner
- generates for the supplied query. The execution plan shows how
- the table(s) referenced by the query will be scanned---by plain
- sequential scan, index scan, etc.---and if multiple tables are
- referenced, what join algorithms will be used to bring together
- the required tuples from each input table.
+ <productname>PostgreSQL</productname> planner generates for the
+ supplied query. The execution plan shows how the table(s)
+ referenced by the query will be scanned---by plain sequential scan,
+ index scan, etc.---and if multiple tables are referenced, what join
+ algorithms will be used to bring together the required tuples from
+ each input table.
</para>
<para>
@@ -156,7 +156,7 @@ ROLLBACK;
The VERBOSE option emits the full internal representation of the plan tree,
rather than just a summary.
Usually this option is only useful for debugging
- <application>PostgreSQL</application>. The VERBOSE dump is either
+ <productname>PostgreSQL</productname>. The VERBOSE dump is either
pretty-printed or not, depending on the setting of the
<option>EXPLAIN_PRETTY_PRINT</option> configuration parameter.
</para>
@@ -232,7 +232,7 @@ EXPLAIN SELECT sum(i) FROM foo WHERE i &lt; 10;
<para>
Note that the specific numbers shown, and even the selected query
- strategy, may vary between <application>PostgreSQL</application>
+ strategy, may vary between <productname>PostgreSQL</productname>
releases due to planner improvements.
</para>
</refsect1>
diff --git a/doc/src/sgml/ref/load.sgml b/doc/src/sgml/ref/load.sgml
index 38fad94aaaf..166f7aefa08 100644
--- a/doc/src/sgml/ref/load.sgml
+++ b/doc/src/sgml/ref/load.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/load.sgml,v 1.12 2002/01/20 22:19:57 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/load.sgml,v 1.13 2002/11/15 03:11:18 momjian Exp $
-->
<refentry id="SQL-LOAD">
@@ -23,13 +23,14 @@ LOAD '<replaceable class="PARAMETER">filename</replaceable>'
<title>Description</title>
<para>
- Loads a shared library file into the PostgreSQL backend's address
- space. If the file had been loaded previously, it is first
- unloaded. This command is primarily useful to unload and reload a
- shared library file that has been changed since the backend first
- loaded it. To make use of the
- shared library, function(s) in it need to be declared using the <xref
- linkend="sql-createfunction" endterm="sql-createfunction-title"> command.
+ Loads a shared library file into the <productname>PostgreSQL</>
+ backend's address space. If the file had been loaded previously,
+ it is first unloaded. This command is primarily useful to unload
+ and reload a shared library file that has been changed since the
+ backend first loaded it. To make use of the shared library,
+ function(s) in it need to be declared using the <xref
+ linkend="sql-createfunction" endterm="sql-createfunction-title">
+ command.
</para>
<para>
diff --git a/doc/src/sgml/ref/pg_config-ref.sgml b/doc/src/sgml/ref/pg_config-ref.sgml
index 222058b7fca..e9adeb2c5e0 100644
--- a/doc/src/sgml/ref/pg_config-ref.sgml
+++ b/doc/src/sgml/ref/pg_config-ref.sgml
@@ -1,4 +1,4 @@
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.11 2002/10/11 23:03:48 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.12 2002/11/15 03:11:18 momjian Exp $ -->
<refentry id="app-pgconfig">
<refmeta>
@@ -131,7 +131,7 @@
<para>
The option <option>--includedir-server</option> is new in
- PostgreSQL 7.2. In prior releases, the server include files were
+ <productname>PostgreSQL</> 7.2. In prior releases, the server include files were
installed in the same location as the client headers, which could
be queried with the <option>--includedir</option>. To make your
package handle both cases, try the newer option first and test the
@@ -139,7 +139,7 @@
</para>
<para>
- In releases prior to PostgreSQL 7.1, before the
+ In releases prior to <productname>PostgreSQL</> 7.1, before the
<command>pg_config</command> came to be, a method for finding the
equivalent configuration information did not exist.
</para>
@@ -150,7 +150,8 @@
<title>History</title>
<para>
- The <command>pg_config</command> utility first appeared in PostgreSQL 7.1.
+ The <command>pg_config</command> utility first appeared in
+ <productname>PostgreSQL</> 7.1.
</para>
</refsect1>
diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml
index ea4d0d6ea87..64b2e00b8b2 100644
--- a/doc/src/sgml/ref/pg_dump.sgml
+++ b/doc/src/sgml/ref/pg_dump.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.52 2002/10/11 23:03:48 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.53 2002/11/15 03:11:18 momjian Exp $
PostgreSQL documentation
-->
@@ -274,11 +274,11 @@ PostgreSQL documentation
<para>
<application>pg_dump</application> can handle databases from
- previous releases of PostgreSQL, but very old versions are not
- supported anymore (currently prior to 7.0). Use this option
- if you need to override the version check (and if
- <application>pg_dump</application> then fails, don't say you
- weren't warned).
+ previous releases of <productname>PostgreSQL</>, but very old
+ versions are not supported anymore (currently prior to 7.0).
+ Use this option if you need to override the version check (and
+ if <application>pg_dump</application> then fails, don't say
+ you weren't warned).
</para>
</listitem>
</varlistentry>
@@ -289,7 +289,7 @@ PostgreSQL documentation
<listitem>
<para>
Dump object identifiers (<acronym>OID</acronym>s) for every
- table. Use this option if your application references the OID
+ table. Use this option if your application references the <acronym>OID</>
columns in some way (e.g., in a foreign key constraint).
Otherwise, this option should not be used.
</para>
diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml
index 2439d040866..2556f6f6bfb 100644
--- a/doc/src/sgml/ref/pg_dumpall.sgml
+++ b/doc/src/sgml/ref/pg_dumpall.sgml
@@ -1,5 +1,5 @@
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.34 2002/09/07 16:14:33 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.35 2002/11/15 03:11:18 momjian Exp $
PostgreSQL documentation
-->
@@ -27,13 +27,13 @@ PostgreSQL documentation
<para>
<application>pg_dumpall</application> is a utility for writing out
- (<quote>dumping</quote>) all PostgreSQL databases of a cluster into
- one script file. The script file contains SQL commands that can be
- used as input to <xref linkend="app-psql">
- to restore the databases. It does this by calling <xref
- linkend="app-pgdump"> for each database
- in a cluster. <application>pg_dumpall</application> also dumps
- global objects that are common to all databases.
+ (<quote>dumping</quote>) all <productname>PostgreSQL</> databases
+ of a cluster into one script file. The script file contains
+ <acronym>SQL</acronym> commands that can be used as input to <xref
+ linkend="app-psql"> to restore the databases. It does this by
+ calling <xref linkend="app-pgdump"> for each database in a cluster.
+ <application>pg_dumpall</application> also dumps global objects
+ that are common to all databases.
(<application>pg_dump</application> does not save these objects.)
This currently includes the information about database users and
groups.
@@ -139,11 +139,11 @@ PostgreSQL documentation
<para>
<application>pg_dumpall</application> can handle databases
- from previous releases of PostgreSQL, but very old versions
- are not supported anymore (currently prior to 7.0). Use this
- option if you need to override the version check (and if
- <application>pg_dumpall</application> then fails, don't say
- you weren't warned).
+ from previous releases of <productname>PostgreSQL</>, but very
+ old versions are not supported anymore (currently prior to
+ 7.0). Use this option if you need to override the version
+ check (and if <application>pg_dumpall</application> then
+ fails, don't say you weren't warned).
</para>
</listitem>
</varlistentry>
diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml
index c380bb499e3..72543dc7ebb 100644
--- a/doc/src/sgml/ref/pg_restore.sgml
+++ b/doc/src/sgml/ref/pg_restore.sgml
@@ -1,4 +1,4 @@
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.31 2002/10/11 23:03:48 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.32 2002/11/15 03:11:18 momjian Exp $ -->
<refentry id="APP-PGRESTORE">
<docinfo>
@@ -417,11 +417,12 @@
</para>
<para>
- Presently, the commands emitted for <option>--disable-triggers</>
- must be done as superuser. So, you should also specify
- a superuser name with <option>-S</>, or preferably specify
- <option>--use-set-session-authorization</> and run
- <application>pg_restore</application> as a PostgreSQL superuser.
+ Presently, the commands emitted for
+ <option>--disable-triggers</> must be done as superuser. So, you
+ should also specify a superuser name with <option>-S</>, or
+ preferably specify <option>--use-set-session-authorization</> and
+ run <application>pg_restore</application> as a
+ <productname>PostgreSQL</> superuser.
</para>
</listitem>
</varlistentry>
@@ -522,12 +523,12 @@ connectDBStart() -- connect() failed: No such file or directory
<msgexplan>
<para>
<application>pg_restore</application> could not attach to the
- PostgreSQL server
- process on the specified host and port. If you see this message,
- ensure that the server
- is running on the proper host and that you have specified the proper
- port. If your site uses an authentication system, ensure that you
- have obtained the required authentication credentials.
+ <productname>PostgreSQL</> server process on the specified
+ host and port. If you see this message, ensure that the
+ server is running on the proper host and that you have
+ specified the proper port. If your site uses an
+ authentication system, ensure that you have obtained the
+ required authentication credentials.
</para>
</msgexplan>
</msgentry>
@@ -537,7 +538,7 @@ connectDBStart() -- connect() failed: No such file or directory
<para>
When a direct database connection is specified using the -d
option, <application>pg_restore</application> internally executes
- SQL statements. If you have problems running
+ <acronym>SQL</acronym> statements. If you have problems running
<application>pg_restore</application>, make sure you are able to select
information from the database using, for example,
<application>psql</application>.