From 554687cfa75991daaba2eb2d265230cc5dd9f7a4 Mon Sep 17 00:00:00 2001 From: Fred Gleason Date: Wed, 1 Nov 2017 09:00:06 -0400 Subject: [PATCH] 2017-11-01 Fred Gleason * Added an rmlsend(1) man page. * Revised the "Interfacing with the Linux Ecosystem" chapter in the Operations Guide to include all command-line utilities. --- ChangeLog | 4 + docs/manpages/Makefile.am | 10 ++- docs/manpages/rmlsend.xml | 101 ++++++++++++++++++++++++ docs/opsguide/opsguide.xml | 156 ++++++++++++++++++++++++++++--------- rivendell.spec.in | 1 + 5 files changed, 231 insertions(+), 41 deletions(-) create mode 100644 docs/manpages/rmlsend.xml diff --git a/ChangeLog b/ChangeLog index 13ebbf14..c8ddd8f0 100644 --- a/ChangeLog +++ b/ChangeLog @@ -16201,3 +16201,7 @@ Operations Guide. * Applied structural markup to the 'voicetracking' chapter of the Operations Guide. +2017-11-01 Fred Gleason + * Added an rmlsend(1) man page. + * Revised the "Interfacing with the Linux Ecosystem" chapter in the + Operations Guide to include all command-line utilities. diff --git a/docs/manpages/Makefile.am b/docs/manpages/Makefile.am index 7901615c..21123aa6 100644 --- a/docs/manpages/Makefile.am +++ b/docs/manpages/Makefile.am @@ -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 = *~\ diff --git a/docs/manpages/rmlsend.xml b/docs/manpages/rmlsend.xml new file mode 100644 index 00000000..e1625288 --- /dev/null +++ b/docs/manpages/rmlsend.xml @@ -0,0 +1,101 @@ + + + + + rmlsend + 1 + November 2017 + Linux Audio Manual + + + rmlsend + Send Rivendell Macro Language (RML) commands + + + + + Fred + Gleason + fredg@paravelsystems.com + + Application Author + + + + + + + rmlsend + --from-file=filename + --to-host=hostname + --to-port=port + rml + + + + + Description + + rmlsend1 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). + + + If started with no arguments, + rmlsend1 will come up in GUI + mode, otherwise it will attempt to perform the specified operation and + then exit. + + + + Options + + + + filename + + + + Take the command(s) to send from filename, + rather than specifying them on the command-line. If + - is specified as + filename, the commands will be read + from standard input. + + + + + + + host + + + + Send the specified command(s) to host. + + + + + + + port + + + + Send the specified command(s) to UDP port + port. Default value is + 5858. + + + + + + + + + diff --git a/docs/opsguide/opsguide.xml b/docs/opsguide/opsguide.xml index 8f23693c..24136d80 100644 --- a/docs/opsguide/opsguide.xml +++ b/docs/opsguide/opsguide.xml @@ -5807,46 +5807,126 @@ Interfacing with the Linux Ecosystem: Command-Line Utilities - - RMLSend + - 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). - - - If started with no arguments, RMLSend will come up in GUI mode (see - Illustration 65). - - - 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. - - - RMLSend also has a full-featured command-line facility that allows - Rivendell commands to be sent using the standard Linux CLI utilities. - Consult the rmlsend1 man - page for details. - - - - RDImport - - 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 rdimport1 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. + + <command>rdclilogedit</command><manvolnum>1</manvolnum> + + rdclilogedit1 is a + command-line interface (CLI) program that can be used to edit + Rivendell logs. It is loosely modeled after the venerable + ed1 command-line editor + and so is particularly well suited for use in scripting + environments. + + + Full documentation is available by doing + man 1 rdclilogedit. + + + + <command>rdconvert</command><manvolnum>1</manvolnum> + + rdconvert1 is a command-line + interface (CLI) program that can be used to convert an audio file + into a different format. + + + Full documentation is available by doing + man 1 rdconvert. + + + + <command>rddbcheck</command><manvolnum>8</manvolnum> + + rddbcheck8 is a + command-line interface (CLI) program that can be used to check a + Rivendell database for consistency and correct errors found. + + + Full documentation is available by doing + man 8 rddbcheck. + + + + <command>rdexport</command><manvolnum>1</manvolnum> + + rdexport1 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. + + + Full documentation is available by doing + man 1 rdexport. + + + + <command>rdimport</command><manvolnum>1</manvolnum> + + rdimport1 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. + + + Full documentation is available by doing + man 1 rdimport. + + + + <command>rdmarkerset</command><manvolnum>8</manvolnum> + + rdmarkerset8 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. + + + Full documentation is available by doing + man 8 rdmarkerset. + + + + <command>rdrevert</command><manvolnum>8</manvolnum> + + rdrevert8 is a + command-line interface (CLI) program that can be used to revert a + Rivendell database to a previous schema version. + + + Full documentation is available by doing + man 8 rdrevert. + + + + <command>rmlsend</command><manvolnum>1</manvolnum> + + rmlsend1 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). + + + If started with no arguments, RMLSend will come up in GUI mode (see + FIXME). + + + Full documentation is available by doing + man 1 rmlsend. + + diff --git a/rivendell.spec.in b/rivendell.spec.in index eabecfe1..5badc01e 100644 --- a/rivendell.spec.in +++ b/rivendell.spec.in @@ -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