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] [-Ptmpdir]"
   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/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 \\
  29         \\( -size +4k -or -name "changelog*" \\) \\
  30         ! -name "*.htm*" ! -name "*.gif" \\
  31         ! -name "copyright"
  32 .SH OPTIONS
  33 .TP
  34 .B \-v, \--verbose
  35 Verbose mode; show all commands that modify the package build directory.
  36 .TP
  37 .B \-a, \--arch
  38 Compress files for all architecture dependent packages.
  39 .TP
  40 .B \-i, \--indep
  41 Compress files for all architecture independent packages.
  42 .TP
  43 .B \-ppackage, \--package=package
  44 Compress files for the package named "package".
  45 .TP
  46 .B \-Ptmpdir, \--tmpdir=tmpdir
  47 Use "tmpdir" for package build directory.
  48 .SH NOTES
  49 The
  50 .B \-a
  51 .B \-i
  52 and
  53 .B \-p
  54 arguments are cumulative. If none are specified, then all packages listed in
  55 the control file will have their files compressed.
  56 .P
  57 The debian/compress file applies to the first binary package listed in your
  58 control file. For the other packages, you can make files named
  59 debian/package.compress, where "package" is the name of the package they
  60 apply to. (This works for the first binary package too.)
  61 .SH ENVIRONMENT
  62 .TP
  63 .I DH_VERBOSE
  64 Enables verbose mode
  65 .SH "SEE ALSO"
  66 .BR /usr/doc/debhelper/README
  67 .SH BUGS
  68 Filenames with spaces in them may not properly be compressed.
  69 .SH "CONFORMS TO"
  70 Debian policy, version 2.3.0.0
  71 .SH AUTHOR
  72 Joey Hess <joeyh@master.debian.org>