postgresql/doc/src/sgml/info.sgml

<!--
$Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.18 2003/01/19 00:13:28 momjian Exp $
-->

<sect1 id="resources">
 <title>Overview of Documentation Resources</title>

 <para>
  The <productname>PostgreSQL</> documentation is organized into
  several books:

  <variablelist>
   <varlistentry>
    <term>&cite-tutorial;</term>
    <listitem>
     <para>
      An informal introduction for new users.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&cite-user;</term>
    <listitem>
     <para>
      Documents the <acronym>SQL</acronym> query language environment,
      including data types and functions, as well as user-level
      performance tuning.  Every <productname>PostgreSQL</> user
      should read this.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&cite-admin;</term>
    <listitem>
     <para>
      Installation and server management information.  Everyone who
      runs a <productname>PostgreSQL</> server, either for personal
      use or for other users, needs to read this.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&cite-programmer;</term>
    <listitem>
     <para>
      Advanced information for application programmers. Topics include
      type and function extensibility, library interfaces, and
      application design issues.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&cite-reference;</term>
    <listitem>
     <para>
      Reference pages for <acronym>SQL</acronym> command syntax, and
      client and server programs.  This book is auxiliary to the
      User's, Administrator's, and Programmer's Guides.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&cite-developer;</term>
    <listitem>
     <para>
      Information for <productname>PostgreSQL</productname>
      developers.  This is intended for those who are contributing to
      the <productname>PostgreSQL</productname> project; application
      development information appears in the &cite-programmer;.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </para>

 <para>
  In addition to this manual set, there are other resources to help you with
  <productname>PostgreSQL</productname> installation and use:

  <variablelist>
   <varlistentry>
    <term>man pages</term>
    <listitem>
     <para>
      The &cite-reference;'s pages in the traditional Unix man
      format. There is no difference in content.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>FAQs</term>
    <listitem>
     <para>
      Frequently Asked Questions (FAQ) lists document both general issues
      and some platform-specific issues.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>READMEs</term>
    <listitem>
     <para>
      README files are available for some contributed packages.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>Web Site</term>
    <listitem>
     <para>
      The <ulink
      url="http://www.postgresql.org"><productname>PostgreSQL</productname>
      web site</ulink> carries details on the latest release, upcoming
      features, and other information to make your work or play with
      <productname>PostgreSQL</productname> more productive.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>Mailing Lists</term>
    <listitem>
     <para>
      The mailing lists are a good place to have your questions
      answered, to share experiences with other users, and to contact
      the developers.  Consult the <ulink
      url="http://www.postgresql.org/users-lounge/">User's
      Lounge</ulink> section of the <productname>PostgreSQL</>
      web site for details.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>Yourself!</term>
    <listitem>
     <para>
      <productname>PostgreSQL</productname> is an open-source effort.
      As such, it depends on the user community for ongoing support.
      As you begin to use <productname>PostgreSQL</productname>, you
      will rely on others for help, either through the documentation
      or through the mailing lists.  Consider contributing your
      knowledge back. If you learn something which is not in the
      documentation, write it up and contribute it.  If you add
      features to the code, contribute them.
     </para>

     <para>
      Even those without a lot of experience can provide corrections
      and minor changes in the documentation, and that is a good way
      to start.  The <email>pgsql-docs@postgresql.org</email> mailing
      list is the place to get going.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </para>
</sect1>

<!-- 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:
-->