]> granicus.if.org Git - postgresql/blobdiff - contrib/README
Avoid scan-build warning about uninitialized htonl() arguments.
[postgresql] / contrib / README
index 23cfe8c4d29e612fa2902686b3e0147201a88fa5..5eaeb2451f29877e986f4683c57dd70edde942d5 100644 (file)
@@ -1,81 +1,28 @@
-
- The PostgreSQL contrib tree
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-       FIXME:
-               odbc
-               spi/preprocessor
-               tools           
-
- - the contrib contain is in the "Contrib.index"       
-
- - in each directory must be Makefile, possible Makefile template
-   is below this text,
-
---------
-#
-# $Header: /cvsroot/pgsql/contrib/README,v 1.19 2000/06/19 13:52:59 momjian Exp $
-#
-
-TOPDIR=../..
-
-include ../Makefile.global
-
-NAME   = some_name
-
-PROGRAM        = 
-OBJS   = $(NAME).o
-DOCS   = $(NAME).doc
-SQLS   = $(NAME).sql
-BINS   =
-EXAMPLES=
-MODS   = $(NAME)$(DLSUFFIX)
-
-CFLAGS += -I. $(CFLAGS_SL)
-
-OTHER_CLEAN = $(SQLS)
-
-all: $(MODS) $(SQLS)
-
-%.sql: %.sql.in
-       $(SED) "s|MODULE_PATHNAME|$(CONTRIB_MODDIR)/$@|" < $< > $@
-
-
-install: install_doc install_sql install_mod install_bin install_example
-
-install_doc:
-       for inst_file in $(DOCS); do \
-               $(INSTALL) $(INSTL_LIB_OPTS) $$inst_file $(CONTRIB_DOCDIR); \
-       done
-
-install_sql:
-       for inst_file in $(SQLS); do \
-               $(INSTALL) $(INSTL_LIB_OPTS) $$inst_file $(CONTRIB_SQLDIR); \
-       done
-
-install_mod:
-       for inst_file in $(MODS); do \
-               $(INSTALL) $(INSTL_SHLIB_OPTS) $$inst_file $(CONTRIB_MODDIR); \
-       done
-
-install_bin:
-       for inst_file in $(BINS); do \
-               $(INSTALL) $(INSTL_EXE_OPTS) $$inst_file $(CONTRIB_BINDIR); \
-       done
-
-install_example:
-       for inst_file in $(EXAMPLES); do \
-               $(INSTALL) $(INSTL_LIB_OPTS) $$inst_file $(CONTRIB_EXAMPLESDIR); \
-       done
-
-depend dep:
-       $(CC) -MM -MG $(CFLAGS) *.c > depend
-
-clean:
-       $(RM) *~ $(OBJS) $(MODS) $(PROGRAM) depend $(OTHER_CLEAN) core log
-
-ifeq (depend,$(wildcard depend))
-include depend
-endif
------------
-  
\ No newline at end of file
+The PostgreSQL contrib tree
+---------------------------
+
+This subtree contains 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.
+
+User documentation for each module appears in the main SGML
+documentation.
+
+When building from the source distribution, these modules are not
+built automatically, unless you build the "world" target.  You can
+also build and install them all by running "make all" and "make
+install" in this directory; or to build and install just one selected
+module, do the same in that module's subdirectory.
+
+Some directories 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 SQL objects in the database
+system by executing a CREATE EXTENSION command.  In a fresh database,
+you can simply do
+
+    CREATE EXTENSION module_name;
+
+See the PostgreSQL documentation for more information about this
+procedure.