mirror of
https://github.com/ElvishArtisan/rivendell.git
synced 2025-05-19 14:43:30 +02:00
34faf369b9
* Added the 'xlink' namespace to all chapters of the Operations Guide. Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
134 lines
5.2 KiB
XML
134 lines
5.2 KiB
XML
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="chapter.utilities">
|
|
<title>Interfacing with the Linux Ecosystem: Command-Line Utilities</title>
|
|
<para>
|
|
Rivendell includes a number of command-line utilities. Some of these
|
|
can be used to perform efficient "bulk" operations --e.g.
|
|
import thousands of audio files in one command -- while others are
|
|
useful in various aspects of system maintenance. This section provides
|
|
a brief overview of the available utilities; full documentation for each
|
|
is available via the Linux man page facility.
|
|
</para>
|
|
<sect1 xml:id="sect.utilities.rdclilogedit">
|
|
<title>rdclilogedit(1)</title>
|
|
<para>
|
|
<command>rdclilogedit</command><manvolnum>1</manvolnum> is a
|
|
command-line interface (CLI) program that can be used to edit
|
|
Rivendell logs. It is loosely modeled after the venerable
|
|
<command>ed</command><manvolnum>1</manvolnum> command-line editor
|
|
and so is particularly well suited for use in scripting
|
|
environments.
|
|
</para>
|
|
<para>
|
|
Full documentation is available by doing
|
|
<userinput>man 1 rdclilogedit</userinput>.
|
|
</para>
|
|
</sect1>
|
|
<sect1 xml:id="sect.utilities.rdconvert">
|
|
<title>rdconvert(1)</title>
|
|
<para>
|
|
<command>rdconvert</command><manvolnum>1</manvolnum> is a command-line
|
|
interface (CLI) program that can be used to convert an audio file
|
|
into a different format.
|
|
</para>
|
|
<para>
|
|
Full documentation is available by doing
|
|
<userinput>man 1 rdconvert</userinput>.
|
|
</para>
|
|
</sect1>
|
|
<sect1 xml:id="sect.utilities.rddbmgr">
|
|
<title>rddbmgr(8)</title>
|
|
<para>
|
|
<command>rddbmgr</command><manvolnum>8</manvolnum> is a command-line
|
|
interface (CLI) program that manages Rivendell databases. It
|
|
includes extensive capabilities for creating, checking and modifying
|
|
such databases.
|
|
</para>
|
|
<para>
|
|
Full documentation is available by doing
|
|
<userinput>man 8 rddbmgr</userinput>.
|
|
</para>
|
|
</sect1>
|
|
<sect1 xml:id="sect.utilities.rdexport">
|
|
<title>rdexport(1)</title>
|
|
<para>
|
|
<command>rdexport</command><manvolnum>1</manvolnum> is a command-line
|
|
interface (CLI) program that can be used to
|
|
export audio material from the Rivendell Library. It is particularly
|
|
useful in situations where a large number of audio files need to be
|
|
exported in an automated fashion, and is capable of exporting
|
|
thousands of files with a single command-line invocation.
|
|
</para>
|
|
<para>
|
|
Full documentation is available by doing
|
|
<userinput>man 1 rdexport</userinput>.
|
|
</para>
|
|
</sect1>
|
|
<sect1 xml:id="sect.utilities.rdimport">
|
|
<title>rdimport(1)</title>
|
|
<para>
|
|
<command>rdimport</command><manvolnum>1</manvolnum> is a command-line
|
|
interface (CLI) program that can be used to
|
|
import audio material into the Rivendell Library. It is particularly
|
|
useful in situations where a large number of audio files need to be
|
|
imported in an automated fashion, and is capable of importing
|
|
thousands of files with a single command-line invocation.
|
|
</para>
|
|
<para>
|
|
Full documentation is available by doing
|
|
<userinput>man 1 rdimport</userinput>.
|
|
</para>
|
|
</sect1>
|
|
<sect1 xml:id="sect.utilities.rdlogmanager">
|
|
<title>rdlogmanager(1)</title>
|
|
<para>
|
|
<command>rdlogmanager</command><manvolnum>1</manvolnum> is a Rivendell
|
|
module for generating logs and reports. When invoked with no arguments,
|
|
it will start up in GUI mode, described in
|
|
<xref linkend="chapter.rdlogmanager" />.
|
|
However, it can also be used in "batch" mode to generate and
|
|
merge logs and reports by means of its command-line interface.
|
|
</para>
|
|
<para>
|
|
Full documentation of rdlogmanager's command line interface is available
|
|
by doing <userinput>man 1 rdlogmanager</userinput>.
|
|
</para>
|
|
</sect1>
|
|
<sect1 xml:id="sect.utilities.rdmarkerset">
|
|
<title>rdmarkerset(8)</title>
|
|
<para>
|
|
<command>rdmarkerset</command><manvolnum>8</manvolnum> is a
|
|
command-line interface (CLI) program that can be used to set or
|
|
alter audio cut markers in the Rivendell Radio Automation System.
|
|
It is capable of altering multiple cuts in a single operation.
|
|
</para>
|
|
<para>
|
|
Full documentation is available by doing
|
|
<userinput>man 8 rdmarkerset</userinput>.
|
|
</para>
|
|
</sect1>
|
|
<sect1 xml:id="sect.utilities.mlsend_1_">
|
|
<title>rmlsend(1)</title>
|
|
<para>
|
|
<command>rmlsend</command><manvolnum>1</manvolnum> is a small
|
|
utility that can be used to send RML commands to a
|
|
local or remote Rivendell host. It can operate in two modes: GUI or
|
|
a command line interface (CLI).
|
|
</para>
|
|
<para>
|
|
If started with no arguments, RMLSend will come up in GUI mode.
|
|
</para>
|
|
<para>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata align="center" fileref="utilities.rmlsend_screenshot.png" width="140mm" depth="44mm"/>
|
|
</imageobject>
|
|
<caption><para>RMLSend in GUI Mode</para></caption>
|
|
</mediaobject>
|
|
</para>
|
|
<para>
|
|
Full documentation is available by doing
|
|
<userinput>man 1 rmlsend</userinput>.
|
|
</para>
|
|
</sect1>
|
|
</chapter>
|