head	1.18;
access;
symbols
	REL9_0_0:1.18
	REL9_1_ALPHA1:1.18
	REL9_0_RC1:1.18
	REL9_0_BETA4:1.18
	REL9_0_STABLE:1.18.0.2
	REL9_0_BETA3:1.18
	REL9_0_BETA2:1.17
	REL8_3_11:1.8
	REL8_4_4:1.13
	REL9_0_BETA1:1.16
	REL9_0_ALPHA5_BRANCH:1.16.0.4
	REL9_0_ALPHA5:1.16
	REL8_3_10:1.8
	REL8_4_3:1.13
	REL9_0_ALPHA4:1.16
	REL9_0_ALPHA4_BRANCH:1.16.0.2
	REL8_5_ALPHA3:1.15
	REL8_5_ALPHA3_BRANCH:1.15.0.2
	REL8_3_9:1.8
	REL8_4_2:1.13
	REL8_5_ALPHA2:1.14
	REL8_5_ALPHA2_BRANCH:1.14.0.4
	REL8_3_8:1.8
	REL8_4_1:1.13
	REL8_5_ALPHA1:1.14
	REL8_5_ALPHA1_BRANCH:1.14.0.2
	REL8_4_STABLE:1.13.0.2
	REL8_4_0:1.13
	REL8_4_RC2:1.13
	REL8_4_RC1:1.13
	REL8_4_BETA2:1.13
	REL8_4_BETA1:1.12
	REL8_3_7:1.8
	REL8_3_6:1.8
	REL8_3_5:1.8
	REL8_3_4:1.8
	REL8_3_3:1.8
	REL8_3_2:1.8
	REL8_3_1:1.8
	REL8_3_STABLE:1.8.0.2
	REL8_3_0:1.8
	REL8_3_RC2:1.8
	REL8_3_RC1:1.8
	REL8_3_BETA4:1.6
	REL8_3_BETA3:1.4;
locks; strict;
comment	@# @;


1.18
date	2010.06.14.17.25.24;	author sriggs;	state Exp;
branches;
next	1.17;

1.17
date	2010.05.12.02.19.11;	author momjian;	state Exp;
branches;
next	1.16;

1.16
date	2010.01.28.23.59.52;	author adunstan;	state Exp;
branches;
next	1.15;

1.15
date	2009.11.18.21.57.56;	author tgl;	state Exp;
branches;
next	1.14;

1.14
date	2009.08.18.10.34.39;	author teodor;	state Exp;
branches;
next	1.13;

1.13
date	2009.04.27.16.27.35;	author momjian;	state Exp;
branches;
next	1.12;

1.12
date	2009.03.25.23.20.01;	author tgl;	state Exp;
branches;
next	1.11;

1.11
date	2009.01.04.22.19.59;	author tgl;	state Exp;
branches;
next	1.10;

1.10
date	2008.11.19.02.59.28;	author tgl;	state Exp;
branches;
next	1.9;

1.9
date	2008.07.29.18.31.20;	author tgl;	state Exp;
branches;
next	1.8;

1.8
date	2007.12.06.04.12.09;	author tgl;	state Exp;
branches;
next	1.7;

1.7
date	2007.12.03.04.18.47;	author tgl;	state Exp;
branches;
next	1.6;

1.6
date	2007.12.02.22.33.20;	author tgl;	state Exp;
branches;
next	1.5;

1.5
date	2007.12.02.21.13.34;	author tgl;	state Exp;
branches;
next	1.4;

1.4
date	2007.11.14.02.36.43;	author tgl;	state Exp;
branches;
next	1.3;

1.3
date	2007.11.14.01.09.50;	author tgl;	state Exp;
branches;
next	1.2;

1.2
date	2007.11.11.03.25.35;	author momjian;	state Exp;
branches;
next	1.1;

1.1
date	2007.11.10.23.30.46;	author momjian;	state Exp;
branches;
next	;


desc
@@


1.18
log
@Docs for pg_archivecleanup
@
text
@<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.17 2010/05/12 02:19:11 momjian Exp $ -->

