2023-09-28 Fred Gleason <fredg@paravelsystems.com>

* Added a 'RDJsonEscape(const QString &str)' function in
	'lib/rdweb.cpp' and 'lib/rdweb.h'.
	* Added a '--dump-panel-updates' switch to rdpanel(1).
	* Added a rdpanel(1) man page.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason
2023-09-28 15:51:08 -04:00
parent 4e48d86522
commit 5118c36219
14 changed files with 302 additions and 7 deletions

View File

@@ -81,6 +81,9 @@ all-local: rdadmin.1\
rdmetadata.1\
rdmetadata.html\
rdmetadata.pdf\
rdpanel.1\
rdpanel.html\
rdpanel.pdf\
rdrender.1\
rdrender.html\
rdrender.pdf\
@@ -112,6 +115,7 @@ man_MANS = rdadmin.1\
rdlogmanager.1\
rdmarkerset.8\
rdmetadata.1\
rdpanel.1\
rdrender.1\
rmlsend.1\
rdservice.8\
@@ -168,6 +172,10 @@ EXTRA_DIST = exitcodes.xml\
rdmetadata.html\
rdmetadata.pdf\
rdmetadata.xml\
rdpanel.1\
rdpanel.html\
rdpanel.pdf\
rdpanel.xml\
rdrender.1\
rdrender.html\
rdrender.pdf\

70
docs/manpages/rdpanel.xml Normal file
View File

@@ -0,0 +1,70 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
Header
-->
<refmeta>
<refentrytitle>rdpanel</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='source'>September 2023</refmiscinfo>
<refmiscinfo class='manual'>Linux Audio Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rdpanel</refname>
<refpurpose>
Module for stand-alone sound panel
</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>rdpanel</command>
<arg choice='opt'><replaceable>OPTIONS</replaceable></arg>
<sbr/>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'>
<title>Description</title>
<para>
The <command>rdpanel</command><manvolnum>1</manvolnum> modules provides
a single, stand-alone &quot;cart wall&quot; application that allows
users to play carts by means of a single button press.
</para>
</refsect1>
<refsect1 id='options'>
<title>Options</title>
<variablelist remap='TP'>
<varlistentry>
<term>
<option>--dump-panel-updates</option>
</term>
<listitem>
<para>
When this option is given,
<command>rdpanel</command><manvolnum>1</manvolnum> will print
a dump of the currently loaded sound panel configuration to
standard output each time the Rivendell user logged into the system
is changed.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>