1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
.\" $Id: ample.conf.5.in,v 1.2 2002/10/25 20:35:10 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.CONF 5 "JANUARY 2002" Ample "User Manual"
.SH NAME
ample.conf \- configuration file for Ample
.SH DESCRIPTION
This file, by default
.IR "@sysconfdir@/ample.conf" ","
is read by Ample at startup. There are three categories of values
than can be defined: strings, numbers and boolean values. Valid boolean
values are (case insensitive) yes, no, true and false. Lines that start
with # are considered to be comments and ignored.
.SH EXAMPLE
.IP
.nf
# An example of a Ample config file
#
# Port number to use
port = 1234
# Should files be ordered when playing a mixed stream?
order = true
# Amount of simultaneous clients allowed
clients = 5
# Path to logfile if syslog isn't used
logfile = /var/log/ample
# Path(s) to MP3 dir/file or M3U file
mp3path = /home/mp3
mp3path = /home/moremp3/zztop.mp3
mp3path = /home/favourites.m3u
# Path to the HTML file to use as a template
htmlfile = /etc/ample.html
# Should the MP3 dir(s) be recursively scanned?
recursive = true
# Name of the server
# (displayed to clients here and there)
servername = Ample
# Address of the server
# (only if your server can't be resolved)
serveraddress = 192.168.0.1
# Username and password, if these are specified, Ample
# will automatically ask for username/password
username = MusicLover
password = Pekaboo
# Filter to pass each music file through
# (before they are sent to the client)
filter = /usr/bin/lame -b64 --quiet "@FPATH@" -
# The end
.SH OPTIONS
.TP
.BI "port=" "NUM"
Listen to TCP port
.IR "NUM" ", default is 1234."
.TP
.BI "order=" "BOOL"
When a list of files is requested, and this option is
.BR "TRUE" ","
play them in alphabetical order.
.TP
.BI "clients=" "NUM"
Allow a maximum of
.I NUM
clients to be connected at the same time.
.TP
.BI "logfile=" "FILE"
Use
.I FILE
as logfile if
.BR syslogd (8)
isn't used.
.TP
.BI "mp3path=" "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. You can specify several paths by adding several
.BI "mp3path=" "PATH"
lines to this config file.
.TP
.BI "htmlfile=" "FILE"
This is the path to the file which Ample should use as it's base
for creating HTML pages. See
.BR "ample.html" "(5)"
for more information.
.TP
.BI "recursive=" "BOOL"
If
.BR "TRUE" ","
all directories that Ample index:es will be scanned recursively
(meaning that all subdirs will be checked for files as well)
.TP
.BI "servername=" "STRING"
The name of the server will be set to
.I STRING
instead of "Ample" (the servername is displayed to clients in various
places).
.TP
.BI "serveraddress=" "STRING"
.I STRING
should be the IP address of the server where Ample is run. This is
only needed if DNS resolving your server, for some reason, doesn't work.
.TP
.BI "username=" "STRING"
If both username and password is specified in the config file, HTTP
authentication will be enabled. This means that if a client wants to
connect to ample, it must do so with a username and password in
order to be granted acccess. If username or password is missing,
HTTP authentication will be disabled.
.TP
.BI "password=" "STRING"
See the description of username above.
.TP
.BI "filter=" "STRING"
Specifies an optional filter to run each file through before it is sent to the client.
As an example, this could be used to downgrade the bitrate of a music file
if you have a lousy net connection but lots of CPU cycles to spare. If
.I STRING
contains the word @FPATH@ it will be replaced with the absolute path of the file.
.SH AUTHOR
David Hrdeman <david@2gen.com>
.SH "SEE ALSO"
.BR "ample" "(1), " "ample.html" "(5)"
|