<appendix id="contrib">
 <title>Additional Supplied Modules</title>

 <para>
  This appendix contains 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,
  and plug-in features that are not part of the core PostgreSQL system,
  mainly because they address a limited audience or are too experimental
  to be part of the main source tree.  This does not preclude their
  usefulness.
 </para>

 <para>
  When building from the source distribution, these modules are not built
  automatically, unless you build the "world" target 
  (see <xref linkend="build">).
  You can build and install all of them by running:
<screen>
<userinput>gmake</userinput>
<userinput>gmake install</userinput>
</screen>
  in the <literal>contrib</literal> directory of a configured source tree;
  or to build and install
  just one selected module, do the same in that module's subdirectory.
  Many of the modules have regression tests, which can be executed by
  running:
<screen>
<userinput>gmake installcheck</userinput>
</screen>
  once you have a <productname>PostgreSQL</> server running.  (Note that
  <literal>gmake check</> is not supported; you must have an operational
  database server to perform these tests, and you must have built and
  installed the module(s) to be tested.)
 </para>

 <para>
  If you are using a pre-packaged version of <productname>PostgreSQL</>,
  these modules are typically made available as a separate subpackage,
  such as <literal>postgresql-contrib</>.
 </para>

 <para>
  Many modules supply new user-defined functions, operators, or types.
  To make use of one of these modules, after you have installed the code
  you need to register the new objects in the database
  system by running the SQL commands in the <literal>.sql</> file
  supplied by the module.  For example,

<programlisting>
psql -d dbname -f <replaceable>SHAREDIR</>/contrib/<replaceable>module</>.sql
</programlisting>

  Here, <replaceable>SHAREDIR</> means the installation's <quote>share</>
  directory (<literal>pg_config --sharedir</> will tell you what this is).
  In most cases the script must be run by a database superuser.
 </para>

 <para>
  You need to run the <literal>.sql</> file in each database that you want
  the module's facilities to be available in.  Alternatively, run it in
  database <literal>template1</> so that the module will be copied into
  subsequently-created databases by default.
 </para>

 <para>
  You can modify the first command in the <literal>.sql</> file to determine
  which schema within the database the module's objects will be created in.
  By default, they will be placed in <literal>public</>.
 </para>

 <para>
  After a major-version upgrade of <productname>PostgreSQL</>, run the
  installation script again, even though the module's objects might have
  been brought forward from the old installation by dump and restore.
  This ensures that any new functions will be available and any needed
  corrections will be applied.
 </para>

 &adminpack;
 &auto-explain;
 &btree-gin;
 &btree-gist;
 &chkpass;
 &citext;
 &cube;
 &dblink;
 &dict-int;
 &dict-xsyn;
 &earthdistance;
 &fuzzystrmatch;
 &hstore;
 &intagg;
 &intarray;
 &isn;
 &lo;
 &ltree;
 &oid2name;
 &pageinspect;
 &passwordcheck;
 &pgarchivecleanup;
 &pgbench;
 &pgbuffercache;
 &pgcrypto;
 &pgfreespacemap;
 &pgrowlocks;
 &pgstandby;
 &pgstatstatements;
 &pgstattuple;
 &pgtrgm;
 &pgupgrade;
 &seg;
 &contrib-spi;
 &sslinfo;
 &tablefunc;
 &test-parser;
 &tsearch2;
 &unaccent;
 &uuid-ossp;
 &vacuumlo;
 &xml2;

</appendix>
@


1.17
log
@Add pg_upgrade to /contrib;  will be in 9.0 beta2.

Add documentation.

Supports migration from PG 8.3 and 8.4.
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.16 2010/01/28 23:59:52 adunstan Exp $ -->
d104 1
@


1.16
log
@Add new make targets "world", "install-world" and "installcheck-world" to build, install and check just about everything.
In addition to everything built installed and tested by all, install and installcheck targets, these build HTML Docs,
build and test contrib, and test PLs and ECPG.
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.15 2009/11/18 21:57:56 tgl Exp $ -->
d113 1
@


1.15
log
@Add a hook to CREATE/ALTER ROLE to allow an external module to check the
strength of database passwords, and create a sample implementation of
such a hook as a new contrib module "passwordcheck".

Laurenz Albe, reviewed by Takahiro Itagaki
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.14 2009/08/18 10:34:39 teodor Exp $ -->
d19 3
a21 1
  automatically.  You can build and install all of them by running:
@


1.14
log
@Unaccent dictionary.
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.13 2009/04/27 16:27:35 momjian Exp $ -->
d101 1
@


