2024-10-08 Fred Gleason <fredg@paravelsystems.com>

* Added a 'rdautoback(8) man page.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>

ChangeLog

@@ -24903,3 +24903,5 @@
 2024-10-08 Fred Gleason <fredg@paravelsystems.com>
 	* Fixed a bug in rdautoback(8) that caused an error to be generated
 	if the destination drive was already mounted.
+2024-10-08 Fred Gleason <fredg@paravelsystems.com>
+	* Added a 'rdautoback(8) man page.

docs/manpages/Makefile.am

@@ -54,6 +54,9 @@ all-local:	rdadmin.1\
                 rdalsaconfig.1\
                 rdalsaconfig.html\
                 rdalsaconfig.pdf\
+                rdautoback.8\
+                rdautoback.html\
+                rdautoback.pdf\
                 rdclilogedit.1\
                 rdclilogedit.html\
                 rdclilogedit.pdf\
@@ -106,6 +109,7 @@ all-local:	rdadmin.1\
 man_MANS = rdadmin.1\
            rdairplay.1\
            rdalsaconfig.1\
+           rdautoback.8\
            rdclilogedit.1\
            rd.conf.5\
            rdconvert.1\
@@ -136,6 +140,10 @@ EXTRA_DIST = exitcodes.xml\
              rdalsaconfig.html\
              rdalsaconfig.pdf\
              rdalsaconfig.xml\
+             rdautoback.8\
+             rdautoback.html\
+             rdautoback.pdf\
+             rdautoback.xml\
              rdclilogedit.1\
              rdclilogedit.html\
              rdclilogedit.pdf\

docs/manpages/rdautoback.xml

@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
+  <!--
+      Header
+  -->
+  <refmeta>
+    <refentrytitle>rdautoback</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo class='source'>October 2024</refmiscinfo>
+    <refmiscinfo class='manual'>Linux Audio Manual</refmiscinfo>
+  </refmeta>
+  <refnamediv>
+    <refname>rdautoback</refname>
+    <refpurpose>Tool for making coherent Rivendell backups</refpurpose>
+  </refnamediv>
+  <info>
+    <author>
+      <personname>
+	<firstname>Fred</firstname>
+	<surname>Gleason</surname>
+	<email>fredg@paravelsystems.com</email>
+      </personname>
+      <contrib>Application Author</contrib>
+    </author>
+  </info>
+
+  <!--
+      Body
+  -->
+  <refsynopsisdiv id='synopsis'>
+    <cmdsynopsis>
+      <command>rdautoback</command>
+      <arg choice='req'><replaceable>mount-pt</replaceable></arg>
+      <sbr/>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id='description'><title>Description</title>
+  <para>
+    <command>rdautoback</command><manvolnum>8</manvolnum> is a command-line
+    tool used for for creating coherent backups of the data
+    (database+audiostore) used by the Rivendell Radio Automation System.
+  </para>
+  <para>
+    <command>rdautoback</command><manvolnum>8</manvolnum> takes exactly one
+    argument: the name of a storage mount point that has been configured
+    in <command>fstab</command><manvolnum>5</manvolnum>. Upon startup,
+    <command>rdautoback</command><manvolnum>8</manvolnum> will attempt to
+    mount the specified mount point and make a copy of the following
+    Rivendell data elements:
+  </para>
+  <itemizedlist mark="opencircle">
+    <listitem>
+      <para>
+	The Rivendell database specified by the current
+	<command>rd.conf</command><manvolnum>5</manvolnum>
+	configuration file.
+      </para>
+    </listitem>
+    <listitem>
+      <para>
+	The contents of the Rivendell audiostore, located at
+	<computeroutput>/var/snd</computeroutput>.
+      </para>
+    </listitem>
+  </itemizedlist>
+  <para>
+    If a previous backup is already present on the target backup device,
+    it will be incrementally updated so as to be a precise backup of the
+    current data. After completing the backup,
+    <command>rdautoback</command><manvolnum>8</manvolnum> will automatically
+    unmount the backup device and remove its mount point.
+  </para>
+  </refsect1>
+
+  <refsect1 id='see_also'><title>See Also</title>
+  <para>
+  <citerefentry>
+    <refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum>
+  </citerefentry>
+  ,
+  <citerefentry>
+    <refentrytitle>rd.conf</refentrytitle><manvolnum>5</manvolnum>
+  </citerefentry>
+  </para>
+  </refsect1>
+
+
+</refentry>
+