From 44afd80cb40da906535992cd99d8d24a2a60414e Mon Sep 17 00:00:00 2001 From: joey Date: Sat, 10 Feb 2001 00:01:19 +0000 Subject: r436: more pods --- dh_movefiles | 71 +++++++++++++++++++++++++++++++++++++++++++++++++-- dh_movefiles.1 | 52 ------------------------------------- dh_perl | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- dh_perl.1 | 62 --------------------------------------------- dh_shlibdeps | 63 +++++++++++++++++++++++++++++++++++++++++++-- dh_shlibdeps.1 | 54 --------------------------------------- dh_strip | 57 +++++++++++++++++++++++++++++++++++++++-- dh_strip.1 | 37 --------------------------- dh_suidregister.1 | 29 --------------------- 9 files changed, 258 insertions(+), 243 deletions(-) delete mode 100644 dh_movefiles.1 delete mode 100644 dh_perl.1 delete mode 100644 dh_shlibdeps.1 delete mode 100644 dh_strip.1 delete mode 100644 dh_suidregister.1 diff --git a/dh_movefiles b/dh_movefiles index 8eac3878..3fc689f6 100755 --- a/dh_movefiles +++ b/dh_movefiles @@ -1,9 +1,64 @@ #!/usr/bin/perl -w -# -# Move files out of debian/tmp, into subpackages. + +=head1 NAME + +dh_movefiles - move files out of debian/tmp into subpackages + +=cut use strict; use Debian::Debhelper::Dh_Lib; + +=head1 SYNOPSIS + + dh_movefiles [debhelper options] [--sourcedir=dir] [file ...] + +=head1 DESCRIPTION + +dh_movefiles is a debhelper program that is responsible for moving files +out of debian/tmp or some other directory and into other package build +directories. This may be useful if your package has a Makefile that installs +everything into debian/tmp, and you need to break that up into subpackages. + +Files named debian/package.files list the files to be moved, separated by +whitespace. The filenames listed should be relative to debian/tmp/. You can +also list directory names, and the whole directory will be moved. If you +prefer, you can list the files to move on the command line and this will +apply to the first package dh_movefiles is told to act on. + +=head1 OPTIONS + +=over 4 + +=item B<--sourcedir=>I + +Instead of moving files out of debian/tmp (the default), this option makes +it move files out of some other directory. Since the entire contents of +the sourcedir is moved, specifiying something like --sourcedir=/ is very +unsafe, so to prevent mistakes, the sourcedir must be a relative filename; +it cannot begin with a `/'. + +=item I + +Lists files to move. The filenames listed should be relative to +debian/tmp/. You can also list directory names, and the whole directory will +be moved. It is an error to list files here unless you use -p, -i, or -a to +tell dh_movefiles which subpackage to put them in. + +=back + +=head1 NOTES + +Note that files are always moved out of debian/tmp by default (even if you +have instructed debhelper to use a compatability level higher than one, +which does not otherwise use debian/tmp for anything at all). The idea +behind this is that the package that is being built can be told to install +into debian/tmp, and then files can be moved by dh_movefiles from that +directory. Any files or directories that remain are ignored, and get +deleted by dh_clean later. + +=cut + init(); my $ret=0; @@ -83,3 +138,15 @@ foreach my $package (@{$dh{DOPACKAGES}}) { # packages that arn't always sure exactly which files need # to be moved. exit $ret; + +=head1 SEE ALSO + +L + +This program is a part of debhelper. + +=head1 AUTHOR + +Joey Hess + +=cut diff --git a/dh_movefiles.1 b/dh_movefiles.1 deleted file mode 100644 index 72c6f254..00000000 --- a/dh_movefiles.1 +++ /dev/null @@ -1,52 +0,0 @@ -.TH DH_MOVEFILES 1 "" "Debhelper Commands" "Debhelper Commands" -.SH NAME -dh_movefiles \- move files out of debian/tmp into subpackages -.SH SYNOPSIS -.B dh_movefiles -.I "[debhelper options] [--sourcedir=dir] [file ..]" -.SH "DESCRIPTION" -dh_movefiles is a debhelper program that is responsible for moving files out -of debian/tmp or some other directory and into other package build -directories. This may be useful if your package has a Makefile that installs -everything into debian/tmp, and you need to break that up into subpackages. -.P -Files named debian/package.files list the files to be moved, separated by -whitespace. The filenames listed should be relative to debian/tmp/. You can -also list directory names, and the whole directory will be moved. If you -prefer, you can list the files to move on the command line and this will -apply to the first package dh_movefiles is told to act on. -.SH OPTIONS -.TP -.B debhelper options -See -.BR debhelper (1) -for a list of options common to all debhelper commands. -.TP -.B --sourcedir=dir -Instead of moving files out of debian/tmp (the default), this option makes -it move files out of some other directory. Since the entire contents of -the sourcedir is moved, specifiying something like --sourcedir=/ is very -unsafe, so to prevent mistakes, the sourcedir must be a relative filename; it -cannot begin with a `/'. -.TP -.B file .. -Lists files to move. The filenames listed should be relative to debian/tmp/. -You can also list directory names, and the whole directory will be moved. You -can even use wildcards if you like. It is an error to list files here unless -you use -p, -i, or -a to tell dh_movefiles which subpackage to put them in. -.SH NOTES -Note that files are always moved out of debian/tmp by default (even if you -have instructed debhelper to use a compatability level higher than one, -which does not otherwise use debian/tmp for anything at all). The idea -behind this is that the package that is being built can be told to install -into debian/tmp, and then files can be moved by dh_movefiles from that -directory. Any files or directories that remain are ignored, and get -deleted by dh_clean later. -.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_perl b/dh_perl index 2077497c..d7755421 100755 --- a/dh_perl +++ b/dh_perl @@ -1,10 +1,68 @@ #!/usr/bin/perl -w -# -# Find dependencies on perl stuff -# Remove .packlist files + +=head1 NAME + +dh_perl - calculates perl scripts & modules dependencies + +=cut use strict; use Debian::Debhelper::Dh_Lib; + +=head1 SYNOPSIS + + dh_perl [debhelper options] [-k] [-d] [library dirs ...] + +=head1 DESCRIPTION + +dh_perl is a debhelper program that is responsible for generating +the perl:Depends substitutions and adding them to substvars files. + +The program will look for the location of installed modules and will +use this information to generate a dependency (at the present time +it can only be perl5, perl5-thread, perl-5.X or perl-5.X-thread). +The dependancy will be substituted into your package's control file +wherever you place the token "${perl:Depends}". + +It will also look at #! lines of perl scripts in order to be able +to calculate a dependency for perl scripts and not only perl modules. + +In addition it will automatically remove .packlist file and will +remove the directory in which it was if it's empty. You can +switch off this option by passing -k. + +=head1 OPTIONS + +=over 4 + +=item B<-k> + +Keep .packlist files. + +=item B<-d> + +In some specific cases you may want to depend on a -base package +(ie perl-5.6-base or perl5-base). If so, you can pass +the -d option to make dh_perl generate a dependency on the correct base +package. This is only necessary for some packages that are included in the +base system. + +=item I + +If your package installs perl modules in non-standard +directories, you can make dh_perl check those directories by passing their +names on the command line. It will only check usr/lib/perl5 by default. + +=back + +=head1 CONFORMS TO + +Debian policy, version 3.0.1 + +Perl policy, version 1.0 + +=cut + init(); my $perlext = ''; @@ -162,3 +220,15 @@ sub dep_from_script { } return $dep; } + +=head1 SEE ALSO + +L + +This program is a part of debhelper. + +=head1 AUTHOR + +Joey Hess + +=cut diff --git a/dh_perl.1 b/dh_perl.1 deleted file mode 100644 index 1a8ee3b8..00000000 --- a/dh_perl.1 +++ /dev/null @@ -1,62 +0,0 @@ -.TH DH_PERL 1 "22 June 1999" "Debhelper Commands" "Debhelper Commands" -.SH NAME -dh_perl \- calculates perl scripts & modules dependencies -.SH SYNOPSIS -.B dh_perl -.I "[debhelper options] [-k] [-d] [library dirs ...]" -.SH "DESCRIPTION" -dh_perl is a debhelper program that is responsible for generating -the perl:Depends substitutions and adding them to substvars files. -.P -The program will look for the location of installed modules and will -use this information to generate a dependency (at the present time -it can only be perl5, perl5-thread, perl-5.X or perl-5.X-thread). -The dependancy will be substituted into your package's control file -wherever you place the token "${perl:Depends}". -.P -It will also look at #! lines of perl scripts in order to be able -to calculate a dependency for perl scripts and not only perl modules. -.P -In addition it will automatically remove .packlist file and will -remove the directory in which it was if it's empty. You can -switch off this option by passing -k. -.SH OPTIONS -.TP -.TP -.B debhelper options -See -.BR debhelper (1) -for a list of options common to all debhelper commands. -.TP -.B -k -Keep .packlist files. -.TP -.B -d -In some specific cases you may want to depend on a -base package -(ie perl-5.6-base or perl5-base). If so, you can pass -the -d option to make -.BR dh_perl -generate a dependency on the correct base package. This is only necessary -for some modules that are included in the base system. -.TP -.B library dirs -If your package installs perl modules in non-standard -directories, you can make -.BR dh_perl -check those directories by passing their names on the command line. -.BR dh_perl -will only check usr/lib/perl5 by default. -.SH ENVIRONMENT -See -.BR debhelper (1) -for a list of environment variables that affect all debhelper commands. -.SH "SEE ALSO" -.TP -.BR debhelper (1) -.SH "CONFORMS TO" -.P -Debian policy, version 3.0.1 -.P -Perl policy, version 1.0 -.SH AUTHOR -Raphaël Hertzog diff --git a/dh_shlibdeps b/dh_shlibdeps index 93f9bd07..33fd9411 100755 --- a/dh_shlibdeps +++ b/dh_shlibdeps @@ -1,10 +1,57 @@ #!/usr/bin/perl -w -# -# Find dependancies. Simple dpkg-shlibdeps wrapper. + +=head1 NAME + +dh_shlibdeps - calculate shared library dependancies + +=cut use strict; use Cwd; use Debian::Debhelper::Dh_Lib; + +=head1 SYNOPSIS + + dh_shlibdeps [debhelper options] [-ldirectory] [-Xitem] [-- params] + +=head1 DESCRIPTION + +dh_shlibdeps is a debhelper program that is responsible for calculating +shared library dependancies for packages. + +This program is merely a wrapper around L that calls it +once for each package listed in the control file, passing it +a list of ELF executables and shared libraries it has found. + +=head1 OPTIONS + +=over 4 + +=item B<-u>I, B<--dpkg-shlibdeps-params=>I + +=item B<--> I + +Pass "params" to L. + +=item B<-X>I, B<--exclude=>I + +Exclude files that contain "item" anywhere in their filename from being +passed to dpkg-shlibdeps. This will make their dependancies be ignored. +This may be useful in some situations, but use it with caution. This option +may be used more than once to exclude more than one thing. + +=item B<-l>I + +Before dpkg-shlibdeps is run, LD_LIBRARY_PATH will be set to the specified +directory. This is useful for multi-binary packages where a library +is built in one package and another package contains binaries linked +against said library. Relative paths will be made absolute for the +benefit of dpkg-shlibdeps. + +=back + +=cut + init(); foreach my $package (@{$dh{DOPACKAGES}}) { @@ -40,3 +87,15 @@ foreach my $package (@{$dh{DOPACKAGES}}) { doit("dpkg-shlibdeps","-Tdebian/${ext}substvars",@{$dh{U_PARAMS}},'-dDepends',@filelist); } } + +=head1 SEE ALSO + +L + +This program is a part of debhelper. + +=head1 AUTHOR + +Joey Hess + +=cut diff --git a/dh_shlibdeps.1 b/dh_shlibdeps.1 deleted file mode 100644 index 14e56b02..00000000 --- a/dh_shlibdeps.1 +++ /dev/null @@ -1,54 +0,0 @@ -.TH DH_SHLIBDEPS 1 "" "Debhelper Commands" "Debhelper Commands" -.SH NAME -dh_shlibdeps \- calculate shared library dependancies -.SH SYNOPSIS -.B dh_shlibdeps -.I "[debhelper options] [-ldirectory] [-uparams] [-Xitem] [-- params]" -.SH "DESCRIPTION" -dh_shlibdeps is a debhelper program that is responsible for calculating -shared library dependancies for packages. -.P -This program is merely a wrapper around -.BR dpkg-shlibdeps (1) -that calls it once for each package listed in the control file, passing it -a list of ELF executables and shared libraries it has found. -.SH OPTIONS -.TP -.B debhelper options -See -.BR debhelper (1) -for a list of options common to all debhelper commands. -.TP -.B \-uparams, \--dpkg-shlibdeps-params=params -.TP -.B \-\- params -Pass "params" to -.BR dpkg-shlibdeps (1) -.TP -.B \-Xitem, \--exclude=item -Exclude files that contain "item" anywhere in their filename from being -passed to dpkg-shlibdeps. This will make their dependancies be ignored. -This may be useful in some situations, but use it with caution. This option -may be used more than once to exclude more than one thing. -.TP -.B \-ldirectory -Before -.BR dpkg-shlibdeps (1) -is run, LD_LIBRARY_PATH will be set to the specified directory. -This is useful for multi-binary packages where a library -is built in one package and another package contains binaries linked -against said library. Relative paths will be made absolute for the -benefit of dpkg-shlibdeps. -.SH ENVIRONMENT -See -.BR debhelper (1) -for a list of environment variables that affect all debhelper commands. -.SH "SEE ALSO" -.TP -.BR debhelper (1) -.TP -.BR dpkg-shlibdeps (1) -.SH "CONFORMS TO" -Debian policy, version 3.0.1 -.SH AUTHOR -Joey Hess diff --git a/dh_strip b/dh_strip index 86304f40..d2f7a445 100755 --- a/dh_strip +++ b/dh_strip @@ -1,10 +1,51 @@ #!/usr/bin/perl -w -# -# Strip files. + +=head1 NAME + +dh_strip - strip executables, shared libraries, and some static libraries + +=cut use strict; use File::Find; use Debian::Debhelper::Dh_Lib; + +=head1 SYNOPSIS + + dh_strip [debhelper options] [-Xitem] + +=head1 DESCRIPTION + +dh_strip is a debhelper program that is responsible for stripping +executables, shared libraries, and static libraries that are not used for +debugging. + +It assumes that files that have names like lib*_g.a are static libraries +used in debugging, and will not strip them. + +=head1 OPTIONS + +=over 4 + +=item B<-X>I, B<--exclude=>I + +Exclude files that contain "item" anywhere in their filename from being +stripped. You may use this option multiple times to build up a list of +things to exclude. + +=back + +=head1 NOTES + +If the DEB_BUILD_OPTIONS environement variable contains "nostrip", nothing +will be stripped, in accordance with Debian policy. + +=head1 CONFORMS TO + +Debian policy, version 3.0.1 + +=cut + init(); # This variable can be used to turn off stripping (see Policy). @@ -76,3 +117,15 @@ foreach my $package (@{$dh{DOPACKAGES}}) { doit("strip","--strip-debug",$_); } } + +=head1 SEE ALSO + +L + +This program is a part of debhelper. + +=head1 AUTHOR + +Joey Hess + +=cut diff --git a/dh_strip.1 b/dh_strip.1 deleted file mode 100644 index 74c6b751..00000000 --- a/dh_strip.1 +++ /dev/null @@ -1,37 +0,0 @@ -.TH DH_STRIP 1 "" "Debhelper Commands" "Debhelper Commands" -.SH NAME -dh_strip \- strip executables, shared libraries, and some static libraries. -.SH SYNOPSIS -.B dh_strip -.I "[debhelper options] [-Xitem]" -.SH "DESCRIPTION" -dh_strip is a debhelper program that is responsible for stripping -executables, shared libraries, and static libraries that are not used for -debugging. -.P -It assumes that files that have names like lib*_g.a are static libraries -used in debugging, and will not strip them. -.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 -stripped. 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 NOTES -If the DEB_BUILD_OPTIONS environement variable contains "nostrip", nothing -will be stripped, in accordance with Debian policy. -.SH "SEE ALSO" -.BR debhelper (1) -.SH "CONFORMS TO" -Debian policy, version 3.0.1 -.SH AUTHOR -Joey Hess diff --git a/dh_suidregister.1 b/dh_suidregister.1 deleted file mode 100644 index 0ec89538..00000000 --- a/dh_suidregister.1 +++ /dev/null @@ -1,29 +0,0 @@ -.TH DH_SUIDREGISTER 1 "" "Debhelper Commands" "Debhelper Commands" -.SH NAME -dh_suidregister \- obsolete suid registration program -.SH SYNOPSIS -Do not run -.SH "DESCRIPTION" -This program used to register suid and sgid files with -.BR suidregister (1) -, but with the introduction of -.BR dpkg-statoverride (8) -, registration of files in this way is unnecessary, and even harmful, so -this program no longer does anything, and you can remove it from any rules -file that uses it. -.P -If your package registered things with suidregister before, you need to -make sure that you add a versioned conflict, as follows: - Conflicts: suidmanager (<< 0.50) -.P -This is not done automatically. If your program did not previously use -suidregister, you do not have to add the conflict. -.SH "SEE ALSO" -.TP -.BR debhelper (1) -.TP -.BR suidregister (8) -.TP -.BR dpkg-statoverride (8) -.SH AUTHOR -Joey Hess -- cgit v1.2.3