aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/info.sgml
blob: 892292e553853154ffdea3683579b239108d4ac8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.16 2002/10/24 17:48:54 petere Exp $
-->

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

 <para>
  The 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 SQL query language environment, including data
      types and functions, as well as user-level performance tuning.
      Every PostgreSQL user should read this.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&cite-admin;</term>
    <listitem>
     <para>
      Installation and server management information.  Everyone who
      runs a 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 SQL 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 <citetitle>Programmer's
      Guide</citetitle>.
     </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 <citetitle>Reference Manual</citetitle>'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:
-->