docguide.sgml

关系型数据库 Postgresql 6.5.2

<row><entry> ./doc/FAQ	</entry><entry>	Not converted	</entry></row>
<row><entry> ./doc/FAQ_DEV	</entry><entry>	Not converted	</entry></row>
<row><entry> ./doc/FAQ_FreeBSD	</entry><entry>	Not converted	</entry></row>
<row><entry> ./doc/FAQ_Irix	</entry><entry>	Not converted	</entry></row>
<row><entry> ./doc/FAQ_Linux	</entry><entry>	Not converted	</entry></row>
<row><entry> ./doc/TODO	</entry><entry>	Not converted	</entry></row>
<row><entry> ./doc/README.GEQO	</entry><entry>	Removed. Superceded by geqo.sgml	</entry></row>
<row><entry> ./doc/README.fsync	</entry><entry>	Assimilate into Admin Guide	</entry></row>
<row><entry> ./doc/README.locale	</entry><entry>	Assimilate into Admin Guide	</entry></row>
<row><entry> ./doc/README.mb	</entry><entry>	Assimilate into Admin Guide	</entry></row>
<row><entry> ./doc/README.mb.jp	</entry><entry>	Not converted	</entry></row>
<row><entry> ./doc/README.support	</entry><entry>	Not converted	</entry></row>
<row><entry> ./doc/TODO.GEQO	</entry><entry>	Removed. Superceded by geqo.sgml	</entry></row>
<row><entry> ./doc/userguide.ps	</entry><entry>	Removed (converted to SGML)	</entry></row>
<row><entry> ./src/DEVELOPERS	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/access/nbtree/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/catalog/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/libpq/pg_hba.conf.sample	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/libpq/pg_ident.conf.sample	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/nodes/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/optimizer/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/optimizer/geqo/pg_geqo.sample	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/optimizer/plan/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/parser/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/port/dynloader/README.dlfcn.aix	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/regex/COPYRIGHT	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/regex/WHATSNEW	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/regex/re_format.7	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/regex/regex.3	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/storage/ipc/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/storage/lmgr/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/backend/storage/smgr/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/bin/pg_dump/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/bin/pgaccess/README.pga	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/bin/pgaccess/formdemo.sql	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/bin/pgtclsh/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/data/charset.conf	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/data/koi-alt.tab	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/data/koi-iso.tab	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/data/koi-koi.tab	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/data/koi-mac.tab	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/data/koi-win.tab	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/ecpg/ChangeLog	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/ecpg/TODO	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/jdbc/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/jdbc/README_6.3	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/jdbc/example/ImageViewer.java	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/jdbc/example/basic.java	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/jdbc/example/blobtest.java	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/jdbc/example/datestyle.java	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/jdbc/example/psql.java	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpgtcl/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq++/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq++/examples/testlibpq0.cc	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq++/examples/testlibpq1.cc	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq++/examples/testlibpq2.cc	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq++/examples/testlibpq2.sql	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq++/examples/testlibpq3.cc	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq++/examples/testlibpq3.sql	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq++/examples/testlibpq4.cc	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq++/examples/testlibpq4.sql	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq++/examples/testlibpq5.cc	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq++/examples/testlibpq5.sql	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq++/examples/testlibpq6.cc	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/libpq++/examples/testlo.cc	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/odbc/license.txt	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/odbc/notice.txt	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/odbc/readme.txt	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/perl5/MANIFEST	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/perl5/Changes	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/perl5/eg/example.newstyle	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/perl5/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/python/Announce	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/python/ChangeLog	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/python/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/python/tutorial/advanced.py	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/python/tutorial/advanced.pyc	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/python/tutorial/basics.py	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/python/tutorial/func.py	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/python/tutorial/func.pyc	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/python/tutorial/pgtools.py	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/python/tutorial/pgtools.pyc	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/python/tutorial/syscat.py	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/interfaces/python/tutorial/syscat.pyc	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/abort.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/alter_table.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/alter_user.l	</entry><entry>	Split into Reference and Admin Guide	</entry></row>
<row><entry> ./src/man/begin.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/catalogs.3	</entry><entry>	Catalog synopsis. Move to Programmer's Guide?	</entry></row>
<row><entry> ./src/man/cleardbdir.1	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/close.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/cluster.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/commit.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/copy.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_aggregate.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_database.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_function.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_index.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_language.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_operator.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_rule.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_sequence.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_table.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_trigger.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_type.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_user.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_version.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/create_view.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/createdb.1	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/createuser.1	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/declare.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/delete.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/destroydb.1	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/destroyuser.1	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop_aggregate.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop_database.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop_function.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop_index.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop_language.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop_operator.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop_rule.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop_sequence.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop_table.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop_trigger.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop_type.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop_user.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/drop_view.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/end.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/ecpg.1	</entry><entry>	Short man page. Retain	</entry></row>
<row><entry> ./src/man/explain.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/fetch.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/grant.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/initdb.1	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/initlocation.1	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/insert.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/ipcclean.1	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/listen.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/load.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/lock.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/move.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/notify.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/pg_dump.1	</entry><entry>	Assimilate into Admin Guide	</entry></row>
<row><entry> ./src/man/pg_dumpall.1	</entry><entry>	Assimilate into Admin Guide	</entry></row>
<row><entry> ./src/man/pg_upgrade.1	</entry><entry>	Assimilate into Admin Guide	</entry></row>
<row><entry> ./src/man/pg_hba.conf.5	</entry><entry>	Assimilate into Admin Guide	</entry></row>
<row><entry> ./src/man/pg_passwd.1	</entry><entry>	Assimilate into Admin Guide	</entry></row>
<row><entry> ./src/man/pgintro.1	</entry><entry>	Assimilate into User's Guide?	</entry></row>
<row><entry> ./src/man/postgres.1	</entry><entry>	Assimilate into User's, Admin Guides	</entry></row>
<row><entry> ./src/man/postmaster.1	</entry><entry>	Assimilate into User's, Admin Guides	</entry></row>
<row><entry> ./src/man/psql.1	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/reset.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/revoke.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/rollback.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/select.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/set.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/show.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/sql.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/update.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/man/vacuum.l	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/pl/tcl/INSTALL	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/pl/tcl/modules/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/pl/tcl/license.terms	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/pl/tcl/test/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/pl/tcl/test/runtest	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/pl/tcl/test/test.expected	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/pl/tcl/test/test_mklang.sql	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/pl/tcl/test/test_queries.sql	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/pl/tcl/test/test_setup.sql	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/test/bench/WISC-README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/test/locale/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/test/performance/results/PgSQL.970926	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/test/regress/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/test/suite/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/tools/RELEASE_CHANGES	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/tools/SQL_keywords	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/tools/backend/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/tools/backend/flow.fig	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/tools/backend/flow.jpg	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/tools/make_keywords.README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/tools/entab/entab.man	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/tools/make_diff/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/tools/mkldexport/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/tools/pgindent/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/tutorial/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./src/utils/README	</entry><entry>	Not converted	</entry></row>
<row><entry> ./lib/pg_hba.conf.sample	</entry><entry>	Not converted	</entry></row>
<row><entry> ./lib/pg_geqo.sample	</entry><entry>	Not converted	</entry></row>
</tbody>
</tgroup>
</table>
</para>
</sect2>

