From 0952ac2e9995da8abe149f3e42b3b8d9d2797112 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Pr=C3=A9vot?= Date: Tue, 19 Oct 2010 18:54:32 -0400 Subject: Apply manual pages conventions As advised in man(1), always use: B type exactly as shown. I replace with appropriate argument. s/debian/Debian/ if needed. s/ / / also. s/perl/Perl/ s/python/Python/ and s/emacs/Emacs/ too. --- dh_compress | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'dh_compress') diff --git a/dh_compress b/dh_compress index 8367b27d..14dfdb33 100755 --- a/dh_compress +++ b/dh_compress @@ -12,21 +12,21 @@ use Debian::Debhelper::Dh_Lib; =head1 SYNOPSIS -B [S>] [B<-X>I] [B<-A>] [S>] +B [S>] [B<-X>I] [B<-A>] [S ...>] =head1 DESCRIPTION -dh_compress is a debhelper program that is responsible for compressing +B is a debhelper program that is responsible for compressing the files in package build directories, and makes sure that any symlinks that pointed to the files before they were compressed are updated to point to the new files. -By default, dh_compress compresses files that debian policy mandates should -be compressed, namely all files in usr/share/info, usr/share/man, -files in usr/share/doc that are larger than 4k in size, -(except the copyright file, .html and .css files, image files, and files +By default, B compresses files that Debian policy mandates should +be compressed, namely all files in F, F, +files in F that are larger than 4k in size, +(except the F file, F<.html> and F<.css> files, image files, and files that appear to be already compressed based on their extensions), and all -changelog files. Plus PCF fonts underneath usr/share/fonts/X11/ +F files. Plus PCF fonts underneath F =head1 FILES @@ -39,8 +39,8 @@ These files are deprecated. If this file exists, the default files are not compressed. Instead, the file is ran as a shell script, and all filenames that the shell script outputs will be compressed. The shell script will be run from inside the -package build directory. Note though that using -X is a much better idea in -general; you should only use a debian/package.compress file if you really +package build directory. Note though that using B<-X> is a much better idea in +general; you should only use a F file if you really need to. =back @@ -51,8 +51,8 @@ need to. =item B<-X>I, B<--exclude=>I -Exclude files that contain "item" anywhere in their filename from being -compressed. For example, -X.tiff will exclude tiff files from compression. +Exclude files that contain F anywhere in their filename from being +compressed. For example, B<-X.tiff> will exclude TIFF files from compression. You may use this option multiple times to build up a list of things to exclude. @@ -61,7 +61,7 @@ exclude. Compress all files specified by command line parameters in ALL packages acted on. -=item I +=item I ... Add these files to the list of files to compress. -- cgit v1.2.3