Add option to format strings to prevent displaying dashes if the meta info was unavai...
[vlc.git] / INSTALL
1 $Id$
2
3 INSTALL file for the VLC media player
4
5 More extensive information for *nix, Windows, Mac OS X and BeOS users can be found here: 
6 http://developers.videolan.org/vlc/
7
8 Bootstrapping VLC
9 =================
10
11 If you retrieved VLC from the SVN server and do not have a "configure"
12 script, please refer to the HACKING file.
13
14 Configuring VLC
15 ===============
16
17 A typical way to configure VLC is:
18
19    ./configure --prefix=/usr
20
21 See `./configure --help' for more information.
22
23 If you intend to debug stuff, you may want to compile with debugging
24 symbols:
25
26    make distclean ; ./configure --prefix=/usr --enable-debug
27
28 We recommend using GCC to build VLC, though some people reported success
29 with the Intel C compiler (version 8) as well. GCC version 3.3 or higher is
30 required. On older systems (e.g. FreeBSD 4.x, BeOS), please select a more
31 recent version manually by setting the CC and CXX environment variables
32 appropriately while running the ./configure shell script.
33
34
35 Building VLC
36 ============
37
38 Once configured, run `make' to build VLC.
39
40
41 Installing and running VLC
42 ==========================
43
44 You can install the VLC and its plugins by typing:
45
46    make install
47
48 But you don't need to install it if you don't want to; VLC can be launched
49 from the current directory as well:
50
51    ./vlc
52
53
54 Building packages
55 =================
56
57 To build a Debian package, you need to get the packaging info
58    svn co svn://svn.debian.org/pkg-multimedia/videolan/vlc/debian debian 
59 and then
60    dpkg-buildpackage -rfakeroot -us -uc
61
62
63 To build RedHat packages, use:
64
65    rpm -ba vlc.spec
66
67 To build an ipkg package (iPAQ familiar Linux), use:
68
69    ipkg-buildpackage
70