dh_compress.1

   1 .TH DH_COMPRESS 1 "" "Debhelper Commands" "Debhelper Commands"
   2 .SH NAME
   3 dh_compress \- compress files and fix symlinks in package build directories
   4 .SH SYNOPSIS
   5 .B dh_compress
   6 .I "[debhelper options] [-Xitem] [-A] [file ...]"
   7 .SH "DESCRIPTION"
   8 dh_compress is a debhelper program that is responsible for compressing
   9 the files in package build directories, and makes sure that any symlinks
  10 that pointed to the files before they were compressed are updated to point
  11 to the new files.
  12 .P
  13 By default, dh_compress compresses files that debian policy mandates should
  14 be compressed, namely all files in usr/share/info, usr/share/man,
  15 usr/X11R6/man, and all files in usr/share/doc that are larger than 4k in size,
  16 (except the copyright file, .html files and .gif files), and all changelog
  17 files. It skips any files that appear to be already compressed (based on their
  18 extensions).
  19 .P
  20 If a debian/package.compress file exists, however, it will be ran as a shell
  21 script, and all filenames that the shell script outputs will be compressed
  22 instead of the default files. Note that the shell script will be run from
  23 inside the package build directory. Note though that using -X is a much
  24 better idea in general; you should only use a debian/package.compress file if
  25 you really have to.
  26 .SH OPTIONS
  27 .TP
  28 .B debhelper options
  29 See
  30 .BR debhelper (1)
  31 for a list of options common to all debhelper commands.
  32 .TP
  33 .B \-Xitem, \--exclude=item
  34 Exclude files that contain "item" anywhere in their filename from being
  35 compressed. For example, -X.jpeg will exclude jpeg's from compression.
  36 You may use this option multiple times to build up a list of things to
  37 exclude. You can accomplish the same thing by using a debian/compress file,
  38 but this is easier.
  39 .TP
  40 .B \-A, \--all
  41 Compress all files specified by command line parameters in ALL packages
  42 acted on.
  43 .TP
  44 .B file ...
  45 Add these files to the list of files to compress.
  46 .SH ENVIRONMENT
  47 See
  48 .BR debhelper (1)
  49 for a list of environment variables that affect all debhelper commands.
  50 .SH "SEE ALSO"
  51 .BR debhelper (1)
  52 .SH BUGS
  53 Filenames with spaces in them may not properly be compressed.
  54 .SH "CONFORMS TO"
  55 Debian policy, version 3.0.0.0
  56 .SH AUTHOR
  57 Joey Hess <joeyh@debian.org>