annotate README @ 1837:be26ff803e4f trunk

[svn] - Make mainwin shading work correctly.
author nhjm449
date Thu, 05 Oct 2006 21:31:27 -0700
parents 3589d4770022
children f6856d226afb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1173
bc721c146511 [svn] - fix spelling
nenolod
parents: 70
diff changeset
1 Audacious (c) GPL 2005-2006
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
2
1173
bc721c146511 [svn] - fix spelling
nenolod
parents: 70
diff changeset
3 Audacious Development Team (see AUTHORS)
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
4
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
5
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
6 Based on:
70
f3445e7184f7 [svn] blah\!
msameer
parents: 0
diff changeset
7 BMP - Beep Media Player.
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
8
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
9 Which was based on:
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
10 XMMS - X Multimedia System (c)1997-2001
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
11
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
12 A Cross platform Multimedia Player
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
13
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
14 Peter Alm, Thomas Nilsson, Olle Hallnas, Håvard Kvålen
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
15
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
16
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
17 NOTE: This document is hardly maintained. Please check the Users' Guide on
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
18 the Audacious website.
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
19
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
20
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
21 TABLE OF CONTENTS
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
22 *****************
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
23
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
24 1. Disclaimer
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
25 2. Installation
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
26 2.1 Basic Installation
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
27 2.2 Border less Installation
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
28 2.3 Skin Installation
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
29 3. Documentation
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
30 3.1 Controlling Audacious
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
31 3.1.1 Key bindings
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
32 3.2 Playlist Editor
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
33 3.3 Equalizer
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
34 3.4 Menu
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
35 3.5 Preferences
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
36 3.5.1 Audio I/O Plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
37 3.5.2 Effect/General Plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
38 3.5.3 Visualization Plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
39 3.5.4 Options
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
40 3.5.5 Fonts
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
41 3.5.6 Title
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
42 3.6 Plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
43 3.6.1 Input plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
44 3.6.1.1 Cd Audio Player
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
45 3.6.1.2 MPEG Layer 1/2/3 player
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
46 3.6.1.3 Ogg Vorbis player
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
47 3.6.1.4 WAV player
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
48 3.6.2 Output plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
49 3.6.2.1 OSS Driver
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
50 3.6.2.2 eSound Output
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
51 3.6.2.3 BSD Sun Output
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
52 3.6.3 Effect plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
53 3.6.4 General plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
54 3.6.5 Visualization plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
55 3.6.5.1 Blur scope
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
56 4. Command Line Options
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
57 5. Features
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
58 5.1 Supported File formats
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
59 5.2 Supported Features
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
60 6. Obtaining Audacious
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
61 7. Misc
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
62 7.1 Shoutcast support
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
63 7.2 Tips and tricks
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
64 8. Bugs
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
65 9. Contact Email
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
66
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
67
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
68
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
69
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
70 1. Disclaimer
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
71 -------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
72
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
73 We are not liable for any damage caused by the use of this program.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
74
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
75 Audacious is NOT a port of WinAmp (http://www.winamp.com). Audacious is a fork of
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
76 XMMS (http://xmms.org) and BMP (http://beep-media-player.org) which borrowed the
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
77 WinAmp GUI.
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
78
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
79
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
80 2. Installation
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
81 ---------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
82
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
83 Audacious requires the following libraries and their development
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
84 packages installed:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
85
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
86 Glib 2.4
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
87 (http://www.gtk.org/download/)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
88
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
89 GTK+ 2.4
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
90 (http://www.gtk.org/download/)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
91
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
92 libglade >= 2.3.1
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
93 (http://ftp.gnome.org/pub/GNOME/sources/libglade/2.3/)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
94
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
95 The following packages are required for optional features:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
96
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
97 Vorbis input plugin:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
98 libvorbis >= 1.0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
99 (http://www.xiph.org/ogg/vorbis/download.html)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
100
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
101 ESD output plugin:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
102 esound >= 0.2.3
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
103 (http://ftp.gnome.org/pub/GNOME/desktop/2.6/2.6.0/sources/)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
104
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
105 ALSA output plugin:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
106 alsa-lib >= 1.0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
107 (http://www.alsa-project.org)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
108
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
109 GNOME VFS support:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
110 gnome-vfs >= 2.6.0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
111 (http://ftp.gnome.org/pub/GNOME/desktop/2.6/2.6.0/sources/)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
112
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
113 GConf support:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
114 GConf >= 2.6.0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
115 (http://ftp.gnome.org/pub/GNOME/desktop/2.6/2.6.0/sources/)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
116
1427
3589d4770022 [svn] - update documentation
nenolod
parents: 1174
diff changeset
117 Taglib:
3589d4770022 [svn] - update documentation
nenolod
parents: 1174
diff changeset
118 Taglib >= 1.4
3589d4770022 [svn] - update documentation
nenolod
parents: 1174
diff changeset
119
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
120 If you compile Audacious from a fresh CVS checkout, you will also need
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
121 the following tools:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
122
1427
3589d4770022 [svn] - update documentation
nenolod
parents: 1174
diff changeset
123 automake >= 1.9
3589d4770022 [svn] - update documentation
nenolod
parents: 1174
diff changeset
124 autoconf >= 2.59
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
125
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
126 Note that these tools and libraries are bundled with major Linux
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
127 distributions. Use the packages provided with them where possible. If
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
128 those packages are not sufficiently new, you may need to search
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
129 third-party repositories for them.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
130
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
131
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
132 2.1 Basic Installation
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
133 ----------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
134
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
135 cd audacious-1.1.0
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
136 ./configure
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
137 make
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
138 make install
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
139
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
140 This will put the binary in /usr/local/bin and plugins in
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
141 /usr/local/lib/audacious/
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
142
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
143 Note for packagers: The gnome-vfs option is VERY EXPERIMENTAL. We suggest you
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
144 do not use it in your official distribution packages.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
145
1427
3589d4770022 [svn] - update documentation
nenolod
parents: 1174
diff changeset
146 If you want to use the automatic character detection system, then you should
3589d4770022 [svn] - update documentation
nenolod
parents: 1174
diff changeset
147 use --enable-chardet.
3589d4770022 [svn] - update documentation
nenolod
parents: 1174
diff changeset
148
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
149
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
150 2.2 Borderless Installation
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
151 ---------------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
152
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
153 As far as I know most WM's accepts GTK decoration hints so it will
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
154 not have borders. But some WM's can't handle this so you have to
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
155 set in manually.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
156
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
157 AfterStep 1.0 ~/.steprc
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
158 Style "XMMS_Player" NoTitle, NoHandles
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
159 Style "XMMS_Playlist" NoTitle, NoHandles
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
160 Style "XMMS_Equalizer" NoTitle, NoHandles
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
161
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
162 AfterStep 1.4 ~/GNUstep/Library/AfterStep/database
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
163 Style "XMMS_Player" NoTitle, NoHandles
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
164 Style "XMMS_Playlist" NoTitle, NoHandles
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
165 Style "XMMS_Equalizer" NoTitle, NoHandles
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
166
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
167 Fvwm's ~/.fvwm95rc
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
168 Style "XMMS_Player" NoTitle
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
169 Style "XMMS_Playlist" NoTitle
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
170 Style "XMMS_Equalizer" NoTitle
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
171
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
172 CTWM's ~/.ctwmrc
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
173 NoTitle and NoBorder sections:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
174 NoTitle {
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
175 "xmms"
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
176 }
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
177
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
178 NoBorder {
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
179 "xmms"
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
180 }
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
181
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
182 2.3 Skin Installation
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
183 ---------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
184
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
185 Audacious will create a directory called ~/.audacious/Skins/. You can unarchive
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
186 the skins the same way as you do for WinAmp.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
187
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
188 However, you don't need to as Audacious supports archived skins. Audacious
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
189 currently reads the following formats: zip, wsz, tar, tar.gz and
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
190 tar.bz2
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
191
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
192 Just copy the archive to one of the skin path's and Audacious will take care
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
193 of the rest.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
194
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
195 In order to support zipped skins you will need to have unzip. Unzip
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
196 is bundled with most Linux distributions.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
197
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
198 Audacious looks for skins in these directories (in listing order):
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
199
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
200 <prefix>/share/audacious/Skins
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
201 ~/.audacious/Skins
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
202
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
203 You can set the environment variable SKINSDIR to another location of
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
204 your choice:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
205
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
206 For BASH:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
207 export SKINSDIR=/path/to/Skins:/more/paths/to/other/locations/of/Skins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
208
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
209 For CSH:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
210 setenv SKINSDIR /path/to/Skins:/more/paths/to/other/locations/of/Skins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
211
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
212
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
213 3. Documentation
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
214 ----------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
215
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
216 This file or http://audacious-media-player.org
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
217
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
218
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
219 3.1 Controlling Audacious
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
220 --------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
221
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
222 When you start up Audacious, you will get a console very similar to that of
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
223 WinAmp.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
224
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
225 - On the top is the window title bar. To the right you will see 3 buttons,
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
226 Left button will minimize Audacious.
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
227 Middle button will make Audacious only display the title bar.
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
228 Right button will end the Audacious session.
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
229
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
230 - The area in the upper left part displays the following:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
231 - Play state: Paused, Stopped, or Playing
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
232 - Time elapsed in the current song or if you click on it, the reversed.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
233 - Spectrum analyzer of the sound being played. Right mouse click will
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
234 bring up the Visualization menu. Left mouse button will change the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
235 analyzer to an oscilloscope and/or none.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
236
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
237 - To the right of the Spectrum analyzer is the title of the file being played.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
238 This also contains the length of the song being played, as well as its
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
239 position in the [unsorted] playlist. Right clicking in this window will bring
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
240 up a new menu with some more options that are self explaining.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
241
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
242 - In the left part of the Spectrum analyzer you'll have letters (at least if
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
243 you use the default skin) O A I D V. This is known as the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
244 "clutterbar'. Left-clicking on these will open up menus or perform the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
245 listed actions.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
246 O : Options menu
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
247 A : Always on top
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
248 I : File info box
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
249 D : Double size mode
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
250 V : Visualization menu
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
251
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
252 - Underneath the track title are the following static informational data:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
253 - bit rate in KBps (usually 128 or 112)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
254 - Sample Rate in KHz (usually 44)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
255 - Stereo or Mono channel mixing
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
256
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
257 - Underneath the informational data are a few controls you can play with:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
258 - The first slider controls the volume
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
259 - The second slider controls the balance between speakers
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
260 - The button marked "EQ" loads up the graphic equalizer
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
261 - The button marked "PL" loads up the playlist editor
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
262 - The LARGE slide bar moves from left to right as the song plays. You can
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
263 drag this to jump to another location in the current file.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
264
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
265 - On the bottom of the console are the standard buttons you would see on a CD
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
266 player: Previous track, Play, Pause, Stop, Next track, eject, shuffle
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
267 and repeat.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
268
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
269 - The eject button doesn't REALLY eject, of course. :) It opens up the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
270 file requester. The File Requester builds a playlist for the current
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
271 Audacious session. You can use it to load files, add files to the list, or
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
272 load all mp3s in a directory.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
273
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
274 - The shuffle button randomizes the sequence of the playlist.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
275
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
276 - The repeat button when enabled makes the playlist loop when it reaches the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
277 end of the playlist.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
278
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
279
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
280 3.1.1 Key bindings
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
281 ------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
282
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
283 Global: (Main, Equalizer and Playlist window)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
284
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
285 z = Previous song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
286 x = Play
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
287 c = Pause
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
288 v = Stop
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
289 b = Next song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
290 l = Play file (brings up the Load file(s) dialog)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
291 j = Jump to file (in the existing playlist)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
292 r = Toggle Repeat
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
293 s = Toggle Shuffle
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
294
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
295 Control + h = Play location (url)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
296 Control + p = Preferences dialog
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
297 Control + r = Time remaining
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
298 Control + o = Always on top
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
299 Control + w = Winshade mode
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
300 Control + j = Jump to time
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
301 Control + z = Start of list
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
302 Control + n = No Playlist Advance
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
303 Control + 3 = File info dialog
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
304
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
305 Control + Alt + w = Toggle Equalizer winshade mode
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
306 Shift + Control + w = Toggle Playlist winshade mode
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
307
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
308 Alt + e = Toggle playlist window
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
309 Alt + g = Toggle equalizer window
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
310
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
311 Main window:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
312
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
313 Arrow key up = Volume up 2%
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
314 Arrow key down = Volume down 2%
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
315 Arrow key right = Skip 5 seconds forward in song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
316 Arrow key left = Skip 5 seconds back in song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
317
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
318 Playlist window:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
319
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
320 Arrow key up = up one step in playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
321 Arrow key down = Down one step in playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
322
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
323 Delete = Remove selected songs from playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
324 Page Up = Move one page up
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
325 Page Down = Move one page down
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
326 Home = Go to the first song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
327 End = Go to the last song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
328 Enter = Play selected song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
329 Insert = Add file dialog
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
330 Shift + Insert = Add directory dialog
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
331 Alt + Insert = Add url dialog
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
332
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
333 Equalizer shade mode:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
334
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
335 Arrow key up = Volume up 2%
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
336 Arrow key down = Volume down 2%
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
337 Arrow key right = Balance 4% to right
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
338 Arrow key left = Balance 4% to left
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
339
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
340
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
341 3.2 Playlist editor
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
342 -------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
343
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
344 To access the Playlist editor, select the button labeled "PL" on the right
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
345 side of the Audacious console.
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
346
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
347 This will bring up the actual playlist window, here you'll find 5 buttons.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
348 All of these buttons can be held down to bring up an extra menu.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
349 From left to right:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
350
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
351 file + : will add a file to current playlist, held down mode you'll have
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
352 2 extra options
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
353 dir : will let you pick a directory (recursive)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
354 url : will let you add an url for streaming
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
355
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
356 file - : will delete the highlighted file, held down mode you'll have 3
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
357 more options
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
358 crop : delete all files except the highlighted in the list
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
359 all : delete all files in the list
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
360 misc : *** NOT FUNCTIONAL ***
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
361
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
362 sel all : select all files in current playlist, held down mode you'll have
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
363 2 extra options
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
364 sel zero : select none
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
365 inv sel : invert you selection
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
366
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
367 misc opts : held down you'll have 2 extra options
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
368 fileinfo : opens the file info dialog.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
369 sort : release button on this will bring up another menu with sort options
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
370
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
371 load list : will let you pick a playlist to load, held down you'll have
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
372 2 extra options
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
373 save : will let you save your playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
374 new : will empty the playlist and let you create a new playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
375
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
376 If you want to select/deselect files in the filrequester/playlist editor use
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
377 CTRL for files and SHIFT key for blocks of files. You can also browse the PL
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
378 using the cursor keys and enter to select song. Pressing the delete button will
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
379 remove the song from the playlist. If your mouse is equipped with a mouse
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
380 wheel, you can use this to scroll up and down.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
381
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
382 3.3. Equalizer
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
383 --------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
384
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
385 To access the Equalizer, select the button labeled "EQ" on the right
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
386 side of the Audacious console.
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
387
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
388 That will bring up the Equalizer window. It looks like an equalizer on a stereo
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
389 and behaves like one as well. Press the button labeled ON to enable the use of
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
390 the equalizer, once you turned it on you use it as a normal equalizer.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
391
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
392 EQ presets will be saved in ~/.audacious/config when you close Audacious. You can also
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
393 have your own presets for different song using the "Preset" button, Audacious can
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
394 also import/export from WinAmp's preset files.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
395
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
396 If 'Auto' is enabled, Audacious will try to load equalizer presets like this:
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
397
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
398 1: Look for a preset file in the directory of the file we are about to play.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
399 2: Look for a directory preset file in the same directory.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
400 3: Look for a preset saved with the "auto-load" feature.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
401 4: Finally, try to load the "default" preset.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
402
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
403 The 'preset' button will open up a menu with the following options:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
404
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
405 Load
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
406 Preset : Will open a window with all available presets.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
407 Auto-load preset : Will open a window with all available auto-load
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
408 presets.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
409 Default : Will load the default preset.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
410 Zero : Will reset the equalizer to zero.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
411 From file : Will load from a .preset file
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
412 From WinAMP EQF file : Will load from a WinAMP equalizer file. If you
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
413 choose a library file only the first entry will
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
414 be loaded.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
415 Import
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
416 WinAMP presets : Imports the presets contained in an WinAMP equalizer
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
417 library file (often named WINAMP.q1) and add all
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
418 the entries to the Preset window.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
419 Save
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
420 Preset : Let you name the current preset and save it.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
421 Auto-load preset : Saves the current settings as a preset for the song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
422 currently playing.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
423 Default : Saves the default value for the equalizer.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
424 From file : Saves the current settings in a preset file.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
425 From WinAMP EQF file : Exports the current settings to a file readable by
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
426 WinAMP.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
427 Delete
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
428 Preset : Let you delete a preset from the list.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
429 Auto-load preset : Let you delete a auto-load preset from the list.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
430
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
431 Configure Equalizer : Change the default names of directory based
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
432 preset files.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
433
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
434 3.4. Menu
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
435 ---------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
436
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
437 There are several menu hot spots on the Audacious window. One place is at the left
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
438 hand side of the visual window described in sections 3.1 If you click the right
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
439 mouse button in the main window, the menus will also pop up (same as clicking
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
440 the button on the top left corner).
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
441
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
442 3.5. Preferences
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
443 ----------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
444
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
445 Use the menu to open Options / Preferences or press CTRL-P to bring the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
446 preferences dialog up.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
447
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
448 3.5.1. Appearance
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
449 -----------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
450
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
451 Skins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
452 In the skinlist you can choose a skin. How to install skins is described above.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
453 Click on a skin in the list to change to it.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
454
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
455 Fonts
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
456 You can set the font in the main window by setting the 'Player' font. You can
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
457 change the playlist font by setting the 'Playlist' font.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
458
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
459 Miscellaneous
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
460 Show track numbers in playlist - Enable/disable displaying of track numbers in
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
461 the playlist.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
462 Use custom cursors - Enable/disable custom cursors set by the skin.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
463
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
464
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
465 3.5.2. Mouse
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
466 ------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
467
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
468 Mouse wheel
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
469 Change how Audacious handles scroll behaviours.
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
470
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
471 3.5.3. Playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
472 ---------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
473
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
474 Filename
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
475 Convert underscores to blanks - Converts '_' (underscores) to ' ' in the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
476 playlist.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
477 Convert %20 to blanks - Converts '%20' to ' ' in the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
478 playlist.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
479
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
480 Metadata
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
481 Load metadata from playlists and files - Loads metadata from files and
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
482 playlists (e.g. ID3 tags).
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
483
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
484 Playback
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
485 Don't advance in playlist - Don't advance to the next song in the playlist when
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
486 the current song ends.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
487 Pause between songs - Set the time (in secons) to pause on songchange
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
488
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
489 Song display
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
490 Title format - Choose the format to display the song names in the playlist.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
491 Custom string - When the above option is set to 'Custom' insert a string of
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
492 substitutes here.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
493
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
494 3.5.6. Plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
495 --------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
496
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
497 Enable/disable and configure plugins in this section.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
498
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
499 Choose a tab to list one of the types of plugins:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
500 - Media (filetype/device support)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
501 - General (general plugins)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
502 - Visualization (visualization plugins)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
503 - Effects (effect plugins)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
504 - Output (output plugins)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
505
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
506 3.6 Plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
507 -----------
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
508 Plugins is what makes Audacious work, by moving most of the code out of Audacious and
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
509 into a plugin architecture it's possible to change almost everything in Audacious.
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
510 There are today 5 different types of plugins. Only a few plugins are
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
511 distributed with Audacious, you can find information on more of them at:
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
512
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
513 http://audacious-media-player.org
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
514
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
515
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
516 3.6.1 Input plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
517 -------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
518 The input plugins is what you use to play mp3, mod, wav and even movies with.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
519
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
520
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
521 3.6.1.1 Cd Audio Player
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
522 -----------------------
1427
3589d4770022 [svn] - update documentation
nenolod
parents: 1174
diff changeset
523 Plays audio cd's on Linux, FreeBSD and Solaris. This plugin typically does not
3589d4770022 [svn] - update documentation
nenolod
parents: 1174
diff changeset
524 pass the sound through Audacious, so no visualization can be made nor will the
3589d4770022 [svn] - update documentation
nenolod
parents: 1174
diff changeset
525 equalizer settings have any effect. It can however, be configured to do so.
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
526
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
527 Before I explain the usage we better have a look on the configuration
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
528 first.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
529
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
530 In the device tab you should set Device to your cdrom unit. /dev/cdrom
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
531 is generally a good choice on Linux systems. Set 'Directory' to where a
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
532 directory which will be used by Audacious to present the available cd tracks in.
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
533 Using the normal mount point for the cdrom is recommended unless the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
534 cdrom is automounted if it contains a data track.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
535
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
536 Example:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
537 --------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
538 Device: /dev/cdrom (which on my system is symlinked to /dev/hdc)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
539 Directory: /mnt/cdrom
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
540
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
541 The next setting is used to decide what volume is to be changed, it's either
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
542 the OSS Mixer for CD Audio or the actual volume on the CDROM.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
543
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
544 In the CD Info tab you can choose if the plugin should try and get the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
545 track names from a Internet database server.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
546
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
547 You can either use the CDDB protocol or CD Index. CDDB defaults to a free
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
548 version of CDDB, but it will work with the infamous cddb servers as well.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
549
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
550 Show network window will display some useful information if something goes
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
551 wrong, but you'll have to close and re-open it to update the content of it.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
552
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
553 If a CDDB server is too slow for your taste, you can press 'Get server list'
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
554 to receive a list of alternate servers.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
555
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
556 CD Index is another type of database, but works in a similar manner. If
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
557 you don't have libxml installed when you compiled the plugin, this will be
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
558 grayed out.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
559
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
560 In the "Track names" box you can decide on how the plugin presents the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
561 tracks to you. This is normally handled by the 'Title' (section 3.5.6) setting
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
562 in the main preferences, but you can choose to override them here.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
563
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
564 Available variables are:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
565
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
566 %p = Performer/Artist %t = Track name
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
567 %a = Album %n = Track number
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
568
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
569 So "%n. %t / %p (%a)" would display something like:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
570
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
571 1. New Life / Depeche Mode (Speak & Spell)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
572
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
573 Now to add your CDROM tracks to the playlist. Insert an audio cd into the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
574 CDROM drive and press the Eject button. Go to the directory which you defined
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
575 earlier ( /mnt/cdrom ) and you should see a list of tracks. They will be named
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
576 Track XX.cda, select the tracks you want to play and press OK. If you had
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
577 choosed an Internet database and the CD exists in it, Audacious will now display
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
578 the tracks you have chosen with their names according to the 'Name format'
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
579 configuration.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
580
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
581 Now, that wasn't hard now was it?
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
582
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
583 If you want Audacious to identify as something else when speaking with servers, you
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
584 can set the environmental variable "XMMS_CDDB_CLIENT_NAME", and Audacious will use
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
585 that instead.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
586
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
587
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
588 3.6.1.2 MPEG Layer 1/2/3 player
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
589 -------------------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
590 The main reason why this player exists today is mp3 files, so what could be
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
591 better than a plugin that plays them?.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
592
1427
3589d4770022 [svn] - update documentation
nenolod
parents: 1174
diff changeset
593 It's loosely based off the mpg123 engine and handles MPEG Layer 1/2/3 files and
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
594 VBR (variable bit rate) MP3 files.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
595
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
596 The first configuration tab is just like the MikMod one, and again, if you
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
597 have an older soundcard and the music is going half speed, change the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
598 'Resolution' setting.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
599
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
600 If you have mp3 files named something else than .mp3, you might want to enable
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
601 'Detect files by content' so Audacious will know that they are supported. Although
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
602 I'd recommend that you rename the files (or just beat the person who burned his
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
603 high-school bands music with in proper file extensions into giving you a new
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
604 cd) since this is rather slow.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
605
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
606 In the streaming tab you can choose a 'Buffer size' in kilobytes which Audacious
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
607 will keep while streaming. This ranges from 4 -> 4096kb (which should be
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
608 sufficient for most people. The 'Pre-buffer' value is how much of the buffer
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
609 Audacious should fill before starting to play the stream. (0%-90%)
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
610
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
611 I'll let Chad Armstrong describe the two following options.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
612
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
613 "As streaming becomes more popular, there is rising demand for better
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
614 information about the current track being played. This 'Now Playing'
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
615 information (also known as 'Title Streaming') allows for more information to be
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
616 passed back to the listener. In the past, there was a method started by the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
617 Shoutcast group, which embedded this information in the stream itself. The mp3
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
618 standard was never designed to allow for text information to be interleaved
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
619 with audio data, and it is this design which can cause errors in playback. The
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
620 Icecast Team has taken this data completely out of the mp3 data, and has
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
621 provided it in a side channel (via UDP)."
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
622
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
623 - Chad Armstrong (icemonk)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
624
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
625 You're better off having both these options enabled. :)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
626
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
627 In the 'Title' tab you can change the way Audacious presents the mp3 files to the
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
628 playlist.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
629
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
630 ID3 is data stored in the mp3 file and can include Artist, Album etc. If you
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
631 uncheck 'Use ID3 tags' Audacious will display the filename instead of the ID3
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
632 information.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
633
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
634 ID3V2 allows for a lot of extra data to be stored in the mp3 file, and don't
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
635 suffer from the limitations of ID3V1, Audacious supports the same data that are
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
636 available in ID3V1 but not the extra data. If a mp3 file contains both ID3V1
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
637 and ID3V2 tags, you might see something different that the 'file info' editor
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
638 displays. If this happens, you might want to turn on 'Disable ID3V2 tags'.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
639
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
640 'Override generic titles' is used if you do not want to use the generic titles
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
641 defined in the preferences. See section 3.5.6.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
642
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
643 The 'ID3 format:' box allows you to alter in which order the information about
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
644 the current song is displayed.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
645
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
646 Example: %p - %t (%a) [%y]
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
647 will display something like "Laibach - Alle Gegen Alle (Nato) [1994]"
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
648
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
649 available fields are:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
650
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
651 %p - Artist (ex: Laibach)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
652 %a - Album (ex: Nato)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
653 %f - File name (ex: laibach-allegegenalle)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
654 %F - File path (ex: /home/thomas/mp3)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
655 %e - File extension (ex: mp3)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
656
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
657 %t - Track name (ex: Alle Gegen Alle)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
658 %n - Track number (ex: 6)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
659 %y - Year (ex: 1994)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
660 %g - Genre (ex: Electronic)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
661 %c - Comment (ex: Cover of D.A.F)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
662
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
663
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
664 3.6.1.3 Ogg Vorbis Player
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
665 -------------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
666
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
667 Plays OGG Vorbis encoded files, see http://www.xiph.org/ogg/vorbis/index.html
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
668 for more information.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
669
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
670
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
671 3.6.1.4 WAV player
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
672 -------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
673 This plugin plays as suggested, wave files. It supports 16bit and 8bit PCM wave
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
674 files.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
675
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
676
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
677 3.6.2 Output plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
678 --------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
679 This type of plugins is what is used to send the audio data to your soundcard
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
680 or alternative devices.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
681
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
682
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
683 3.6.2.1 OSS Driver
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
684 ------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
685 This plugin is probably what most of you will use if your system is equipped
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
686 with the OpenSoundSystem (www.opensound.com) drivers or compatible.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
687 Compatible drivers are ALSA with their OSS emulation, and Linux kernel sound
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
688 drivers.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
689
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
690 In the 'Devices' tab you can change the soundcard which Audacious is going to use.
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
691 If your driver have more than one dsp, you can change the one Audacious uses by
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
692 enabling 'Use alternate device' and changing the '/dev/dsp' to suit your needs.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
693
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
694 If you have changed your Audio Device to another soundcard (if you for some
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
695 reason have two cards) don't forget to change the 'Mixer device' setting to the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
696 soundcard you want to use.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
697
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
698 In the 'Buffering' tab you can change how much data the OSS plugin will buffer.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
699 The 'Buffer size' ranges from 200 - 10000ms. If you want the plugin to wait for
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
700 the buffer to be filled before it starts playing the music change the 'Pre-
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
701 buffer' value, this ranges from 0% - 90% of the 'Buffer size' value.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
702
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
703 In the 'Mixer' tab you can change which volume setting Audacious should change when
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
704 you alter the volume from Audacious. Enable 'Volume controls Master not PCM' if you
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
705 want Audacious to change the volume of all sounds instead of only PCM/wave sound.
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
706
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
707
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
708 3.6.2.2 eSound Output
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
709 ---------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
710 The 'ESD' plugin will use the 'Enlightened Sound Daemon' to playback the audio.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
711 It's useful if you want to be able to have sound effects in your programs and
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
712 still be able to listen to music with Audacious.
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
713
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
714 In the 'Server' tab of the configuration, you can tell the plugin where to send
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
715 the audio data. Enable 'Use remote host' and enter the name/ip of the server
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
716 and port to send to. This is probably only useful in a LAN environment, since
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
717 the audio data is sent uncompressed to the remote ESD.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
718
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
719 The 'Buffering' tab works just like the 'OSS Driver' one.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
720
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
721
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
722 3.6.2.3 BSD Sun Output
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
723 ----------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
724 The 'Sun' output plugin will use the native audio(4) interface provided
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
725 by OpenBSD and NetBSD for playback and mixing.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
726
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
727 The $AUDIODEVICE and $MIXERDEVICE environment variables will override the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
728 current configuration settings. Defaults are /dev/audio and /dev/mixer.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
729
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
730 In the 'Devices' tab you can change the audio, audioctl and mixer devices
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
731 Audacious is going to use. The audioctl device is used for ioctl(2) calls
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
732 independent of audio data I/O.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
733
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
734 In the 'Buffering' tab you can change how much data the Sun plugin will
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
735 buffer. The 'Buffer size' ranges from 200 - 10000ms. If you want the plugin
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
736 to wait for the buffer to be filled before it starts playing the music,
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
737 change the 'Pre-buffer' value, this ranges from 0% - 90% of the 'Buffer size'
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
738 value.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
739
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
740 In the 'Mixer' tab you can select the volume device to be affected when you
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
741 alter the volume from Audacious. `Audacious uses mixer exclusively' causes Audacious to
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
742 keep the mixer device open instead of re-opening it for each operation.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
743
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
744 There may also be some more options depending on what your audio mixer
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
745 device supports (eg. loudness, spatial, surround, preamp).
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
746
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
747 In the 'Status' tab you can see audio device information and real-time
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
748 playback status.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
749
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
750
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
751 3.6.3 Effect plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
752 --------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
753 Effect plugins can alter the sound of the music you are listening to.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
754
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
755
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
756 3.6.4 General plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
757 ---------------------
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
758 Mostly used for controlling Audacious and passing data to other programs.
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
759
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
760
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
761 3.6.5 Visualization plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
762 ---------------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
763 Eye candy plugins.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
764
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
765
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
766 3.6.5.1 Blur scope
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
767 -------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
768 A simple blurring oscilloscope, in the configuration you can change the color
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
769 with the standard GTK color dialog.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
770
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
771
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
772 4. Command Line Options
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
773 -----------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
774
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
775 beep-media-player --help will produce:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
776
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
777 Usage: beep-media-player [options] [files] ...
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
778
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
779 Options:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
780 --------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
781
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
782 -h, --help Display this text and exit.
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
783 -n, --session Select Audacious/XMMS session (Default: 0)
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
784 -r, --rew Skip backwards in playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
785 -p, --play Start playing current playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
786 -u, --pause Pause current song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
787 -s, --stop Stop current song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
788 -t, --play-pause Pause if playing, play otherwise
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
789 -f, --fwd Skip forward in playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
790 -e, --enqueue Don't clear the playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
791 -m, --show-main-window Show the main window
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
792 -v, --version Print version number and exit.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
793
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
794 You can specify files on the command line, e.g:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
795
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
796 beep-media-player file1.mp3 file2.mp3 file3.mp3
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
797 beep-media-player *.mp3
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
798 beep-media-player playlist.m3u (note: playlists must be named .m3u)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
799
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
800 If you do this while Audacious is running the current playlist
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
801 will be cleared and the files/playlist specified on the command
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
802 line will be used instead.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
803
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
804 To keep the current playlist intact use the -e option.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
805
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
806
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
807 5. Features
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
808 -----------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
809
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
810 5.1 Supported File formats
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
811 -------------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
812
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
813 OGG Vorbis
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
814 MP2 and MP3 streams
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
815 WAV/AU samples
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
816
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
817 Others:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
818
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
819 CD audio
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
820 Shout/Icecast
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
821
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
822
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
823 5.2 Supported Features
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
824 ----------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
825
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
826 Seeking in files
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
827 Volume/Balance
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
828 Shuffle play
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
829 Repeat play
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
830 Playlist editor
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
831 Spectrum Analyzer
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
832 One Line mode al'a WinShade in WinAmp
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
833 Oscilloscope
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
834 Timer Elapsed/Timer Remaining
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
835 Plug-in system Output/Input/Effect/General/Visualization
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
836 Equalizer
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
837 Double Size option
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
838 WinAmp 2.0 skin support (can use wsz files)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
839 GTK Requesters (with theme support)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
840 Streaming/Shoutcast(1.0/1.1)/Icecast support
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
841 Auto remove borders if the WM has support for it
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
842 Fast jump in playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
843 Scroll wheel support
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
844 Saves HTTP streams to HD
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
845 HTTP authentication
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
846 Plays MPEG layer 1/2/3, WAV, Ogg Vorbis
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
847 Compiles and works on other Unixes
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
848 Proxy authentication support
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
849
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
850
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
851 6. Obtaining Audacious
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
852 -------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
853
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
854 Currently, we only provide source tarballs at:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
855
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
856 http://audacious-media-player.org/Downloads
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
857
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
858 The Subversion snapshots listed are not regularly updated. We
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
859 encourage you to download Audacious straight from our SVN repository:
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
860
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
861 svn co http://svn.atheme.org/audacious/trunk audacious-devel
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
862
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
863
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
864 6.1 Obtaining Skins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
865 -------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
866
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
867 You can find Audacious/XMMS skins made by Audacious/XMMS users at:
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
868
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
869 http://www.xmms.org/skins.html
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
870 http://themes.org/skins/xmms
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
871
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
872 You can find more places on our website, at:
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
873
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
874 http://audacious-media-player.org/Skins
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
875
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
876
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
877 7. Misc
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
878 -------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
879
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
880 7.1. Tips and Tricks
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
881 -------------------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
882
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
883 If you have a windows partition with WinAmp installed, a good idea would be to
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
884 set the SKINSDIR variable to that dir.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
885
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
886 Audacious features some command line options like next/previous songs, those
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
887 things can be binded to a key. I use AfterStep and the useless window keys
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
888 for this. Here is an example from my .steprc:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
889
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
890 Key Meta_R A N Exec "Audacious" audacious -r
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
891 Key Menu A N Exec "Audacious" audacious -f
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
892
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
893 If you want all your mp3's in one playlist an easy way is:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
894 locate .mp3 > /path/to/playlistname
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
895
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
896 (considering you have a fairly recent updatedb, don't blame us if locate don't
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
897 find the file you downloaded 3 minutes ago)
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
898
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
899
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
900 8. Bugs
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
901 -------
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
902
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
903 Audacious is under heavy development and as such, has quite a number of
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
904 bugs. Our bug tracker page is maintained at:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
905
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
906 http://bugs.audacious-media-player.org/
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
907
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
908 It will continue to have bugs as we fix and introduce new ones through
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
909 rewriting and enhancement. Help us along by reporting new bugs, and
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
910 verifying existing ones.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
911
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
912
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
913 9. Contact Emails
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
914 -----------------
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
915
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
916 Project Admins:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
917
1174
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
918 William Pitcock email: nenolod at nenolod.net
6ae15616b516 [svn] - update README a bit
nenolod
parents: 1173
diff changeset
919 Tony Vroon email: chainsaw at gentoo.org
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
920