<sect2>
<title>Styles and Conventions</title>

<para>
<productname>DocBook</productname> has a rich set of tags and
constructs, and a suprisingly large percentage are directly and
obviously useful for well-formed documentation. The
<productname>Postgres</productname> documentation set has only
recently been adapted to <acronym>SGML</acronym>, and in the near
future several sections of the set will be selected and maintained as
prototypical examples of <productname>DocBook</productname> usage.
Also, a short summary of <productname>DocBook</productname> tags will
be included below.
</para>

<!--
<para>
<table tocentry="1">
<title>SGML Constructs</title>
<titleabbrev>SGML Constructs</titleabbrev>
<tgroup cols="2">
<thead>
  <row>
    <entry>SGML Tag</entry>
    <entry>Usage</entry>
  </row>
</thead>
<tbody>
  <row>
    <entry><sgmltag>book</sgmltag></entry>
    <entry>Delimits a Book element</entry>
  </row>
  <row>
    <entry><sgmltag>chapter</sgmltag></entry>
    <entry>Delimits a Chapter element</entry>
  </row>
  <row>
    <entry><sgmltag>appendix</sgmltag></entry>
    <entry><sgmltag>Delimits a Appendix element</sgmltag></entry>
  </row>
</tbody>
</tgroup>
</table>
</para>
-->
</sect2>

<sect2>
<title>SGML Authoring Tools</title>

<para>
The current <acronym>Postgres</acronym> documentation set was written using
a plain text editor (or emacs/psgml; see below) with the content marked up using 
<acronym>SGML</acronym> DocBook tags.
</para>

<para>
<acronym>SGML</acronym> and <productname>DocBook</productname> do not suffer
from an oversupply of open-source authoring tools. The most common toolset is
the emacs/xemacs editing package with the psgml feature extension.
On some systems (e.g. RedHat Linux) these tools are provided in a typical full installation.
</para>

<sect3>
<title>emacs/psgml</title>

<para>
<application>emacs</application> (and <application>xemacs</application>) have
an <acronym>SGML</acronym> <firstterm>major mode</firstterm>. When properly configured,
this will allow you to use <application>emacs</application> to insert tags and
check markup consistancy.
</para>

<para>
     Put the following in your <filename>~/.emacs</filename> environment file:

<programlisting>
; ********** for SGML mode (psgml)

(setq sgml-catalog-files "/usr/lib/sgml/CATALOG")
(setq sgml-local-catalogs "/usr/lib/sgml/CATALOG")

(autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t )
</programlisting>

and add an entry in the same file
for <acronym>SGML</acronym> into the (existing) definition for
auto-mode-alist:

<programlisting>
(setq
  auto-mode-alist
  '(("\\.sgml$" . sgml-mode)
   ))
</programlisting>

Each <acronym>SGML</acronym> source file has the following block at the
end of the file:

<programlisting>
<sgmltag>!-- Keep this comment at the end of the file