<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!--ARC : LSARC 2006/202 GNOME 2.14-->
<!ENTITY exam-tt "EXAMPLES">
<!ENTITY cmd "rhythmbox-client">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY suncopy "Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="rhythmbox-client-1">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>rhythmbox-client</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">3 Dec 2007</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<indexterm><primary>rhythmbox-client</primary></indexterm><indexterm><primary>
controls a running instance of rhythmbox
</primary></indexterm>
<refnamediv id="rhythmbox-client-1-name"><refname>rhythmbox-client</refname><refpurpose>
controls a running instance of rhythmbox
</refpurpose></refnamediv>
<refsynopsisdiv id="rhythmbox-client-1-synp"><title>&synp-tt;</title>
<cmdsynopsis><command>&cmd;</command>
<arg choice="opt"><option>-clear-queue</option></arg>
<arg choice="opt"><option>-debug</option></arg>
<arg choice="opt"><option>-enqueue=<replaceable>filename</replaceable></option></arg>
<arg choice="opt"><option>-help</option></arg>
<arg choice="opt"><option>-hide</option></arg>
<arg choice="opt"><option>-mute</option></arg>
<arg choice="opt"><option>-next</option></arg>
<arg choice="opt"><option>-no-present</option></arg>
<arg choice="opt"><option>-no-start</option></arg>
<arg choice="opt"><option>-notify</option></arg>
<arg choice="opt"><option>-pause</option></arg>
<arg choice="opt"><option>-play</option></arg>
<arg choice="opt"><option>-play-pause</option></arg>
<arg choice="opt"><option>-play-uri=<replaceable>uri</replaceable></option></arg>
<arg choice="opt"><option>-previous</option></arg>
<arg choice="opt"><option>-print-playing</option></arg>
<arg choice="opt"><option>-print-playing-format=<replaceable>format</replaceable></option></arg>
<arg choice="opt"><option>-print-volume</option></arg>
<arg choice="opt"><option>-quit</option></arg>
<arg choice="opt"><option>-set-volume=<replaceable>float</replaceable></option></arg>
<arg choice="opt"><option>-unmute</option></arg>
<arg choice="opt"><option>-volume-down</option></arg>
<arg choice="opt"><option>-volume-up</option></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1 id="rhythmbox-client-1-desc"><title>&desc-tt;</title>
<para><command>&cmd;</command> is a tool for controlling an already running instance of rhythmbox.
It is useful for remote control scripting or printing details of what is playing. 
</para>
</refsect1>
<refsect1 id="rhythmbox-client-1-opts"><title>&opts-tt;</title>
<para>The following options are supported:</para>
<variablelist termlength="wide">
<varlistentry>
<term><option>-client-queue</option></term>
<listitem><para>
Empty the play queue before adding new tracks.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-debug</option></term>
<listitem><para>
Display debug output.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-enqueue=<replaceable>filename</replaceable></option></term>
<listitem><para>
Add specified tracks already in the library to the play queue.
</para></listitem></varlistentry>
<varlistentry>
<term><option>?</option>, <option>-help</option></term>
<listitem><para>
Show help options.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-hide</option></term>
<listitem><para>
Hide the &cmd; window.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-mute</option></term>
<listitem><para>
Mute playback.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-next</option></term>
<listitem><para>
Jump to next song.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-no-present</option></term>
<listitem><para>
Do not present an existing &cmd; window.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-no-start</option></term>
<listitem><para>
Do not start a new instance of &cmd;.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-notify</option></term>
<listitem><para>
Show notification of the playing song.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-pause</option></term>
<listitem><para>
Pause playback if currently playing.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-play</option></term>
<listitem><para>
Resume playback if currently paused.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-play-pause</option></term>
<listitem><para>
Toggle play/pause mode.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-play-uri=<replaceable>uri</replaceable></option></term>
<listitem><para>
Play a specified <replaceable>uri</replaceable>, importing it if
necessary.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-previous</option></term>
<listitem><para>
Jump to previous song.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-print-playing</option></term>
<listitem><para>
Print the title and artist of the playing song.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-print-playing-format=<replaceable>format</replaceable></option></term>
<listitem><para>
Print the formatted details of the song.  Refer to the extended description 
to see valid <replaceable>format</replaceable> options.  Multiple options can be
combined using quotes.  For example "%tn %aa %tt", will print the track number
followed by the artist and the title of the track.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-print-volume</option></term>
<listitem><para>
Print the current playback volume.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-quit</option></term>
<listitem><para>
Quit Rhythmbox.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-set-volume=<replaceable>float</replaceable></option></term>
<listitem><para>
Set the playback volume.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-unmute</option></term>
<listitem><para>
Unmute playback
</para></listitem></varlistentry>
<varlistentry>
<term><option>-volume-down</option></term>
<listitem><para>
Decreate the playback volume.
</para></listitem></varlistentry>
<varlistentry>
<term><option>-volume-up</option></term>
<listitem><para>
Increase the playback volume.
</para></listitem></varlistentry>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="rhythmbox-client-1-exde"><title>&exde-tt;</title>
<para>
&cmd; accepts the following format options to be used with the 
<option>-print-playing-format</option> option:
</para>
<variablelist termlength="wide">
<varlistentry>
<term><option role="nodash">%at</option></term>
<listitem><para>
Album title
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%aT</option></term>
<listitem><para>
Album title in lowercase
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%aa</option></term>
<listitem><para>
Album artist
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%aA</option></term>
<listitem><para>
Album artist in lowercase
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%ay</option></term>
<listitem><para>
Release year of album
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%an</option></term>
<listitem><para>
Album disc number
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%aN</option></term>
<listitem><para>
Album disc number with leading zero
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%ag</option></term>
<listitem><para>
Album genre
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%aG</option></term>
<listitem><para>
Album genre in lowercase
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%tt</option></term>
<listitem><para>
Track title
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%tT</option></term>
<listitem><para>
Track title in lowercase
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%ta</option></term>
<listitem><para>
Track artist
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%tA</option></term>
<listitem><para>
Track artist in lowercase
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%tn</option></term>
<listitem><para>
Track number
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%tN</option></term>
<listitem><para>
Track number with leading zero
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%td</option></term>
<listitem><para>
Track duration
</para></listitem></varlistentry>
<varlistentry>
<term><option role="nodash">%te</option></term>
<listitem><para>
Elapsed time of track
</para></listitem></varlistentry>
</variablelist>
</refsect1>
<refsect1 id="rhythmbox-client-1-exit"><title>&exit-tt;</title>
<para>The following exit values are returned:</para>
<variablelist termlength="xtranarrow">
<varlistentry><term><returnvalue>0</returnvalue></term><listitem><para>Application
exited successfully</para>
</listitem></varlistentry>
<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application
exited with failure</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="rhythmbox-client-1-file"><title>&file-tt;</title>
<para>The following files are used by this application:</para>
<variablelist termlength="large">
<varlistentry><term><filename>/usr/bin/&cmd;</filename></term><listitem><para>
Executable for &cmd;</para>
</listitem></varlistentry>
<varlistentry><term><filename>/usr/lib/rhythmbox/plugins</filename></term><listitem><para>
Location of &cmd; plugins.</para>
</listitem></varlistentry>
<varlistentry><term><filename>/usr/share/gtk-doc/html/rhythmbox</filename></term><listitem>
<para>
Location of developer documentation for writing a &cmd; plugin.
</para></listitem>
</varlistentry>
</refsect1>
<refsect1 id="rhythmbox-client-1-attr"><title>&attr-tt;</title>
<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
for descriptions of the following attributes:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
<colspec colname="COLSPEC1" colwidth="1*">
<thead>
<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
valign="middle">ATTRIBUTE VALUE</entry></row>
</thead>
<tbody>
<row><entry><para>Availability</para></entry><entry><para>gnome/media/gnome-media-player</para></entry>
</row>
<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
colname="COLSPEC1"><para>Volatile</para></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="rhythmbox-client-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
<citerefentry><refentrytitle>rhythmbox</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1 id="rhythmbox-client-1-note"><title>&note-tt;</title>
<para>
Written by Brian Cameron, Sun Microsystems Inc., 2007.
</para>
</refsect1>
</refentry>
