<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!--
      Header
  -->
  <refmeta>
    <refentrytitle>rdairplay</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class='source'>September 2023</refmiscinfo>
    <refmiscinfo class='manual'>Linux Audio Manual</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>rdairplay</refname>
    <refpurpose>
      Module for playing Rivendell logs
    </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>rdairplay</command>
      <arg choice='opt'><replaceable>OPTIONS</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id='description'><title>Description</title>
  <para>
    The <command>rdairplay</command><manvolnum>1</manvolnum> module is the
    primary interface for executing logs other audio content. This man page
    documents its command-line arguments. For overview of the UI and other
    elements, see the <emphasis>Running Logs with RDAirPlay</emphasis> 
    chapter in the 
    <emphasis>Rivendell Operations and Administration Guide</emphasis>.
  </para>
  </refsect1>

  <refsect1 id='options'><title>Options</title>
  <variablelist>
    <varlistentry>
      <term>
	<replaceable>log-spec</replaceable>=<replaceable>log-name</replaceable>[:<replaceable>next-line</replaceable>[+]]
      </term>
      <listitem>
	<para>
	  After startup, load the <replaceable>log-name</replaceable> log into
	  the log machine specified by <replaceable>log-spec</replaceable>.
	  If a <replaceable>next-line</replaceable> value has been specified,
	  then do a <userinput>make next</userinput> to that line. If a
	  <userinput>+</userinput> has been appended to the line number,
	  then start the log.
	</para>
	<para>
	  <replaceable>log-spec</replaceable>
	  must be <userinput>--log1</userinput>,
	  <userinput>--log2</userinput>
	  or <userinput>--log3</userinput>, referring to the
	  <computeroutput>Main Log</computeroutput>,
	  <computeroutput>Aux 1 Log</computeroutput> or
	  <computeroutput>Aux 2 Log</computeroutput> log machines
	  respectively. It is possible to use multiple
	  <replaceable>log-spec</replaceable> clauses. If multiple clauses
	  referring to the same log machine are given, then the last one
	  specified will be used.
	</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
	<option>--dump-panel-updates</option>
      </term>
      <listitem>
	<para>
	  When this option is given,
	  <command>rdairplay</command><manvolnum>1</manvolnum> will print
	  a dump of the currently loaded sound panel array to
	  standard output each time the Rivendell user logged into the system
	  is changed.
	</para>
      </listitem>
    </varlistentry>
  </variablelist>
  </refsect1>

  <refsect1 id='examples'><title>Examples</title>
  <variablelist remap='TP'>
    <varlistentry>
      <term>
	<userinput>rdairplay --log1=MyLog</userinput>
      </term>
      <listitem>
	<para>
	  Load <userinput>MyLog</userinput> into the Main Log machine
	</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
	<userinput>rdairplay --log2=MyLog:14+</userinput>
      </term>
      <listitem>
	<para>
	  Load <userinput>MyLog</userinput> into the Aux Log 1 machine,
	  'Make Next' to line <userinput>14</userinput> and then start the log.
	</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
	<userinput>rdairplay --log1=YourLog --log2=MyLog</userinput>
      </term>
      <listitem>
	<para>
	  Load <userinput>YourLog</userinput> into the Main Log machine
	  and <userinput>MyLog</userinput> into the Aux Log 1 machine.
	</para>
      </listitem>
    </varlistentry>

  </variablelist>
</refsect1>

</refentry>

