windows/README-Windows.txt

   1
   2 XZ Utils for Windows
   3 ====================
   4
   5 Introduction
   6 ------------
   7
   8     This package includes command line tools (xz.exe and a few
   9     others) and the liblzma compression library from XZ Utils.
  10     You can find the latest version and full source code from
  11     <https://tukaani.org/xz/>.
  12
  13     The parts of the XZ Utils source code, that are relevant to this
  14     binary package, are under the BSD Zero Clause License (0BSD).
  15     XZ Utils have been built using GCC and MinGW-w64 and linked
  16     statically against the MinGW-w64 runtime libraries. See
  17     COPYING.MinGW-w64-runtime.txt for copyright and license
  18     information that applies to the MinGW-w64 runtime.
  19
  20         IMPORTANT: You must include COPYING.MinGW-w64-runtime.txt
  21         when distributing these XZ Utils binaries to meet
  22         the license terms of the MinGW-w64 runtime!
  23
  24     (The file COPYING mentions GNU getopt_long. It's *not* used when
  25     XZ Utils is built with MinGW-w64. Thus GNU LGPLv2.1 doesn't apply.)
  26
  27
  28 Package contents
  29 ----------------
  30
  31     All executables and libraries in this package require
  32     Universal CRT (UCRT). It is included in Windows 10 and later.
  33
  34     There is a SSE2 optimization in the compression code but this
  35     version of XZ Utils doesn't include run-time processor detection.
  36     The binaries don't work on 32-bit processors without SSE2 support.
  37
  38     There is one directory for each type of executable and library files:
  39
  40         bin_i686-sse2   32-bit x86 (i686 with SSE2)
  41         bin_x86-64      64-bit x86-64
  42
  43     Each of the above directories have the following files:
  44
  45         *.exe         Command line tools. (It's useless to double-click
  46                       these; use the command prompt instead.) These have
  47                       been linked statically against liblzma, so they
  48                       don't require liblzma.dll. Thus, you can copy e.g.
  49                       xz.exe to a directory that is in PATH without
  50                       copying any other files from this package.
  51
  52                       NOTE: xzdec.exe and lzmadec.exe are optimized for
  53                       size, single-threaded, and slower than xz.exe.
  54                       Use xz.exe unless program size is important.
  55
  56         liblzma.dll   Shared version of the liblzma compression library.
  57                       This file is mostly useful to developers, although
  58                       some non-developers might use it to upgrade their
  59                       copy of liblzma.
  60
  61     The rest of the directories contain architecture-independent files:
  62
  63         doc           Basic documentation in the plain text (TXT)
  64                       format. COPYING.txt, COPYING.0BSD.txt, and
  65                       COPYING.MinGW-w64-runtime.txt contain
  66                       copyright and license information.
  67                       liblzma.def is in this directory too.
  68
  69         doc/manuals   The manuals of the command line tools
  70
  71         doc/examples  Example programs for basic liblzma usage.
  72
  73         include       C header files for liblzma. These should be
  74                       compatible with most C and C++ compilers.
  75
  76
  77 Creating an import library for MSVC / Visual Studio
  78 ---------------------------------------------------
  79
  80     To link against liblzma.dll, you need to create an import library
  81     first. You need the "lib" command from MSVC and liblzma.def from
  82     the "doc" directory of this package. Here is the command that works
  83     on 32-bit x86:
  84
  85         lib /def:liblzma.def /out:liblzma.lib /machine:ix86
  86
  87     On x86-64, the /machine argument has to be changed:
  88
  89         lib /def:liblzma.def /out:liblzma.lib /machine:x64
  90
  91     IMPORTANT: See also the file liblzma-crt-mixing.txt if your
  92     application isn't using UCRT.
  93
  94
  95 Reporting bugs
  96 --------------
  97
  98     Report bugs to <xz@tukaani.org>.
  99