PACKAGERS

   1
   2 Information to packagers of XZ Utils
   3 ====================================
   4
   5     0. Preface
   6     1. Package naming
   7     2. Package description
   8     3. License
   9     4. configure options
  10     5. Additional documentation
  11     6. Extra files
  12     7. Installing XZ Utils and LZMA Utils in parallel
  13     8. Example
  14
  15
  16 0. Preface
  17 ----------
  18
  19     This document is meant for people who create and maintain XZ Utils
  20     packages for operating system distributions. The focus is on GNU/Linux
  21     systems, but most things apply to other systems too.
  22
  23     While the standard "configure && make DESTDIR=$PKG install" should
  24     give a pretty good package, there are some details which packagers
  25     may want to tweak.
  26
  27     Packagers should also read the INSTALL file.
  28
  29
  30 1. Package naming
  31 -----------------
  32
  33     The preferred name for the XZ Utils package is "xz", because that's
  34     the name of the upstream tarball. Naturally you may have good reasons
  35     to use some other name; I won't get angry about it. ;-) It's just nice
  36     to be able to point people to the correct package name without asking
  37     what distro they have.
  38
  39     If your distro policy is to split things into small pieces, here is
  40     one suggestion:
  41
  42         xz              xz, xzdec, scripts (xzdiff, xzgrep, etc.), docs
  43         xz-lzma         lzma, unlzma, lzcat, lzgrep etc. symlinks and
  44                         lzmadec binary for compatibility with LZMA Utils
  45         liblzma         liblzma.so.*
  46         liblzma-devel   liblzma.so, liblzma.a, API headers
  47         liblzma-doc     Doxygen-generated liblzma API docs (HTML),
  48                         example programs
  49
  50
  51 2. Package description
  52 ----------------------
  53
  54     Here is a suggestion which you may use as the package description.
  55     If you can use only one-line description, pick only the first line.
  56     Naturally, feel free to use some other description if you find it
  57     better, and maybe send it to me too.
  58
  59         Library and command line tools for XZ and LZMA compressed files
  60
  61         XZ Utils provide a general purpose data compression library
  62         and command line tools. The native file format is the .xz
  63         format, but also the legacy .lzma format is supported. The .xz
  64         format supports multiple compression algorithms, of which LZMA2
  65         is currently the primary algorithm. With typical files, XZ Utils
  66         create about 30 % smaller files than gzip.
  67
  68     If you are splitting XZ Utils into multiple packages, here are some
  69     suggestions for package descriptions:
  70
  71     xz:
  72
  73         Command line tools for XZ and LZMA compressed files
  74
  75         This package includes the xz compression tool and other command
  76         line tools from XZ Utils. xz has command line syntax similar to
  77         that of gzip. The native file format is the .xz format, but also
  78         the legacy .lzma format is supported. The .xz format supports
  79         multiple compression algorithms, of which LZMA2 is currently the
  80         primary algorithm. With typical files, XZ Utils create about 30 %
  81         smaller files than gzip.
  82
  83         Note that this package doesn't include the files needed for
  84         LZMA Utils 4.32.x compatibility. Install also the xz-lzma
  85         package to make XZ Utils emulate LZMA Utils 4.32.x.
  86
  87     xz-lzma:
  88
  89         LZMA Utils emulation with XZ Utils
  90
  91         This package includes executables and symlinks to make
  92         XZ Utils emulate lzma, unlzma, lzcat, and other command
  93         line tools found from the legacy LZMA Utils 4.32.x package.
  94
  95     liblzma:
  96
  97         Library for XZ and LZMA compressed files
  98
  99         liblzma is a general purpose data compression library with
 100         an API similar to that of zlib. liblzma supports multiple
 101         algorithms, of which LZMA2 is currently the primary algorithm.
 102         The native file format is .xz, but also the legacy .lzma
 103         format and raw streams (no headers at all) are supported.
 104
 105         This package includes the shared library.
 106
 107     liblzma-devel:
 108
 109         Library for XZ and LZMA compressed files
 110
 111         This package includes the API headers, static library, and
 112         other development files related to liblzma.
 113
 114     liblzma-doc:
 115
 116         liblzma API documentation in HTML and example usage
 117
 118         This package includes the Doxygen-generated liblzma API
 119         HTML docs and example programs showing how to use liblzma.
 120
 121
 122 3. License
 123 ----------
 124
 125     If the package manager supports a license field, you probably should
 126     put GPLv2+ there (GNU GPL v2 or later). The interesting parts of
 127     XZ Utils are in the public domain, but some less important files
 128     ending up into the binary package are under GPLv2+. So it is simplest
 129     to just say GPLv2+ if you cannot specify "public domain and GPLv2+".
 130
 131     If you split XZ Utils into multiple packages as described earlier
 132     in this file, liblzma and liblzma-dev packages will contain only
 133     public domain code (from XZ Utils at least; compiler or linker may
 134     add some third-party code, which may be copyrighted).
 135
 136
 137 4. configure options
 138 --------------------
 139
 140     Unless you are building a package for a distribution that is meant
 141     only for embedded systems, don't use the following configure options:
 142
 143         --enable-debug
 144         --enable-encoders (*)
 145         --enable-decoders
 146         --enable-match-finders
 147         --enable-checks
 148         --enable-small (*)
 149         --disable-threads (*)
 150         --disable-microlzma (*)
 151         --disable-lzip-decoder (*)
 152
 153     (*) These are OK when building xzdec and lzmadec as described
 154         in INSTALL.
 155
 156     xzdec and lzmadec don't provide any functionality that isn't already
 157     available in the xz tool. Shipping xzdec and lzmadec without size
 158     optimization and statically-linked liblzma isn't very useful. Doing
 159     that would give users the xzdec man page, which may make it easier
 160     for people to find out that such tools exists, but the executables
 161     wouldn't have any advantage over the full-featured xz.
 162
 163
 164 5. Additional documentation
 165 ---------------------------
 166
 167     "make install" copies some additional documentation to $docdir
 168     (--docdir in configure). There is a copy of the GNU GPL v2, which
 169     can be replaced with a symlink if your distro ships with shared
 170     copies of the common license texts.
 171
 172     The Doxygen-generated documentation (HTML) for the liblzma API
 173     headers is included in the source release and will be installed by
 174     "make install" to $docdir/api. All JavaScript is removed to
 175     simplify license compliance and to reduce the install size. If the
 176     liblzma API documentation is not desired, either run configure with
 177     --disable-doc or remove the doc/api directory before running
 178     "make install".
 179
 180
 181 6. Extra files
 182 --------------
 183
 184     The "extra" directory contains some small extra tools or other files.
 185     The exact set of extra files can vary between XZ Utils releases. The
 186     extra files have only limited use or they are too dangerous to be
 187     put directly to $bindir (7z2lzma.sh is a good example, since it can
 188     silently create corrupt output if certain conditions are not met).
 189
 190     If you feel like it, you may copy the extra directory under the doc
 191     directory (e.g. /usr/share/doc/xz/extra). Maybe some people will find
 192     them useful. However, most people needing these tools probably are
 193     able to find them from the source package too.
 194
 195     The "debug" directory contains some tools that are useful only when
 196     hacking on XZ Utils. Don't package these tools.
 197
 198
 199 7. Installing XZ Utils and LZMA Utils in parallel
 200 -------------------------------------------------
 201
 202     XZ Utils and LZMA Utils 4.32.x can be installed in parallel by
 203     omitting the compatibility symlinks (lzma, unlzma, lzcat, lzgrep etc.)
 204     from the XZ Utils package. It's probably a good idea to still package
 205     the symlinks into a separate package so that users may choose if they
 206     want to use XZ Utils or LZMA Utils for handling .lzma files.
 207
 208
 209 8. Example
 210 ----------
 211
 212     Here is an example for i686 GNU/Linux that
 213       - links xz and lzmainfo against shared liblzma;
 214       - links size-optimized xzdec and lzmadec against static liblzma
 215         while avoiding libpthread dependency;
 216       - includes only shared liblzma in the final package; and
 217       - copies also the "extra" directory to the package.
 218
 219     PKG=/tmp/xz-pkg
 220     tar xf xz-x.y.z.tar.gz
 221     cd xz-x.y.z
 222     ./configure \
 223             --prefix=/usr \
 224             --disable-static \
 225             --disable-xzdec \
 226             --disable-lzmadec \
 227             CFLAGS='-march=i686 -mtune=generic -O2'
 228     make
 229     make DESTDIR=$PKG install-strip
 230     make clean
 231     ./configure \
 232             --prefix=/usr \
 233             --disable-shared \
 234             --disable-nls \
 235             --disable-encoders \
 236             --enable-small \
 237             --disable-threads \
 238             CFLAGS='-march=i686 -mtune=generic -Os'
 239     make -C src/liblzma
 240     make -C src/xzdec
 241     make -C src/xzdec DESTDIR=$PKG install-strip
 242     cp -a extra $PKG/usr/share/doc/xz
 243