Rivendellaudio/docs/manpages/rdmetadata.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!--
      Header
  -->
  <refmeta>
    <refentrytitle>rdmetadata</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class='source'>May 2019</refmiscinfo>
    <refmiscinfo class='manual'>Linux Audio Manual</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>rdmetadata</refname>
    <refpurpose>Tool for altering Rivendell cart metadata</refpurpose>
  </refnamediv>
  <info>
    <author>
      <personname>
	<firstname>Patrick</firstname>
	<surname>Linstruth</surname>
	<email>patrick@deltecent.com</email>
      </personname>
      <contrib>Application Author</contrib>
    </author>
  </info>

  <!--
      Body
  -->
  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>rdmetadata --cart-number=<replaceable>cart</replaceable></command>
      <arg choice='opt'><replaceable>OPTIONS</replaceable></arg>
      <sbr/>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id='description'><title>Description</title>
  <para>
    <command>rdmetadata</command><manvolnum>1</manvolnum> is a command-line
    tool for setting or altering cart metadata in the Rivendell Radio
    Automation System.
  </para>
  </refsect1>

  <refsect1 id='options'><title>Options</title>
  <variablelist remap='TP'>
    <varlistentry>
      <term>
	<option>--add-schedcode=</option><replaceable>schedcode</replaceable>
      </term>
      <listitem>
	<para>
	  Add scheduler code <replaceable>schedcode</replaceable> to
          <replaceable>cart</replaceable>.
	  Default action is to leave the scheduler codes unaltered.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--agency=</option><replaceable>agency</replaceable>
      </term>
      <listitem>
	<para>
	  Set <replaceable>cart</replaceable> agency metadata
          to <replaceable>agency</replaceable>.
	  Default action is to leave the agency unaltered.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--album=</option><replaceable>album</replaceable>
      </term>
      <listitem>
	<para>
	  Set <replaceable>cart</replaceable> album metadata
          to <replaceable>album</replaceable>.
	  Default action is to leave the album unaltered.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--artist=</option><replaceable>artist</replaceable>
      </term>
      <listitem>
	<para>
	  Set <replaceable>cart</replaceable> artist metadata
          to <replaceable>artist</replaceable>.
	  Default action is to leave the artist unaltered.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--bpm=</option><replaceable>bpm</replaceable>
      </term>
      <listitem>
	<para>
	  Set <replaceable>cart</replaceable> BPM metadata
          to <replaceable>bpm</replaceable>.
	  Default action is to leave the BPM unaltered.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--composer=</option><replaceable>composer</replaceable>
      </term>
      <listitem>
	<para>
	  Set <replaceable>cart</replaceable> composer metadata
          to <replaceable>composer</replaceable>.
	  Default action is to leave the composer unaltered.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--conductor=</option><replaceable>conductor</replaceable>
      </term>
      <listitem>
	<para>
	  Set <replaceable>cart</replaceable> conductor metadata
          to <replaceable>conductor</replaceable>.
	  Default action is to leave the conductor unaltered.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--label=</option><replaceable>label</replaceable>
      </term>
      <listitem>
	<para>
	  Set <replaceable>cart</replaceable> label metadata
          to <replaceable>label</replaceable>.
	  Default action is to leave the label unaltered.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--publisher=</option><replaceable>publisher</replaceable>
      </term>
      <listitem>
	<para>
	  Set <replaceable>cart</replaceable> publisher metadata
          to <replaceable>publisher</replaceable>.
	  Default action is to leave the publisher unaltered.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--rem-schedcode=</option><replaceable>schedcode</replaceable>
      </term>
      <listitem>
	<para>
	  Remove scheduler code <replaceable>schedcode</replaceable> from
          <replaceable>cart</replaceable>.
	  Default action is to leave the scheduler codes unaltered.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--songid=</option><replaceable>songid</replaceable>
      </term>
      <listitem>
	<para>
	  Set <replaceable>cart</replaceable> song ID metadata
          to <replaceable>songid</replaceable>.
	  Default action is to leave the song ID unaltered.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--title=</option><replaceable>title</replaceable>
      </term>
      <listitem>
	<para>
	  Set <replaceable>cart</replaceable> title metadata
          to <replaceable>title</replaceable>.
	  Default action is to leave the title unaltered.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--year=</option><replaceable>year</replaceable>
      </term>
      <listitem>
	<para>
	  Set <replaceable>cart</replaceable> year metadata
          to <replaceable>year</replaceable>.
	  Default action is to leave the year unaltered.
	</para>
      </listitem>
    </varlistentry>

    <varlistentry>
      <term>
	<option>--verbose</option>
      </term>
      <listitem>
	<para>
	  Print messages to STDOUT describing progress.
	</para>
      </listitem>
    </varlistentry>

  </variablelist>

  <refsect1 id='see_also'><title>See Also</title>
  <para>
  <citerefentry>
    <refentrytitle>rdlibrary</refentrytitle><manvolnum>1</manvolnum>
  </citerefentry>
  </para>
  </refsect1>
</refsect1>

</refentry>