mirror of
https://github.com/ElvishArtisan/rivendell.git
synced 2025-12-21 16:11:14 +01:00
2023-08-04 Fred Gleason <fredg@paravelsystems.com>
* Added a rivendell(7) man page. Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1,6 +1,7 @@
|
|||||||
*~
|
*~
|
||||||
*.1
|
*.1
|
||||||
*.5
|
*.5
|
||||||
|
*.7
|
||||||
*.8
|
*.8
|
||||||
*.buildinfo
|
*.buildinfo
|
||||||
*.cgi
|
*.cgi
|
||||||
|
|||||||
@@ -24330,3 +24330,5 @@
|
|||||||
2023-08-04 Fred Gleason <fredg@paravelsystems.com>
|
2023-08-04 Fred Gleason <fredg@paravelsystems.com>
|
||||||
* Fixed a regression in rdlibrary(1) that caused cart deletion to
|
* Fixed a regression in rdlibrary(1) that caused cart deletion to
|
||||||
fail with the message "Voicetrack Found".
|
fail with the message "Voicetrack Found".
|
||||||
|
2023-08-04 Fred Gleason <fredg@paravelsystems.com>
|
||||||
|
* Added a rivendell(7) man page.
|
||||||
|
|||||||
@@ -30,6 +30,8 @@
|
|||||||
xsltproc $(DOCBOOK_STYLESHEETS)/manpages/docbook.xsl $<
|
xsltproc $(DOCBOOK_STYLESHEETS)/manpages/docbook.xsl $<
|
||||||
%.5: %.xml
|
%.5: %.xml
|
||||||
xsltproc $(DOCBOOK_STYLESHEETS)/manpages/docbook.xsl $<
|
xsltproc $(DOCBOOK_STYLESHEETS)/manpages/docbook.xsl $<
|
||||||
|
%.7: %.xml
|
||||||
|
xsltproc $(DOCBOOK_STYLESHEETS)/manpages/docbook.xsl $<
|
||||||
%.8: %.xml
|
%.8: %.xml
|
||||||
xsltproc $(DOCBOOK_STYLESHEETS)/manpages/docbook.xsl $<
|
xsltproc $(DOCBOOK_STYLESHEETS)/manpages/docbook.xsl $<
|
||||||
|
|
||||||
@@ -93,7 +95,10 @@ all-local: rdadmin.1\
|
|||||||
rdsinglestart.pdf\
|
rdsinglestart.pdf\
|
||||||
rdsoftkeys.1\
|
rdsoftkeys.1\
|
||||||
rdsoftkeys.html\
|
rdsoftkeys.html\
|
||||||
rdsoftkeys.pdf
|
rdsoftkeys.pdf\
|
||||||
|
rivendell.7\
|
||||||
|
rivendell.html\
|
||||||
|
rivendell.pdf
|
||||||
|
|
||||||
man_MANS = rdadmin.1\
|
man_MANS = rdadmin.1\
|
||||||
rdairplay.1\
|
rdairplay.1\
|
||||||
@@ -111,7 +116,8 @@ man_MANS = rdadmin.1\
|
|||||||
rmlsend.1\
|
rmlsend.1\
|
||||||
rdservice.8\
|
rdservice.8\
|
||||||
rdsinglestart.1\
|
rdsinglestart.1\
|
||||||
rdsoftkeys.1
|
rdsoftkeys.1\
|
||||||
|
rivendell.7
|
||||||
|
|
||||||
EXTRA_DIST = exitcodes.xml\
|
EXTRA_DIST = exitcodes.xml\
|
||||||
rdadmin.1\
|
rdadmin.1\
|
||||||
@@ -181,13 +187,18 @@ EXTRA_DIST = exitcodes.xml\
|
|||||||
rdsoftkeys.1\
|
rdsoftkeys.1\
|
||||||
rdsoftkeys.html\
|
rdsoftkeys.html\
|
||||||
rdsoftkeys.pdf\
|
rdsoftkeys.pdf\
|
||||||
rdsoftkeys.xml
|
rdsoftkeys.xml\
|
||||||
|
rivendell.7\
|
||||||
|
rivendell.html\
|
||||||
|
rivendell.pdf\
|
||||||
|
rivendell.xml
|
||||||
|
|
||||||
CLEANFILES = *~
|
CLEANFILES = *~
|
||||||
MAINTAINERCLEANFILES = *~\
|
MAINTAINERCLEANFILES = *~\
|
||||||
*.1\
|
*.1\
|
||||||
*.5\
|
*.5\
|
||||||
*.8\
|
*.5\
|
||||||
|
*.7\
|
||||||
*.html\
|
*.html\
|
||||||
*.pdf\
|
*.pdf\
|
||||||
aclocal.m4\
|
aclocal.m4\
|
||||||
|
|||||||
219
docs/manpages/rivendell.xml
Normal file
219
docs/manpages/rivendell.xml
Normal file
@@ -0,0 +1,219 @@
|
|||||||
|
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||||
|
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
<!--
|
||||||
|
Header
|
||||||
|
-->
|
||||||
|
<refmeta>
|
||||||
|
<refentrytitle>rivendell</refentrytitle>
|
||||||
|
<manvolnum>7</manvolnum>
|
||||||
|
<refmiscinfo class='source'>August 2023</refmiscinfo>
|
||||||
|
<refmiscinfo class='manual'>Linux Audio Manual</refmiscinfo>
|
||||||
|
</refmeta>
|
||||||
|
<refnamediv>
|
||||||
|
<refname>rivendell</refname>
|
||||||
|
<refpurpose>
|
||||||
|
Common command-line switches for Rivendell modules
|
||||||
|
</refpurpose>
|
||||||
|
</refnamediv>
|
||||||
|
<info>
|
||||||
|
<author>
|
||||||
|
<personname>
|
||||||
|
<firstname>Fred</firstname>
|
||||||
|
<surname>Gleason</surname>
|
||||||
|
<email>fredg@paravelsystems.com</email>
|
||||||
|
</personname>
|
||||||
|
<contrib>Application Author</contrib>
|
||||||
|
</author>
|
||||||
|
</info>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Body
|
||||||
|
-->
|
||||||
|
<refsect1 id='description'><title>Description</title>
|
||||||
|
<para>
|
||||||
|
Rivendell is a complete radio broadcast automation system, with
|
||||||
|
facilities for the acquisition, management, scheduling and playout of
|
||||||
|
audio content. This man page covers the set of command-line options
|
||||||
|
supported by all Rivendell modules.
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
For a comprehensive overview of Rivendell and its features, see the
|
||||||
|
<link xlink:href="https://opsguide.rivendellaudio.org/html">
|
||||||
|
Rivendell Operations Guide
|
||||||
|
</link>.
|
||||||
|
</para>
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
<refsect1 id='basic_options'><title>Basic Options</title>
|
||||||
|
<para>
|
||||||
|
The following command-line options work with nearly all Rivendell
|
||||||
|
modules:
|
||||||
|
</para>
|
||||||
|
<variablelist remap='TP'>
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
<userinput>--help</userinput>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Print a list of available command-line options and then exit.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
<userinput>--list-styles</userinput>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Print the list of available Qt style plug-ins to standard output
|
||||||
|
and then exit.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
<userinput>--skip-db-check</userinput>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Bypass the usual check to ensure that the Rivendell database
|
||||||
|
is using the expected schema version. Useless except for debugging.
|
||||||
|
</para>
|
||||||
|
<warning>
|
||||||
|
<para>
|
||||||
|
This option is <emphasis>dangerous</emphasis>, and can cause
|
||||||
|
<emphasis>database corruption</emphasis>! It should only used be as
|
||||||
|
a debugging aid and when you know exactly what you are doing.
|
||||||
|
</para>
|
||||||
|
</warning>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
<userinput>--skip-db-check</userinput>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Bypass the usual check to ensure that the "rivendell"
|
||||||
|
service is running. Useless except for debugging.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
<userinput>-style <replaceable>plugin-name</replaceable></userinput>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Use the Qt style plug-in <replaceable>plugin-name</replaceable>.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
<userinput>--ticket=<replaceable>tkt-str</replaceable></userinput>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Manually add the ticket string <replaceable>tkt-str</replaceable>
|
||||||
|
to the WebAPI ticket store. Useless except for debugging.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
<userinput>--version</userinput>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Print the Rivendell version and then exit.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
<refsect1 id='bugs'><title>Bugs</title>
|
||||||
|
<para>
|
||||||
|
The <userinput>-style</userinput> option uses the X11-style format
|
||||||
|
(single leading hyphen, with a space separating the switch and its value)
|
||||||
|
rather than the Rivendell-style one (double leading hyphens with an equal
|
||||||
|
sign separating the switch and its value).
|
||||||
|
</para>
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
<refsect1 id='see_also'><title>See Also</title>
|
||||||
|
<para>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdadmin</refentrytitle><manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdairplay</refentrytitle><manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdalsaconfig</refentrytitle><manvolnum>8</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdclilogedit</refentrytitle><manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rd.conf</refentrytitle><manvolnum>5</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdconvert</refentrytitle><manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rddbmgr</refentrytitle><manvolnum>8</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdexport</refentrytitle><manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdimport</refentrytitle><manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdlogmanager</refentrytitle><manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdmarkerset</refentrytitle><manvolnum>8</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdmetadata</refentrytitle><manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdrender</refentrytitle><manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdservice</refentrytitle><manvolnum>8</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdsinglestart</refentrytitle><manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rdsoftkeys</refentrytitle><manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
<literal>, </literal>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>rmlsend</refentrytitle><manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
</refsect1>
|
||||||
|
</refentry>
|
||||||
|
|
||||||
@@ -143,7 +143,7 @@ bool RDCoreApplication::open(QString *err_msg,ErrorType *err_type,
|
|||||||
bool skip_db_check=false;
|
bool skip_db_check=false;
|
||||||
int persistent_dropbox_id=-1;
|
int persistent_dropbox_id=-1;
|
||||||
bool ok=false;
|
bool ok=false;
|
||||||
QString sql;
|
QString sql;
|
||||||
RDSqlQuery *q=NULL;
|
RDSqlQuery *q=NULL;
|
||||||
|
|
||||||
if(err_type!=NULL) {
|
if(err_type!=NULL) {
|
||||||
@@ -163,21 +163,31 @@ bool RDCoreApplication::open(QString *err_msg,ErrorType *err_type,
|
|||||||
app_ticket=app_cmd_switch->value(i);
|
app_ticket=app_cmd_switch->value(i);
|
||||||
app_cmd_switch->setProcessed(i,true);
|
app_cmd_switch->setProcessed(i,true);
|
||||||
}
|
}
|
||||||
if(app_cmd_switch->key(i)=="--persistent-dropbox-id") {
|
if((app_cmd_switch->key(i)=="--persistent-dropbox-id")&&
|
||||||
|
(app_command_name=="rdimport")) {
|
||||||
|
//
|
||||||
|
// Catch this here so we can include the dropbox ID the
|
||||||
|
// ident parameter to openlog(3).
|
||||||
|
//
|
||||||
persistent_dropbox_id=app_cmd_switch->value(i).toUInt(&ok);
|
persistent_dropbox_id=app_cmd_switch->value(i).toUInt(&ok);
|
||||||
if(ok) {
|
if(ok) {
|
||||||
app_command_name=QString::asprintf("dropbox[%u]",persistent_dropbox_id);
|
strncpy(app_syslog_name,
|
||||||
|
QString::asprintf("dropbox[%u]",persistent_dropbox_id).toUtf8(),
|
||||||
|
PATH_MAX-1);
|
||||||
|
app_cmd_switch->setProcessed(i,true);
|
||||||
}
|
}
|
||||||
app_cmd_switch->setProcessed(i,true);
|
|
||||||
}
|
}
|
||||||
if(app_cmd_switch->key(i)=="--list-styles") {
|
if(app_cmd_switch->key(i)=="--list-styles") {
|
||||||
QStringList f0=QStyleFactory::keys();
|
QStringList f0=QStyleFactory::keys();
|
||||||
printf("Available styles:\n");
|
|
||||||
for(int j=0;j<f0.size();j++) {
|
for(int j=0;j<f0.size();j++) {
|
||||||
printf(" %s\n",f0.at(j).toUtf8().constData());
|
printf("%s\n",f0.at(j).toUtf8().constData());
|
||||||
}
|
}
|
||||||
exit(0);
|
exit(0);
|
||||||
}
|
}
|
||||||
|
if(app_cmd_switch->key(i)=="--skip-service-check") {
|
||||||
|
check_svc=false;
|
||||||
|
app_cmd_switch->setProcessed(i,true);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
//
|
//
|
||||||
|
|||||||
@@ -473,6 +473,7 @@ rm -rf $RPM_BUILD_ROOT
|
|||||||
%{_mandir}/man1/rdsinglestart.1.gz
|
%{_mandir}/man1/rdsinglestart.1.gz
|
||||||
%{_mandir}/man1/rdsoftkeys.1.gz
|
%{_mandir}/man1/rdsoftkeys.1.gz
|
||||||
%{_mandir}/man5/rd.conf.5.gz
|
%{_mandir}/man5/rd.conf.5.gz
|
||||||
|
%{_mandir}/man7/rivendell.7.gz
|
||||||
%{_mandir}/man8/rddbmgr.8.gz
|
%{_mandir}/man8/rddbmgr.8.gz
|
||||||
%{_mandir}/man8/rdmarkerset.8.gz
|
%{_mandir}/man8/rdmarkerset.8.gz
|
||||||
%{_mandir}/man8/rdservice.8.gz
|
%{_mandir}/man8/rdservice.8.gz
|
||||||
|
|||||||
Reference in New Issue
Block a user