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/info, usr/man, usr/X11R6/man, and
  15 all files in usr/doc that are larger than 4k in size, except
  16 the copyright file, .html files and .gif files, and all changelog files.
  17 .P
  18 If a debian/package.compress file exists (debian/compress may be used for the
  19 first binary package in debian/control), however, it will be ran as a shell
  20 script, and all filenames that the shell script outputs will be compressed
  21 instead of the default files. Note that the shell script will be run from
  22 inside the package build directory.
  23 .SH EXAMPLE
  24 Here is a sample debian/compress file that causes dh_compress to compress
  25 the same files as it would by default. This is a good starting point for
  26 customization of what files are compressed:
  27 .PP
  28  find usr/info usr/man usr/X11*/man -type f
  29  find usr/doc -type f \\
  30         \\( -size +4k -or -name "changelog*" \\) \\
  31         ! -name "*.htm*" ! -name "*.gif" \\
  32         ! -name "copyright"
  33 .SH OPTIONS
  34 .TP
  35 .B debhelper options
  36 See
  37 .BR debhelper (1)
  38 for a list of options common to all debhelper commands.
  39 .TP
  40 .B \-Xitem, \--exclude=item
  41 Exclude files that contain "item" anywhere in their filename from being
  42 compressed. For example, -X.jpeg will exclude jpeg's from compression.
  43 You may use this option multiple times to build up a list of things to
  44 exclude. You can accomplish the same thing by using a debian/compress file,
  45 but this is easier.
  46 .TP
  47 .B \-A, \--all
  48 Compress all files specified by command line parameters in ALL packages
  49 acted on.
  50 .TP
  51 .B file ...
  52 Add these files to the list of files to compress.
  53 .SH NOTES
  54 The debian/compress file applies to the first binary package listed in your
  55 control file. For the other packages, you can make files named
  56 debian/package.compress, where "package" is the name of the package they
  57 apply to. (This works for the first binary package too.)
  58 .SH ENVIRONMENT
  59 See
  60 .BR debhelper (1)
  61 for a list of environment variables that affect all debhelper commands.
  62 .SH "SEE ALSO"
  63 .BR debhelper (1)
  64 .SH BUGS
  65 Filenames with spaces in them may not properly be compressed.
  66 .SH "CONFORMS TO"
  67 Debian policy, version 2.5.0.0
  68 .SH AUTHOR
  69 Joey Hess <joeyh@master.debian.org>