.\" $Id: ample.1.in,v 1.1 2002/02/07 01:02:47 alphix Exp $
.\" 
.\" This file is part of Ample.
.\" 
.\" Ample is free software; you can redistribute it and/or modify
.\" it 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.
.\" 
.\" Ample 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 Ample; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
.\"
.\"
.\" Process this file with something like
.\" groff -man -Tascii foo.1
.\"

.TH AMPLE 1 "JANUARY 2002" Ample "User Manual"
.SH NAME 
ample \- Ample MP3 server
.SH SYNOPSIS
.B ample
.RI "[" "OPTION" "] [" "PATH" "...]"

.SH DESCRIPTION
.B ample
Ample is an MP3 server that allows you to listen to your music that 
can be stored locally or remotely. It does not intend to support mixing, 
radio shows etc. It's just an easy way to listen to your MP3's everywhere 
using the "open location" features already present in XMMS, WinAmp and 
Media Player.
After installing, configuring and starting ample, try connecting to
.B http://server:1234/
with the "open location" feature of your favourite MP3 player or
.B http://server:1234/index.html
with your favourite web browser.

.SH OPTIONS
.TP
.BI "-p " "NUM " "--port=" "NUM"
Listen to TCP port 
.IR "NUM" ", default is 1234."
.TP
.B -o --order
When a list of files is requested, play them in alphabetical order.
.TP
.BI "-c " "NUM " "--clients=" "NUM"
Allow a maximum of
.I NUM
clients to be connected at the same time.
.TP
.B -n --norecursive
Don't automatically index files in subdirs of the directories being indexed
.TP
.BI "-f " "FILE " "--conffile=" "FILE"
Use 
.I FILE
as config file instead of the default
.IR "/etc/ample.conf" "."
.RI "See " "ample.conf" "(5) for details."
.TP
.BI "-m " "FILE " "--htmlfile=" "FILE"
Use 
.I FILE
as HTML template instead of the default
.IR "/etc/ample.html" "."
.RI "See " "ample.html" "(5) for details."
.TP
.B -h --help
Display help message and exit.
.TP
.BI "-d [" "NUM" "] --debug[=" "NUM" "]"
Print debug messages, a higher value of
.I NUM
means more detail.
.TP
.B -t --trace
Disables forking and backgrounding, useful for debugging.
.TP
.B -v --version
Display version information and exit.
.TP
.B -i --pidfile [PIDFILE]
Write a PIDFILE to handle ample as a daemon
.TP
.BI "[" "PATH" "...]"
These are path(s) to files or directories that Ample can use to 
populate it's list of MP3's. If
.I PATH
is a directory, all files (possibly recursively, see the
.B -n
option above) will be added. If 
.I PATH
is a regular file ending with .mp3 it will be added and if it
is a regular file ending with .m3u (MP3 playlist) the files listed
in it will be added.

.SH FILES
.I /etc/ample.conf
.RS
The default config file (another file may be used, see the
.B -f
option above). See 
.BR ample.conf (5)
for further details.
.P
.RE
.I /etc/ample.html
.RS
The default HTML template file (another file may be used, see the
.B -m
option above). See
.BR ample.html (5)
for further details.

.SH BUGS
Of course totally bugfree or your money back :-)

.SH AUTHOR
David Härdeman <david@2gen.com>

.SH "SEE ALSO"
.BR "ample.conf" "(5), " "ample.html" "(5)"