doc/pkgdelta.8.txt

   1 /////
   2 vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
   3 /////
   4 pkgdelta(8)
   5 =========
   6
   7 Name
   8 ----
   9 pkgdelta - package delta generation utility
  10
  11
  12 Synopsis
  13 --------
  14 'pkgdelta' [options] <package1> <package2>
  15
  16
  17 Description
  18 -----------
  19 'pkgdelta' is used to create package delta files between two versions of the
  20 same package. These files are essentially binary patches. linkman:pacman[8] can
  21 download deltas instead of full package upgrades, and use them with the
  22 previous versions of packages (in the package cache) to synthesize the upgraded
  23 version of the packages. This likely reduces download sizes for upgrades
  24 significantly.
  25
  26 'pkgdelta' requires linkman:xdelta3[1] to do its job.
  27
  28 Options
  29 -------
  30 *--max-delta-size <ratio>*::
  31         Only create delta files if the delta is smaller than ratio * package_size.
  32         Possible values: 0.0 to 2.0.
  33         Recommended values: 0.2 to 0.9.
  34         Default value: 0.7
  35
  36 *--min-pkg-size <size>*::
  37         Minimal size of the package file in bytes to be considered for delta creation.
  38         Default value: 1048576 bytes = 1MiB. This may be any absolute size in bytes, or
  39         a human readable value such as `4 MiB` or `3.5MB`.
  40
  41 *-q, \--quiet*::
  42         Be quiet. Do not output anything but warnings and errors.
  43
  44 Examples
  45 --------
  46
  47   $ pkgdelta libreoffice-3.3.2-1-x86_64.pkg.tar.xz libreoffice-3.3.2-2-x86_64.pkg.tar.xz
  48
  49 See Also
  50 --------
  51 linkman:pacman[8], linkman:xdelta3[1]
  52
  53 include::footer.txt[]