postgresql/doc/src/sgml/postgres.sgml

<!--
$Header: /cvsroot/pgsql/doc/src/sgml/postgres.sgml,v 1.28 1999/06/23 06:15:12 thomas Exp $

Postgres integrated documentation.
Other subset docs should be copied and shrunk from here.
thomas 1998-02-23

$Log: postgres.sgml,v $
Revision 1.28  1999/06/23 06:15:12  thomas
Add backup/restore info to Admin Guide.
Split management chapter from start-ag.sgml to manage-ag.sgml.

Revision 1.27  1999/06/03 04:21:49  thomas
Markup changes for v6.5 release.
Clean out duplicate stuff in odbc.sgml resulting from a faulty patch.

Revision 1.26  1999/06/01 17:26:18  thomas
Make sure that only one intro is included in the integrated doc.
Multiple intros cause trouble since they have some section elements
 (e.g. "y2k.sgml") in common leading to duplicate labels.
Include emacs formatting hints in the intro*.sgml sources.

Revision 1.25  1999/05/27 15:49:08  thomas
Markup fixes.
Update for v6.5 release.

Revision 1.24  1999/05/26 17:30:29  thomas
Add chapters on CVS access, MVCC, SQL theory to the docs.
Add an appendix with more details on date/time attributes and handling.
Update most references to Postgres version numbers to 6.5,
 *except* for the porting list which will require a report
 from a successful installation to be updated.

Revision 1.23  1999/05/22 02:27:24  thomas
Finish initial markup of cvs.sgml, and include it in the programmer's guide
 and the integrated doc. Clean up other markup.

Revision 1.22  1999/05/20 05:39:27  thomas
Rearrange and consolidate the Admin Guide.
Add reference pages for utilities and remove standalone chapters for same.
Add material for an appendix on date/time properties, but not yet
 integrated with the User's Guide.
Break up the former chapter on pg_options
 into Admin and Programmer's Guides.

Revision 1.21  1999/05/04 02:19:20  thomas
Include chapters on security and an intro to SQL.

Revision 1.20  1999/04/06 15:41:13  thomas
Fix markup to include all closing tags.
Required by newest versions of DocBook and style sheets.

Revision 1.19  1999/03/30 15:23:03  thomas
Include libpq+.sgml in the doc set.
Had been omitted from the integrated doc for no good reason.

Revision 1.18  1999/02/13 03:52:46  thomas
Include chapter on SQL language elements (keywords, etc).
Should merge with or complement Stefan's Master's Thesis intro to SQL.

Revision 1.17  1999/01/19 16:06:25  thomas
Merge current.sgml into release.sgml so all release notes are in the same
 file. Per Bruce's preference. Go to it Bruce!
No info yet for v6.4.2 or upcoming releases.

Revision 1.16  1999/01/07 02:59:45  thomas
Include installation instructions for WIN32 client-side libraries.
From Magnus Hagander <mha@sollentuna.net>.

Revision 1.15  1998/12/18 16:23:34  thomas
Fix typos in rules.sgml.
Add Emacs configuration block to postgres.sgml.

Revision 1.14  1998/10/31 09:36:34  thomas
Cleanup for v6.4 release.
Make new file current.sgml to hold release info for the current release.
 Should be moved to release.sgml before filling with next release info.

Revision 1.13  1998/10/30 19:37:09  thomas
Minor editing and markup changes as a result of preparing the Postscript
 documentation for v6.4.
Bigger updates to the installation instructions (install and config).

Revision 1.12  1998/10/27 06:14:01  thomas
Include configuration chapter with new info on configure and make.

Revision 1.11  1998/10/25 00:24:31  thomas
Add Y2K statement for intros.
Make sure notation section is included in most intros.

Revision 1.7-1.10  1998/10/21 05:31:52  thomas
Include new information from Massimo. Rearrange ODBC docs.
Add information for operator precedence.
Split introduction sections into separate files to allow the legal notice
 and notation sections appear in all documents without having the history
 show up everplace too.
Add full list of reserved and non-reserved key words in syntax.sgml.
Add a separate chapter to the admin guide on security.
Move SQL reference pages up into the User's Guide.

-->

