manual.lyx

Aqualung is an advanced music player primarily targeted for the GNU/Linux operating system, but als

-r,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

rate\InsetSpace ~
<int> Set the output sample rate.
 
\end_layout

\begin_layout Subsubsection
JACK
\end_layout

\begin_layout Description
-a[<port_L>,<port_R>],\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

auto[=<port_L>,<port_R>] Auto-connect output ports to given JACK ports (defaults
 to first two hardware playback ports).
\end_layout

\begin_layout Description
-c,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

client\InsetSpace ~
<name> Set client name (needed if you want to run multiple instances
 of the program).
\end_layout

\begin_layout Standard
NOTE: In the case when JACK output has been selected as part of the automatic
 output device detection, the -a option is implicitly applied.
\end_layout

\begin_layout Subsubsection
Win32
\end_layout

\begin_layout Description
-r,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

rate\InsetSpace ~
<int> Set the output sample rate.
 
\end_layout

\begin_layout Subsection
Options relevant to the Sample Rate Converter
\end_layout

\begin_layout Description
-s[<int>],\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

srctype[=<int>] Choose the SRC type, or print the list of available types
 if no number given.
 The default is SRC type 4 (Linear Interpolator).
\end_layout

\begin_layout Subsection
Options for remote cue control
\end_layout

\begin_layout Description
-N,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

session\InsetSpace ~
<int> Specify the instance number to send the remote command to.
 Instances are numbered on a per user basis, starting with 0.
 Except for the zero-th instance (started first), the instance number is
 displayed in the title bar of the main window (e.g.: Aqualung.3).
 If you don't use this option, the following options will control the zero-th
 instance by default, except for -L which defaults to the present instance
 (so as to be able to start playback immediately from the command line).
\end_layout

\begin_layout Description
-B,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

back Jump to previous track.
\end_layout

\begin_layout Description
-F,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

fwd Jump to next track.
\end_layout

\begin_layout Description
-L,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

play Start playing.
\end_layout

\begin_layout Description
-U,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

pause Pause playback, or resume if already paused.
\end_layout

\begin_layout Description
-T,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

stop Stop playback.
\end_layout

\begin_layout Description
-V,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

volume\InsetSpace ~
[m|M]|[=]<val> Adjust the volume.
 m/M means mute; if = is present, the remote instance's volume control will
 be set to the value specified, otherwise, the volume will be adjusted by
 the supplied (signed) value.
 The values are in dB units.
\end_layout

\begin_layout Description
-Q,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

quit Terminate remote instance.
\end_layout

\begin_layout Subsection
Options for file loading
\end_layout

\begin_layout Description
-E,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

enqueue Don't clear the contents of the playlist when adding new items.
 
\end_layout

\begin_layout Subsection
Options for changing state of Playlist/Music Store windows
\end_layout

\begin_layout Description
-l,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

show-pl=[yes|no] Show/hide playlist window.
\end_layout

\begin_layout Description
-m,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

show-ms=[yes|no] Show/hide music store window.
\end_layout

\begin_layout Subsection
Examples
\end_layout

\begin_layout Description
$\InsetSpace ~
aqualung\InsetSpace ~
-s3\InsetSpace ~
-o\InsetSpace ~
alsa\InsetSpace ~
-R\InsetSpace ~
-r\InsetSpace ~
48000\InsetSpace ~
-d\InsetSpace ~
hw:0,0\InsetSpace ~
-p\InsetSpace ~
2048\InsetSpace ~
-n\InsetSpace ~
2
\end_layout

\begin_layout Description
$\InsetSpace ~
aqualung\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

srctype=1\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

output\InsetSpace ~
oss\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

rate\InsetSpace ~
96000
\end_layout

\begin_layout Description
$\InsetSpace ~
aqualung\InsetSpace ~
-o\InsetSpace ~
jack\InsetSpace ~
-a\InsetSpace ~
-E\InsetSpace ~
`find\InsetSpace ~
./ledzeppelin/\InsetSpace ~
-name\InsetSpace ~

\backslash
*.flac`
\end_layout

\begin_layout Subsection
Environment
\end_layout

