Update of /home/cvsd/slony1/slony1-engine/doc/adminguide
In directory main.slony.info:/tmp/cvs-serv22485

Modified Files:
	adminscripts.sgml 
Log Message:
Add in documentation for start_slon.sh script


Index: adminscripts.sgml
===================================================================
RCS file: /home/cvsd/slony1/slony1-engine/doc/adminguide/adminscripts.sgml,v
retrieving revision 1.50
retrieving revision 1.51
diff -C2 -d -r1.50 -r1.51
*** adminscripts.sgml	27 Feb 2008 19:37:03 -0000	1.50
--- adminscripts.sgml	1 Aug 2008 19:32:24 -0000	1.51
***************
*** 362,365 ****
--- 362,409 ----
  </sect2>
  
+ <sect2 id="startslon"> <title>start_slon.sh</title>
+ 
+ <para> This <filename>rc.d</filename>-style script was introduced in
+ &slony1; version 2.0; it provides automatable ways of:</para>
+ 
+ <itemizedlist>
+ <listitem><para>Starting the &lslon;, via <command> start_slon.sh start </command> </para> 
+ 
+ <para> Attempts to start the &lslon;, checking first to verify that it
+ is not already running, that configuration exists, and that the log
+ file location is writable.  Failure cases include:</para>
+ 
+ <itemizedlist>
+ <listitem><para> No <link linkend="runtime-config"> slon runtime configuration file </link> exists, </para></listitem>
+ <listitem><para> A &lslon; is found with the PID indicated via the runtime configuration, </para></listitem>
+ <listitem><para> The specified <envar>SLON_LOG</envar> location is not writable. </para></listitem>
+ </listitem>
+ <listitem><para>Stopping the &lslon;, via <command> start_slon.sh stop </command> </para> 
+ <para> This fails (doing nothing) if the PID (indicated via the runtime configuration file) does not exist; </para> </listitem>
+ <listitem><para>Monitoring the status of the &lslon;, via <command> start_slon.sh status </command> </para> 
+ <para> This indicates whether or not the &lslon; is running, and, if so, prints out the process ID. </para> </listitem>
+ 
+ </itemizedlist>
+ 
+ <para> The following environment variables are used to control &lslon; configuration:</para>
+ 
+ <glosslist>
+ <glossentry><glossterm> <envar> SLON_BIN_PATH </envar> </glossterm>
+ <glossdef><para> This indicates where the &lslon; binary program is found. </para> </glossdef> </glossentry>
+ <glossentry><glossterm> <envar> SLON_CONF </envar> </glossterm>
+ <glossdef><para> This indicates the location of the <link linkend="runtime-config"> slon runtime configuration file </link> that controls how the &lslon; behaves. </para> 
+ <para> Note that this file is <emphasis>required</emphasis> to contain a value for <link linkend="slon-config-logging-pid-file">log_pid_file</link>; that is necessary to allow this script to detect whether the &lslon; is running or not. </para>
+ </glossdef> </glossentry>
+ <glossentry><glossterm> <envar> SLON_LOG </envar> </glossterm>
+ <glossdef><para> This file is the location where &lslon; log files are to be stored, if need be.  There is an option <xref linkend ="slon-config-logging-syslog"> for &lslon; to use <application>syslog</application> to manage logging; in that case, you may prefer to set <envar>SLON_LOG</envar> to <filename>/dev/null</filename>.  </para> </glossdef> </glossentry>
+ </glosslist>
+ 
+ <para> Note that these environment variables may either be set, in the
+ script, or overridden by values passed in from the environment.  The
+ latter usage makes it easy to use this script in conjunction with the
+ <xref linkend="testbed"> so that it is regularly tested. </para>
+ 
+ </sect2>
+ 
  <sect2 id="launchclusters"><title> launch_clusters.sh </title>
  
***************
*** 367,374 ****
  
  <para> This is another shell script which uses the configuration as
! set up by <filename>mkslonconf.sh</filename> and is intended to either
! be run at system boot time, as an addition to the
! <filename>rc.d</filename> processes, or regularly, as a cron process,
! to ensure that &lslon; processes are running.</para>
  
  <para> It uses the following environment variables:</para>
--- 411,418 ----
  
  <para> This is another shell script which uses the configuration as
! set up by <filename>mkslonconf.sh</filename> and is intended to
! support an approach to running &slony1; involving regularly
! (<emphasis>e.g.</emphasis> via a cron process) checking to ensure that
! &lslon; processes are running.</para>
  
  <para> It uses the following environment variables:</para>