dh_compress.1

   1 .TH DH_COMPRESS 1
   2 .SH NAME
   3 dh_compress \- compress files and fix symlinks in package build directories
   4 .SH SYNOPSIS
   5 .B dh_compress
   6 .I "[-v] [-a] [-i] [-ppackage]"
   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.
  17 .P
  18 If a debian/compress file exits, however, it will be ran as a shell script,
  19 and all filenames that the shell script outputs will be compressed instead
  20 of the default files. Note that the shell script will be run from inside the
  21 package build directory.
  22 .SH EXAMPLE
  23 Here is a sample debian/compress file that causes dh_compress to compress
  24 the same files as it would by default. This is a good starting point for
  25 customization of what files are compressed:
  26 .PP
  27  find usr/info usr/man usr/X11*/man -type f
  28  find usr/doc -type f -size +4k \\
  29         ! -name "*.htm*" ! -name "*.gif" \\
  30         ! -name "copyright"
  31 .SH OPTIONS
  32 .TP
  33 .B \-v
  34 Verbose mode; show all commands that modify the package build directory.
  35 .TP
  36 .B \-a
  37 Compress files for all architecture dependent packages.
  38 .TP
  39 .B \-i
  40 Compress files for all architecture independent packages.
  41 .TP
  42 .B \-ppackage
  43 Compress files for the package named "package".
  44 .SH NOTES
  45 The
  46 .B \-a
  47 .B \-i
  48 and
  49 .B \-p
  50 arguments are cumulative. If none are specified, then all packages listed in
  51 the control file will have their files compressed.
  52 .P
  53 The debian/compress file applies to the first binary package listed in your
  54 control file. For the other packages, you can make files named
  55 debian/package.compress, where "package" is the name of the package they
  56 apply to.
  57 .SH ENVIRONMENT
  58 .TP
  59 .I DH_VERBOSE
  60 Enables verbose mode
  61 .SH "SEE ALSO"
  62 .BR /usr/doc/debhelper/README
  63 .SH BUGS
  64 Filenames with spaces in them may not properly be compressed.
  65 .SH "CONFORMS TO"
  66 Debian policy, version 2.3.0.0
  67 .SH AUTHOR
  68 Joey Hess <joeyh@master.debian.org>