\begin_layout Standard
Aqualung obeys two environment variables concerning LADSPA plugins.
 LADSPA_PATH should contain a colon-separated list of paths to search for
 LADSPA plugin .so files.
 LADSPA_RDF_PATH should contain a colon-separated list of paths to RDF metadata
 files about these plugins.
 When any of these is not specified, the program will use sensible defaults
 and look in the obvious places.
\end_layout

\begin_layout Subsection
Files
\end_layout

\begin_layout Standard
Here is a list of files that Aqualung creates, reads and relies on.
\end_layout

\begin_layout Description
~/.aqualung Directory containing user settings.
\end_layout

\begin_layout Description
~/.aqualung/config.xml GUI (skin, window size/position, etc.)\InsetSpace ~
and other settings.
\end_layout

\begin_layout Description
~/.aqualung/plugin.xml List of running plugins and all their settings.
\end_layout

\begin_layout Description
~/.aqualung/playlist.xml Automatically saved and restored playlist (if you
 enable this feature).
\end_layout

\begin_layout Description
~/.aqualung/<skin-name> Locally available skin <skin-name> (useful for skin
 development).
\end_layout

\begin_layout Description
${prefix}/share/aqualung/skin System-wide skin directory.
\end_layout

\begin_layout Section
Graphical Interface
\end_layout

\begin_layout Subsection
Main window
\end_layout

\begin_layout Standard
You can control most of the program from this window.
 The cue controls in the down-left corner are fairly obvious.
 You can drag the large slider in the middle for seeking.
 There are two smaller sliders above that, the left one is for adjusting
 the volume and the right one for adjusting the balance.
 Above these, there are two horizontal text areas showing information about
 the currently playing track, and input/output parameters such as sample
 rate, mono/stereo, bitrate, output driver (e.g.\InsetSpace ~
OSS, ALSA, JACK) etc.
 The first trick to learn is that these lines are horizontally draggable
 with the mouse if the text does not fit in the available visible space.
 However, they don't scroll automatically (as in XMMS), and for a very good
 reason.
\end_layout

\begin_layout Standard
In the upper left corner, you find one bigger and two smaller displays that
 show track times: elapsed time and remaining time and total track time.
 The big display also shows the current volume and balance setting when
 appropriate.
 By clicking in these displays with the left or right mouse button, you
 can rearrange the displays as you want them.
 The following table may seem a bit confusing at first, but once you realize
 the point, it becomes blindingly obvious.
 
\end_layout

\begin_layout Standard
\align center
\begin_inset Tabular
<lyxtabular version="3" rows="2" columns="2">
<features>
<column alignment="center" valignment="top" leftline="true" width="0">
<column alignment="center" valignment="top" leftline="true" rightline="true" width="0">
<row topline="true">
<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\begin_layout Standard
A
\end_layout

\end_inset
</cell>
<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\begin_layout Standard

\end_layout

\end_inset
</cell>
</row>
<row topline="true" bottomline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\begin_layout Standard
B
\end_layout

\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\begin_layout Standard
C
\end_layout

\end_inset
</cell>
</row>
</lyxtabular>

\end_inset


\begin_inset ERT
status collapsed

\begin_layout Standard


\backslash
hspace{2cm}
\end_layout

\end_inset


\begin_inset Tabular
<lyxtabular version="3" rows="4" columns="4">
<features>
<column alignment="center" valignment="top" leftline="true" width="0">
<column alignment="center" valignment="top" leftline="true" width="0">
<column alignment="center" valignment="top" leftline="true" width="0">
<column alignment="center" valignment="top" leftline="true" rightline="true" width="0">
<row>
<cell multicolumn="1" alignment="center" valignment="top" usebox="none">
\begin_inset Text

\begin_layout Standard

\end_layout

\end_inset
</cell>
<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\begin_layout Standard
clicked into
\end_layout

\end_inset
</cell>
<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\begin_layout Standard

\end_layout

\end_inset
</cell>
<cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text

\begin_layout Standard

\end_layout

\end_inset
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text

\begin_layout Standard
mouse button
\end_layout