diff options
Diffstat (limited to 'doc/src/sgml/contrib.sgml')
| -rw-r--r-- | doc/src/sgml/contrib.sgml | 89 |
1 files changed, 79 insertions, 10 deletions
diff --git a/doc/src/sgml/contrib.sgml b/doc/src/sgml/contrib.sgml index 07190c5eff2..6b13a0abefb 100644 --- a/doc/src/sgml/contrib.sgml +++ b/doc/src/sgml/contrib.sgml @@ -4,7 +4,7 @@ <title>Additional Supplied Modules</title> <para> - This appendix contains information regarding the modules that + This appendix and the next one contain information regarding the modules that can be found in the <literal>contrib</literal> directory of the <productname>PostgreSQL</> distribution. These include porting tools, analysis utilities, @@ -15,7 +15,13 @@ </para> <para> - When building from the source distribution, these modules are not built + This appendix covers extensions and other server plug-in modules found in + <literal>contrib</literal>. <xref linkend="contrib-prog"> covers utility + programs. + </para> + + <para> + When building from the source distribution, these components are not built automatically, unless you build the "world" target (see <xref linkend="build">). You can build and install all of them by running: @@ -88,6 +94,14 @@ CREATE EXTENSION <replaceable>module_name</> FROM unpackaged; <xref linkend="extend-extensions">. </para> + <para> + Note, however, that some of these modules are not <quote>extensions</quote> + in this sense, but are loaded into the server in some other way, for instance + by way of + <xref linkend="guc-shared-preload-libraries">. See the documentation of each + module for details. + </para> + &adminpack; &auth-delay; &auto-explain; @@ -109,22 +123,15 @@ CREATE EXTENSION <replaceable>module_name</> FROM unpackaged; &isn; &lo; <ree; - &oid2name; &pageinspect; &passwordcheck; - &pgarchivecleanup; - &pgbench; &pgbuffercache; &pgcrypto; &pgfreespacemap; &pgrowlocks; - &pgstandby; &pgstatstatements; &pgstattuple; - &pgtestfsync; - &pgtesttiming; &pgtrgm; - &pgupgrade; &seg; &sepgsql; &contrib-spi; @@ -135,7 +142,69 @@ CREATE EXTENSION <replaceable>module_name</> FROM unpackaged; &tsearch2; &unaccent; &uuid-ossp; - &vacuumlo; &xml2; </appendix> + +<!-- +These are two separate appendixes because it is difficult to mix regular +sections (for extensions) and refentries (for programs) in one chapter or +appendix. And we do want the programs as refentries so that we can produce man +pages. +--> + +<appendix id="contrib-prog"> + <title>Additional Supplied Programs</title> + + <para> + This appendix and the previous one contain information regarding the modules that + can be found in the <literal>contrib</literal> directory of the + <productname>PostgreSQL</> distribution. See <xref linkend="contrib"> for + more information about the <literal>contrib</literal> section in general and + server extensions and plug-ins found in <literal>contrib</literal> + specifically. + </para> + + <para> + This appendix covers utility programs found in <literal>contrib</literal>. + Once installed, either from source or a packaging system, they are found in + the <filename>bin</filename> directory of the + <productname>PostgreSQL</productname> installation and can be used like any + other program. + </para> + + <sect1 id="contrib-prog-client"> + <title>Client Applications</title> + + <para> + This section covers <productname>PostgreSQL</productname> client + applications in <literal>contrib</literal>. They can be run from anywhere, + independent of where the database server resides. See + also <xref linkend="reference-client"> for information about client + applications that part of the core <productname>PostgreSQL</productname> + distribution. + </para> + + &oid2name; + &pgbench; + &vacuumlo; + </sect1> + + <sect1 id="contrib-prog-server"> + <title>Server Applications</title> + + <para> + This section covers <productname>PostgreSQL</productname> server-related + applications in <literal>contrib</literal>. They are typically run on the + host where the database server resides. See also <xref + linkend="reference-server"> for information about server applications that + part of the core <productname>PostgreSQL</productname> distribution. + </para> + + &pgarchivecleanup; + &pgstandby; + &pgtestfsync; + &pgtesttiming; + &pgupgrade; + </sect1> +</appendix> |
