<!-- $Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.14 1999/01/07 03:01:27 thomas Exp $ Documentation Guide Thomas Lockhart $Log: docguide.sgml,v $ Revision 1.14 1999/01/07 03:01:27 thomas Fix column formatting for a table. No content changes. Revision 1.13 1998/12/29 02:24:14 thomas Clean up to ensure tag completion as required by the newest versions of Norm's Modular Style Sheets and jade/docbook. From Vince Vielhaber <vev@michvhf.com>. Revision 1.12 1998/12/18 16:17:29 thomas Include more details on editing with Emacs. Remove mention of the old "migration" flat files. Change URLs for resources to point to areas, not particular files. That way things stay correct even when version of tools change. Suggested by Vince Vielhaber. Revision 1.11 1998/10/30 19:36:57 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.10 1998/10/25 00:25:30 thomas Update info on source files for v6.4. Should add/change ToDo list some more before release... Revision 1.9 1998/10/15 05:46:54 momjian SGML updates from post 6.3.2 manual changes. Added pg_upgrade man page. Revision 1.8 1998/08/17 16:17:07 thomas Bring document list closer to up to day. Add a note on sgml-tools that they are now working with jade and so may become the toolset of choice in the future. Revision 1.7 1998/08/15 06:53:52 thomas Include working list of all documentation sources, with current status and plans for some of them. --> <appendix label="A" Id="docguide"> <docinfo> <authorgroup> <author> <firstname>Thomas</firstname> <surname>Lockhart</surname> </author> <author> <firstname>Tom Ivar</firstname> <surname>Helbekkmo</surname> </author> </authorgroup> <date>1998-04-28</date> </docinfo> <title>Documentation</title> <para> The purpose of documentation is to make <productname>Postgres</productname> easier to learn, use, and develop. The documentation set should describe the <productname>Postgres</productname> system, language, and interfaces. It should be able to answer common questions and to allow a user to find those answers on his own without resorting to mailing list support. </para> <sect1> <title>Documentation Roadmap</title> <para> <productname>Postgres</productname> has four primary documentation formats: <itemizedlist> <listitem><para> Plain text for pre-installation information. </para></listitem> <listitem><para> <acronym>HTML</acronym>, for on-line browsing and reference. </para></listitem> <listitem><para> Hardcopy, for in-depth reading and reference. </para></listitem> <listitem><para> <acronym>man pages</acronym>, for quick reference. </para></listitem> </itemizedlist> </para> <para> <table tocentry="1"> <title><ProductName>Postgres</ProductName> Documentation Products</title> <tgroup cols="2"> <thead> <row> <entry> File </entry> <entry> Description </entry> </row> </thead> <tbody> <row><entry> ./COPYRIGHT </entry><entry> Copyright notice </entry></row> <row><entry> ./INSTALL </entry><entry> Installation instructions (text from sgml->rtf->text) </entry></row> <row><entry> ./README </entry><entry> Introductory info </entry></row> <row><entry> ./register.txt </entry><entry> Registration message during make </entry></row> <row><entry> ./doc/bug.template </entry><entry> Bug report template </entry></row> <row><entry> ./doc/postgres.tar.gz </entry><entry> Integrated docs (<acronym>HTML</acronym>) </entry></row> <row><entry> ./doc/programmer.ps.gz </entry><entry> Programmer's Guide (Postscript) </entry></row> <row><entry> ./doc/programmer.tar.gz </entry><entry> Programmer's Guide (<acronym>HTML</acronym>) </entry></row> <row><entry> ./doc/reference.ps.gz </entry><entry> Reference Manual (Postscript) </entry></row> <row><entry> ./doc/reference.tar.gz </entry><entry> Reference Manual (<acronym>HTML</acronym>) </entry></row> <row><entry> ./doc/tutorial.ps.gz </entry><entry> Introduction (Postscript) </entry></row> <row><entry> ./doc/tutorial.tar.gz </entry><entry> Introduction (<acronym>HTML</acronym>) </entry></row> <row><entry> ./doc/user.ps.gz </entry><entry> User's Guide (Postscript) </entry></row> <row><entry> ./doc/user.tar.gz </entry><entry> User's Guide (<acronym>HTML</acronym>) </entry></row> </tbody> </tgroup> </table> </para> <para> There are man pages available for installation, as well as a large number of plain-text README-type files throughout the <productname>Postgres</productname> source tree. </para> </sect1> <sect1> <title>The Documentation Project</title> <para> Packaged documentation is available in both <acronym>HTML</acronym> and <firstterm>Postscript</firstterm> formats. These are available as part of the standard <productname>Postgres</productname> installation. We discuss here working with the documentation sources and generating documentation packages. </para> <para> The purpose of <productname>DocBook</productname> <acronym>SGML</acronym> is to allow an author to specify the structure and content of a document (e.g. using the <productname>DocBook</productname> <acronym>DTD</acronym>), and to have a document style define how that content is rendered into a final form (e.g. using Norm Walsh's <productname>Modular Style Sheets</productname>).</para> <para> See <ulink url="http://nis-www.lanl.gov/~rosalia/mydocs/docbook-intro.html"> Introduction to DocBook</ulink> for a nice "quickstart" summary of DocBook features. <ulink url="http://www.ora.com/homepages/dtdparse/docbook/3.0/"> DocBook Elements</ulink> provides a powerful cross-reference for features of <productname>DocBook</productname>. </para> <para> This documentation set is constructed using several tools, including James Clark's <ulink url="http://www.jclark.com/jade/"> <productname>jade</productname></ulink> and Norm Walsh's <ulink url="http://www.berkshire.net/~norm/docbook/dsssl">Modular DocBook Stylesheets</ulink>. </para> <para> Currently, hardcopy is produced by importing <firstterm>Rich Text Format</firstterm> (<acronym>RTF</acronym>) output from <application>jade</application> into <productname>ApplixWare</productname> for minor formatting fixups then exporting as a Postscript file.</para> <para> <ulink url="http://sunsite.unc.edu/pub/packages/TeX/systems/unix/"> <productname>TeX</productname></ulink> is a supported format for <application>jade</application> output, but was not used at this time for several reasons, including the inability to make minor format fixes before committing to hardcopy and generally inadequate table support in the <productname>TeX</productname> stylesheets.</para> </sect1> <sect1> <title>Documentation Sources</title> <para> Documentation sources include plain text files, man pages, and html. However, most new <productname>Postgres</productname> documentation will be written using the <firstterm>Standard Generalized Markup Language</firstterm> (<acronym>SGML</acronym>) <ulink url="http://www.ora.com/davenport/"> <productname>DocBook</productname></ulink> <firstterm>Document Type Definition</firstterm> (<acronym>DTD</acronym>). Much of the existing documentation has been or will be converted to <acronym>SGML</acronym>. </para> <para> The purpose of <acronym>SGML</acronym> is to allow an author to specify the structure and content of a document (e.g. using the <productname>DocBook</productname> <acronym>DTD</acronym>), and to have the document style define how that content is rendered into a final form (e.g. using Norm Walsh's stylesheets). </para> <para> Documentation has accumulated from several sources. As we integrate and assimilate existing documentation into a coherent documentation set, the older versions will become obsolete and will be removed from the distribution. However, this will not happen immediately, and will not happen to all documents at the same time. To ease the transition, and to help guide developers and writers, we have defined a transition roadmap. </para> <para> Here is the documentation plan for v6.5: <itemizedlist> <listitem> <para> Start compiling index information for the User's and Administrator's Guides. </para> </listitem> <listitem> <para> Write more sections for the User's Guide covering areas outside the reference pages. This would include introductory information and suggestions for approaches to typical design problems. </para> </listitem> <listitem> <para> Merge information in the existing man pages into the reference pages and User's Guide. Condense the man pages down to reminder information, with references into the primary doc set. </para> </listitem> <listitem> <para> Convert the new sgml reference pages to new man pages, replacing the existing man pages. </para> </listitem> <listitem> <para> Convert all source graphics to CGM format files for portability. Currently we mostly have Applix Graphics sources from which we can generate .gif output. One graphic is only available in .gif and .ps, and should be redrawn or removed. </para> </listitem> </itemizedlist> </para> <sect2> <title>Document Structure</title> <para> There are currently five separate documents written in DocBook. Each document has a container source document which defines the DocBook environment and other document source files. These primary source files are located in <filename>doc/src/sgml/</filename>, along with many of the other source files used for the documentation. The primary source files are: <variablelist> <varlistentry> <term>postgres.sgml</term> <listitem> <para> This is the integrated document, including all other documents as parts. Output is generated in <acronym>HTML</acronym> since the browser interface makes it easy to move around all of the documentation by just clicking. The other documents are available in both <acronym>HTML</acronym> and hardcopy. </para> </listitem> </varlistentry> <varlistentry> <term>tutorial.sgml</term> <listitem> <para> The introductory tutorial, with examples. Does not include programming topics, and is intended to help a reader unfamiliar with <acronym>SQL</acronym>. This is the "getting started" document. </para> </listitem> </varlistentry> <varlistentry> <term>user.sgml</term> <listitem> <para> The User's Guide. Includes information on data types and user-level interfaces. This is the place to put information on "why". </para> </listitem> </varlistentry> <varlistentry> <term>reference.sgml</term> <listitem> <para> The Reference Manual. Includes <productname>Postgres</productname> <acronym>SQL</acronym> syntax. This is the place to put information on "how". </para> </listitem> </varlistentry> <varlistentry> <term>programming.sgml</term> <listitem> <para> The Programmer's Guide. Includes information on <productname>Postgres</productname> extensibility and on the programming interfaces. </para> </listitem> </varlistentry> <varlistentry> <term>admin.sgml</term> <listitem> <para> The Administrator's Guide. Include installation and release notes. </para> </listitem> </varlistentry> </variablelist> </para> <!-- Disable for the hardcopy production release. Too much tabular info and not very helpful in hardcopy. - thomas 1998-10-27 --> </sect2> <sect2> <title>Documentation Files</title> <para> <table tocentry="1"> <title><ProductName>Postgres</ProductName> Documentation Sources</title> <tgroup cols="3"> <thead> <row> <entry> File </entry> <entry> Status </entry> </row> </thead> <tbody> <row><entry> ./doc/src/graphics/catalogs.gif </entry><entry> Output file </entry></row> <row><entry> ./doc/src/graphics/clientserver.ag </entry><entry> Source file. Convert to CGM </entry></row> <row><entry> ./doc/src/graphics/clientserver.gif </entry><entry> Output file </entry></row> <row><entry> ./doc/src/graphics/connections.ag </entry><entry> Source file. Convert to CGM </entry></row> <row><entry> ./doc/src/graphics/connections.gif </entry><entry> Output file </entry></row> <row><entry> ./doc/src/graphics/layout.ag </entry><entry> Source file. Convert to CGM </entry></row> <row><entry> ./doc/src/graphics/layout.gif </entry><entry> Output file </entry></row> <row><entry> ./doc/src/sgml/about.sgml </entry><entry> New document </entry></row> <row><entry> ./doc/src/sgml/admin.sgml </entry><entry> Administrator's Guide container </entry></row> <row><entry> ./doc/src/sgml/advanced.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/arch-dev.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/arch-pg.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/arch.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/array.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/biblio.sgml </entry><entry> New document </entry></row> <row><entry> ./doc/src/sgml/bki.sgml </entry><entry> Converted from bki.5 </entry></row> <row><entry> ./doc/src/sgml/compiler.sgml </entry><entry> New document </entry></row> <row><entry> ./doc/src/sgml/config.sgml </entry><entry> New document </entry></row> <row><entry> ./doc/src/sgml/contacts.sgml </entry><entry> Docs contributors? Not used. Either complete or discard </entry></row> <row><entry> ./doc/src/sgml/datatype.sgml </entry><entry> New document </entry></row> <row><entry> ./doc/src/sgml/dfunc.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/docguide.sgml </entry><entry> Documentation info. New document </entry></row> <row><entry> ./doc/src/sgml/ecpg.sgml </entry><entry> ecpg eSQL pre-compiler docs </entry></row> <row><entry> ./doc/src/sgml/environ.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/extend.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/func-ref.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/func.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/geqo.sgml </entry><entry> GEQO genetic optimizer docs </entry></row> <row><entry> ./doc/src/sgml/gist.sgml </entry><entry> New from mailing list </entry></row> <row><entry> ./doc/src/sgml/history.sgml </entry><entry> New document </entry></row> <row><entry> ./doc/src/sgml/indices.sgml </entry><entry> New document </entry></row> <row><entry> ./doc/src/sgml/info.sgml </entry><entry> New document </entry></row> <row><entry> ./doc/src/sgml/inherit.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/install.sgml </entry><entry> Installation instructions </entry></row> <row><entry> ./doc/src/sgml/intro-ag.sgml </entry><entry> Admin Guide intro. Converted </entry></row> <row><entry> ./doc/src/sgml/intro-pg.sgml </entry><entry> Programmers Guide intro. Converted </entry></row> <row><entry> ./doc/src/sgml/intro.sgml </entry><entry> Users Guide intro </entry></row> <row><entry> ./doc/src/sgml/jdbc.sgml </entry><entry> New document from Peter Mount </entry></row> <row><entry> ./doc/src/sgml/keys.sgml </entry><entry> New document </entry></row> <row><entry> ./doc/src/sgml/legal.sgml </entry><entry> Copyright etc. for intros </entry></row> <row><entry> ./doc/src/sgml/libpgtcl.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/libpq++.sgml </entry><entry> C++ library. Converted </entry></row> <row><entry> ./doc/src/sgml/libpq.sgml </entry><entry> C library </entry></row> <row><entry> ./doc/src/sgml/lobj.sgml </entry><entry> Large objects </entry></row> <row><entry> ./doc/src/sgml/manage.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/notation.sgml </entry><entry> Docs notation for intros </entry></row> <row><entry> ./doc/src/sgml/odbc.sgml </entry><entry> ODBC driver </entry></row> <row><entry> ./doc/src/sgml/oper.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/page.sgml </entry><entry> On-disk storage scheme </entry></row> <row><entry> ./doc/src/sgml/pg_options.sgml </entry><entry> Backend configuration </entry></row> <row><entry> ./doc/src/sgml/pgaccess.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/ports.sgml </entry><entry> Supported/unsupported platforms </entry></row> <row><entry> ./doc/src/sgml/postgres.sgml </entry><entry> Container for all docs. Best for html output </entry></row> <row><entry> ./doc/src/sgml/programmer.sgml </entry><entry> Programmer's Guide </entry></row> <row><entry> ./doc/src/sgml/protocol.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/psql.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/query-ug.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/query.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/recovery.sgml </entry><entry> Database recovery </entry></row> <row><entry> ./doc/src/sgml/reference.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/regress.sgml </entry><entry> Regression testing </entry></row> <row><entry> ./doc/src/sgml/release.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/rules.sgml </entry><entry> Rule system </entry></row> <row><entry> ./doc/src/sgml/runtime.sgml </entry><entry> Runtime environment. New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/security.sgml </entry><entry> Server security </entry></row> <row><entry> ./doc/src/sgml/signals.sgml </entry><entry> System signals for backend. </entry></row> <row><entry> ./doc/src/sgml/spi.sgml </entry><entry> Converted. Original removed </entry></row> <row><entry> ./doc/src/sgml/start-ag.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/start.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/storage.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/syntax.sgml </entry><entry> SQL syntax. In UG </entry></row> <row><entry> ./doc/src/sgml/trigger.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/tutorial.sgml </entry><entry> Container for tutorial </entry></row> <row><entry> ./doc/src/sgml/typeconv.sgml </entry><entry> Datatype conversion. New for v6.4. In UG </entry></row> <row><entry> ./doc/src/sgml/user.sgml </entry><entry> User's Guide </entry></row> <row><entry> ./doc/src/sgml/xaggr.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/xfunc.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/xindex.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/xoper.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/xplang.sgml </entry><entry> Programming Language. New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/xtypes.sgml </entry><entry> Converted </entry></row> <row><entry> ./doc/src/sgml/y2k.sgml </entry><entry> Y2K statement. New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/abort.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/allfiles.sgml </entry><entry> List of files in ref/ (internal) </entry></row> <row><entry> ./doc/src/sgml/ref/alter_table.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/alter_user.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/begin.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/close.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/cluster.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/commands.sgml </entry><entry> List of commands (internal) </entry></row> <row><entry> ./doc/src/sgml/ref/commit.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/copy.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/create_aggregate.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/create_database.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/create_function.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/create_index.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/create_language.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/create_operator.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/create_rule.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/create_sequence.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/create_table.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/create_trigger.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/create_type.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/create_user.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/create_view.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/createdb.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/createuser.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/declare.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/delete.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/destroydb.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/destroyuser.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/drop_aggregate.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/drop_database.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/drop_function.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/drop_index.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/drop_language.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/drop_operator.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/drop_rule.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/drop_sequence.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/drop_table.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/drop_trigger.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/drop_type.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/drop_user.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/drop_view.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/explain.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/fetch.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/grant.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/initdb.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/initlocation.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/insert.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/listen.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/load.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/lock.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/move.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/notify.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/pg_dump.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/pg_dumpall.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/psql-ref.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/reset.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/revoke.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/rollback.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/select.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/set.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/show.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/update.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/vacuum.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/unlisten.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/vacuumdb.sgml </entry><entry> New for v6.4 </entry></row> <row><entry> ./doc/src/sgml/ref/pg_upgrade.sgml </entry><entry> New for v6.4 </entry></row> </tbody> </tgroup> </table> </para> </sect2> <sect2> <title>Document Conversion</title> <para> <table tocentry="1"> <title><ProductName>Postgres</ProductName> Documentation Sources</title> <tgroup cols="3"> <thead> <row> <entry> File </entry> <entry> Status </entry> </row> </thead> <tbody> <row><entry> ./HISTORY </entry><entry> Obsolete. Converted to release.sgml </entry></row> <row><entry> ./README </entry><entry> Not converted </entry></row> <row><entry> ./INSTALL </entry><entry> Obsolete. Converted to install.sgml </entry></row> <row><entry> ./contrib/README </entry><entry> Not converted </entry></row> <row><entry> ./contrib/apache_logging/README </entry><entry> Not converted </entry></row> <row><entry> ./contrib/array/array_iterator.doc </entry><entry> Not converted </entry></row> <row><entry> ./contrib/datetime/datetime_functions.doc </entry><entry> Not converted </entry></row> <row><entry> ./contrib/earthdistance/README </entry><entry> Not converted </entry></row> <row><entry> ./contrib/int8/README </entry><entry> Not converted </entry></row> <row><entry> ./contrib/ip_and_mac/README </entry><entry> Not converted </entry></row> <row><entry> ./contrib/lo/README </entry><entry> Not converted </entry></row> <row><entry> ./contrib/mSQL-interface/README </entry><entry> Not converted </entry></row> <row><entry> ./contrib/noupdate/noup.example </entry><entry> Not converted </entry></row> <row><entry> ./contrib/pginterface/README </entry><entry> Not converted </entry></row> <row><entry> ./contrib/sequence/set_sequence.sql.in </entry><entry> Not converted </entry></row> <row><entry> ./contrib/soundex/soundex.sql.in </entry><entry> Not converted </entry></row> <row><entry> ./contrib/spi/README </entry><entry> Not converted </entry></row> <row><entry> ./contrib/spi/autoinc.example </entry><entry> Not converted </entry></row> <row><entry> ./contrib/spi/insert_username.example </entry><entry> Not converted </entry></row> <row><entry> ./contrib/spi/refint.example </entry><entry> Not converted </entry></row> <row><entry> ./contrib/spi/timetravel.example </entry><entry> Not converted </entry></row> <row><entry> ./contrib/string/string_io.sql.in </entry><entry> Not converted </entry></row> <row><entry> ./contrib/unixdate/unixdate.sql </entry><entry> Not converted </entry></row> <row><entry> ./contrib/userlock/user_locks.doc </entry><entry> Not converted </entry></row> <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 Local variables: mode: sgml sgml-omittag:t 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: --</sgmltag> </programlisting> </para> <para> The <productname>Postgres</productname> distribution includes a parsed DTD definitions file <filename>reference.ced</filename>. You may find that </para> <para> When using <application>emacs</application>/psgml, a comfortable way of working with these separate files of book parts is to insert a proper DOCTYPE declaration while you're editing them. If you are working on this source, for instance, it's an appendix chapter, so you would specify the document as an "appendix" instance of a DocBook document by making the first line look like this: <programlisting> <sgmltag>!doctype appendix PUBLIC "-//Davenport//DTD DocBook V3.0//EN"</sgmltag> </programlisting> This means that anything and everything that reads <acronym>SGML</acronym> will get it right, and I can verify the document with "nsgmls -s docguide.sgml". </para> </sect3> </sect2> </sect1> <sect1> <title>Building Documentation</title> <para> GNU <application>make</application> is used to build documentation from the DocBook sources. There are a few environment definitions which may need to be set or modified for your installation. The <filename>Makefile</filename> looks for <filename>doc/../src/Makefile</filename> and (implicitly) for <filename>doc/../src/Makefile.custom</filename> to obtain environment information. On my system, the <filename>src/Makefile.custom</filename> looks like <programlisting> # Makefile.custom # Thomas Lockhart 1998-03-01 POSTGRESDIR= /opt/postgres/current CFLAGS+= -m486 YFLAGS+= -v # documentation HSTYLE= /home/tgl/SGML/db107.d/docbook/html PSTYLE= /home/tgl/SGML/db107.d/docbook/print </programlisting> where HSTYLE and PSTYLE determine the path to <filename>docbook.dsl</filename> for <acronym>HTML</acronym> and hardcopy (print) stylesheets, respectively. These stylesheet file names are for Norm Walsh's Modular Style Sheets; if other stylesheets are used then one can define HDSL and PDSL as the full path and file name for the stylesheet, as is done above for HSTYLE and PSTYLE. On many systems, these stylesheets will be found in packages installed in <filename>/usr/lib/sgml/</filename>, <filename>/usr/share/lib/sgml/</filename>, or <filename>/usr/local/lib/sgml/</filename>. </para> <para> <acronym>HTML</acronym> documentation packages can be generated from the <acronym>SGML</acronym> source by typing <programlisting> % cd doc/src % make tutorial.tar.gz % make user.tar.gz % make admin.tar.gz % make programmer.tar.gz % make postgres.tar.gz % make install </programlisting> </para> <para> These packages can be installed from the main documentation directory by typing <programlisting> % cd doc % make install </programlisting> </para></sect1> <sect1> <title>Hardcopy Generation for v6.4</title> <para> The hardcopy Postscript documentation is generated by converting the <acronym>SGML</acronym> source code to <acronym>RTF</acronym>, then importing into <productname>ApplixWare-4.4.1</productname>. After a little cleanup (see the following section) the output is "printed" to a postscript file. </para> <para> Some figures were redrawn to avoid having bitmap <acronym>GIF</acronym> files in the hardcopy documentation. One figure, of the system catalogs, was sufficiently complex that there was not time to redraw it. It was converted to fit using the following commands: <programlisting> % convert -monochrome -v -geometry 500x500'>' catalogs.ps catalogs.gif % convert -v -crop 400x500 catalogs.gif catalogs-cropped.gif </programlisting> </para> <sect2> <title><acronym>RTF</acronym> Cleanup Procedure</title> <para> Several items must be addressed in generating Postscript hardcopy:</para> <procedure> <title>Applixware <acronym>RTF</acronym> Cleanup</title> <para> Applixware does not seem to do a complete job of importing <acronym>RTF</acronym> generated by jade/MSS. In particular, all text is given the <quote>Header1</quote> style attribute label, although the text formatting itself is acceptable. Also, the Table of Contents page numbers do not refer to the section listed in the table, but rather refer to the page of the ToC itself.</para> <step performance="required"> <para> Generate the <acronym>RTF</acronym> input by typing <programlisting> % cd doc/src/sgml % make tutorial.rtf </programlisting> </para> </step> <step performance="required"> <para> Open a new document in <productname>Applix Words</productname> and then import the <acronym>RTF</acronym> file. </para> </step> <step performance="required"> <para> Print out the existing Table of Contents, to mark up in the following few steps. </para> </step> <step performance="required"> <para> Insert figures into the document. Center each figure on the page using the centering margins button.</para> <para> Not all documents have figures. You can grep the <acronym>SGML</acronym> source files for the string <quote>Graphic</quote> to identify those parts of the documentation which may have figures. A few figures are replicated in various parts of the documentation. </para> </step> <step performance="required"> <para> Work through the document, adjusting page breaks and table column widths. </para> </step> <step performance="required"> <para> If a bibliography is present, Applix Words seems to mark all remaining text after the first title as having an underlined attribute. Select all remaining text, turn off underlining using the underlining button, then explicitly underline each document and book title. </para> </step> <step performance="required"> <para> Work through the document, marking up the ToC hardcopy with the actual page number of each ToC entry. </para> </step> <step performance="required"> <para> Replace the right-justified incorrect page numbers in the ToC with correct values. This only takes a few minutes per document. </para> </step> <step performance="required"> <para> Save the document as native Applix Words format to allow easier last minute editing later. </para> </step> <step performance="required"> <para> Export the document to a file in Postscript format. </para> </step> <step performance="required"> <para> Compress the Postscript file using <application>gzip</application>. Place the compressed file into the <filename>doc</filename> directory. </para> </step> </procedure> </sect2> </sect1> <sect1> <title>Toolsets</title> <para> We have documented experience with two installation methods for the various tools that are needed to process the documentation. One is installation from <acronym>RPM</acronym>s on <productname>Linux</productname>, the other is a general installation from original distributions of the individual tools. Both will be described below.</para> <para> We understand that there are some other packaged distributions for these tools. <productname>FreeBSD</productname> seems to have them available. Please report package status to the docs mailing list and we will include that information here. </para> <sect2> <title><acronym>RPM</acronym> installation on <productname>Linux</productname></title> <para> Install <ulink url="ftp://ftp.cygnus.com/pub/home/rosalia/"> <acronym>RPM</acronym>s</ulink> for <productname>Jade</productname> and related packages. </para> </sect2> <sect2> <title>Manual installation of tools</title> <para> This is a brief run-through of the process of obtaining and installing the software you'll need to edit DocBook source with Emacs and process it with Norman Walsh's DSSSL style sheets to create <acronym>HTML</acronym> and <acronym>RTF</acronym>. </para> <para> These instructions do not cover new <application>jade</application>/DocBook support in the <ulink url="http://www.sgmltools.org/"><productname>sgml-tools</productname></ulink> package. The authors have not tried this package since it adopted DocBook, but it is almost certainly a good candidate for use. </para> <sect3><title>Prerequisites</title> <para>What you need: <itemizedlist> <listitem><para>A working installation of GCC 2.7.2</para></listitem> <listitem><para>A working installation of Emacs 19.19 or later</para></listitem> <listitem><para>An unzip program for UNIX to unpack things</para></listitem> </itemizedlist> </para> <para>What you must fetch: <itemizedlist> <listitem> <para><ulink url="ftp://ftp.jclark.com/pub/jade/"> James Clark's <productname>Jade</productname></ulink> (version 1.1 in file <filename>jade1_1.zip</filename> was current at the time of writing) </para></listitem> <listitem> <para><ulink url="http://www.ora.com/davenport/docbook/current/docbk30.zip"> <productname>DocBook</productname> version 3.0</ulink> </para></listitem> <listitem> <para><ulink url="http://nwalsh.com/docbook/dsssl/"> Norman Walsh's <productname>Modular Stylesheets</productname></ulink> (version 1.19 was used to produce these documents) </para></listitem> <listitem> <para><ulink url="ftp://ftp.lysator.liu.se/pub/sgml/"> Lennart Staflin's <productname>PSGML</productname></ulink> (version 1.0.1 in <filename>psgml-1.0.1.tar.gz</filename> was available at the time of writing) </para></listitem> </itemizedlist> </para> <para>Important URLs: <itemizedlist> <listitem><para><ulink url="http://www.jclark.com/jade/"> The <productname>Jade</productname> web page</ulink></para></listitem> <listitem><para><ulink url="http://www.ora.com/davenport/"> The <productname>DocBook</productname> web page</ulink></para></listitem> <listitem><para><ulink url="http://nwalsh.com/docbook/dsssl/"> The <productname>Modular Stylesheets</productname> web page</ulink> </para></listitem> <listitem><para> <ulink url="http://www.lysator.liu.se/projects/about_psgml.html"> The <productname>PSGML</productname> web page</ulink></para></listitem> <listitem><para><ulink url="http://www.infotek.no/sgmltool/guide.htm"> Steve Pepper's Whirlwind Guide</ulink></para></listitem> <listitem><para><ulink url="http://www.sil.org/sgml/publicSW.html"> Robin Cover's database of <acronym>SGML</acronym> software</ulink></para></listitem> </itemizedlist> </para> </sect3> <sect3> <title>Installing Jade</title> <procedure> <title>Installing Jade</title> <step performance="required"> <para> Read the installation instructions at the above listed URL. </para> </step> <step performance="required"> <para> Unzip the distribution kit in a suitable place. The command to do this will be something like <programlisting> unzip -aU jade1_1.zip </programlisting> </para> </step> <step performance="required"> <para><productname>Jade</productname> is not built using <productname>GNU Autoconf</productname>, so you'll need to edit a <filename>Makefile</filename> yourself. Since James Clark has been good enough to prepare his kit for it, it is a good idea to make a build directory (named for your machine architecture, perhaps) under the main directory of the <productname>Jade</productname> distribution, copy the file <filename>Makefile</filename> from the main directory into it, edit it there, and then run <command>make</command> there.</para> <para>However, the <filename>Makefile</filename> does need to be edited. There is a file called <filename>Makefile.jade</filename> in the main directory, which is intended to be used with <command>make -f Makefile.jade</command> when building <productname>Jade</productname> (as opposed to just <productname>SP</productname>, the <acronym>SGML</acronym> parser kit that <productname>Jade</productname> is built upon). We suggest that you don't do that, though, since there is more that you need to change than what is in <filename>Makefile.jade</filename>, so you'd have to edit one of them anyway.</para> <para>Go through the <filename>Makefile</filename>, reading James' instructions and editing as needed. There are various variables that need to be set. Here is a collected summary of the most important ones, with typical values: <programlisting> prefix = /usr/local XDEFINES = -DSGML_CATALOG_FILES_DEFAULT=\"/usr/local/share/sgml/catalog\" XLIBS = -lm RANLIB = ranlib srcdir = .. XLIBDIRS = grove spgrove style XPROGDIRS = jade </programlisting> Note the specification of where to find the default catalog of <acronym>SGML</acronym> support files -- you may want to change that to something more suitable for your own installation. If your system doesn't need the above settings for the math library and the <command>ranlib</command> command, leave them as they are in the <filename>Makefile</filename>. </para> </step> <step performance="required"> <para>Type <command>make</command> to build Jade and the various <productname>SP</productname> tools.</para> </step> <step performance="required"> <para>Once the software is built, <command>make install</command> will do the obvious.</para> </step> </procedure> </sect3> <sect3> <title>Installing the <productname>DocBook</productname> <acronym>DTD</acronym> Kit</title> <procedure> <title>Installing the <productname>DocBook</productname> <acronym>DTD</acronym> Kit</title> <step performance="required"> <para>You'll want to place the files that make up the <productname>DocBook</productname> <acronym>DTD</acronym> kit in the directory you built <productname>Jade</productname> to expect them in, which, if you followed our suggestion above, is <filename>/usr/local/share/sgml/</filename>. In addition to the actual <productname>DocBook</productname> files, you'll need to have a <filename>catalog</filename> file in place, for the mapping of document type specifications and external entity references to actual files in that directory. You'll also want the <acronym>ISO</acronym> character set mappings, and probably one or more versions of <acronym>HTML</acronym>.</para> <para>One way to install the various <acronym>DTD</acronym> and support files and set up the <filename>catalog</filename> file, is to collect them all into the above mentioned directory, use a single file named <filename>CATALOG</filename> to describe them all, and then create the file <filename>catalog</filename> as a catalog pointer to the former, by giving it the single line of content: <programlisting> CATALOG /usr/local/share/sgml/CATALOG </programlisting> </para> </step> <step performance="required"> <para> The <filename>CATALOG</filename> file should then contain three types of lines. The first is the (optional) <acronym>SGML</acronym> declaration, thus: <programlisting> SGMLDECL docbook.dcl </programlisting> Next, the various references to <acronym>DTD</acronym> and entity files must be resolved. For the <productname>DocBook</productname> files, these lines look like this: <programlisting> PUBLIC "-//Davenport//DTD DocBook V3.0//EN" docbook.dtd PUBLIC "-//USA-DOD//DTD Table Model 951010//EN" cals-tbl.dtd PUBLIC "-//Davenport//ELEMENTS DocBook Information Pool V3.0//EN" dbpool.mod PUBLIC "-//Davenport//ELEMENTS DocBook Document Hierarchy V3.0//EN" dbhier.mod PUBLIC "-//Davenport//ENTITIES DocBook Additional General Entities V3.0//EN" dbgenent.mod </programlisting> </para> </step> <step performance="required"> <para> Of course, a file containing these comes with the <productname>DocBook</productname> kit. Note that the last item on each of these lines is a file name, given here without a path. You can put the files in subdirectories of your main <acronym>SGML</acronym> directory if you like, of course, and modify the reference in the <filename>CATALOG</filename> file. <productname>DocBook</productname> also references the <acronym>ISO</acronym> character set entities, so you need to fetch and install these (they are available from several sources, and are easily found by way of the URLs listed above), along with catalog entries for all of them, such as: <programlisting> PUBLIC "ISO 8879-1986//ENTITIES Added Latin 1//EN" ISO/ISOlat1 </programlisting> Note how the file name here contains a directory name, showing that we've placed the <acronym>ISO</acronym> entity files in a subdirectory named <filename>ISO</filename>. Again, proper catalog entries should accompany the entity kit you fetch. </para> </step> </procedure> </sect3> <sect3> <title>Installing Norman Walsh's <acronym>DSSSL</acronym> Style Sheets</title> <procedure> <title>Installing Norman Walsh's <acronym>DSSSL</acronym> Style Sheets</title> <step performance="required"> <para>Read the installation instructions at the above listed URL.</para> </step> <step performance="required"> <para>To install Norman's style sheets, simply unzip the distribution kit in a suitable place. A good place to dot this would be <filename>/usr/local/share</filename>, which places the kit in a directory tree under <filename>/usr/local/share/docbook</filename>. The command will be something like <programlisting> unzip -aU db119.zip </programlisting> </para> </step> <step performance="required"> <para>One way to test the installation is to build the <acronym>HTML</acronym> and <acronym>RTF</acronym> forms of the <citetitle><productname>PostgreSQL</productname> User's Guide</citetitle>. </para> <substeps> <step performance="required"> <para> To build the <acronym>HTML</acronym> files, go to the <acronym>SGML</acronym> source directory, <filename>doc/src/sgml</filename>, and say <programlisting> jade -t sgml -d /usr/local/share/docbook/html/docbook.dsl -D ../graphics postgres.sgml </programlisting> </para> <para> <filename>book1.htm</filename> is the top level node of the output.. </para> </step> <step performance="required"> <para> To generate the <acronym>RTF</acronym> output, ready for importing into your favorite word processing system and printing, type: <programlisting> jade -t rtf -d /usr/local/share/docbook/print/docbook.dsl -D ../graphics postgres.sgml </programlisting> </para> </step> </substeps> </step> </procedure> </sect3> <sect3> <title>Installing <productname>PSGML</productname></title> <procedure> <title>Installing <productname>PSGML</productname></title> <step performance="required"> <para>Read the installation instructions at the above listed URL.</para> </step> <step performance="required"> <para>Unpack the distribution file, run configure, make and make install to put the byte-compiled files and info library in place. </para> </step> <step performance="required" id="psgml-setup"> <para> Then add the following lines to your <filename>/usr/local/share/emacs/site-lisp/site-start.el</filename> file to make <productname>Emacs</productname> properly load <productname>PSGML</productname> when needed: <programlisting> (setq load-path (cons "/usr/local/share/emacs/site-lisp/psgml" load-path)) (autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t) </programlisting> </para> </step> <step performance="optional"> <para> If you want to use <productname>PSGML</productname> when editing <acronym>HTML</acronym> too, also add this: <programlisting> (setq auto-mode-alist (cons '("\\.s?html?\\'" . sgml-mode) auto-mode-alist)) </programlisting> </para> </step> <step performance="optional"> <para>There is one important thing to note with <productname>PSGML</productname>: its author assumed that your main <acronym>SGML</acronym> <acronym>DTD</acronym> directory would be <filename>/usr/local/lib/sgml</filename>. If, as in the examples in this chapter, you use <filename>/usr/local/share/sgml</filename>, you have to compensate for this. </para> <substeps> <step performance="optional"> <para> You can set the <filename>SGML_CATALOG_FILES</filename> environment variable. </para> </step> <step performance="optional"> <para> You can customize your <productname>PSGML</productname> installation (its manual tells you how). </para> </step> <step performance="optional"> <para> You can even edit the source file <filename>psgml.el</filename> before compiling and installing <productname>PSGML</productname>, changing the hard-coded paths to match your own default.</para> </step> </substeps> </step> </procedure> </sect3> <sect3><title>Installing <productname>JadeTeX</productname></title> <para>If you want to, you can also install <productname>JadeTeX</productname> to use <productname>TeX</productname> as a formatting backend for <productname>Jade</productname>. Note that this is still quite unpolished software, and will generate printed output that is inferior to what you get from the <acronym>RTF</acronym> backend. Still, it works all right, especially for simpler documents that don't use tables, and as both <productname>JadeTeX</productname> and the style sheets are under continuous improvement, it will certainly get better over time.</para> <para>To install and use <productname>JadeTeX</productname>, you will need a working installation of <productname>TeX</productname> and <productname>LaTeX2e</productname>, including the supported <productname>tools</productname> and <productname>graphics</productname> packages, <productname>Babel</productname>, <productname><acronym>AMS</acronym> fonts</productname> and <productname>AMS-LaTeX</productname>, the <productname><acronym>PSNFSS</acronym></productname> extension and companion kit of "the 35 fonts", the <productname>dvips</productname> program for generating <productname>PostScript</productname>, the macro packages <productname>fancyhdr</productname>, <productname>hyperref</productname>, <productname>minitoc</productname>, <productname>url</productname> and <productname>ot2enc</productname>, and of course <productname>JadeTeX</productname> itself. All of these can be found on your friendly neighborhood <acronym>CTAN</acronym> site.</para> <para><productname>JadeTeX</productname> does not at the time of writing come with much of an installation guide, but there is a <filename>makefile</filename> which shows what is needed. It also includes a directory <filename>cooked</filename>, wherein you'll find some of the macro packages it needs, but not all, and not complete -- at least last we looked.</para> <para>Before building the <filename>jadetex.fmt</filename> format file, you'll probably want to edit the <filename>jadetex.ltx</filename> file, to change the configuration of <productname>Babel</productname> to suit your locality. The line to change looks something like <programlisting> \RequirePackage[german,french,english]{babel}[1997/01/23] </programlisting> and you should obviously list only the languages you actually need, and have configured <productname>Babel</productname> for.</para> <para>With <productname>JadeTeX</productname> working, you should be able to generate and format <productname>TeX</productname> output for the <productname>PostgreSQL</productname> manuals by giving the commands (as above, in the <filename>doc/src/sgml</filename> directory) <programlisting> jade -t tex -d /usr/local/share/docbook/print/docbook.dsl -D ../graphics postgres.sgml jadetex postgres.tex jadetex postgres.tex dvips postgres.dvi </programlisting> Of course, when you do this, <productname>TeX</productname> will stop during the second run, and tell you that its capacity has been exceeded. This is, as far as we can tell, because of the way <productname>JadeTeX</productname> generates cross referencing information. <productname>TeX</productname> can, of course, be compiled with larger data structure sizes. The details of this will vary according to your installation. </para> </sect3> </sect2> </sect1> <sect1> <title>Alternate Toolsets</title> <para> <productname>sgml-tools</productname> v2.x now supports <application>jade</application> and <productname>DocBook</productname>. It may be the preferred toolset for working with <acronym>SGML</acronym> but we have not had a chance to evaluate the new package. </para> <!-- <para> The current stable release of <productname>sgml-tools</productname> is version 1.0.4. The v1.0 release includes some restructuring of the directory tree to more easily support additional document styles, possibly including <productname>DocBook</productname>. The only version of <productname>sgml-tools</productname> evaluated for <productname>Postgres</productname> was v0.99.0. </para> <sect2> <title><productname>sgml-tools</productname></title> <para> Install <productname>sgml-tools-0.99.0</productname>. </para> <para> Apply <ulink url="http://alumni.caltech.edu/~lockhart/postgres/linuxdoc/sgml-tools-patches-0.99.0.tar.gz"> <productname>sgml-tools-patches</productname> </ulink> to the linuxdoc styles. These patches fix small problems with table formatting and with figure file names on conversion to postscript or html. </para></sect2> <sect2> <title><productname>sgml2latex</productname></title> <para> The current stable release of <productname>sgml2latex</productname> is version 1.4. I have misplaced the original reference for this package, so will temporarily post it with this example. </para> <para> Install <ulink url="http://alumni.caltech.edu/~lockhart/postgres/linuxdoc/sgml2latex-format.1.4.tar.gz"> <productname>sgml2latex</productname> </ulink>. </para></sect2> <sect2> <title><productname>latex</productname></title> <para> Get and install <productname>texmf</productname>, <productname>teTeX</productname>, or another package providing full tex/latex functionality. </para> <para> Add the <ulink url="http://alumni.caltech.edu/~lockhart/postgres/linuxdoc/latex-styles-0.99.0.tar.gz">required styles</ulink> linuxdoc-sgml.sty, linuxdoc-sgml-a4.sty isolatin.sty, qwertz.sty, and null.sty to texmf/tex/latex/tools/ or the appropriate area. <programlisting> % cat latex-styles-0.99.0.tar.gz | (cd texmf/tex/latex/tools/; tar zxvf -) </programlisting> Run <productname>texhash</productname> to update the tex database. </para></sect2></sect1> --> </sect1> </appendix> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t 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: -->