1.13
log
@Proofreading adjustments for first two parts of documentation (Tutorial
and SQL).
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.12 2009/03/25 23:20:01 tgl Exp $ -->
d116 1
@


1.12
log
@Add btree_gin contrib module.

Teodor Sigaev and Oleg Bartunov
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.11 2009/01/04 22:19:59 tgl Exp $ -->
d19 1
a19 1
  automatically.  You can build and install all of them by running
d28 1
a28 1
  running
@


1.11
log
@Add contrib/pg_stat_statements for server-wide tracking of statement execution
statistics.

Takahiro Itagaki
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.10 2008/11/19 02:59:28 tgl Exp $ -->
d83 1
@


1.10
log
@Add auto-explain contrib module for automatic logging of the plans of
slow-running queries.

Takahiro Itagaki
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.9 2008/07/29 18:31:20 tgl Exp $ -->
d106 1
@


1.9
log
@Add a new, improved version of citext as a contrib module.

David E. Wheeler
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.8 2007/12/06 04:12:09 tgl Exp $ -->
d82 1
@


1.8
log
@Make an editorial pass over the newly SGML-ified contrib documentation.
Fix lots of bad markup, bad English, bad explanations.

This commit covers only about half the contrib modules, but I grow weary...
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.7 2007/12/03 04:18:47 tgl Exp $ -->
d84 1
@


1.7
log
@Add SGML documentation for contrib/spi and contrib/test_parser.
The spi documentation is pretty rudimentary, but it's a start.
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.6 2007/12/02 22:33:20 tgl Exp $ -->
d47 1
a47 1
  you need to register the new objects in the database 
d57 1
@


1.6
log
@Ensure that all <sect1> and <refentry> tags have IDs.  This is needed
to ensure that the resulting webpages have predictable URLs, instead of
ever-changing numeric IDs.  The new contrib docs were the biggest
offender, but some old stuff had the problem too.  Also, rename a couple
of new contrib sgml files for consistency's sake.
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.5 2007/12/02 21:13:34 tgl Exp $ -->
d106 1
d109 1
@


1.5
log
@Add SGML docs for contrib/dict_int and contrib/dict_xsyn.
Albert Cervera i Areny
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.4 2007/11/14 02:36:43 tgl Exp $ -->
d98 1
a98 1
 &buffercache;
d100 1
a100 1
 &freespacemap;
d102 1
a102 1
 &standby;
d104 1
a104 1
 &trgm;
@


1.4
log
@Move contrib docs to an appendix (next door to External Projects).
Change title to Additional Supplied Modules.  Improve discussion of
how to build and install 'em.
@
text
@d1 1
a1 1
<!-- $PostgreSQL$ -->
d85 2
@


1.3
log
@Add some quick documentation for tsearch2 compatibility module.
@
text
@d1 4
a4 2
<chapter id="contrib">
 <title>Standard Modules</title>
d7 1
a7 1
  This section contains information regarding the standard modules which
d9 2
a10 1
  PostgreSQL distribution. These are porting tools, analysis utilities,
d18 60
a77 15
  Some modules supply new user-defined functions, operators, or types.  In 
  these cases, you will need to run <literal>make</literal> and <literal>make
  install</literal> in <literal>contrib/module</literal>. After you have 
  installed the files you need to register the new entities in the database 
  system by running the commands in the supplied <literal>.sql</> file.
  For example,

  <programlisting>
   $ psql -d dbname -f module.sql
  </programlisting>

  You can modify the first command in the <literal>.sql</> file to control
  the schema where the module is created.  During major upgrades, even
  though the restored database might already have the desired module
  functions, run the installation script again to add any new functions.
a109 1
</chapter>
d111 1
@


1.2
log
@Make /contrib install/uninstall script consistent:

	remove transactions
	use create or replace function
	make formatting consistent
	set search patch on first line

Add documentation on modifying *.sql to set the search patch, and
mention that major upgrades should still run the installation scripts.

Some of these issues were spotted by Tom today.
@
text
@d58 1
@


1.1
log
@Move most /contrib README files into SGML.  Some still need conversion
or will never be converted.
@
text
@d19 2
a20 1
  system by running the commands in the supplied .sql file.  For example,
d25 5
@

