diff --git a/ChangeLog b/ChangeLog index 3c8bd879..405950d8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -17021,3 +17021,5 @@ * Implemented show database status in rddbmgr(8). 2018-06-07 Fred Gleason * Implemented the '--check' command in rddbmgr(8). +2018-06-08 Fred Gleason + * Added an rddbmgr(8) man page. diff --git a/docs/manpages/Makefile.am b/docs/manpages/Makefile.am index 21123aa6..529be382 100644 --- a/docs/manpages/Makefile.am +++ b/docs/manpages/Makefile.am @@ -34,16 +34,18 @@ all-local: rdclilogedit.1\ rdconvert.1\ rddbcheck.8\ + rddbmgr.8\ + rdexport.1\ + rdimport.1\ rdmarkerset.8\ rdrender.1\ rdrevert.8\ - rdexport.1\ - rdimport.1\ rmlsend.1 man_MANS = rdclilogedit.1\ rdconvert.1\ rddbcheck.8\ + rddbmgr.8\ rdexport.1\ rdimport.1\ rdmarkerset.8\ @@ -57,16 +59,18 @@ EXTRA_DIST = rdclilogedit.1\ rdconvert.xml\ rddbcheck.8\ rddbcheck.xml\ + rddbmgr.8\ + rddbmgr.xml\ + rdexport.1\ + rdexport.xml\ + rdimport.1\ + rdimport.xml\ rdmarkerset.8\ rdmarkerset.xml\ rdrender.1\ rdrender.xml\ rdrevert.8\ rdrevert.xml\ - rdexport.1\ - rdexport.xml\ - rdimport.1\ - rdimport.xml\ rmlsend.1\ rmlsend.xml diff --git a/docs/manpages/rddbmgr.xml b/docs/manpages/rddbmgr.xml new file mode 100644 index 00000000..b8c6c118 --- /dev/null +++ b/docs/manpages/rddbmgr.xml @@ -0,0 +1,499 @@ + + + + + rddbmgr + 8 + June 2018 + Linux Audio Manual + + + rddbmgr + Tool for managing Rivendell databases + + + + + Fred + Gleason + fredg@paravelsystems.com + + Application Author + + + + + + + rddbmgr + OPTIONS + + + + + Description + + rddbmgr8 is a command-line + tool used for managing (creating, modifying and checking) Rivendell + databases. When invoked without any options, + rddbmgr8 will attempt to connect + to the database specified in + rd.conf5, print a single + line summary of its status to standard output and then exit. + + + rddbmgr8 can be invoked with + one of three primary modes, as follows: + + + + + + + Check an existing Rivendell database for errors and inconsistencies. + + + + + + + + Initialize a new Rivendell database in an empty database container. + + + + + + + + Modify the schema of an existing Rivendell database. + + + + + + + General Options + + The following options can be used with any of the commands: + + + + hostname + + + Connect to the database on hostname. + Default is to use the corresponding value found in the + [mySQL] section of + rd.conf5. + + + + + username + + + Connect to the database as user username. + Default is to use the corresponding value found in the + [mySQL] section of + rd.conf5. + + + + + password + + + Connect to the database using password + hostname. + Default is to use the corresponding value found in the + [mySQL] section of + rd.conf5. + + + + + dbname + + + Connect to the database named dbname. + Default is to use the corresponding value found in the + [mySQL] section of + rd.conf5. + + + + + driver + + + Connect to the database using the driver + Qt driver. + Default is to use the corresponding value found in the + [mySQL] section of + rd.conf5. + + + + + engine + + + Use table engine engine when + creating new DB tables. + Default is to use the corresponding value found in the + [mySQL] section of + rd.conf5. + + + + + charset + + + Configure new tables to use character set + charset. + Default is to use the corresponding value found in the + [mySQL] section of + rd.conf5. + + + + + collation + + + Configure new tables to use collation + collation. + Default is to use the corresponding value found in the + [mySQL] section of + rd.conf5. + + + + + + + Consistency Checking and Audio Recovery + + The switch causes + rddbmgr8 to run a series of + consistency checks of an existing database and audio store. The database + to be checked must at the native schema of the installed Rivendell version. + + + The following options can be used in conjunction with + : + + + + + dir-name + + + + Move any "orphaned" audio files found to the + dir-name directory. + + + + + + + + + + + Automatically answer all interactive prompts with + No. + + + + + + + grp-name + + + + Move carts with missing/invalid GROUP information to the + grp-name group. + + + + + + + target + + + + 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. + + + The target value can be one of the + following: + + + + + Cart number --e.g. 123456 + + + + Check hashs for all cuts within the specified cart. + + + + + + Cart/cut specification --e.g. 123456_001 + + + + Check the hash for the specified cut. + + + + + + ALL + + + + Check hashes for all cuts in the audio store. + + + + + + + + + + dir-name + + + + Scan the files in the directory dir-name + and copy/rename them into the Rivendell audio store if their SHA-1 + hash matches that for one or more Rivendell cuts. + + + + + + + + + + + When given along with , move the + audio data to the Rivendell audio store rather than copying it + --i.e. copy the audio data, then delete the original. + + + + + + + + + + + Automatically answer all interactive prompts with + Yes. + + + + + + + Database Creation + + The switch causes + rddbmgr8 to initialize a new + Rivendell database at the location specified by + rd.conf5 and/or the relevant + general options (see above). The location so specified must contain an + empty database, otherwise + rddbmgr8 will exit + with an error. + + + When creating an empty database for initialization by + rddbmgr8, the following + permissions should be enabled: + + + + + Select + + + + + Insert + + + + + Update + + + + + Delete + + + + + Create + + + + + Drop + + + + + References + + + + + Index + + + + + Alter + + + + + Create Temporary Tables + + + + + Lock Tables + + + + + The following options can be used in conjunction with + : + + + + + + + + + In addition to initializing a database, also generate the audio + for the test-tone cart in the audio store. + + + + + + schema + + + + Create a database with a schema of + schema [integer], which must be + between 243 and the native schema (inclusive). + + + + + + version + + + + Create a database with a schema appropriate for Rivendell version + version [X.Y.Z], which must be + between 2.10.0 and the native Rivendell + version (inclusive). + + + + + + If neither nor + options are given, the database created will have the native schema of + the installed version of Rivendell. + + + + Database Modification + + The switch causes + rddbmgr8 to modify the + schema of the indicated database, in accordance with the following + options: + + + + + schema + + + + Change the database schema to + schema [integer], which must be + between 243 and the native schema (inclusive). + + + + + + version + + + + Change the database schema to that appropriate for Rivendell version + version [X.Y.Z], which must be + between 2.10.0 and the native Rivendell + version (inclusive). + + + + + + If neither nor + options are given, the database will be changed to native schema of + the installed version of Rivendell. + + + + When reverting the schema of a database, the contents of fields that + do not exist in the reverted schema will be irrecoverably lost! + + + + + See Also + + + rdmarkerset8 + + + + + + +