Initial configuration stuff

doc/configuration-file-settings.sgml

@@ -0,0 +1,26 @@
+<sect1 id="configuration-file-settings" xreflabel="configuration file settings">
+  <title>Configuration file settings</title>
+  <para>
+
+  </para>
+  <para>
+    For a full list of annotated configuration items, see the file
+    <ulink url="https://raw.githubusercontent.com/2ndQuadrant/repmgr/master/repmgr.conf.sample">repmgr.conf.sample</>.
+  </para>
+
+  <note>
+    <para>
+    The following parameters in the configuration file can be overridden with
+command line options:
+    <itemizedlist>
+     <listitem>
+       <simpara>`-L/--log-level` overrides `log_level` in repmgr.conf </simpara>
+     </listitem>
+     <listitem>
+       <simpara>`-b/--pg_bindir` overrides `pg_bindir` in repmgr.conf</simpara>
+     </listitem>
+    </itemizedlist>
+    </para>
+  </note>
+
+</sect1>

doc/configuration-file.sgml

@@ -0,0 +1,42 @@
+<sect1 id="configuration-file" xreflabel="configuration file location">
+  <title>Configuration file location</title>
+  <para>
+    `repmgr` and `repmgrd` use a common configuration file, by default called
+    `repmgr.conf` (although any name can be used if explicitly specified).
+    `repmgr.conf` must contain a number of required parameters, including
+    the database connection string for the local node and the location
+    of its data directory; other values will be inferred from defaults if
+    not explicitly supplied. See section `configuration file parameters`
+    for more details.
+  </para>
+
+  <para>
+   The configuration file will be searched for in the following locations:
+   <itemizedlist spacing="compact" mark="bullet">
+    <listitem>
+     <para>a configuration file specified by the `-f/--config-file` command line option</para>
+    </listitem>
+    <listitem>
+     <para>a location specified by the package maintainer (if `repmgr` was installed
+  from a package and the package maintainer has specified the configuration
+  file location)</para>
+    </listitem>
+    <listitem>
+     <para>`repmgr.conf` in the local directory</para>
+    </listitem>
+    <listitem>
+     <para>`/etc/repmgr.conf`</para>
+    </listitem>
+    <listitem>
+     <para>the directory reported by `pg_config --sysconfdir`</para>
+    </listitem>
+   </itemizedlist>
+  </para>
+
+  <para>
+    Note that if a file is explicitly specified with `-f/--config-file`, an error will
+    be raised if it is not found or not readable and no attempt will be made to check
+    default locations; this is to prevent `repmgr` unexpectedly reading the wrong file.
+  </para>
+
+</sect1>

doc/configuration.sgml

@@ -0,0 +1,7 @@
+<chapter id="configuration" xreflabel="Configuration">
+ <title>repmgr configuration</title>
+
+  &configuration-file;
+  &configuration-file-settings;
+
+</chapter>

doc/filelist.sgml

@@ -35,4 +35,7 @@
 <!ENTITY install-requirements      SYSTEM "install-requirements.sgml">
 <!ENTITY install-packages      SYSTEM "install-packages.sgml">
 <!ENTITY install-source      SYSTEM "install-source.sgml">
+<!ENTITY configuration      SYSTEM "configuration.sgml">
+<!ENTITY configuration-file      SYSTEM "configuration-file.sgml">
+<!ENTITY configuration-file-settings      SYSTEM "configuration-file-settings.sgml">
 <!ENTITY appendix-signatures      SYSTEM "appendix-signatures.sgml">

doc/install-requirements.sgml

@@ -1,4 +1,4 @@
- <sect1 id="install-requirements" xreflabel="installation requirements">
+<sect1 id="install-requirements" xreflabel="installation requirements">
   <title>Requirements for installing repmgr</title>
   <para>
     repmgr is developed and tested on Linux and OS X, but should work on any

doc/legal.sgml

@@ -1,53 +1,18 @@
 <!-- doc/src/sgml/legal.sgml -->
 
-<date>2016</date>
+<date>2017</date>
 
 <copyright>
- <year>1996-2016</year>
+ <year>2010-2017</year>
- <holder>The PostgreSQL Global Development Group</holder>
+ <holder>2ndQuadrant, Ltd.</holder>
 </copyright>
 
 <legalnotice id="legalnotice">
  <title>Legal Notice</title>
 
  <para>
-  <productname>Postgres BDR</productname> is Copyright &copy; 2013-2016
+  <productname>repmgr</productname> is Copyright &copy; 2010-2017
-  by the PostgreSQL Global Development Group.
+  by 2ndQuadrant, Ltd.
- </para>
-
- <para>
-  <productname>PostgreSQL</productname> is Copyright &copy; 1996-2016
-  by the PostgreSQL Global Development Group.
- </para>
-
- <para>
-  <productname>Postgres95</productname> is Copyright &copy; 1994-5
-  by the Regents of the University of California.
- </para>
-
- <para>
-  Permission to use, copy, modify, and distribute this software and
-  its documentation for any purpose, without fee, and without a
-  written agreement is hereby granted, provided that the above
-  copyright notice and this paragraph and the following two paragraphs
-  appear in all copies.
- </para>
-
- <para>
-  IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY
-  PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
-  DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS
-  SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA
-  HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- </para>
-
- <para>
-  THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
-  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE
-  PROVIDED HEREUNDER IS ON AN <quote>AS-IS</quote> BASIS, AND THE UNIVERSITY OF
-  CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
-  UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  </para>
 
 </legalnotice>

doc/repmgr.sgml

@@ -65,8 +65,13 @@
   &overview;
   &install;
  </part>
+
+ <part id="repmgr-administration-manual">
+  <title>repmgr administration manual</title>
+
+  &configuration;
+ </part>
+
  &appendix-signatures;
 
- <![%include-index;[&bookindex;]]>
- <![%include-xslt-index;[<index id="bookindex"></index>]]>
 </book>