Documentation updates.
[vlc.git] / INSTALL
1 INSTALL file for vlc, the VideoLAN Client
2
3
4 Configuring VideoLAN
5 ====================
6
7 A typical way to configure vlc is:
8
9    ./configure --prefix=/usr --enable-gnome
10
11 See `./configure --help' for more information.
12
13 Here is a shortcut to copy-paste for a complete build:
14
15    make distclean ; ./configure --prefix=/usr --enable-gnome \
16       --enable-fb --with-glide --with-ggi --enable-esd \
17       --enable-gtk --enable-qt --enable-xvideo --enable-alsa
18
19 If you intend to debug stuff, you may want to compile with debugging
20 symbols:
21
22    make distclean ; ./configure --prefix=/usr --enable-gnome \
23       --enable-fb --with-glide --with-ggi --enable-esd \
24       --enable-gtk --enable-qt --enable-xvideo --enable-alsa \
25       --enable-debug
26
27 It is also possible to cross-compile for the Win32 platform using mingw32:
28
29    make distclean ; CC=i586-mingw32msvc-gcc CFLAGS=-I/usr/i586-mingw32msvc \
30      RANLIB=i586-mingw32msvc-ranlib ./configure --host=i386-mingw32msvc \
31      --target=i386-mingw32msvc --build=i386-linux --disable-dsp \
32      --disable-x11 --disable-xvideo
33
34
35 Building VideoLAN
36 =================
37
38 Have a look at the generated Makefile.opts file, you may want to choose
39 which modules will be compiled as plugins, and which ones will remain in
40 the core application. The configure script tries to guess for you.
41
42 Once configured, run `make' to build vlc.
43
44
45 Installing and running VideoLAN
46 ===============================
47
48 You can install the vlc and its plugins by typing:
49
50    make install
51
52 But you don't need to install it if you don't want to; vlc can be launched
53 from the current directory as well:
54
55    ./vlc
56
57
58 Building packages
59 =================
60
61 To build a Debian package, you may use:
62
63    dpkg-buildpackage -rfakeroot -us -uc
64
65
66 To build RedHat packages, use:
67
68    rpm -ba vlc.spec
69
70 To build an ipkg package (iPAQ familiar Linux), use:
71
72    ipkg-buildpackage