From: joey Date: Fri, 9 Feb 2001 09:48:34 +0000 (+0000) Subject: r425: mode pod man pages X-Git-Tag: version_2.0.101~174 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=8b21a3c92ca26438bb925da9a5a280fc4bfd1182;p=debhelper.git r425: mode pod man pages --- diff --git a/dh_builddeb.1 b/dh_builddeb.1 deleted file mode 100644 index 3a5851b..0000000 --- a/dh_builddeb.1 +++ /dev/null @@ -1,34 +0,0 @@ -.TH DH_BUILDDEB 1 "" "Debhelper Commands" "Debhelper Commands" -.SH NAME -dh_builddeb \- build debian packages -.SH SYNOPSIS -.B dh_builddeb -.I "[debhelper options] [--destdir=directory] [--name=filename] [-uparams] [-- params]" -.SH "DESCRIPTION" -dh_builddeb simply calls -.BR dpkg (8) -to build a .deb package or packages. -.SH OPTIONS -.TP -.B --destdir=directory -Use this if you want the generated .deb files to be put in a directory other -than the default of ".." -.TP -.B --name=filename -Use this if you want to force the generated .deb file to have a particular -file name. Does not work well if more than one .deb is generated! -.TP -.B \-uparams -.TP -.B \-\- params -Pass "params" to -.BR dpkg-deb (1) -when it is used to build the package. -.SH ENVIRONMENT -See -.BR debhelper (1) -for a list of environment variables that affect all debhelper commands. -.SH "SEE ALSO" -.BR debhelper (1) -.SH AUTHOR -Joey Hess diff --git a/dh_clean b/dh_clean index fb4e3a8..7876cdd 100755 --- a/dh_clean +++ b/dh_clean @@ -1,10 +1,61 @@ #!/usr/bin/perl -w -# -# Clean up $tmp and other tepmorary files generated by the -# build process. + +=head1 NAME + +dh_clean - clean up package build directories + +=cut use strict; use Debian::Debhelper::Dh_Lib; + +=head1 SYNOPSIS + + dh_clean [debhelper options] [-k] [-d] [file ...] [-Xitem] + +=head1 DESCRIPTION + +dh_clean is a debhelper program that is responsible for cleaning up after a +package is built. It removes the package build directories, and removes +some +other files, such as debian/substvars, debian/files, and any detritus left +behind by other debhelper commands. It also removes common files that +should not appear in a debian diff: + #*# *~ DEADJOE *.orig *.rej *.SUMS TAGS core .deps/* *.P + +=head1 OPTIONS + +=over 4 + +=item B<-k>, B<--keep> + +Do not delete debian/files. When do you want to use this? Anytime you have a +debian/rules that has 2 binary targets that build different .deb packages; +for example, one target is binary-arch, and the other is binary-indep, or +one target builds the shared library, and the other the -dev package. If you +didn't use -k in these cases, then debian/files would be deleted in the +middle, and your changes file will only contain the last binary package that +was built. + +=item B<-d>, B<--dirs-only> + +Only clean the package build directories, do not clean up any other files +at all. + +=item B<-X>I B<--exclude=>I + +Exclude files that contain "item" anywhere in their filename from being +deleted, even if they would normally be deleted. You may use this option +multiple times to build up a list of things to exclude. + +=item I + +Delete these files too. + +=back + +=cut + init(); foreach my $package (@{$dh{DOPACKAGES}}) { @@ -51,3 +102,14 @@ if (! $dh{D_FLAG}) { doit('rm', '-rf', 'debian/tmp') if -x 'debian/tmp' && ! compat(1); +=head1 SEE ALSO + +L + +This program is a part of debhelper. + +=head1 AUTHOR + +Joey Hess + +=cut diff --git a/dh_clean.1 b/dh_clean.1 deleted file mode 100644 index 5db26de..0000000 --- a/dh_clean.1 +++ /dev/null @@ -1,48 +0,0 @@ -.TH DH_CLEAN 1 "" "Debhelper Commands" "Debhelper Commands" -.SH NAME -dh_clean \- clean up package build directories -.SH SYNOPSIS -.B dh_clean -.I "[debhelper options] [-k] [-d] [file ...] [-Xitem]" -.SH "DESCRIPTION" -dh_clean is a debhelper program that is responsible for cleaning up after a -package is built. It removes the package build directories, and removes some -other files, such as debian/substvars, debian/files, and any detritus left -behind by other debhelper commands. It also removes common files that -should not appear in a debian diff: - #*# *~ DEADJOE *.orig *.rej *.SUMS TAGS core .deps/* *.P -.SH OPTIONS -.TP -.B debhelper options -See -.BR debhelper (1) -for a list of options common to all debhelper commands. -.TP -.B \-k, \--keep -Do not delete debian/files. When do you want to use this? Anytime you have a -debian/rules that has 2 binary targets that build different .deb packages; -for example, one target is binary-arch, and the other is binary-indep, or -one target builds the shared library, and the other the -dev package. If you -didn't use -k in these cases, then debian/files would be deleted in the -middle, and your changes file will only contain the last binary package that -was built. -.TP -.B \-d, \--dirs-only -Only clean the package build directories, do not clean up any other files at -all. -.TP -.B \-Xitem, \--exclude=item -Exclude files that contain "item" anywhere in their filename from being -deleted, even if they would normally be deleted. You may use this option -multiple times to build up a list of things to exclude. -.TP -.B file ... -Delete these files too. -.SH ENVIRONMENT -See -.BR debhelper (1) -for a list of environment variables that affect all debhelper commands. -.SH "SEE ALSO" -.BR debhelper (1) -.SH AUTHOR -Joey Hess diff --git a/dh_compress b/dh_compress index 7a930bc..504d0a2 100755 --- a/dh_compress +++ b/dh_compress @@ -1,11 +1,69 @@ #!/usr/bin/perl -w -# -# Compresses files and makes sure that symlinks pointing to the -# compressed files get fixed. + +=head1 NAME + +dh_compress - compress files and fix symlinks in package build directories + +=cut use strict; use Cwd; use Debian::Debhelper::Dh_Lib; + +=head1 SYNOPSIS + + dh_compress [debhelper options] [-Xitem] [-A] [file ...] + +=head1 DESCRIPTION + +dh_compress 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, +usr/X11R6/man, and all files in usr/share/doc that are larger than 4k in size, +(except the copyright file, .html files and .gif files), and all changelog +files. It skips any files that appear to be already compressed (based on their +extensions). + +If a debian/package.compress file exists, however, it will be ran as a shell +script, and all filenames that the shell script outputs will be compressed +instead of the default files. 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 have to. + +=head1 OPTIONS + +=over 4 + +=item B<-X>I, B<--exclude=>I + +Exclude files that contain "item" anywhere in their filename from being +compressed. For example, -X.jpeg will exclude jpeg's from compression. +You may use this option multiple times to build up a list of things to +exclude. You can accomplish the same thing by using a debian/compress file, +but this is easier. + +=item B<-A>, B<--all> + +Compress all files specified by command line parameters in ALL packages +acted on. + +=item I + +Add these files to the list of files to compress. + +=back + +=head1 CONFORMS TO + +Debian policy, version 3.0 + +=cut + init(); foreach my $package (@{$dh{DOPACKAGES}}) { @@ -117,3 +175,15 @@ foreach my $package (@{$dh{DOPACKAGES}}) { } } } + +=head1 SEE ALSO + +L + +This program is a part of debhelper. + +=head1 AUTHOR + +Joey Hess + +=cut diff --git a/dh_compress.1 b/dh_compress.1 deleted file mode 100644 index e3319df..0000000 --- a/dh_compress.1 +++ /dev/null @@ -1,57 +0,0 @@ -.TH DH_COMPRESS 1 "" "Debhelper Commands" "Debhelper Commands" -.SH NAME -dh_compress \- compress files and fix symlinks in package build directories -.SH SYNOPSIS -.B dh_compress -.I "[debhelper options] [-Xitem] [-A] [file ...]" -.SH "DESCRIPTION" -dh_compress 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. -.P -By default, dh_compress compresses files that debian policy mandates should -be compressed, namely all files in usr/share/info, usr/share/man, -usr/X11R6/man, and all files in usr/share/doc that are larger than 4k in size, -(except the copyright file, .html files and .gif files), and all changelog -files. It skips any files that appear to be already compressed (based on their -extensions). -.P -If a debian/package.compress file exists, however, it will be ran as a shell -script, and all filenames that the shell script outputs will be compressed -instead of the default files. Note that 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 have to. -.SH OPTIONS -.TP -.B debhelper options -See -.BR debhelper (1) -for a list of options common to all debhelper commands. -.TP -.B \-Xitem, \--exclude=item -Exclude files that contain "item" anywhere in their filename from being -compressed. For example, -X.jpeg will exclude jpeg's from compression. -You may use this option multiple times to build up a list of things to -exclude. You can accomplish the same thing by using a debian/compress file, -but this is easier. -.TP -.B \-A, \--all -Compress all files specified by command line parameters in ALL packages -acted on. -.TP -.B file ... -Add these files to the list of files to compress. -.SH ENVIRONMENT -See -.BR debhelper (1) -for a list of environment variables that affect all debhelper commands. -.SH "SEE ALSO" -.BR debhelper (1) -.SH BUGS -Filenames with spaces in them may not properly be compressed. -.SH "CONFORMS TO" -Debian policy, version 3.0.0.0 -.SH AUTHOR -Joey Hess diff --git a/dh_fixperms b/dh_fixperms index 6024c50..7cd3393 100755 --- a/dh_fixperms +++ b/dh_fixperms @@ -1,9 +1,45 @@ #!/usr/bin/perl -w -# -# Do some general file permission fixups. + +=head1 NAME + +dh_fixperms - fix permissions of files in package build directories + +=cut use strict; use Debian::Debhelper::Dh_Lib; + +=head1 SYNOPSIS + +dh_fixperms [debhelper options] [-Xitem] + +=head1 DESCRIPTION + +dh_fixperms is a debhelper program that is responsible for setting the +permissions of files and directories in package build directories to a +sane state -- a state that complies with Debian policy. + +dh_fixperms makes all files in usr/share/doc in the package build directory +(excluding files in the examples/ directory) be mode 644. It also changes +the permissions of all man pages to mode 644. It makes all files be owned by +root, and it removes group and other write permission from all files. +It removes execute permissions from any libraries that have it set. Finally, +it removes the setuid and setgid bits from all files in the package. + +=head1 OPTIONS + +=over 4 + +=item B<-X>I, B<--exclude>I + +Exclude files that contain "item" anywhere in their filename from having +their permissions changed. You may use this option multiple times to build +up a list of things to exclude. + +=back + +=cut + init(); foreach my $package (@{$dh{DOPACKAGES}}) { @@ -37,3 +73,15 @@ foreach my $package (@{$dh{DOPACKAGES}}) { "\\( -name '*.so*' -or -name '*.la' -or -name '*.a' \\) $find_options -print0", "2>/dev/null | xargs -0r chmod a-X"); } + +=head1 SEE ALSO + +L + +This program is a part of debhelper. + +=head1 AUTHOR + +Joey Hess + +=cut diff --git a/dh_fixperms.1 b/dh_fixperms.1 deleted file mode 100644 index debc8ec..0000000 --- a/dh_fixperms.1 +++ /dev/null @@ -1,38 +0,0 @@ -.TH DH_FIXPERMS 1 "" "Debhelper Commands" "Debhelper Commands" -.SH NAME -dh_fixperms \- fix permissions of files in package build directories -.SH SYNOPSIS -.B dh_fixperms -.I "[debhelper options] [-Xitem]" -.SH "DESCRIPTION" -dh_fixperms is a debhelper program that is responsible for setting the -permissions of files and directories in package build directories to a -sane state -- a state that complies with Debian policy. -.P -dh_fixperms makes all files in usr/share/doc in the package build directory -(excluding files in the examples/ directory) be mode 644. It also changes -the permissions of all man pages to mode 644. It makes all files be owned by -root, and it removes group and other write permission from all files. -It removes execute permissions from any libraries that have it set. Finally, -it removes the setuid and setgid bits from all files in the package. -.SH OPTIONS -.TP -.B debhelper options -See -.BR debhelper (1) -for a list of options common to all debhelper commands. -.TP -.B \-Xitem, \--exclude=item -Exclude files that contain "item" anywhere in their filename from having -their permissions changed. You may use this option multiple times to build -up a list of things to exclude. -.SH ENVIRONMENT -See -.BR debhelper (1) -for a list of environment variables that affect all debhelper commands. -.SH "SEE ALSO" -.BR debhelper (1) -.SH "CONFORMS TO" -Debian policy, version 3.0.1 -.SH AUTHOR -Joey Hess