manual.lyx

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

#LyX 1.4.2 created this file. For more info see http://www.lyx.org/
\lyxformat 245
\begin_document
\begin_header
\textclass article
\begin_preamble
\sloppy

\usepackage[bookmarks, bookmarksopen=true, bookmarksopenlevel=2, colorlinks=true, pdfstartview=FitH, urlcolor=blue, linkcolor=black, pdftitle={Aqualung User's Manual}]{hyperref}
\usepackage{fancyhdr}
\lhead{Aqualung}
\chead{User's Manual}
\rhead{\thepage}
\lfoot{}
\cfoot{}
\rfoot{}
\end_preamble
\language english
\inputencoding default
\fontscheme ae
\graphics default
\paperfontsize 10
\spacing single
\papersize a4paper
\use_geometry true
\use_amsmath 1
\cite_engine basic
\use_bibtopic false
\paperorientation portrait
\leftmargin 2.5cm
\topmargin 3.5cm
\rightmargin 2.5cm
\bottommargin 3cm
\headsep 1cm
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle fancy
\tracking_changes false
\output_changes true
\end_header

\begin_body

\begin_layout Standard
\begin_inset ERT
status collapsed

\begin_layout Standard


\backslash
begin{titlepage}
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard


\backslash
begin{center}
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard


\backslash
hspace{0mm}
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard


\backslash
vspace{10mm}
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard

{
\backslash
Huge
\backslash
bf Aqualung}
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard


\backslash
vspace{3mm}
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard

{
\backslash
LARGE Music Player for GNU/Linux}
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard


\backslash
vspace{10mm}
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard


\backslash
today
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard


\backslash
vspace{70mm}
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard

{
\backslash
Huge User's Manual}
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard


\backslash
vspace{60mm}
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard

Copyright 
\backslash
copyright{} 2006 Peter Szilagyi
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard


\backslash
vspace{5mm}
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard

Permission is granted to copy, distribute and/or modify this document
\backslash

\backslash

\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard

under the terms of the GNU Free Documentation License, Version 1.2
\backslash

\backslash

\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard

or any later version published by the Free Software Foundation.
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard


\backslash
end{center}
\end_layout

\begin_layout Standard

\end_layout

\begin_layout Standard


\backslash
end{titlepage}
\end_layout

\end_inset


\end_layout

\begin_layout Standard
\begin_inset LatexCommand \tableofcontents{}

\end_inset


\newpage

\end_layout

\begin_layout Section
Introduction
\end_layout

\begin_layout Standard
Aqualung is a music player for the GNU/Linux operating system.
 It plays audio files from your filesystem and has the feature of inserting
 no gaps between adjacent tracks.
 It also supports high quality sample rate conversion between the file and
 the output device, when necessary.
\end_layout

\begin_layout Standard
Almost all sample-based, uncompressed formats (e.g.\InsetSpace ~
WAV, AIFF, AU etc.) are
 supported.
 Files encoded with FLAC (the Free Lossless Audio Codec), Ogg Vorbis, Ogg
 Speex, MPEG Audio (including the infamous MP3 format), MOD audio formats
 (MOD, S3M, XM, IT, etc.), Musepack and Monkey's Audio Codec are also supported.
 The program can play the music through OSS, ALSA or the JACK Audio Connection
 Kit, or even using the Win32 Sound API (available only under Cygwin).
 Depending on the compile-time options, not all file formats and output
 drivers may be usable.
 Type `aqualung -v' to get a list of all the compiled-in features.
\end_layout

\begin_layout Standard
Aqualung supports the LADSPA 1.1 plugin standard.
 You can use any suitable plugin to enhance the music you are listening
 to.
\end_layout

\begin_layout Standard
Other features of the program are internally working volume and balance
 controls (not touching the soundcard mixer), multiple skin support, random
 seeking during playback, track repeat, list repeat and shuffle mode (besides
 normal playback).
 Aqualung will come up in the same state as it was when you closed it, including
 playback modes, volume and balance settings, currently processing LADSPA
 plugins, window sizes, positions and visibility, and other miscellaneous
 options.
 Aqualung has the ability to display and edit Ogg Xiph comments, ID3v1,
 ID3v2 and APE tags found in files that support them.
\end_layout

\begin_layout Standard
You can control any running instance of the program remotely from the command
 line (start, stop, pause etc.).
 Remote loading or enqueueing soundfiles as well as complete playlists is
 also supported.
\end_layout

\begin_layout Standard
In addition to all this, Aqualung provides a so-called Music Store that
 is an XML-based music database, capable of storing various metadata about
 music on your computer (including, but not limited to, the names of artists,
 and the titles of records and tracks).
 You can (and should) organize your music into trees of Artists/Records/Tracks,
 thereby making life easier than with the all-in-one Winamp/XMMS playlist.
 Importing file metadata (ID3v1, ID3v2 tags, Ogg Xiph comments, APE metadata)
 into the Music Store as well as getting track names from a CDDB/Freedb
 database is supported.
\end_layout

\begin_layout Section
Command Line Interface
\end_layout

\begin_layout Subsection
Invocation
\end_layout

\begin_layout Description
aqualung\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

help Print help message with valid parameters and example invocations.
\end_layout

\begin_layout Description
aqualung\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

version Print version information and list of compiled-in features.
\end_layout

\begin_layout Description
aqualung\InsetSpace ~
[
\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

output\InsetSpace ~
(oss|alsa|jack|win32)]\InsetSpace ~
[options]\InsetSpace ~
[file1\InsetSpace ~
[file2\InsetSpace ~
\SpecialChar \ldots{}
]]
\end_layout

\begin_layout Subsection
General options
\end_layout

\begin_layout Description
-D,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

disk-realtime Try to use realtime (SCHED_FIFO) scheduling for disk thread,
 a background worker thread doing file decoding and sample rate conversion.
 Try this (and optionally -Y) if you experience short audio dropouts caused
 by other programs (e.g.\InsetSpace ~
web browser loading a complex page).
\end_layout

\begin_layout Description
-Y,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

disk-priority\InsetSpace ~
<int> When running -D, set scheduler priority to <int> (defaults
 to 1).
 
\end_layout

\begin_layout Subsection
Output specific options
\end_layout

\begin_layout Subsubsection
ALSA
\end_layout

\begin_layout Description
-d,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

device\InsetSpace ~
<name> Set the output device (defaults to plughw:0,0).
\end_layout

\begin_layout Description
-p,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

period\InsetSpace ~
<int> Set ALSA period size (defaults to 8192).
\end_layout

\begin_layout Description
-n,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

nperiods\InsetSpace ~
<int> Specify the number of periods in hardware buffer (defaults
 to 2).
\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 Description
-R,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

realtime Try to use realtime (SCHED_FIFO) scheduling for ALSA output thread.
\end_layout

\begin_layout Description
-P,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

priority\InsetSpace ~
<int> When running 
\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

realtime, set scheduler priority to <int> (defaults to 1).
\end_layout

\begin_layout Subsubsection
OSS
\end_layout

\begin_layout Description
-d,\InsetSpace ~

\begin_inset ERT
status collapsed

\begin_layout Standard

{-}{-}
\end_layout

\end_inset

device\InsetSpace ~
<name> Set the output device (defaults to /dev/dsp).
\end_layout

\begin_layout Description