Rivendellaudio/docs/manpages/rdservice.xml
Fred Gleason 998e0124f6 2020-10-09 Fred Gleason <fredg@paravelsystems.com>
* Defined a set of standard exit code defines starting with
	'RD_EXIT_' in 'lib/rd.h'.
	* Regularized the exit codes returned by rdlogmanager(1).
	* Cleaned up error handling when using rdlogmanager(1) in
	command line mode.
	* Fixed a bug in rdlogmanager(1) that could leave a log lock
	asserted after exiting when handling schedule import errors.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
2020-10-09 13:48:44 -04:00

142 lines
4.7 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
Header
-->
<refmeta>
<refentrytitle>rdservice</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class='source'>Mat 2019</refmiscinfo>
<refmiscinfo class='manual'>Linux Audio Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rdservice</refname>
<refpurpose>Rivendell service manager</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>rdservice</command>
<arg choice='opt'><replaceable>OPTIONS</replaceable></arg>
<sbr/>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'><title>Description</title>
<para>
<command>rdservice</command><manvolnum>8</manvolnum> manages the various
background service components of the Rivendell Radio Automation
System, including <command>caed</command><manvolnum>8</manvolnum>,
<command>rdcatchd</command><manvolnum>8</manvolnum>,
<command>ripcd</command><manvolnum>8</manvolnum>,
<command>rdpadd</command><manvolnum>8</manvolnum>,
<command>rdpadengined</command><manvolnum>8</manvolnum>,
<command>rdvairplayd</command><manvolnum>8</manvolnum>,
<command>rdimport</command><manvolnum>1</manvolnum> (in dropbox mode)
as well as periodic system maintenance tasks using
<command>rdmaint</command><manvolnum>8</manvolnum>.
It is normally invoked by the host's boot system
(such as <command>systemd</command><manvolnum>1</manvolnum>)
at system boot-time and runs continuously thereafter.
There should only be one instance of
<command>rdservice</command><manvolnum>8</manvolnum> running at any
given time; attempts to start an additional instance will terminate
with exit code <computeroutput>1</computeroutput>.
</para>
</refsect1>
<refsect1 id='options'><title>Options</title>
<variablelist remap='TP'>
<varlistentry>
<term>
<option>--end-startup-after-caed</option>
</term>
<term>
<option>--end-startup-after-ripcd</option>
</term>
<term>
<option>--end-startup-after-rdcatchd</option>
</term>
<term>
<option>--end-startup-after-rdpadd</option>
</term>
<term>
<option>--end-startup-after-rdpadengined</option>
</term>
<term>
<option>--end-startup-after-rdvairplayd</option>
</term>
<term>
<option>--end-startup-after-rdrepld</option>
</term>
<listitem>
<para>
Skip the remainder of the startup sequence after the specified
component is started. (Useless except for debugging).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='exit_values'><title>Exit Values</title>
<para>
<segmentedlist>
<?dbhtml list-presentation="tabular"?>
<?dbfo list-presentation="tabular"?>
<segtitle></segtitle>
<segtitle></segtitle>
<seglistitem><seg>0</seg><seg>Normal exit</seg></seglistitem>
<seglistitem><seg>1</seg><seg>Prior instance found</seg></seglistitem>
<seglistitem><seg>2</seg><seg>Unable to open database</seg></seglistitem>
<seglistitem><seg>3</seg><seg>Unable to start a service component</seg></seglistitem>
<seglistitem><seg>4</seg><seg>Unrecognized/invalid command line option</seg></seglistitem>
<seglistitem><seg>5</seg><seg>Output overwrite protected</seg></seglistitem>
<seglistitem><seg>6</seg><seg>No such service</seg></seglistitem>
<seglistitem><seg>7</seg><seg>No such log</seg></seglistitem>
<seglistitem><seg>8</seg><seg>No such report</seg></seglistitem>
<seglistitem><seg>9</seg><seg>Log generation failed</seg></seglistitem>
<seglistitem><seg>10</seg><seg>Schedule file import failed</seg></seglistitem>
<seglistitem><seg>11</seg><seg>Insufficient permissions</seg></seglistitem>
<seglistitem><seg>11</seg><seg>Report generation failed</seg></seglistitem>
</segmentedlist>
</para>
</refsect1>
<refsect1 id='see_also'><title>See Also</title>
<para>
<citerefentry>
<refentrytitle>rddbmgr</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
<literal>, </literal>
<citerefentry>
<refentrytitle>rdimport</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>
<literal>, </literal>
<citerefentry>
<refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>
<literal>, </literal>
<citerefentry>
<refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>