INSTALL.win32 4.54 KB
Newer Older
1
INSTALL file for the Windows 2k/XP/Vista/Seven version of the VLC media player
2 3 4 5


Running VLC
===========
Gildas Bazin's avatar
Gildas Bazin committed
6

7 8
If you are using a binary release from videolan.org or if you have already built
VLC (see below), just run 'vlc.exe'.
Gildas Bazin's avatar
Gildas Bazin committed
9

10
You can also run VLC from a dos command box, in which case you'll be able
Gildas Bazin's avatar
Gildas Bazin committed
11
to use the command line arguments. You can obtain a list of these command
12 13
line arguments by typing 'vlc --help' or 'vlc --help --advanced'.

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.
Gildas Bazin's avatar
Gildas Bazin committed
17

18
Additional documentation is available at http://www.videolan.org/doc/ and http://wiki.videolan.org/.
19 20


21 22
Building VLC from the source code
=================================
Gildas Bazin's avatar
Gildas Bazin committed
23

24 25
If you want to build VLC from sources, you can do it in several ways:

26
- On GNU/Linux, using the mingw32 cross-compiler.
27
  This method is preferred over all the others.
28

Gildas Bazin's avatar
Gildas Bazin committed
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 33
  Please note that the gettext utilities are not included in the default
  MSYS/MINGW packages so you won't be able to build VLC with i18n support.
Gildas Bazin's avatar
Gildas Bazin committed
34

35 36 37 38 39 40 41
UNSUPPORTED METHODS
-------------------
- natively on Windows, using cygwin (www.cygwin.com) with or without the
  POSIX emulation layer. This is the preferred way to compile vlc if you want
  to do it on Windows.
  Read http://wiki.videolan.org/Win32CompileCygwinNew to have a complete HOWTO

42
- natively on Windows, using Microsoft Visual Studio. This will not work.
43

44 45
Getting the right compiler tools
================================
Gildas Bazin's avatar
Gildas Bazin committed
46 47

- cross-compiling with mingw32:
48
You first need to download a GNU/Linux cross-compiler version of mingw32.
49 50 51

For Debian GNU/Linux users, you can use the mingw32, mingw32-binutils and
mingw32-runtime packages.
52
For Fedora users, you can use mingw-binutils, mingw-gcc-core, mingw-gcc-g++
53

54 55 56
For MingW and Cygwin, please refer to our Wiki:
- http://wiki.videolan.org/Win32CompileMSYS
- http://wiki.videolan.org/Win32CompileCygwin
Gildas Bazin's avatar
Gildas Bazin committed
57

58
Getting the additional libraries
59
=================================
Gildas Bazin's avatar
Gildas Bazin committed
60

61
VLC depends on many other libraries to provide some features like most of the codecs.
Gildas Bazin's avatar
Gildas Bazin committed
62

63
Usually, you don't want to compile those by yourself, so use pre-compiled ones.
64

65 66 67
* We also provide a package with all the libraries already compiled so it is
  actually really easy to compile a full-featured version of vlc (these compiled
  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 72 73
  All you need to do is extract it in your root directory (the include files
  and libraries will be put in /usr/win32). You can do this with the following
  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 80 81
* An automated way of building the contrib libraries is provided in 
  extra/contrib. It will download, configure and build the libraries.
  See the extras/contrib/README for more info.
82

83

Gildas Bazin's avatar
Gildas Bazin committed
84 85 86
Configuring the build
=====================

87 88
Once you've got all the files you need in place, you need to configure the
build with the `./configure' script.
Gildas Bazin's avatar
Gildas Bazin committed
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.
Gildas Bazin's avatar
Gildas Bazin committed
92

93 94 95
If you are cross-compiling from Debian, you can use this:

  sh extras/package/win32/configure-mingw.sh
96 97


98 99 100 101 102 103 104 105 106 107
If you are compiling with MSYS/MINGW, then you can use this:

  sh extras/package/win32/configure-msys.sh


If you are using cygwin, you should build VLC without the POSIX emulation layer.
Use this:

  sh extras/package/win32/configure-cygwin.sh

108
See `./configure --help' for more information.
Gildas Bazin's avatar
Gildas Bazin committed
109

110

111 112
Actually Compiling the VLC source
=================================
Gildas Bazin's avatar
Gildas Bazin committed
113

114
Once configured, to build VLC, just run `make'.
Gildas Bazin's avatar
Gildas Bazin committed
115

116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
Once the compilation is done, you can either run VLC directly from the source
tree or you can build self-contained VLC packages with the following
'make' rules:

  make package-win32-base
   will create a subdirectory named vlc-x.x.x with all the binaries
   'stripped' (ie. without any debugging symbols).

  make package-win32-zip
   Same as above but will package the directory in a zip file.

  make package-win32
   Same as above but will also create an auto-installer package. You will need
   to have NSIS installed in its default location for this to work.

131
Well done, now you're ready to use VLC!
132
=======================================