vlm: remove some spurious calls to asprintf: vlm_MessageNew does it already.
[vlc/vlc-austin.git] / INSTALL.win32
1 INSTALL file for the Windows 2k/XP/Vista/Seven version of the VLC media player
2
3
4 Running VLC
5 ===========
6
7 If you are using a binary release from videolan.org or if you have already built
8 VLC (see below), just run 'vlc.exe'.
9
10 You can also run VLC from a dos command box, in which case you'll be able
11 to use the command line arguments. You can obtain a list of these command
12 line arguments by typing 'vlc --help' or 'vlc --help --advanced'.
13
14 To store a debug log of the current VLC session, you can use
15 'vlc -vvv --extraintf=logger'. You will end-up with a vlc-log.txt file in
16 your current directory.
17
18 Additional documentation is available at http://www.videolan.org/doc/ and http://wiki.videolan.org/.
19
20
21 Building VLC from the source code
22 =================================
23
24 If you want to build VLC from sources, you can do it in several ways:
25
26 - On GNU/Linux, using the mingw32 cross-compiler.
27   This method is preferred over all the others.
28
29 - natively on Windows, using MSYS+MINGW (www.mingw.org)
30   (MSYS is a minimal build environment to compile Unixish projects under
31   windoze. It provides all the common Unix tools like sh, gmake...)
32   Please note that the gettext utilities are not included in the default
33   MSYS/MINGW packages so you won't be able to build VLC with i18n support.
34
35 UNSUPPORTED METHODS
36 -------------------
37 - natively on Windows, using cygwin (www.cygwin.com) with or without the
38   POSIX emulation layer. This is the preferred way to compile vlc if you want
39   to do it on Windows.
40   Read http://wiki.videolan.org/Win32CompileCygwinNew to have a complete HOWTO
41
42 - natively on Windows, using Microsoft Visual Studio. This will not work.
43
44 Getting the right compiler tools
45 ================================
46
47 - cross-compiling with mingw32:
48 You first need to download a GNU/Linux cross-compiler version of mingw32.
49
50 For Debian GNU/Linux users, you can use the mingw32, mingw32-binutils and
51 mingw32-runtime packages.
52 For Fedora users, you can use mingw-binutils, mingw-gcc-core, mingw-gcc-g++
53
54 For MingW and Cygwin, please refer to our Wiki:
55 - http://wiki.videolan.org/Win32CompileMSYS
56 - http://wiki.videolan.org/Win32CompileCygwin
57
58 Getting the additional libraries
59 =================================
60
61 VLC depends on many other libraries to provide some features like most of the codecs.
62
63 Usually, you don't want to compile those by yourself, so use pre-compiled ones.
64
65 * We also provide a package with all the libraries already compiled so it is
66   actually really easy to compile a full-featured version of vlc (these compiled
67   libraries will only work with mingw or cygwin):
68   http://download.videolan.org/pub/testing/win32/contrib-200xxxxx-win32-bin-gcc-x.x.x-only.tar.bz2
69   (Check out for more recent versions at the same location). 
70
71   All you need to do is extract it in your root directory (the include files
72   and libraries will be put in /usr/win32). You can do this with the following
73   command: 
74
75     tar xjvf contrib-20060330-win32-bin-gcc-3.4.5-only.tar.bz2 -C /
76
77   Please note the "-C /".
78
79 * An automated way of building the contrib libraries is provided in 
80   extra/contrib. It will download, configure and build the libraries.
81   See the extras/contrib/README for more info.
82
83
84 Configuring the build
85 =====================
86
87 Once you've got all the files you need in place, you need to configure the
88 build with the `./configure' script.
89
90 I'll assume that you are using the pre-compiled 3rd party libraries we are
91 providing and that they are in /usr/win32.
92
93 If you are cross-compiling from Debian, you can use this:
94
95   sh extras/package/win32/configure-mingw.sh
96
97
98 If you are compiling with MSYS/MINGW, then you can use this:
99
100   sh extras/package/win32/configure-msys.sh
101
102
103 If you are using cygwin, you should build VLC without the POSIX emulation layer.
104 Use this:
105
106   sh extras/package/win32/configure-cygwin.sh
107
108 See `./configure --help' for more information.
109
110
111 Actually Compiling the VLC source
112 =================================
113
114 Once configured, to build VLC, just run `make'.
115
116 Once the compilation is done, you can either run VLC directly from the source
117 tree or you can build self-contained VLC packages with the following
118 'make' rules:
119
120   make package-win32-base
121    will create a subdirectory named vlc-x.x.x with all the binaries
122    'stripped' (ie. without any debugging symbols).
123
124   make package-win32-zip
125    Same as above but will package the directory in a zip file.
126
127   make package-win32
128    Same as above but will also create an auto-installer package. You will need
129    to have NSIS installed in its default location for this to work.
130
131 Well done, now you're ready to use VLC!
132 =======================================