<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [

<!entity about    SYSTEM "about.sgml">
<!entity history  SYSTEM "history.sgml">
<!entity info     SYSTEM "info.sgml">
<!entity legal    SYSTEM "legal.sgml">
<!entity notation SYSTEM "notation.sgml">
<!entity y2k      SYSTEM "y2k.sgml">

<!-- tutorial -->
<!entity arch     SYSTEM "arch.sgml">
<!entity intro    SYSTEM "intro.sgml">
<!entity query    SYSTEM "query.sgml">
<!entity sql      SYSTEM "sql.sgml">
<!entity start    SYSTEM "start.sgml">

<!-- user's guide -->
<!entity advanced SYSTEM "advanced.sgml">
<!entity array    SYSTEM "array.sgml">
<!entity datatype SYSTEM "datatype.sgml">
<!entity datetime SYSTEM "datetime.sgml">
<!entity environ  SYSTEM "environ.sgml">
<!entity func     SYSTEM "func.sgml">
<!entity inherit  SYSTEM "inherit.sgml">
<!entity keys     SYSTEM "keys.sgml">
<!entity manage   SYSTEM "manage.sgml">
<!entity mvcc     SYSTEM "mvcc.sgml">
<!entity oper     SYSTEM "oper.sgml">
<!entity pgaccess SYSTEM "pgaccess.sgml">
<!entity psql     SYSTEM "psql.sgml">
<!entity query-ug SYSTEM "query-ug.sgml">
<!entity storage  SYSTEM "storage.sgml">
<!entity syntax   SYSTEM "syntax.sgml">
<!entity typeconv SYSTEM "typeconv.sgml">

<!-- reference pages -->
<!entity % allfiles SYSTEM "ref/allfiles.sgml">
%allfiles;

<!-- administrator's guide -->
<!entity config    SYSTEM "config.sgml">
<!entity intro-ag  SYSTEM "intro-ag.sgml">
<!entity install   SYSTEM "install.sgml">
<!entity installw  SYSTEM "install-win32.sgml">
<!entity layout    SYSTEM "layout.sgml">
<!entity manage-ag SYSTEM "manage-ag.sgml">
<!entity ports     SYSTEM "ports.sgml">
<!entity recovery  SYSTEM "recovery.sgml">
<!entity regress   SYSTEM "regress.sgml">
<!entity release   SYSTEM "release.sgml">
<!entity runtime   SYSTEM "runtime.sgml">
<!entity security  SYSTEM "security.sgml">
<!entity start-ag  SYSTEM "start-ag.sgml">
<!entity trouble   SYSTEM "trouble.sgml">

<!-- programmer's guide -->
<!entity intro-pg SYSTEM "intro-pg.sgml">
<!entity arch-pg  SYSTEM "arch-pg.sgml">
<!entity extend   SYSTEM "extend.sgml">
<!entity rules    SYSTEM "rules.sgml">
<!entity xfunc    SYSTEM "xfunc.sgml">
<!entity xtypes   SYSTEM "xtypes.sgml">
<!entity xoper    SYSTEM "xoper.sgml">
<!entity xaggr    SYSTEM "xaggr.sgml">
<!entity xindex   SYSTEM "xindex.sgml">
<!entity gist     SYSTEM "gist.sgml">
<!entity dfunc    SYSTEM "dfunc.sgml">
<!entity lobj     SYSTEM "lobj.sgml">
<!entity trigger  SYSTEM "trigger.sgml">
<!entity spi      SYSTEM "spi.sgml">
<!entity func-ref SYSTEM "func-ref.sgml">
<!entity libpq    SYSTEM "libpq.sgml">
<!entity libpqpp  SYSTEM "libpq++.sgml">
<!entity libpgtcl SYSTEM "libpgtcl.sgml">
<!entity ecpg     SYSTEM "ecpg.sgml">
<!entity odbc     SYSTEM "odbc.sgml">
<!entity jdbc     SYSTEM "jdbc.sgml">
<!entity xplang   SYSTEM "xplang.sgml">

<!-- developer's guide -->
<!entity arch-dev SYSTEM "arch-dev.sgml">
<!entity biblio   SYSTEM "biblio.sgml">
<!entity bki      SYSTEM "bki.sgml">
<!entity compiler SYSTEM "compiler.sgml">
<!entity contacts SYSTEM "contacts.sgml">
<!entity cvs      SYSTEM "cvs.sgml">
<!entity docguide SYSTEM "docguide.sgml">
<!entity geqo     SYSTEM "geqo.sgml">
<!entity options  SYSTEM "pg_options.sgml">
<!entity page     SYSTEM "page.sgml">
<!entity protocol SYSTEM "protocol.sgml">
<!entity signals  SYSTEM "signals.sgml">
]>
<!-- entity manpages SYSTEM "man/manpages.sgml" subdoc -->
<Book Id="postgres">

 <!-- Title information -->

 <Title>PostgreSQL</Title>
 <BookInfo>
  <ReleaseInfo>Covering v6.5 for general release</ReleaseInfo>
  <BookBiblio>
   <AuthorGroup>
    <CorpAuthor>The PostgreSQL Development Team</CorpAuthor>
   </AuthorGroup>
