rdfetch.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!--
      Header
  -->
  <refmeta>
    <refentrytitle>rdfetch</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class='source'>October 2021</refmiscinfo>
    <refmiscinfo class='manual'>Linux Audio Manual</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>rdfetch</refname>
    <refpurpose>
      Podcast fetcher and importation tool for the Rivendell Radio Automation System
    </refpurpose>
  </refnamediv>
  <info>
    <author>
      <personname>
	<firstname>David</firstname>
	<surname>Klann</surname>
	<email>dklann@broadcasttool.com</email>
      </personname>
      <contrib>Application Author</contrib>
    </author>
  </info>

  <!--
      Body
  -->
  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>rdfetch</command>
      <arg choice='opt'><replaceable>OPTIONS</replaceable></arg>
      <sbr/>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1 id='description'><title>Description</title>
  <para>
    <command>rdfetch</command><manvolnum>1</manvolnum> is a text-menu
    command-line tool for fetching and importing audio files from
    podcasts (also known as RSS feeds) into the Rivendell Radio
    Automation System. By default, a new cart is created for each
    podcast, although this behavior can be modified by choosing the
    appropriate option when adding a podcast.
  </para>
  <para>
    <command>rdfetch</command> leads you through the process of
    setting up a download using a text-based wizard. The wizard asks
    questions about the podcast you want to retrieve and where to
    store the audio in Rivendell. Simply answer
    <replaceable>yes</replaceable> or <replaceable>no</replaceable>,
    and type other responses as appropriate when prompted.
  </para>
  </refsect1>

  <refsect1 id='options'><title>Options</title>
  <variablelist remap='TP'>
    <varlistentry>
      <term>
	<option>--config=</option><replaceable>podget-configuration-file</replaceable>
      </term>
      <listitem>
	<para>
	  Specify the podget<manvolnum>1</manvolnum> configuration file to use
	  for this run of <command>rdfetch</command>. You may want to do this
	  if you are testing your <command>rdfetch</command> installation.
	</para>
      </listitem>
    </varlistentry>
    
    <varlistentry>
      <term>
	<option>--dir_config=</option><replaceable>podget-configuration-directory</replaceable>
      </term>
      <listitem>
	<para>
	  Specify the podget<manvolnum>1</manvolnum> configuration directory
	  to use for this run of <command>rdfetch</command>. You may want to do this if
	  you are testing your <command>rdfetch</command> installation, or if you have multiple
	  instances of <command>rdfetch</command> installed on a workstation.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--help</option>
      </term>
      <listitem>
	<para>
	  Display a brief usage message for <command>rdfetch</command>.
	</para>
      </listitem>
    </varlistentry>
    
    <varlistentry>
      <term>
	<option>--verbose</option> (<option>-v</option>)
      </term>
      <listitem>
	<para>
	  Print progress messages during processing.
	</para>
      </listitem>
    </varlistentry>
    
    <varlistentry>
      <term>
	<option>--version</option> (<option>-V</option>)
      </term>
      <listitem>
	<para>
	  Output version information and exit.
	</para>
      </listitem>
    </varlistentry>
    
  </variablelist>
  </refsect1>
  
  <refsect1>
    <title>BUGS</title>
    <para>
      Probably many.
    </para>
  </refsect1>
  
  <refsect1 id='see_also'><title>See Also</title>
  <para>
    <citerefentry>
      <refentrytitle>rdimport</refentrytitle><manvolnum>1</manvolnum>
    </citerefentry>
  </para>
  </refsect1>

</refentry>