Tue Dec 21 15:13:26 PST 2004
- Previous message: [Slony1-commit] By darcyb: Time to box the text files up and move them to the attic
- Next message: [Slony1-commit] By darcyb: use the correct dsl when building docs
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
Log Message:
-----------
Convert book to parts + chapters
Modified Files:
--------------
slony1-engine/doc/adminguide:
Makefile (r1.5 -> r1.6)
adminscripts.sgml (r1.6 -> r1.7)
installation.sgml (r1.4 -> r1.5)
intro.sgml (r1.2 -> r1.3)
prerequisites.sgml (r1.3 -> r1.4)
reference.sgml (r1.2 -> r1.3)
schemadoc.xml (r1.1 -> r1.2)
slonik_ref.sgml (r1.2 -> r1.3)
slony.sgml (r1.5 -> r1.6)
-------------- next part --------------
Index: adminscripts.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/adminscripts.sgml,v
retrieving revision 1.6
retrieving revision 1.7
diff -Ldoc/adminguide/adminscripts.sgml -Ldoc/adminguide/adminscripts.sgml -u -w -r1.6 -r1.7
--- doc/adminguide/adminscripts.sgml
+++ doc/adminguide/adminscripts.sgml
@@ -1,4 +1,5 @@
-<sect1 id="altperl"><title/ Slony-I Administration Scripts/
+<chapter id="altperl">
+<title/ Slony-I Administration Scripts/
<para>In the <filename/altperl/ directory in the <application/CVS/
tree, there is a sizable set of <application/Perl/ scripts that may be
@@ -17,7 +18,7 @@
An administrator should review the script <emphasis/before/ submitting
it to <link linkend="slonik"> slonik </link>.
-<sect2><title> Node/Cluster Configuration - cluster.nodes</title>
+<sect1><title> Node/Cluster Configuration - cluster.nodes</title>
<para>The UNIX environment variable <envar/SLONYNODES/ is used to
determine what Perl configuration file will be used to control the
@@ -53,8 +54,8 @@
noforward => undef # shall this node be set up to forward results?
);
</programlisting>
-
-<sect2><title> Set configuration - cluster.set1, cluster.set2</title>
+</sect1>
+<sect1><title> Set configuration - cluster.set1, cluster.set2</title>
<para>The UNIX environment variable <envar/SLONYSET/ is used to
determine what Perl configuration file will be used to determine what
@@ -92,8 +93,8 @@
<para> An array of names of sequences that are to be replicated
</itemizedlist>
-
-<sect2><title/ build_env.pl/
+</sect1>
+<sect1><title/ build_env.pl/
<para>Queries a database, generating output hopefully suitable for
<filename/slon.env/ consisting of:
@@ -102,80 +103,80 @@
<listitem><Para> a set of <function/add_node()/ calls to configure the cluster
<listitem><Para> The arrays <envar/@KEYEDTABLES/, <envar/@SERIALTABLES/, and <envar/@SEQUENCES/
</itemizedlist>
-
-<sect2><title/ create_set.pl/
+</sect1>
+<sect1><title/ create_set.pl/
<para>This requires <envar/SLONYSET/ to be set as well as
<envar/SLONYNODES/; it is used to generate the Slonik script to set up
a replication set consisting of a set of tables and sequences that are
to be replicated.
-
-<sect2><title/ drop_node.pl/
+</sect1>
+<sect1><title/ drop_node.pl/
<para>Generates Slonik script to drop a node from a Slony-I cluster.
-
-<sect2><title/ drop_set.pl/
+</sect1>
+<sect1><title/ drop_set.pl/
<para>Generates Slonik script to drop a replication set (<emphasis/e.g./ - set of tables and sequences) from a Slony-I cluster.
-
-<sect2><title/ failover.pl/
+</sect1>
+<sect1><title/ failover.pl/
<para>Generates Slonik script to request failover from a dead node to some new origin
-
-<sect2><title/ init_cluster.pl/
+</sect1>
+<sect1><title/ init_cluster.pl/
<para>Generates Slonik script to initialize a whole Slony-I cluster,
including setting up the nodes, communications paths, and the listener
routing.
-
-<sect2><title/ merge_sets.pl/
+</sect1>
+<sect1><title/ merge_sets.pl/
<para>Generates Slonik script to merge two replication sets together.
-
-<sect2><title/ move_set.pl/
+</sect1>
+<sect1><title/ move_set.pl/
<para>Generates Slonik script to move the origin of a particular set to a different node.
-
-<sect2><title/ replication_test.pl/
+</sect1>
+<sect1><title/ replication_test.pl/
<para>Script to test whether Slony-I is successfully replicating data.
-
-<sect2><title/ restart_node.pl/
+</sect1>
+<sect1><title/ restart_node.pl/
<para>Generates Slonik script to request the restart of a node. This was
particularly useful pre-1.0.5 when nodes could get snarled up when
slon daemons died.
-
-<sect2><title/ restart_nodes.pl/
+</sect1>
+<sect1><title/ restart_nodes.pl/
<para>Generates Slonik script to restart all nodes in the cluster. Not
particularly useful...
-
-<sect2><title/ show_configuration.pl/
+</sect1>
+<sect1><title/ show_configuration.pl/
<para>Displays an overview of how the environment (e.g. - <envar/SLONYNODES/) is set
to configure things.
-
-<sect2><title/ slon_kill.pl/
+</sect1>
+<sect1><title/ slon_kill.pl/
<para>Kills slony watchdog and all slon daemons for the specified set. It
only works if those processes are running on the local host, of
course!
-
-<sect2><title/ slon_pushsql.pl/
+</sect1>
+<sect1><title/ slon_pushsql.pl/
<para>Generates Slonik script to push DDL changes to a replication set.
-
-<sect2><title/ slon_start.pl/
+</sect1>
+<sect1><title/ slon_start.pl/
<para>This starts a slon daemon for the specified cluster and node, and uses
slon_watchdog.pl to keep it running.
-
-<sect2><title/ slon_watchdog.pl/
+</sect1>
+<sect1><title/ slon_watchdog.pl/
<para>Used by slon_start.pl...
-<sect2><title/ slon_watchdog2.pl/
+</sect1><sect1><title/ slon_watchdog2.pl/
<para>This is a somewhat smarter watchdog; it monitors a particular Slony-I
node, and restarts the slon process if it hasn't seen updates go in in
@@ -184,27 +185,27 @@
<para>This is helpful if there is an unreliable network connection such that
the slon sometimes stops working without becoming aware of it...
-<sect2><title/ subscribe_set.pl/
+</sect1><sect1><title/ subscribe_set.pl/
<para>Generates Slonik script to subscribe a particular node to a particular replication set.
-<sect2><title/ uninstall_nodes.pl/
+</sect1><sect1><title/ uninstall_nodes.pl/
<para>This goes through and drops the Slony-I schema from each node; use
this if you want to destroy replication throughout a cluster. This is
a VERY unsafe script!
-<sect2><title/ unsubscribe_set.pl/
+</sect1><sect1><title/ unsubscribe_set.pl/
<para>Generates Slonik script to unsubscribe a node from a replication set.
-<sect2><title/ update_nodes.pl/
+</sect1><sect1><title/ update_nodes.pl/
<para>Generates Slonik script to tell all the nodes to update the
Slony-I functions. This will typically be needed when you upgrade
from one version of <productname/Slony-I/ to another.
-<sect2 id="regenlisten"><title> regenerate-listens.pl</title>
+<sect1 id="regenlisten"><title> regenerate-listens.pl</title>
<para> This script connects to a <productname>Slony-I</productname>
node, and queries various tables (sl_set, sl_node, sl_subscribe,
@@ -214,7 +215,7 @@
<para> See the documentation on <link linkend="autolisten"> Automated
Listen Path Generation </link> for more details on how this
-works.</para></sect2>
+works.</para>
</sect1>
Index: slonik_ref.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/slonik_ref.sgml,v
retrieving revision 1.2
retrieving revision 1.3
diff -Ldoc/adminguide/slonik_ref.sgml -Ldoc/adminguide/slonik_ref.sgml -u -w -r1.2 -r1.3
--- doc/adminguide/slonik_ref.sgml
+++ doc/adminguide/slonik_ref.sgml
@@ -1,43 +1,45 @@
-<article id="slonikcommands"><title/Slonik Command Summary/
-<sect1 id="slonikintro"><title/Slonik Command Summary/
+<ARTICLE id="slonikcommands">
+<title>Slonik Command Summary</title>
+<sect1 id="slonikintro">
+<title>Slonik Command Summary</title>
<sect2><title/Introduction/
<para>
- <application/Slonik/ is a command line utility designed
+ <application>Slonik</application> is a command line utility designed
specifically to setup and modify configurations of the
- <productname/Slony-I/ replication system.
+ <productname>Slony-I</productname> replication system.
</para>
<sect2 id="outline">
<title>General outline</title>
<para>
- The <application/slonik/ commandline utility is supposed to be
+ The <application>slonik</application> commandline utility is supposed to be
used embedded into shell scripts and reads commands from files
or stdin (via here documents for example). Nearly all of the
<emphasis>real</emphasis> configuration work is done by
calling stored procedures after loading the
- <productname/Slony-I/ support base into a database. You may
+ <productname>Slony-I</productname> support base into a database. You may
find documentation for those procedures in the <ulink
- url="schemadoc.html"> <productname/Slony-I/ Schema
+ url="schemadoc"><productname>Slony-I</productname> Schema
Documentation </ulink>, as well as in comments associated with
them in the database.
</para>
<para>
- <Application/Slonik/ was created because:
+ <Application>Slonik</Application> was created because:
<itemizedlist>
<listitem><para> The stored procedures have special
requirements as to on which particular node in the replication
- system they are called,
+ system they are called,</para></listitem>
<listitem><para> The lack of named parameters for stored
procedures makes it rather difficult to do this from the
- <application/psql/ prompt, and
+ <application>psql</application> prompt, and</para></listitem>
- <listitem><para> <application/psql/ lacks the ability to
- maintain multiple connections with open transactions.
+ <listitem><para><application>psql</application>lacks the ability to
+ maintain multiple connections with open transactions.</para></listitem>
</itemizedlist>
</para>
<para>
@@ -57,10 +59,10 @@
<para>
Option values may be:
<itemizedlist>
- <listitem><para>integer values
- <listitem><para>string literals enclosed in single quotes
- <listitem><para>boolean values {TRUE|ON|YES} or {FALSE|OFF|NO}
- <listitem><para>keywords for special cases
+ <listitem><para>integer values</para></listitem>
+ <listitem><para>string literals enclosed in single quotes</para></listitem>
+ <listitem><para>boolean values {TRUE|ON|YES} or {FALSE|OFF|NO}</para></listitem>
+ <listitem><para>keywords for special cases</para></listitem>
</itemizedlist>
</para>
<sect3><title>Comments</title>
@@ -259,13 +261,17 @@
<!-- **************************************** -->
-<reference id="cmds"><title>Configuration and Action commmands</title>
+<reference id="cmds">
+ <title>Configuration and Action commmands</title>
+ <refentry id ="stmtinitcluster">
+ <refmeta>
+ <refentrytitle>INIT CLUSTER</refentrytitle>
+ </refmeta>
-<refentry id ="stmtinitcluster"><refmeta><refentrytitle>INIT CLUSTER</refentrytitle> </refmeta>
+ <refnamediv>
+ <refname>INIT CLUSTER</refname>
-<refnamediv><refname>INIT CLUSTER</refname>
-
-<refpurpose> Initialize <productname/Slony-I/ cluster </refpurpose>
+ <refpurpose>Initialize <productname>Slony-I</productname> cluster</refpurpose>
<refsynopsisdiv>
<cmdsynopsis>
<command>INIT CLUSTER </command>
@@ -275,7 +281,6 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
-
<para> Initialize the first node in a new <productname/Slony-I/
replication cluster. The initialization process consists of creating
the cluster namespace, loading all the base tables, functions,
@@ -283,11 +288,11 @@
<variablelist>
<varlistentry><term><literal> ID </literal></term>
- <listitem><para> The unique, numeric ID number of the node. </para>
+ <listitem><para>The unique, numeric ID number of the node.</para></listitem>
</varlistentry>
<varlistentry><term><literal> COMMENT = 'comment text' </literal></term>
- <listitem><para> A descriptive text added to the node entry in the table sl_node.</para>
+ <listitem><para> A descriptive text added to the node entry in the table sl_node.</para></listitem>
</varlistentry>
</variablelist>
@@ -300,9 +305,9 @@
objects of the <productname>Slony-I</productname> system must be installed in the
PostgreSQL library directory. Also the procedural language PL/pgSQL is
assumed to already be installed in the target database. </para>
-
</Refsect1>
-<Refsect1><Title>Example</Title>
+ <Refsect1>
+ <Title>Example</Title>
<Programlisting>
INIT CLUSTER (
ID = 1,
@@ -329,7 +334,7 @@
<title>Description</title>
<para> Initialize a new node and add it to the configuration of an
-existing cluster.
+existing cluster.</para>
<para> The initialization process consists of creating the cluster
namespace in the new node (the database itself must already exist),
@@ -339,11 +344,11 @@
<variablelist>
<varlistentry><term><literal> ID = ival </literal></term>
- <listitem><para> The unique, numeric ID number of the new node. </para>
+ <listitem><para> The unique, numeric ID number of the new node.</para></listitem>
</varlistentry>
<varlistentry><term><literal> COMMENT = 'description' </literal></term>
- <listitem><para> A descriptive text added to the node entry in the table sl_node.</para>
+ <listitem><para> A descriptive text added to the node entry in the table sl_node.</para></listitem>
</varlistentry>
<varlistentry><term><literal> SPOOLNODE = boolean </literal></term>
@@ -351,17 +356,18 @@
<listitem><para> Specifies that the new node is a virtual spool node
for file archiving of replication log. If true <application/slonik/
will not attempt to initialize a database with the replication
- schema. </para>
+ schema.</para></listitem>
</varlistentry>
<varlistentry><term><literal> EVENT NODE = ival </literal></term>
<listitem><para> The ID of the node used to create the configuration
event that tells all existing nodes about the new node. Default
- value is 1. </para>
+ value is 1.</para></listitem>
</varlistentry>
</variablelist>
</para>
+
</Refsect1>
<Refsect1><Title>Example</Title>
<Programlisting>
@@ -392,10 +398,10 @@
<variablelist>
<varlistentry><term><literal> ID = ival </literal></term>
- <listitem><para> Node ID of the node to remove. </para>
+ <listitem><para> Node ID of the node to remove.</para></listitem>
</varlistentry>
<varlistentry><term><literal> EVENT NODE = ival </literal></term>
- <listitem><para> Node ID of the node to generate the event. </para>
+ <listitem><para> Node ID of the node to generate the event.</para></listitem>
</varlistentry>
</variablelist>
</para>
@@ -430,7 +436,7 @@
<variablelist>
<varlistentry><term><literal> ID = ival </literal></term>
- <listitem><para> Node ID of the node to uninstall. </para>
+ <listitem><para> Node ID of the node to uninstall.</para></listitem>
</varlistentry>
</variablelist>
</para>
@@ -466,7 +472,7 @@
<variablelist>
<varlistentry><term><literal> ID = ival </literal></term>
- <listitem><para> Node ID of the node to restart. </para>
+ <listitem><para> Node ID of the node to restart.</para></listitem>
</varlistentry>
</variablelist>
</para>
@@ -518,18 +524,18 @@
<variablelist>
<varlistentry><term><literal> SERVER = ival </literal></term>
- <listitem><para> Node ID of the database to connect to. </para>
+ <listitem><para> Node ID of the database to connect to.</para></listitem>
</varlistentry>
<varlistentry><term><literal> CLIENT = ival </literal></term>
- <listitem><para> Node ID of the replication daemon connecting. </para>
+ <listitem><para> Node ID of the replication daemon connecting.</para></listitem>
</varlistentry>
<varlistentry><term><literal> CONNINFO = string </literal></term>
- <listitem><para> <function/PQconnectdb()/ argument to establish the connection. </para>
+ <listitem><para> <function/PQconnectdb()/ argument to establish the connection.</para></listitem>
</varlistentry>
<varlistentry><term><literal> CONNRETRY = ival </literal></term>
<listitem><para> Number of seconds to wait before another attempt to
connect is made in case the server is unavailable. Default is 10.
- </para>
+ </para></listitem>
</varlistentry>
</variablelist>
</para>
@@ -567,10 +573,10 @@
<variablelist>
<varlistentry><term><literal> SERVER = ival </literal></term>
- <listitem><para> Node ID of the database to connect to. </para>
+ <listitem><para> Node ID of the database to connect to.</para></listitem>
</varlistentry>
<varlistentry><term><literal> CLIENT = ival </literal></term>
- <listitem><para> Node ID of the replication daemon connecting. </para>
+ <listitem><para> Node ID of the replication daemon connecting.</para></listitem>
</varlistentry>
<varlistentry><term><literal> EVENT NODE = ival </literal></term>
@@ -629,14 +635,14 @@
<variablelist>
<varlistentry><term><literal> ORIGIN = ival </literal></term>
- <listitem><para> Node ID of the event origin the receiver is listening for. </para>
+ <listitem><para> Node ID of the event origin the receiver is listening for.</para></listitem>
</varlistentry>
<varlistentry><term><literal> PROVIDER = ival </literal></term>
- <listitem><para> Node ID of the node from which the receiver gets events that come from the origin. If not specified, default is the origin.</para>
+ <listitem><para> Node ID of the node from which the receiver gets events that come from the origin. If not specified, default is the origin.</para></listitem>
</varlistentry>
<varlistentry><term><literal> RECEIVER = ival </literal></term>
- <listitem><para> The ID of the node receiving the events. </para>
+ <listitem><para> The ID of the node receiving the events.</para></listitem>
</varlistentry>
</variablelist>
@@ -671,14 +677,14 @@
<variablelist>
<varlistentry><term><literal> ORIGIN = ival </literal></term>
- <listitem><para> Node ID of the event origin the receiver is listening for. </para>
+ <listitem><para> Node ID of the event origin the receiver is listening for.</para></listitem>
</varlistentry>
<varlistentry><term><literal> PROVIDER = ival </literal></term>
- <listitem><para> Node ID of the node from which the receiver gets events that come from the origin. If not specified, default is the origin.</para>
+ <listitem><para> Node ID of the node from which the receiver gets events that come from the origin. If not specified, default is the origin.</para></listitem>
</varlistentry>
<varlistentry><term><literal> RECEIVER = ival </literal></term>
- <listitem><para> The ID of the node receiving the events. </para>
+ <listitem><para> The ID of the node receiving the events.</para></listitem>
</varlistentry>
</variablelist>
@@ -727,13 +733,13 @@
<varlistentry><term><literal> NODE ID = ival </literal></term>
<listitem><para> Node ID of the set origin where the table will be
added as a set member. (See <link linkend="stmtsetaddtable">
- <command/ SET ADD TABLE / </link>.) </para>
+ <command>SET ADD TABLE</command></link>.)</para></listitem>
</varlistentry>
<varlistentry><term><literal> FULLY QUALIFIED NAME = 'string' </literal></term>
<listitem><para> The full name of the table consisting of the schema
and table name as the SQL expression <command>quote_ident(nspname)
|| '.' || quote_ident(relname)</command>
- would return it. </para>
+ would return it.</para></listitem>
</varlistentry>
</variablelist>
@@ -784,13 +790,13 @@
<variablelist>
<varlistentry><term><literal> ID = ival </literal></term>
- <listitem><para> ID of the set to be created. </para>
+ <listitem><para> ID of the set to be created.</para></listitem>
</varlistentry>
<varlistentry><term><literal> ORIGIN = ival </literal></term>
- <listitem><para> Initial origin node of the set. </para>
+ <listitem><para> Initial origin node of the set.</para></listitem>
</varlistentry>
<varlistentry><term><literal> COMMENT = 'string' </literal></term>
- <listitem><para> A descriptive text added to the set entry. </para>
+ <listitem><para> A descriptive text added to the set entry.</para></listitem>
</varlistentry>
</variablelist>
@@ -829,10 +835,10 @@
<variablelist>
<varlistentry><term><literal> ID = ival </literal></term>
- <listitem><para> ID of the set to be dropped. </para>
+ <listitem><para> ID of the set to be dropped.</para></listitem>
</varlistentry>
<varlistentry><term><literal> ORIGIN = ival </literal></term>
- <listitem><para> Current origin node of the set. </para>
+ <listitem><para> Current origin node of the set.</para></listitem>
</varlistentry>
</variablelist>
@@ -876,7 +882,7 @@
<variablelist>
<varlistentry><term><literal> ID = ival </literal></term>
- <listitem><para> Unique ID of the set to contain the union of the two separate sets. </para>
+ <listitem><para> Unique ID of the set to contain the union of the two separate sets.</para></listitem>
</varlistentry>
<varlistentry><term><literal> ADD ID = ival </literal></term>
<listitem><para> Unique ID of the set whose objects should be transferred. </para>
Index: schemadoc.xml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/schemadoc.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -Ldoc/adminguide/schemadoc.xml -Ldoc/adminguide/schemadoc.xml -u -w -r1.1 -r1.2
--- doc/adminguide/schemadoc.xml
+++ doc/adminguide/schemadoc.xml
@@ -1,13 +1,5 @@
<!-- $Header$ -->
-<book id="database.schemadoc" xreflabel="schemadoc database schema"><title>schemadoc Model</title>
-
-
-
-
- <chapter id="schemadoc.schema"
- xreflabel="schemadoc">
- <title>Schema schemadoc</title>
<para></para>
@@ -9146,9 +9138,4 @@
end;
</programlisting>
</para>
- </section>
-
- </chapter>
-
-</book>
Index: intro.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/intro.sgml,v
retrieving revision 1.2
retrieving revision 1.3
diff -Ldoc/adminguide/intro.sgml -Ldoc/adminguide/intro.sgml -u -w -r1.2 -r1.3
--- doc/adminguide/intro.sgml
+++ doc/adminguide/intro.sgml
@@ -1,13 +1,14 @@
-<sect1 id="introduction"> <title>Introduction to Slony-I</title>
-
-<sect2> <title>Why yet another replication system? </title>
+<article id="introduction">
+ <title>Introduction to Slony-I</title>
+ <sect1>
+ <title>Why yet another replication system?</title>
<para>Slony-I was born from an idea to create a replication system that was not tied
to a specific version of PostgreSQL, which is allowed to be started and stopped on
-an existing database with out the need for a dump/reload cycle.</para></sect2>
-
-<sect2> <title>What Slony-I is</title>
-
+an existing database with out the need for a dump/reload cycle.</para>
+ </sect1>
+ <sect1>
+ <title>What Slony-I is</title>
<para>Slony-I is a <quote>master to multiple slaves</quote> replication
system supporting cascading and slave promotion. The big picture for
the development of Slony-I is as a master-slave system that includes
@@ -31,10 +32,10 @@
extension where updates would be serialized into files. Given that,
log files could be distributed by any means desired without any need
of feedback between the provider node and those nodes subscribing via
-<quote>log shipping.</quote></para></sect2>
+<quote>log shipping.</quote></para></sect1>
-<sect2><title> Slony-I is not</title>
+<sect1><title> Slony-I is not</title>
<para>Slony-I is not a network management system.</para>
@@ -48,9 +49,9 @@
<para>(That being said, the plan is for a subsequent system, Slony-II,
to provide "multimaster" capabilities, and be "bootstrapped" using
Slony-I. But that is a separate project, and expectations for Slony-I
-should not be based on hopes for future projects.)</para></sect2>
+should not be based on hopes for future projects.)</para></sect1>
-<sect2><title> Why doesn't Slony-I do automatic fail-over/promotion?
+<sect1><title> Why doesn't Slony-I do automatic fail-over/promotion?
</title>
<para>This is the job of network monitoring software, not Slony.
@@ -62,9 +63,9 @@
clearly the realm of network management software and not
Slony-I.</para>
-<para>Let Slony-I do what it does best: provide database replication.</para></sect2>
+<para>Let Slony-I do what it does best: provide database replication.</para></sect1>
-<sect2><title> Current Limitations</title>
+<sect1><title> Current Limitations</title>
<para>Slony-I does not automatically propagate schema changes, nor
does it have any ability to replicate large objects. There is a
@@ -100,9 +101,9 @@
<para>There are a number of distinct models for database replication;
it is impossible for one replication system to be all things to all
-people.</para></sect2>
+people.</para></sect1>
-<sect2 id="slonylistenercosts"><title> Slony-I Communications
+<sect1 id="slonylistenercosts"><title> Slony-I Communications
Costs</title>
<para>The cost of communications grows in a quadratic fashion in
@@ -139,9 +140,9 @@
Up to a half dozen nodes seems pretty reasonable; every time the
number of nodes doubles, this can be expected to quadruple
communications overheads.</para>
-</sect2>
-
</sect1>
+
+</article>
<!-- Keep this comment at the end of the file
Local variables:
mode:sgml
Index: reference.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/reference.sgml,v
retrieving revision 1.2
retrieving revision 1.3
diff -Ldoc/adminguide/reference.sgml -Ldoc/adminguide/reference.sgml -u -w -r1.2 -r1.3
--- doc/adminguide/reference.sgml
+++ doc/adminguide/reference.sgml
@@ -1,5 +1,5 @@
-<reference id="slony-commands"> <title>Slony-I Commands</title>
-
+<chapter id="slony-commands">
+ <title>Slony-I Commands</title>
&slon;
&slonik;
&slonikref;
Index: installation.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/installation.sgml,v
retrieving revision 1.4
retrieving revision 1.5
diff -Ldoc/adminguide/installation.sgml -Ldoc/adminguide/installation.sgml -u -w -r1.4 -r1.5
--- doc/adminguide/installation.sgml
+++ doc/adminguide/installation.sgml
@@ -1,5 +1,7 @@
-<sect1 id="installation"> <title> Slony-I Installation</title>
-
+<article id="installation">
+<title>Slony-I Installation</title>
+<sect1>
+<title>Slony-I Installation</title>
<para>You should have obtained the <productname/Slony-I/ source from
the previous step. Unpack it.</para>
@@ -11,16 +13,18 @@
<para> This will create a directory under the current directory with
the <productname/Slony-I/ sources. Head into that that directory for the rest of
the installation procedure.</para>
-
-<sect2><title> Short Version</title>
+</sect1>
+<sect1>
+<title>Short Version</title>
<para>
<screen>
./configure --with-pgsourcetree=/whereever/the/source/is
gmake all; gmake install
</screen>
-
-<sect2><title> Configuration</title>
+</sect1>
+<sect1>
+<title>Configuration</title>
<para>The first step of the installation procedure is to configure the
source tree for your system. This is done by running the
@@ -31,12 +35,14 @@
<productname/Slony-I/ is configured by pointing it to the various
library, binary, and include directories; for a full list of these
options, use the command <command> ./configure --help </command>
-</para></sect2>
+</para>
+</sect1>
-<sect2><title> Example</title>
+<sect1>
+<title>Example</title>
<screen>
-./configure --with-pgsourcetree=/usr/local/src/postgresql-7.4.3
+./configure --with-pgsourcetree=/usr/local/src/postgresql-7.4.6
</screen>
<para>This script will run a number of tests to guess values for
@@ -45,10 +51,12 @@
specific platforms such as Solaris2.X on SPARC this patch can be found
at <ulink
url="http://developer.postgresql.org/~wieck/slony1/download/threadsafe-libpq-742.diff.gz">
-http://developer.postgresql.org/~wieck/slony1/download/threadsafe-libpq-742.diff.gz</ulink></para></sect2>
+http://developer.postgresql.org/~wieck/slony1/download/threadsafe-libpq-742.diff.gz</ulink></para>
+</sect1>
-<sect2><title> Build</title>
+<sect1>
+<title>Build</title>
<para>To start the build process, type
@@ -64,9 +72,11 @@
line displayed should be</para>
<para> <command> All of Slony-I is successfully made. Ready to
-install. </command></para></sect2>
+install. </command></para>
+</sect1>
-<sect2><title> Installing Slony-I</title>
+<sect1>
+<title> Installing Slony-I</title>
<para> To install Slony-I, enter
@@ -78,7 +88,8 @@
specified by the <option>--prefix</option> option used in the
PostgreSQL configuration. Make sure you have appropriate permissions
to write into that area. Normally you need to do this either as root
-or as the postgres user. </para></sect2></sect1>
+or as the postgres user. </para>
+</sect1>
<!-- Keep this comment at the end of the file
Local variables:
Index: prerequisites.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/prerequisites.sgml,v
retrieving revision 1.3
retrieving revision 1.4
diff -Ldoc/adminguide/prerequisites.sgml -Ldoc/adminguide/prerequisites.sgml -u -w -r1.3 -r1.4
--- doc/adminguide/prerequisites.sgml
+++ doc/adminguide/prerequisites.sgml
@@ -1,7 +1,9 @@
-<sect1 id="requirements"><title/ Requirements/
-
+<article id="requirements">
+<title>System Requirements</title>
+<sect1>
+<title>System Requirements</title>
<para>Any platform that can run PostgreSQL should be able to run
-<productname/Slony-I/.
+<productname>Slony-I</productname>.
<para>The platforms that have received specific testing at the time of
this release are FreeBSD-4X-i368, FreeBSD-5X-i386, FreeBSD-5X-alpha,
@@ -30,8 +32,10 @@
there being a <filename>pthreads</filename> library for
<trademark>Windows</trademark>, so nothing should prevent some
interested party from volunteering to do the port.</para>
+</sect1>
-<sect2><title> Software needed</title>
+<sect1>
+<title> Software needed</title>
<para>
<itemizedlist>
@@ -72,19 +76,20 @@
<para>Also check to make sure you have sufficient disk space. You
will need approximately 5MB for the source tree during build and
-installation.
+installation.</sect1>
-<sect2><title> Getting <productname>Slony-I</productname>
-Source</title>
+<sect1>
+<title> Getting <productname>Slony-I</productname>Source</title>
<para>You can get the <productname>Slony-I</productname> source from
<ulink url="http://developer.postgresql.org/~wieck/slony1/download/">
http://developer.postgresql.org/~wieck/slony1/download/</ulink>
</para>
-</sect2>
+</sect1>
-<sect2><title> Time Synchronization</title>
+<sect1>
+<title> Time Synchronization</title>
<para> All the servers used within the replication cluster need to
have their Real Time Clocks in sync. This is to ensure that slon
@@ -101,9 +106,9 @@
<para> See <ulink url="http://www.ntp.org/"> www.ntp.org </ulink> for
more details about NTP (Network Time Protocol).
-</sect2>
+</sect1>
-<sect2><title> Network Connectivity</title>
+<sect1><title> Network Connectivity</title>
<para>It is necessary that the hosts that are to replicate between one
another have <emphasis>bidirectional</emphasis> network communications
@@ -157,9 +162,8 @@
one way communications so that <quote>subscribers</quote> that use log
shipping would have no need for access to other
<productname>Slony-I</productname> nodes.
-</sect2>
</sect1>
-
+</article>
<!-- Keep this comment at the end of the file
Local variables:
mode:sgml
Index: Makefile
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/Makefile,v
retrieving revision 1.5
retrieving revision 1.6
diff -Ldoc/adminguide/Makefile -Ldoc/adminguide/Makefile -u -w -r1.5 -r1.6
--- doc/adminguide/Makefile
+++ doc/adminguide/Makefile
@@ -15,7 +15,7 @@
.NOTPARALLEL:
-GENERATED_SGML = bookindex.sgml
+GENERATED_SGML = bookindex.sgml version.sgml
ALLSGML := $(wildcard $(srcdir)/*.sgml $(GENERATED_SGML))
@@ -167,7 +167,7 @@
OSX = osx # (may be called sx or sgml2xml on some systems)
XSLTPROC = xsltproc
-postgres.xml: postgres.sgml $(GENERATED_SGML)
+slony.xml: slony.sgml $(GENERATED_SGML)
$(OSX) -x lower $< | \
sed -e 's/\[\(lt\|gt\|amp\|nbsp\|copy\|quot\|ouml\|uuml\|egrave\) *\]/\&\1;/g' \
-e '1a\' -e '<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">' \
@@ -182,7 +182,7 @@
##
# Quick syntax check without style processing
-check: postgres.sgml $(ALLSGML)
+check: slony.sgml $(ALLSGML) $(GENERATED_SGML)
$(NSGMLS) $(SPFLAGS) $(SGMLINCLUDE) -s $<
@@ -218,3 +218,9 @@
$(PGAUTODOC) -d $(TEMPDB) -s $(TEMPSCHEMA) -t xml -f schemadoc ;\
$(pgbindir)/dropdb $(TEMPDB) >/dev/null 2>&1 \
) || echo "unable to createdb $(TEMPDB)"
+
+version.sgml: $(slony_top_builddir)/Makefile.global
+ { \
+ echo "<!entity version \"$(VERSION)\">"; \
+ echo "<!entity majorversion \"`expr $(VERSION) : '\([0-9][0-9]*\.[0-9][0-9]*\)'`\">"; \
+ } >$@
Index: slony.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/slony.sgml,v
retrieving revision 1.5
retrieving revision 1.6
diff -Ldoc/adminguide/slony.sgml -Ldoc/adminguide/slony.sgml -u -w -r1.5 -r1.6
--- doc/adminguide/slony.sgml
+++ doc/adminguide/slony.sgml
@@ -1,23 +1,25 @@
-<!-- $Id$ -->
+<!-- $Id -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
-
+ <!entity % version SYSTEM "version.sgml">
+ %version;
<!entity % filelist SYSTEM "filelist.sgml">
%filelist;
-
<!entity reference SYSTEM "reference.sgml">
-
]>
<book id="slony">
- <title>Slony-I 1.1 Administration</title>
+ <title>Slony-I &version; Documentation</title>
<bookinfo>
<corpauthor>The Slony Global Development Group</corpauthor>
- <author> <firstname>Christopher</firstname> <surname>Browne</surname> </author>
+ <author>
+ <firstname>Christopher</firstname>
+ <surname>Browne</surname>
+ </author>
&legal;
</bookinfo>
- <article id="slonyintro">
+ <part id="slonyintro">
<title>Slony-I Introduction</title>
&intro;
@@ -26,11 +28,14 @@
&concepts;
&cluster;
&defineset;
- </article>
+ </part>
+ <part id="refrence">
+ <title>Slony-I Command Reference</title>
&reference;
+ </part>
- <article id="slonyadmin">
+ <part id="slonyadmin">
<title>Slony-I Administration</title>
&adminscripts;
@@ -46,37 +51,25 @@
&ddlchanges;
&firstdb;
&help;
- </article>
-
- <article id="faq"><title>Slony-I FAQ</title>
- <articleinfo><title>Slony-I FAQ</title>
- <corpauthor>The Slony Global Development Group</corpauthor>
- <author>
- <firstname>Christopher </firstname>
- <surname>Browne</surname>
- </author>
- </articleinfo>
+ </part>
+ <part id="faq">
+ <title>Slony-I FAQ</title>
+ <article>
<para>Not all of these are, strictly speaking, <quote>frequently
asked;</quote> some represent <emphasis>trouble found that seemed
worth documenting</emphasis>.</para>
&faq;
</article>
+ </part>
- <article id="developer">
- <title>Slony-I Internals</title>
- <articleinfo>
+ <part id="developer">
<title>Slony-I Internals</title>
- <corpauthor>The Slony Global Development Group</corpauthor>
- <author>
- <firstname>Christopher</firstname>
- <surname>Browne</surname>
- </author>
- </articleinfo>
-
+ <article id="schemadoc">
&schemadoc;
</article>
+ </part>
<!-- &errcodes; -->
<!-- &biblio; -->
<!-- &bookindex; -->
- Previous message: [Slony1-commit] By darcyb: Time to box the text files up and move them to the attic
- Next message: [Slony1-commit] By darcyb: use the correct dsl when building docs
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
More information about the Slony1-commit mailing list