merged r35594, use versions from http://code.google.com/p/xbmc-port-depends, the...
[vuplus_xbmc] / README.linux
1 TOC
2 1. Introduction
3 2. Getting the source code
4 3. Installing the required libraries and headers
5 4. How to compile
6 5. How to run
7 6. Uninstalling
8
9 -----------------------------------------------------------------------------
10 1. Introduction
11 -----------------------------------------------------------------------------
12
13 A gfx-adapter with OpenGL acceleration is highly recommended and 24/32 bitdepth
14 is required with OpenGL.
15
16 NOTE TO NEW LINUX USERS: All lines that are prefixed with the '$'
17 character are commands that need to be typed into a terminal window /
18 console (similar to the command prompt for Windows). Note that the '$'
19 character itself should NOT be typed as part of the command.
20
21
22 -----------------------------------------------------------------------------
23 2. Getting the source code
24 -----------------------------------------------------------------------------
25
26 You will have to grab the source code of course. First install the subversion
27 package provided by your distribution. Then from a terminal, type:
28
29    $ cd $HOME
30    $ svn checkout http://xbmc.svn.sourceforge.net/svnroot/xbmc/trunk xbmc
31
32 -----------------------------------------------------------------------------
33 3. Installing the required libraries and headers
34 -----------------------------------------------------------------------------
35
36 You will then need the required libraries. The following is the list of packages
37 that are used to build XBMC packages on Debian/Ubuntu (with all supported
38 external libraries enabled).
39
40 Build-Depends: debhelper (>= 7.0.50), quilt, python-support, cmake,
41  autotools-dev, autoconf, automake, unzip, libboost-dev,
42  libgl1-mesa-dev | libgl-dev, libglu-dev, libglew-dev, libmad0-dev, libjpeg-dev,
43  libsamplerate-dev, libogg-dev, libvorbis-dev, libvorbisenc2, libfreetype6-dev,
44  libfontconfig-dev, libbz2-dev, libfribidi-dev, libsqlite3-dev,
45  libmysqlclient-dev, libasound-dev, libpng-dev, libpcre3-dev, liblzo2-dev,
46  libcdio-dev, libsdl-dev, libsdl-image1.2-dev, libsdl-mixer1.2-dev, libenca-dev,
47  libjasper-dev, libxt-dev, libxtst-dev, libxmu-dev, libxinerama-dev, libcurl3,
48  libcurl4-gnutls-dev | libcurl-dev, libdbus-1-dev, libhal-storage-dev,
49  libhal-dev, libpulse-dev, libavahi-common-dev, libavahi-client-dev,
50  libxrandr-dev, libavcodec-dev, libavformat-dev, libavutil-dev, libpostproc-dev,
51  libswscale-dev, liba52-dev, libdts-dev, libfaad-dev, libmp4ff-dev,
52  libmpeg2-4-dev, libass-dev, libflac-dev, libwavpack-dev,
53  python-dev, gawk, gperf, nasm [!amd64], libcwiid1-dev, libbluetooth-dev,
54  zlib1g-dev, libmms-dev, libsmbclient-dev, libtiff4-dev, libiso9660-dev, libssl-dev,
55  libmicrohttpd-dev, libmodplug-dev, libssh-dev, gettext, cvs, libtool
56
57 *** For developers and anyone else who compiles frequently it is recommended to
58 use ccache
59
60 --------------------------------------------------------------
61 3.1. Using the XBMC PPA to get all build dependencies (Debian/Ubuntu only)
62 --------------------------------------------------------------
63
64 For this, you need to specify the PPA in your apt sources. Please find them on
65 the forum.
66
67 http://forum.xbmc.org/showthread.php?t=33327
68
69 Update apt:
70    $ sudo apt-get update
71
72 Here is the magic command to get the build dependencies (used to compile the
73 version on the PPA).
74    $ sudo apt-get build-dep xbmc
75
76 -----------------------------------------------------------------------------
77 4. How to compile
78 -----------------------------------------------------------------------------
79
80 To create the XBMC executable manually perform these steps:
81
82 .0  $ ./bootstrap
83
84 .1  $ ./configure <option1> <option2> ... (See --help for available options)
85
86 A full listing of supported options can be viewed by typing
87 './configure --help'.
88
89 .2  $ make
90
91 Tip: by adding -j<number> to the make command, you describe how many
92      concurrent jobs will be used. So for dualcore the command is: 
93
94     $ make -j2
95
96 .3  $ make -C lib/addons/script.module.pil
97
98 .4  $ make -C lib/addons/script.module.pysqlite
99     
100 .5  $ make install
101
102 This will install XBMC in the prefix provided in 4.1 as well as a launcher script.
103
104 NOTE: You may need to run this with sudo (sudo make install) if your user
105 doesn't have write permissions to the prefix you have provided (as in the
106 default case, /usr/local).
107
108 Tip: To override the location that XBMC is installed, use PREFIX=<path>.
109 For example.
110
111     $ make install DESTDIR=$HOME/xbmc
112
113 -----------------------------------------------------------------------------
114 5. How to run
115 -----------------------------------------------------------------------------
116 How to run xbmc depends on the type of installation you have done. It is
117 possible to run XBMC without the requirement to install xbmc anywhere else. In
118 this case, type the following from the top source directory.
119
120     $ ./xbmc.bin
121
122 If you chose to install XBMC using '/usr' or '/usr/local' as the PREFIX, you
123 can just issue 'xbmc' in a teminal session.
124
125 If you overridden PREFIX to install XBMC into some non-standard location, you
126 will have to run xbmc by directly running 'xbmc.bin'. For example.
127
128     $ $HOME/xbmc/usr/share/xbmc.bin
129
130 If you wish to use VDPAU decoding you will now have to change the Render Method
131 in Settings->Videos->Player from "Auto Detect" to "VDPAU".
132
133 -----------------------------------------------------------------------------
134 6. Uninstalling
135 -----------------------------------------------------------------------------
136 Issue "make uninstall"  ("sudo make uninstall" if you user doesn't have write
137 permission to the install directory) from your source tree. If you would like
138 to also remove any settings and 3rd party addons (skins, scripts, etc) you
139 should also run "rm -rf ~/.xbmc".
140
141 NOTE: If you have rerun configure with a different prefix, you will either need
142 to rerun configure with the correct prefix for this step to work correctly.
143
144 EOF
145