From 00b1630b893a934851e803ea05e31ebbc1cebd68 Mon Sep 17 00:00:00 2001 From: Fred Gleason Date: Wed, 30 Oct 2019 13:50:17 -0400 Subject: [PATCH] 2019-10-30 Fred Gleason * Added an rdsoftkeys(1) man page. --- ChangeLog | 2 + docs/manpages/Makefile.am | 10 ++- docs/manpages/rdsoftkeys.xml | 168 +++++++++++++++++++++++++++++++++++ rivendell.spec.in | 2 + 4 files changed, 179 insertions(+), 3 deletions(-) create mode 100644 docs/manpages/rdsoftkeys.xml diff --git a/ChangeLog b/ChangeLog index 669e2c2d..d541aa71 100644 --- a/ChangeLog +++ b/ChangeLog @@ -19241,3 +19241,5 @@ startup. 2019-10-30 Fred Gleason * Added an rd.conf(5) man page. +2019-10-30 Fred Gleason + * Added an rdsoftkeys(1) man page. diff --git a/docs/manpages/Makefile.am b/docs/manpages/Makefile.am index dec4fca0..caac2cc6 100644 --- a/docs/manpages/Makefile.am +++ b/docs/manpages/Makefile.am @@ -46,7 +46,8 @@ all-local: rdairplay.1\ rdmetadata.1\ rdrender.1\ rmlsend.1\ - rdservice.8 + rdservice.8\ + rdsoftkeys.1 man_MANS = rdairplay.1\ rdalsaconfig.1\ @@ -61,7 +62,8 @@ man_MANS = rdairplay.1\ rdmetadata.1\ rdrender.1\ rmlsend.1\ - rdservice.8 + rdservice.8\ + rdsoftkeys.1 EXTRA_DIST = rdairplay.1\ rdairplay.xml\ @@ -90,7 +92,9 @@ EXTRA_DIST = rdairplay.1\ rmlsend.1\ rmlsend.xml\ rdservice.8\ - rdservice.xml + rdservice.xml\ + rdsoftkeys.1\ + rdsoftkeys.xml CLEANFILES = *~ MAINTAINERCLEANFILES = *~\ diff --git a/docs/manpages/rdsoftkeys.xml b/docs/manpages/rdsoftkeys.xml new file mode 100644 index 00000000..91035e05 --- /dev/null +++ b/docs/manpages/rdsoftkeys.xml @@ -0,0 +1,168 @@ + + + + + rdsoftkeys + 1 + October 2019 + Linux Audio Manual + + + rdsoftkeys + + Simple button panel for sending Rivendell Macro Language (RML) commands + + + + + + Fred + Gleason + fredg@paravelsystems.com + + Application Author + + + + + + + rdsoftkeys + --map-file=filename + + + + + Description + + rdsoftkeys1 is a small + utility that can be configured to present the user with a set of push + buttons, each of which, when clicked, will send a specified RML command + to a local or remote Rivendell host. + + + If started with no arguments, + rdsoftkeys1 will look in + the [SoftKeys] section of + /etc/rd.conf for button programming information. + + + + Options + + + + filename + + + + Look in the filename file for button + programming information rather than + /etc/rd.conf. + + + + + + +Programming Buttons + + Button programming information is contained in a + [SoftKeys] section, which can contain the + following directives: + + + + + Columns = cols + + + + The maximum number of buttons to place in a single row. If + more than this number of buttons are programmed, + rdsoftkeys1 will + use multiple rows. Default is to place all buttons in a + single row. + + + + + + Legendnum = text + + + + Put text on button number + num. Button numbers must start with + 1 and be incremented for each additional + button desired. + + + + + + Colornum = color + + + + Use color for the background color of + button num. Button numbers must start with + 1 and be incremented for each additional + button desired. + + + color can be English color names --e.g. + red or blue, or + specified in standard HTML notation --e.g. + #FF0000, #0000FF. + + + + + + Commandnum = + address:rml + + + + Send the RML command rml on button number + num to + address. Button numbers must start with + 1 and be incremented for each additional + button desired. + + + + + Example + + The following example will create three buttons, each of which + will send a PN RML to an rdairplay(1) + instance at rd.example.com: + + +[SoftKeys] +Columns=2 + +Command1=rd.example.com:PN 1! +Legend1=Start Main Log +Color1=red + +Command2=rd.example.com:PN 2! +Legend2=Start Aux Log 1 +Color2=#00FF00 + +Command3=rd.example.com:PN 3! +Legend3=Start Aux Log 2 +Color3=blue + + + + + + + diff --git a/rivendell.spec.in b/rivendell.spec.in index 664bff1c..3ee6cbcb 100644 --- a/rivendell.spec.in +++ b/rivendell.spec.in @@ -398,6 +398,8 @@ rm -rf $RPM_BUILD_ROOT %{_mandir}/man1/rdmetadata.1.gz %{_mandir}/man1/rdrender.1.gz %{_mandir}/man1/rmlsend.1.gz +%{_mandir}/man1/rdsoftkeys.1.gz +%{_mandir}/man5/rd.conf.5.gz %{_mandir}/man8/rddbmgr.8.gz %{_mandir}/man8/rdmarkerset.8.gz %{_mandir}/man8/rdservice.8.gz