git.sesse.net Git - vlc/blob - INSTALL.win32

   1 INSTALL file for the Windows XP/Vista/Seven version of 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 is the preferred method, as this is the one used by VideoLAN to
  28   build the official Windows binaries.
  29
  30 - natively on Windows, using MSYS+MINGW (www.mingw.org)
  31   (MSYS is a minimal build environment to compile Unixish projects under
  32   windows. It provides all the common Unix tools like sh, gmake...)
  33
  34 UNSUPPORTED METHOD
  35 ------------------
  36
  37 - natively on Windows, using cygwin (www.cygwin.com) with or without the
  38   POSIX emulation layer.
  39   Read http://wiki.videolan.org/Win32CompileCygwinNew to have a complete HOWTO
  40
  41
  42 Getting the right compiler tools
  43 ================================
  44
  45 - cross-compiling with mingw32:
  46 You first need to download a GNU/Linux cross-compiler version of mingw32.
  47
  48 For Debian GNU/Linux users, you can use the gcc-mingw32, mingw32-binutils and
  49 mingw32-runtime packages.
  50 For Fedora users, you can use mingw-binutils, mingw-gcc-core, mingw-gcc-g++
  51
  52 For MingW and Cygwin, please refer to our Wiki:
  53 - http://wiki.videolan.org/Win32CompileMSYS
  54 - http://wiki.videolan.org/Win32CompileCygwin
  55
  56
  57 Getting the additional libraries
  58 =================================
  59
  60 VLC depends on many other libraries to provide some features like most of the codecs.
  61
  62 Usually, you don't want to compile those by yourself, so use pre-compiled ones.
  63
  64 * We also provide a package with all the libraries already compiled so it is
  65   actually really easy to compile a full-featured version of vlc (these compiled
  66   libraries will only work with mingw or cygwin):
  67   http://download.videolan.org/pub/testing/win32/contrib-201xxxxx-win32-bin-gcc-x.x.x-runtime-x.xx.x-only.tar.bz2
  68   (Check out for more recent versions at the same location).
  69
  70   All you need to do is extract it in your root directory (the include files
  71   and libraries will be put in /usr/win32). You can do this with the following
  72   command:
  73
  74     tar xjvf contrib-20110614-win32-bin-gcc-4.4.4-runtime-3.15.2-only.tar.bz2 -C /
  75
  76   Please note the "-C /".
  77
  78 * An automated way of building the contrib libraries is provided in
  79   extra/contrib. It will download, configure and build the libraries.
  80   See the extras/contrib/README for more info.
  81
  82
  83 Configuring the build
  84 =====================
  85
  86 Once you've got all the files you need in place, you need to configure the
  87 build with the `./configure' script.
  88
  89 I'll assume that you are using the pre-compiled 3rd party libraries we are
  90 providing and that they are in /usr/win32.
  91
  92 If you are cross-compiling from Debian, you can use this:
  93
  94   sh extras/package/win32/configure-mingw.sh
  95
  96
  97 If you are compiling with MSYS/MINGW, then you can use this:
  98
  99   sh extras/package/win32/configure-msys.sh
 100
 101
 102 If you are using cygwin, you should build VLC without the POSIX emulation layer.
 103 Use this:
 104
 105   sh extras/package/win32/configure-cygwin.sh
 106
 107 See `./configure --help' for more information.
 108
 109
 110 Actually Compiling the VLC source
 111 =================================
 112
 113 Once configured, to build VLC, just run `make'.
 114
 115 Once the compilation is done, you can either run VLC directly from the source
 116 tree or you can build self-contained VLC packages with the following
 117 'make' rules:
 118
 119   make package-win-base
 120    will create a subdirectory named vlc-x.x.x with all the binaries
 121    'stripped' (ie. without any debugging symbols).
 122
 123   make package-win32-zip
 124    Same as above but will package the directory in a zip file.
 125
 126   make package-win32
 127    Same as above but will also create an auto-installer package. You will need
 128    to have NSIS installed in its default location for this to work.
 129
 130 Well done, now you're ready to use VLC!
 131 =======================================