annotate INSTALL @ 249:b02705a9b2d6

Duh.
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 21 Dec 2004 17:37:03 +0000
parents 5648f2ca3eb2
children e9ea4ce4c697
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
1 This document describes overall requirements and procedure
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
2 for installation of XMMS-SID package, please read it carefully!
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
3 For more tips, please also read README and FAQ.
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
4
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
5 Requirements
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
6 ============
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
7 - XMMS version 1.2.0 or later (http://www.xmms.org/)
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
8
145
e85ea6735767 Updated requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 123
diff changeset
9 - Gtk+ and Glib 1.2.5 or later (http://www.gtk.org/)
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
10
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
11 - C and C++-compiler. Preferably GCC along with rest of the
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
12 GNU toolchain. I have no idea whether this compiles with
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
13 any other compiler ... sorry.
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
14
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
15 - You need AT LEAST one emulation library:
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
16
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
17 * libSIDPlay1
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
18 * libSIDPlay2
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
19
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
20 Only one is required, but all are supported. You may also need
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
21 some supplementary libraries, that are required by the emulator
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
22 library. See below for more information.
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
23
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
24
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
25 NOTICE! Refer to file README for recommendations about which
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
26 emulator libraries you should install!
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
27
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
28
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
29
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
30 Where to get XMMS?
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
31 ==================
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
32 Latest version of XMMS should be available from:
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
33
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
34 http://www.xmms.org/
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
35
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
36 Please refer to XMMS documentation for information on its usage
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
37 and installation, etc. You probably have XMMS already installed,
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
38 but if you installed from a pre-built package, make sure that
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
39 you have corresponding xmms-devel -package also.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
40
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
41
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
42 Where to get libSIDPlay1?
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
43 =========================
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
44 libSIDPlay1 is available at SIDPlay's homepage:
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
45
145
e85ea6735767 Updated requirements.
Matti Hamalainen <ccr@tnsp.org>
parents: 123
diff changeset
46 http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/linux.html
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
47
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
48 You only need libsidplay, the sidplay-base is not necessary
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
49 if you are sure that you don't need the commandline player.
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
50
23
469efc05e01e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 7
diff changeset
51
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
52 Where to get libSIDPlay2?
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
53 =========================
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
54 libSIDPlay2 is available at SourceForge:
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
55
123
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
56 http://sidplay2.sourceforge.net/
9ab0c2fff794 Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 80
diff changeset
57
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
58 You need the "sidplay-libs-2.1.0" package! Earlier versions WILL NOT
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
59 WORK! Later versions MAY work, but I can't really guarantee that.
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
60
80
7047a6390b08 Updated and improved documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
61
36
f6afce365705 Minor fix
Matti Hamalainen <ccr@tnsp.org>
parents: 34
diff changeset
62 Building a CVS-version
f6afce365705 Minor fix
Matti Hamalainen <ccr@tnsp.org>
parents: 34
diff changeset
63 ======================
f6afce365705 Minor fix
Matti Hamalainen <ccr@tnsp.org>
parents: 34
diff changeset
64 To build a CVS-version of XMMS-SID, you need to have latest
41
c145ff12f2d0 Various improvements
Matti Hamalainen <ccr@tnsp.org>
parents: 36
diff changeset
65 (STABLE) versions of following tools installed, including:
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
66
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
67 - GNU autoconf 2.56 or newer
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
68 - GNU automake 1.7 (older and newer versions MAY be incompatible!)
210
5648f2ca3eb2 Updated requirements
Matti Hamalainen <ccr@tnsp.org>
parents: 200
diff changeset
69 - GNU libtool 1.5.6 or newer
41
c145ff12f2d0 Various improvements
Matti Hamalainen <ccr@tnsp.org>
parents: 36
diff changeset
70 - Glade for Gtk+ 1.2 programs (I use Glade 0.6.4)
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
71
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
72 If you have all required tools installed, just run the
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
73 "bootstrap.sh"-script which generates all necessary build-files.
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
74 After successfull bootstrapping, you should be able to install
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
75 the package normally, following steps described in next chapter.
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
76
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
77
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
78 Installing XMMS-SID
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
79 ===================
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
80 When you have the requirements installed and working succesfully,
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
81 you may try compiling and installation of XMMS-SID.
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
82
171
78e06aecad7f Updated documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 159
diff changeset
83 Invoke configure script (use parameter --help for help)
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
84
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
85 $ ./configure
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
86
34
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
87 The configure-script will print out lots of information and in
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
88 the end it tells you some of the selected build options.
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
89
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
90 If configure passed without errors, try compilation. (Depending
0e1189b94a7f Updated installation instructions
Matti Hamalainen <ccr@tnsp.org>
parents: 31
diff changeset
91 on your system, you may need to invoke 'gmake' instead of 'make'.)
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
92
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
93 $ make
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
94
198
c7b5120c53c8 Cleanup
Matti Hamalainen <ccr@tnsp.org>
parents: 181
diff changeset
95 If that went OK too, then you may try installation. Again, you
c7b5120c53c8 Cleanup
Matti Hamalainen <ccr@tnsp.org>
parents: 181
diff changeset
96 may need to invoke 'gmake' instead of 'make'. Install globally
c7b5120c53c8 Cleanup
Matti Hamalainen <ccr@tnsp.org>
parents: 181
diff changeset
97 to whole system (as root):
7
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
98
e5c49367b899 Updated to 0.8
Matti Hamalainen <ccr@tnsp.org>
parents: 1
diff changeset
99 # make install
1
183e7cbc1036 Initial revision
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
100
198
c7b5120c53c8 Cleanup
Matti Hamalainen <ccr@tnsp.org>
parents: 181
diff changeset
101 or install for current user only:
181
be1cf864f28e Added install-user and uninstall-user targets which install to current
Matti Hamalainen <ccr@tnsp.org>
parents: 171
diff changeset
102
be1cf864f28e Added install-user and uninstall-user targets which install to current
Matti Hamalainen <ccr@tnsp.org>
parents: 171
diff changeset
103 $ make install-user
be1cf864f28e Added install-user and uninstall-user targets which install to current
Matti Hamalainen <ccr@tnsp.org>
parents: 171
diff changeset
104
249
Matti Hamalainen <ccr@tnsp.org>
parents: 210
diff changeset
105 Assuming all went correctly, XMMS-SID is now installed. You should
Matti Hamalainen <ccr@tnsp.org>
parents: 210
diff changeset
106 now start or re-start XMMS and configure XMMS-SID's various options.
199
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
107
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
108
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
109 Post-installation configuration
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
110 ===============================
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
111 To gain full advantages of using XMMS-SID, you need to configure it.
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
112 XMMS-SID can be configured just like any other XMMS plugin, in XMMS
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
113 do as follows:
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
114
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
115 -> Press <ctrl+p>
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
116 -> Select "Audio I/O Plugins"-tab
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
117 -> Choose "XMMS-SID x.y.z [libxmmssid.so]" from the list
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
118 -> Click "Configure"
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
119
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
120 Please refer to README for more information about configuration.
6117c326cc3e Updated documentation
Matti Hamalainen <ccr@tnsp.org>
parents: 198
diff changeset
121