2018-06-08 Fred Gleason <fredg@paravelsystems.com>

* Removed rddbcheck(8).
	* Removed rdrevert(8).
This commit is contained in:
Fred Gleason
2018-06-08 12:47:46 +00:00
parent fa307d948c
commit a6bed61842
13 changed files with 5 additions and 3186 deletions

View File

@@ -33,32 +33,26 @@
all-local: rdclilogedit.1\
rdconvert.1\
rddbcheck.8\
rddbmgr.8\
rdexport.1\
rdimport.1\
rdmarkerset.8\
rdrender.1\
rdrevert.8\
rmlsend.1
man_MANS = rdclilogedit.1\
rdconvert.1\
rddbcheck.8\
rddbmgr.8\
rdexport.1\
rdimport.1\
rdmarkerset.8\
rdrender.1\
rdrevert.8\
rmlsend.1
EXTRA_DIST = rdclilogedit.1\
rdclilogedit.xml\
rdconvert.1\
rdconvert.xml\
rddbcheck.8\
rddbcheck.xml\
rddbmgr.8\
rddbmgr.xml\
rdexport.1\
@@ -69,8 +63,6 @@ EXTRA_DIST = rdclilogedit.1\
rdmarkerset.xml\
rdrender.1\
rdrender.xml\
rdrevert.8\
rdrevert.xml\
rmlsend.1\
rmlsend.xml

View File

@@ -1,210 +0,0 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
Header
-->
<refmeta>
<refentrytitle>rddbcheck</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class='source'>March 2017</refmiscinfo>
<refmiscinfo class='manual'>Linux Audio Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rddbcheck</refname>
<refpurpose>Tool for checking and repairing Rivendell databases</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>rddbcheck</command>
<arg choice='opt'><replaceable>OPTIONS</replaceable></arg>
<sbr/>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'><title>Description</title>
<para>
<command>rddbcheck</command><manvolnum>8</manvolnum> is a command-line
tool for checking the consistency of a Rivendell database and (perhaps)
repairing any inconsistencies found. When invoked without any options,
<command>rddbcheck</command><manvolnum>8</manvolnum> will run a set of
consistency checks (with the exception of the check of the SHA-1 hashes),
report any problems found and offer to repair the problem. To force a
SHA-1 hash check as well, see the <option>--rehash</option> option below.
</para>
</refsect1>
<refsect1 id='consistency_check_options'><title>Consistency Check Options</title>
<variablelist remap='TP'>
<varlistentry>
<term>
<option>--dump-cuts-dir=</option><replaceable>dir-name</replaceable>
</term>
<listitem>
<para>
Move any &quot;orphaned&quot; audio files found to the
<replaceable>dir-name</replaceable> directory.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--no</option>
</term>
<listitem>
<para>
Automatically answer all interactive prompts with
<userinput>No</userinput>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--orphan-group=</option><replaceable>grp-name</replaceable>
</term>
<listitem>
<para>
Move carts with missing/invalid GROUP information to the
<replaceable>grp-name</replaceable> group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--rehash=</option><replaceable>target</replaceable>
</term>
<listitem>
<para>
Generate SHA-1 hashes from the specified files in the audio store
and validate them against the values stored in the database. This
is an inherently expensive operation that may require a
significant amount of time to complete as each audio
file to be checked must be opened and read in its entirety.
</para>
<para>
The <replaceable>target</replaceable> value can be one of the
following:
</para>
<variablelist>
<varlistentry>
<term>
Cart number --e.g. <userinput>123456</userinput>
</term>
<listitem>
<para>
Check hashs for all cuts within the specified cart.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
Cart/cut specification --e.g. <userinput>123456_001</userinput>
</term>
<listitem>
<para>
Check the hash for the specified cut.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<userinput>ALL</userinput>
</term>
<listitem>
<para>
Check hashes for all cuts in the audio store.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--user=</option><replaceable>user-name</replaceable>
</term>
<listitem>
<para>
Use the <replaceable>user-name</replaceable> Rivendell user.
Default value is <userinput>user</userinput>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--yes</option>
</term>
<listitem>
<para>
Automatically answer all interactive prompts with
<userinput>Yes</userinput>.
</para>
</listitem>
</varlistentry>
</variablelist>
<refsect1 id='audio_recovery_options'><title>Audio Recovery Options</title>
<variablelist remap='TP'>
<varlistentry>
<term>
<option>--relink-audio=</option><replaceable>dir-name</replaceable>
</term>
<listitem>
<para>
Scan the files in the directory <replaceable>dir-name</replaceable>
and copy/rename them into the Rivendell audio store if their SHA-1
hash matches that for one or more Rivendell cuts.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--relink-audio-move</option>
</term>
<listitem>
<para>
When given along with <option>--relink-audio</option>, move the
audio data to the Rivendell audio store rather than copying it
--i.e. copy the audio data, then delete the original.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='see_also'><title>See Also</title>
<para>
<citerefentry>
<refentrytitle>rdmarkerset</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
<literal>,</literal>
<citerefentry>
<refentrytitle>rdrevert</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
</refsect1>
</refentry>

View File

@@ -1,84 +0,0 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
Header
-->
<refmeta>
<refentrytitle>rdrevert</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class='source'>March 2016</refmiscinfo>
<refmiscinfo class='manual'>Linux Audio Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rdrevert</refname>
<refpurpose>Revert a Rivendell database to a previous schema version</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>rdrevert</command>
<arg choice='opt'><replaceable>OPTIONS</replaceable></arg>
<arg choice='opt'><userinput>--set-schema=</userinput><replaceable>schema</replaceable></arg>
<arg choice='opt'><userinput>--set-version=</userinput><replaceable>version</replaceable></arg>
<sbr/>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'><title>Description</title>
<para>
<command>rdrevert</command><manvolnum>8</manvolnum> can be used to revert
the schema of a Rivendell database to an earlier version, specified as
either a Rivendell version string or an absolute schema version number.
If no arguments are given, <command>rdrevert</command><manvolnum>8</manvolnum>
will print the current database schema version to standard output and
then exit.
</para>
</refsect1>
<refsect1 id='options'><title>Options</title>
<variablelist remap='TP'>
<varlistentry>
<term>
<option>--set-schema=</option><replaceable>schema</replaceable>
</term>
<listitem>
<para>
Set the version number of the schema to which to revert.
<command>rdrevert</command><manvolnum>8</manvolnum> can revert back
up to schema version 242 (v2.10.0) inclusive. Attempting to
revert to an earlier schema than 242 will generate an
<computeroutput>unsupported schema</computeroutput> error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--set-version=</option><replaceable>version</replaceable>
</term>
<listitem>
<para>
Determine the schema to which to revert on the basis of the
specified Rivendell version --e.g. <userinput>2.10.3</userinput>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>