mirror of
https://github.com/ElvishArtisan/rivendell.git
synced 2025-06-03 17:42:32 +02:00
2017-11-01 Fred Gleason <fredg@paravelsystems.com>
* Added an rmlsend(1) man page. * Revised the "Interfacing with the Linux Ecosystem" chapter in the Operations Guide to include all command-line utilities.
This commit is contained in:
Fred Gleason
parent
eb49fdaa73
commit
554687cfa7
@ -16201,3 +16201,7 @@
|
||||
Operations Guide.
|
||||
* Applied structural markup to the 'voicetracking' chapter of the
|
||||
Operations Guide.
|
||||
2017-11-01 Fred Gleason <fredg@paravelsystems.com>
|
||||
* Added an rmlsend(1) man page.
|
||||
* Revised the "Interfacing with the Linux Ecosystem" chapter in the
|
||||
Operations Guide to include all command-line utilities.
|
||||
|
||||
@ -38,7 +38,8 @@ all-local: rdclilogedit.1\
|
||||
rdrender.1\
|
||||
rdrevert.8\
|
||||
rdexport.1\
|
||||
rdimport.1
|
||||
rdimport.1\
|
||||
rmlsend.1
|
||||
|
||||
man_MANS = rdclilogedit.1\
|
||||
rdconvert.1\
|
||||
@ -47,7 +48,8 @@ man_MANS = rdclilogedit.1\
|
||||
rdimport.1\
|
||||
rdmarkerset.8\
|
||||
rdrender.1\
|
||||
rdrevert.8
|
||||
rdrevert.8\
|
||||
rmlsend.1
|
||||
|
||||
EXTRA_DIST = rdclilogedit.1\
|
||||
rdclilogedit.xml\
|
||||
@ -64,7 +66,9 @@ EXTRA_DIST = rdclilogedit.1\
|
||||
rdexport.1\
|
||||
rdexport.xml\
|
||||
rdimport.1\
|
||||
rdimport.xml
|
||||
rdimport.xml\
|
||||
rmlsend.1\
|
||||
rmlsend.xml
|
||||
|
||||
CLEANFILES = *~
|
||||
MAINTAINERCLEANFILES = *~\
|
||||
|
||||
101
docs/manpages/rmlsend.xml
Normal file
101
docs/manpages/rmlsend.xml
Normal file
@ -0,0 +1,101 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>rmlsend</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
<refmiscinfo class='source'>November 2017</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Linux Audio Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rmlsend</refname>
|
||||
<refpurpose>Send Rivendell Macro Language (RML) commands</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>rmlsend</command>
|
||||
<arg choice='opt'><userinput>--from-file=</userinput><replaceable>filename</replaceable></arg>
|
||||
<arg choice='opt'><userinput>--to-host=</userinput><replaceable>hostname</replaceable></arg>
|
||||
<arg choice='opt'><userinput>--to-port=</userinput><replaceable>port</replaceable></arg>
|
||||
<arg choice='opt'><replaceable>rml</replaceable></arg>
|
||||
<sbr/>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</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,
|
||||
<command>rmlsend</command><manvolnum>1</manvolnum> will come up in GUI
|
||||
mode, otherwise it will attempt to perform the specified operation and
|
||||
then exit.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='options'><title>Options</title>
|
||||
<variablelist remap='TP'>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--from-file=</option><replaceable>filename</replaceable>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Take the command(s) to send from <replaceable>filename</replaceable>,
|
||||
rather than specifying them on the command-line. If
|
||||
<userinput>-</userinput> is specified as
|
||||
<replaceable>filename</replaceable>, the commands will be read
|
||||
from standard input.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--to-host=</option><replaceable>host</replaceable>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Send the specified command(s) to <replaceable>host</replaceable>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--set-port=</option><replaceable>port</replaceable>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Send the specified command(s) to UDP port
|
||||
<replaceable>port</replaceable>. Default value is
|
||||
<userinput>5858</userinput>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
@ -5807,46 +5807,126 @@
|
||||
|
||||
<chapter id="chapter.interfacing_with_the_linux_ecosystem__command_line_utilities">
|
||||
<title>Interfacing with the Linux Ecosystem: Command-Line Utilities</title>
|
||||
<sect1 id="sect.interfacing_with_the_linux_ecosystem__command_line_utilities.rmlsend">
|
||||
<title>RMLSend</title>
|
||||
<sect1 id="sect.interfacing_with_the_linux_ecosystem__command_line_utilities">
|
||||
<para>
|
||||
RMLSend 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 (see
|
||||
Illustration 65).
|
||||
</para>
|
||||
<para>
|
||||
The Sent To: should have the name or IP address of the system to which
|
||||
to send the RML. Dest: controls the method by which the command will
|
||||
be sent. 'RML' is standard RML transmission that returns an echo code
|
||||
to indicate success/failure. 'RML (No echo)' does not return an echo
|
||||
code, while 'Set Port' allows the destination UDP port to be set
|
||||
(useful for controlling Rivendell from outside firewalls). Command:
|
||||
is the RML command to be sent, and Response: will show any echo code
|
||||
returned from the remote system (or 'No response' if no reply is
|
||||
received). Touching the Send Command button actually sends the command.
|
||||
</para>
|
||||
<para>
|
||||
RMLSend also has a full-featured command-line facility that allows
|
||||
Rivendell commands to be sent using the standard Linux CLI utilities.
|
||||
Consult the <command>rmlsend</command><manvolnum>1</manvolnum> man
|
||||
page for details.
|
||||
</para>
|
||||
</sect1>
|
||||
<sect1 id="sect.interfacing_with_the_linux_ecosystem__command_line_utilities.rdimport">
|
||||
<title>RDImport</title>
|
||||
<para>
|
||||
RDImport 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. Consult
|
||||
the <command>rdimport</command><manvolnum>1</manvolnum> man page for
|
||||
details.
|
||||
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>
|
||||
<sect2 id="sect.interfacing_with_the_linux_ecosystem__command_line_utilities.rdclilogedit">
|
||||
<title><command>rdclilogedit</command><manvolnum>1</manvolnum></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>
|
||||
</sect2>
|
||||
<sect2 id="sect.interfacing_with_the_linux_ecosystem__command_line_utilities.rdconvert">
|
||||
<title><command>rdconvert</command><manvolnum>1</manvolnum></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>
|
||||
</sect2>
|
||||
<sect2 id="sect.interfacing_with_the_linux_ecosystem__command_line_utilities.rddbcheck">
|
||||
<title><command>rddbcheck</command><manvolnum>8</manvolnum></title>
|
||||
<para>
|
||||
<command>rddbcheck</command><manvolnum>8</manvolnum> is a
|
||||
command-line interface (CLI) program that can be used to check a
|
||||
Rivendell database for consistency and correct errors found.
|
||||
</para>
|
||||
<para>
|
||||
Full documentation is available by doing
|
||||
<userinput>man 8 rddbcheck</userinput>.
|
||||
</para>
|
||||
</sect2>
|
||||
<sect2 id="sect.interfacing_with_the_linux_ecosystem__command_line_utilities.rdexport">
|
||||
<title><command>rdexport</command><manvolnum>1</manvolnum></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>
|
||||
</sect2>
|
||||
<sect2 id="sect.interfacing_with_the_linux_ecosystem__command_line_utilities.rdimport">
|
||||
<title><command>rdimport</command><manvolnum>1</manvolnum></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>
|
||||
</sect2>
|
||||
<sect2 id="sect.interfacing_with_the_linux_ecosystem__command_line_utilities.rdmarkerset">
|
||||
<title><command>rdmarkerset</command><manvolnum>8</manvolnum></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>
|
||||
</sect2>
|
||||
<sect2 id="sect.interfacing_with_the_linux_ecosystem__command_line_utilities.rdrevert">
|
||||
<title><command>rdrevert</command><manvolnum>8</manvolnum></title>
|
||||
<para>
|
||||
<command>rdrevert</command><manvolnum>8</manvolnum> is a
|
||||
command-line interface (CLI) program that can be used to revert a
|
||||
Rivendell database to a previous schema version.
|
||||
</para>
|
||||
<para>
|
||||
Full documentation is available by doing
|
||||
<userinput>man 8 rdrevert</userinput>.
|
||||
</para>
|
||||
</sect2>
|
||||
<sect2 id="sect.rinterfacing_with_the_linux_ecosystem__command_line_utilities.mlsend_1_">
|
||||
<title><command>rmlsend</command><manvolnum>1</manvolnum></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 (see
|
||||
FIXME).
|
||||
</para>
|
||||
<para>
|
||||
Full documentation is available by doing
|
||||
<userinput>man 1 rmlsend</userinput>.
|
||||
</para>
|
||||
</sect2>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
||||
|
||||
@ -359,6 +359,7 @@ rm -rf $RPM_BUILD_ROOT
|
||||
%{_mandir}/man1/rdexport.1.gz
|
||||
%{_mandir}/man1/rdimport.1.gz
|
||||
%{_mandir}/man1/rdrender.1.gz
|
||||
%{_mandir}/man1/rmlsend.1.gz
|
||||
%{_mandir}/man8/rddbcheck.8.gz
|
||||
%{_mandir}/man8/rdmarkerset.8.gz
|
||||
%{_mandir}/man8/rdrevert.8.gz
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user