.\" Copyright (C) 2008 Steve Stalcup <vorian@ubuntu.com>
.\"
.\" This manual page is free software.  It is distributed under the
.\" terms of the GNU General Public License as published by the Free
.\" Software Foundation; either version 2 of the License, or (at your
.\" option) any later version.
.\"
.\" This manual page is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this manual page; if not, write to the Free Software
.\" Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
.\" USA
.\"
.TH "ESPERANZA" "1"

.SH "NAME"
Esperanza \- A XMMS2 client.

.SH "SYNOPSIS"
Esperanza [\fI\s-1CORE\s0\fR] [\fI\s-1LOOK\s0\fR] [\fI\s-1FEEL\s0\fR] [\fI\s-1SHORTCUTS\s0\fR]

.SH "DESCRIPTION"
Esperanza is an XMMS2 client designed to manage and organize music files in
multiple platforms.

.SH "CORE"

.TP
.BR \-\-`Autostart xmms = (on/off)
Choose to autostart xmms if it is not running.

.TP
.BR \-\-`Ignore desktop settings = (on/off)
Ignore the desktop settings (use this if everything is black).

.TP
.BR \-\-`Size of Cache (KB)
Choose the size of album art cache in KBs.

.TP
.BR \-\-`Ignore locale settings = (on/off)
Ignore locale settings and use default language.

.TP
.BR \-\-`Show icon tray = (on/off)
Show icon in system tray.

.TP
.BR \-\-`Load artist/album = (on/off)
Load artists and albums for completion in Medialib window.

.TP
.BR \-\-`Show server browser = (on/off)
Show the server browser on startup.

.SH "LOOK"

.TP
.BR \-\-`Show album art = (on/off)
Shows album art under artist.

.TP
.BR \-\-`Compact playlist = (on/off)
Use compact playlist mode (no context area).

.TP
.BR \-\-`Lighten Context area = (on/off)
Draw the context area in a lighter color.

.TP
.BR \-\-`Context area information choices
Album, Artist, Duration, Filename, Genre, Timesplayed, Title, Tracknumber, Show
time remaining instead of elapsed, Show a stop button, Paint the progress bar in
a lighter color.

.SH "FEEL"

.TP
.BR \-\-`Show pupups = (on/off)
Show popus notification on song change.

.TP
.BR \-\-`Show OiNK = (on/off)
Show OiNK search in Last.FM view.

.TP
.BR \-\-`Jump = (on/off)
Jump to the current entry in the playlist on song change.

.TP
.BR \-\-`Show Main window = (on/off)
Shows main window when you click or double click.

.TP
.BR \-\-`Show playlist = (on/off)
Show the playlist (and minimode window) always on top.

.TP
.BR \-\-`No Quit = (on/off)
Do not quit esperanza on close, rather than hide it (needs system tray active).

.TP
.BR \-\-`Set time (sec)
Set the time, how long a popup notification should be shown.

.TP
.BR \-\-`Show playerwindow = (on/off)
Show the playerwindow as a toolwindow (no windowlist entry).

.TP
.BR \-\-`Change Volume = (on/off)
Change volume interactively (could cause problems).

.TP
.BR \-\-`Show volume pupups = (on/off)
Show the volume slider in a popup.


.SH "SHORTCUTS (Default)"

.TP
.BR \-\-`Ctrl+Shift+X
Global shortcut to jump to the previous playlist entry.

.TP
.BR \-\-`Ctrl+Shift+V
Global shortcut to jump to the next playlist entry.

.TP
.BR \-\-`Ctrl+Shift+C
Global shortcut to play / pause the playback.

.TP
.BR \-\-`Ctrl+Shift+M
Global shortcut to show / hide the player.

.TP
.BR \-\-`Ctrl+Shift+B
Global shortcut to stop the playback.

.TP
.BR \-\-`D
Add a local directory recursively.

.TP
.BR \-\-`A
Add a local file.

.TP
.BR \-\-`V
Jump to the previous playlist entry.

.TP 
.BR \-\-`Ctrl+W
Close the window.

.TP
.BR \-\-`B
Jump to the next playlist entry.

.TP
.BR \-\-`Esc
Hide the player.

.TP
.BR \-\-`Return
JumpPos !?

.TP
.BR \-\-`Ctrl+M
Switch between minimode and the normal mode.

.TP
.BR \-\-`Space
Play / pause the playback.

.TP
.BR \-\-`Ctrl+Q
Quit esperanza.

.TP
.BR \-\-`Del
Remove a selected playlist entry from the playlist.

.TP
.BR \-\-`Backspace
Remove a selected playlist entry from the playlist.

.TP
.BR \-\-`C
Clear the playlist.

.TP
.BR \-\-`S
Enable / Disable shuffling the playlist.

.SH "BUGS"
Report bugs to http://wiki.xmms2.xmms.se/index.php/Client:Esperanza

.SH "AUTHORS"
Esperanza was written by Tobias Rundström <tru@xmms.org>. This manual page was
written by Steve Stalcup <vorian@ubuntu.com>.
.br
Both are released under the GNU General Public License, version 2 or later.