<!-- editor in authorgroup is not supported
    <AuthorGroup>
-->
   <Editor>
    <FirstName>Thomas</FirstName>
    <SurName>Lockhart</SurName>
    <Affiliation>
     <OrgName>Caltech/JPL</OrgName>
    </Affiliation>
   </Editor>
<!--
    </AuthorGroup>
-->
 
<!--
    <AuthorInitials>TGL</AuthorInitials>
-->

   <Date>(last updated 1999-06-01)</Date>
  </BookBiblio>

  <LegalNotice>
   <Para>
    <ProductName>PostgreSQL</ProductName> is Copyright &copy; 1996-9 
    by the Postgres Global Development Group.
   </Para>
  </LegalNotice>

 </BookInfo>

<!--
<TOC> </TOC>
<LOT> </LOT>
-->

<!--
<Dedication>
<Para>
Your name here...
</Para>
</Dedication>
-->

 <preface id="preface">
  <Title>Summary</Title>

  <Para>
   <ProductName>Postgres</ProductName>, 
   developed originally in the UC Berkeley Computer Science Department,
   pioneered many of the object-relational concepts
   now becoming available in some commercial databases.
   It provides SQL92/SQL3 language support,
   transaction integrity, and type extensibility.
   <ProductName>PostgreSQL</ProductName> is a public-domain,
   open source descendant of this original Berkeley code.
  </Para>
 </Preface>

 <part Id="part-user">
  <Title>User's Guide</Title>
  <PartIntro>
   <Para>
    Information for users.
   </Para>
  </PartIntro>

  &intro;
  &syntax;
  &datatype;
  &oper;
  &func;
  &typeconv;
  &keys;
  &array;
  &inherit;
  &mvcc;
  &environ;
  &manage;
  &storage;
  &commands;
 </Part>

 <part Id="part-admin">
  <Title>Administrator's Guide</Title>
  <PartIntro>
   <Para>
    Installation and maintenance information.
   </Para>
  </PartIntro>
<!--
  Disable these extra intro chapters since some elements (e.g. y2k
  statement) are included in the first intro.sgml and cause errors if
  included twice.
   &intro-ag;
-->
   &ports;
   &config;
   &layout;
   &install;
   &installw;
   &runtime;
   &security;
   &start-ag;
   &manage-ag;
   &trouble;
   &recovery;
   &regress;
   &release;
 </Part>

 <part Id="part-programmer">
  <Title>Programmer's Guide</Title>
  <PartIntro>
   <Para>
    Information for extending <ProductName>Postgres</ProductName>.
   </Para>
  </PartIntro>
<!--
  Disable these extra intro chapters since some elements (e.g. y2k
  statement) are included in the first intro.sgml and cause errors if
  included twice.
   &intro-pg;
-->
   &arch-pg;
   &extend;
   &xfunc;
   &xtypes;
   &xoper;
   &xaggr;
   &rules;
   &xindex;
   &gist;
   &dfunc;
   &trigger;
   &spi;
   &xplang;
  <!-- &libpq; -->
 </Part>

 <part Id="part-interfaces">
  <Title>Interfaces</Title>
  <PartIntro>
   <Para>
    User and programmer interfaces.
   </Para>
  </PartIntro>
   &func-ref;
   &lobj;
   &ecpg;
   &libpq;
   &libpqpp;
   &libpgtcl;
   &odbc;
   &jdbc;
 </Part>
 
 <part Id="part-developer">
  <Title>Developer's Guide</Title>
  <PartIntro>
   <Para>
    The Developer's Guide includes discussion of design decisions and 
    suggestions for future development.
   </Para>
  </PartIntro>
   &arch-dev;
   &options;
   &geqo;
   &protocol;
   &signals;
   &compiler;
   &bki;
   &page;
 </Part>
 
 <part Id="part-tutorial">
  <Title>Tutorial</Title>
  <PartIntro>
   <Para>
    Introduction for new users.
   </Para>
  </PartIntro>
   &sql;
   &arch;
   &start;
   &query;
   &advanced;
 </Part>

 <part Id="part-appendix">
  <Title>Appendices</Title>
  <PartIntro>
   <Para>
    Additional related information.
   </Para>
  </PartIntro>

  &datetime;
  &cvs;
  &docguide;
<!--
   &contacts;
-->
   &biblio;
 </Part>

<!--
Omit index until we have some index entries.
- thomas 1998-10-26
<index Id="part-index">
</index>
-->

</Book>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"./reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/CATALOG"
sgml-local-ecat-files:nil
End:
-->