INSTALL.readme
1General Instructions for Installing UADE
2========================================
3
4*** 1. Dependencies ***
5
6Compiling and running UADE requires some libraries depending on which
7frontends you want to use:
8
9 Frontend name | Type | Dependencies
10 -----------------------------------------------------------------------
11 uade123 | Command line | libao: http://www.xiph.org/ao/
12 xmms | XMMS plugin | XMMS
13 audacious | Audacious plugin | Audacious:
14 | http:/audacious-media-player.org
15 uadefs | Amiga to WAV filesys. | FUSE, uade123
16
17 - pkg-config is required for detecting libao, audacious and fuse in the
18 configure script. This dependency can be hacked away for specific
19 platforms.
20
21 - sed is required for creating Makefiles in the configure script
22
23 - The default shell /bin/sh should be more or less compatible with Bash
24
25*** 2. Compiling and installation ***
26
27The installation process has 3 or 4 steps.
28
29(1) ./configure
30(2) make
31(3) make soundcheck (optional phase)
32(4) make install (possibly run as root user)
33
34Longer explanations of these steps follow:
35
36(1) ./configure
37
38 Look at which frontends will be compiled in. In the good case you will see:
39
40 uade123 : yes
41 XMMS plugin : yes
42 .. other frontends
43
44
45 You have the possibility of using many options, such as disabling possible
46 frontends (methods for using uadecore through various systems such as the
47 command line and XMMS). See ./configure --help for options. Some of the
48 more important options are:
49
50 --prefix
51 --user
52
53 --user makes uade to be installed into users ~/.uade2/ directory, but of
54 course you may issue --prefix=$HOME/something to achieve the same effect.
55
56 It is possible to leavy any uade frontend or even uadecore compiled so that
57 packing for distributions is faster and easier. Important options for
58 distribution packagers are:
59
60 --package-prefix
61 --without-audacious
62 --without-uadecore
63 --without-uade123
64 --without-uadefs
65 --without-xmms
66
67(2) make
68
69 This will build all the components that were configured.
70
71(3) make soundcheck
72
73 You should hear sound if uade123 was compiled in and it works. If uade123
74 was not compiled, you may still have success with other frontends such as
75 the XMMS plugin. uade123 is only the command line player tool.
76
77(4) make install
78
79 This will install the software. If --user was used the uadecore and frontends
80 are installed into ~/.uade2/.
81
82
83*** 3. Notes on GNU/Linux distributions ***
84
853.1 Gentoo
86
87To install necessary dependencies for Gentoo, execute:
88
89 emerge -u libao (the dependency for uade123)
90 emerge -u xmms
91 emerge -u audacious
92
933.2 Debian and Ubuntu
94
95In Debian/Ubuntu, the required libraries can be downloaded by:
96
97uade123:
98 apt-get install libao-dev
99XMMS plugin:
100 apt-get install xmms-dev
101Audacious plugin:
102 apt-get install audacious-dev (get a mirror from
103 audacious-mediaplayer.org)
104uadefs:
105 apt-get install libfuse-dev
106
107*** 4. Notes on Solaris ***
108
109 - Change configure scripts #!/bin/sh to #!/bin/bash
110 - Change reference of floorf() function in src/audio.c to floor()
111 - Use gmake instead of make
112 - Add #include <sys/time.h> into src/unixatomic.c
113
114*** 5. Notes on Mac OS X ***
115 - Install libao and pkg-config from MacPorts (http://www.macports.org)
116
117 - If compiling the XMMS plugin fails, either
118 * use --without-xmms for the configure script
119 or try a hack:
120 * Remove line
121 $(OBJCOPY) -G get_iplugin_info $@
122 from src/frontends/xmms/Makefile after you have run the
123 configure script. This work-around can be useful if the compilation
124 fails with following kind of error:
125
126 objcopy -G get_iplugin_info libuade2.so
127 objcopy: styJDS31: Invalid operation
128 make[1]: *** [libuade2.so] Error 1
129 make: *** [xmmsplugin] Error 2
130
131*** 5. Notes on Cygwin ***
132
133- Run Cygwin setup and install the following binary packages:
134 gcc-core, libao2, libao-devel, make and pkg-config
135
136- During compilation you may see hundreds of warnings like this:
137 Warning: .stabs: description field '1399a' too big, try a different
138 debug format; they can safely be ignored.
139
140Limitations of Cygwin builds:
141
142- UNIX<->Windows path conversion is not always reliable causing
143 multifile songs to fail. Use of UNIX paths negates this problem.
144
145- The binary version of libao produces a lot of debug output when using
146 the winmm driver
147
README