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