.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "DH-MAKE-PERL 1" .TH DH-MAKE-PERL 1 "2008-06-17" "perl v5.8.4" "debian" .SH "NAME" \&\fBdh\-make\-perl\fR \- Create debian source packages from perl modules .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBdh-make-perl\fR [\fB\s-1SOURCE_DIR\s0\fR | \fB\-\-cpan\fR \fI\s-1MODULE\s0\fR] .PP \&\fBdh-make-perl\fR \fB\-\-refresh\fR .PP You can modify \fBdh-make-perl\fR's behaviour with some switches: .IP "\fB\-\-desc\fR \fI\s-1SHORT\s0 \s-1DESCRIPTION\s0\fR" 4 .IX Item "--desc SHORT DESCRIPTION" Uses the argument to \-\-desc as short description for the package. .IP "\fB\-\-arch\fR \fIany\fR | \fIall\fR" 4 .IX Item "--arch any | all" This switches between arch-dependent and arch-independet packages. If \fB\-\-arch\fR isn't used, \fBdh-make-perl\fR uses a relatively good-working algorithms to decide this alone. .IP "\fB\-\-version\fR \fI\s-1VERSION\s0\fR" 4 .IX Item "--version VERSION" Specifies the version of the resulting package. .IP "\fB\-\-email\fR | \fB\-e\fR \fI\s-1EMAIL\s0\fR" 4 .IX Item "--email | -e EMAIL" Manually specify the Maintainer email address to use in debian/control and in debian/changelog. .IP "\fB\-\-packagename\fR | \fB\-p\fR \fI\s-1PACKAGENAME\s0\fR" 4 .IX Item "--packagename | -p PACKAGENAME" Manually specify the Package Name, useful when the module has dashes in its name. .IP "\fB\-\-closes\fR \fI\s-1ITPBUG\s0\fR" 4 .IX Item "--closes ITPBUG" Manually specify the \s-1ITP\s0 bug number that this package closes. If not given, dh-make-perl will try to connect to bugs.debian.org to fetch the appropriate bug number, using WWW::Mechanize. .IP "\fB\-\-depends\fR \fI\s-1DEPENDS\s0\fR" 4 .IX Item "--depends DEPENDS" Manually specify the string to be used for the module's dependencies. This should be used when building modules where dh-make-perl cannot guess the Perl dependencies (such as modules built using Module::Install), or when the Perl code depends on non-Perl binaries or libraries. Usually, dh-make-perl will figure out the dependencies by itself. If you need to pass dh-make-perl dependency information, you must do it using the debian package format. i.e. .Sp dh-make-perl \-\-depends libtest-more-perl .IP "\fB\-\-bdepends\fR \fIBUILD-DEPENDS\fR" 4 .IX Item "--bdepends BUILD-DEPENDS" Manually specify the string to be used for the module's build-dependencies (that is, the packages and their versions that have to be installed in order to successfully build the package). Keep in mind that packages generated by dh-make-perl require debhelper to be specified as a build dependency. Same note as for \-\-depends applies here \- Use only when needed. .IP "\fB\-\-bdependsi\fR \fIBUILD-DEPENDS-INDEP\fR" 4 .IX Item "--bdependsi BUILD-DEPENDS-INDEP" Manually specify the string to be used for the module's build-dependencies for architecture-independent builds. Same notes as those for the \-\-depends and \-\-bdepends options apply here. .Sp Note that for \-\-depends, \-\-bdepends and \-\-bdependsi you can also specify that the field should not appear in debian/rules (if you really mean it, of course ;\-) ) by giving it an empty string as an argument. .IP "\fB\-\-pkg\-perl\fR" 4 .IX Item "--pkg-perl" Useful when preparing a package for the Debian Perl Group . .Sp Sets \f(CW\*(C`Maintainer\*(C'\fR, \f(CW\*(C`Uploaders\*(C'\fR, \f(CW\*(C`Vcs\-Svn\*(C'\fR and \f(CW\*(C`Vcs\-Browser\*(C'\fR fields in debian/control accordingly. .IP "\fB\-\-cpan\-mirror\fR \fI\s-1MIRROR\s0\fR" 4 .IX Item "--cpan-mirror MIRROR" Specifies a \s-1CPAN\s0 site to use as mirror. .IP "\fB\-\-exclude\fR | \fB\-i\fR [\fI\s-1REGEX\s0\fR]" 4 .IX Item "--exclude | -i [REGEX]" This allows you to specify a \s-1PCRE\s0 to exclude some files from the search for docs and stuff like that. If no argument is given (but the switch is specified \&\- not specifying the switch will include everything), it defaults to exclude \&\s-1CVS\s0 and .svn directories. .IP "\fB\-\-build\fR" 4 .IX Item "--build" Builds the package after setting it up. .Sp \&\s-1NB:\s0 This builds only a binary package (by calling \*(L"fakeroot debian/rules binary\*(R") and does not sign the package. It is meant for a quick local install of a package, not for creating a package ready for submission to the Debian archive. .IP "\fB\-\-install\fR" 4 .IX Item "--install" Installs the freshly built package. Specifying \-\-install implies \-\-build \- The package will not be installed unless it was built (obviously ;\-) ) .IP "\fB\-\-notest\fR" 4 .IX Item "--notest" Does not run the automatic testing of the module as part of the build script. This is mostly useful when packaging buggy or incomplete software. .IP "\fB\-\-basepkgs\fR" 4 .IX Item "--basepkgs" Explicitly gives a comma-separated list of packages to consider \*(L"base\*(R" packages (i.e. packages that should always be available in Debian systems). This option defaults to \f(CW\*(C`perl,perl\-base,perl\-modules\*(C'\fR \- It is used to check for module dependencies. If a needed module is in the \&\f(CW\*(C`basepkgs\*(C'\fR, it won't be mentioned in the \f(CW\*(C`depends:\*(C'\fR field of \&\f(CW\*(C`debian/control\*(C'\fR. .Sp If this option is specified, the above mentioned default packages will not be included (but will be mentioned as explicit dependencies in the resulting package). You can, of course, mention your own modules and explicitly specify the default values. .Sp Note that this option should be used sparsingly and with care, as it might lead to packages not being rebuildable because of unfulfilled dependencies. .IP "\fB\-\-requiredeps\fR" 4 .IX Item "--requiredeps" Fail if a dependency perl package was not found (dependency tracking requires the apt-file package installed and updated) .IP "\fB\-\-core\-ok\fR" 4 .IX Item "--core-ok" Allows building core Perl modules. By default, dh-make-perl will not allow building a module that is shipped as part of the standard Perl library; by specifying this option, dh-make-perl will build them anyway. .Sp Note that, although it is not probable, this might break unrelated items in your system \- If a newer version of a core module breaks the \s-1API\s0, all kinds of daemons might get upset ;\-) .IP "\fB\-\-refresh\fR" 4 .IX Item "--refresh" Refresh mode. .Sp Instead of creating new debian/ directory, \fB\-\-refresh\fR makes \fBdh-make-perl\fR to re-create only \fBdebian/rules\fR according to the current templates. .Sp This is useful when \fBdebian/rules\fR was created using older templates and doesn't contain much customisations. As always, you're strongly encouraged to verify if \fBdebian/rules\fR looks sane. .RE .IP "\fB\-\-dh ver\fR" .IX Item "--dh ver" Set desired debhelper version. If \f(CW\*(C`ver\*(C'\fR is 7, generated debian/rules is minimalistic, using the auto-mode of debhelper. Also, any additional documentation and examples are listed in additional files under debian/, instead of being listed in debian/rules .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBdh-make-perl\fR will create the files required to build a debian source package out of a perl package. This works for most simple packages and is also useful for getting started with packaging perl modules. .PP You can specify a module name with the \fB\-\-cpan\fR switch and \fBdh-make-perl\fR will download the module for you from a \s-1CPAN\s0 mirror, or you can specify the directory with the already unpacked sources. If neither \-\-cpan nor a directory is given as argument, dh-make-perl tries to create a perl package from the data in \fI.\fR .PP There is an override mechanism in place to handle most of the little changes that may be needed for some modules (this hasn't been tested much, though, and the override database needs to be filled in). .PP You can build and install the debian package using the \-\-build and \-\-install command line switches. .PP Using this program is no excuse for not reading the debian developer documentation, including the Debian policy, the perl policy, the packaging manual and so on. .SH "FILES" .IX Header "FILES" The following directories will be searched to find additional files required by dh\-make\-perl: .PP .Vb 2 \& /usr/share/dh-make-perl/ \& $HOME/.dh-make-perl/ .Ve .IP "* overrides" 4 .IX Item "overrides" File that overrides information retreived (or guessed) about the package. All the files in the library directories are loaded: entries in the home take precedence. See the distributed overrides file for usage information. .IP "* rules.MakeMaker.noxs" 4 .IX Item "rules.MakeMaker.noxs" A debian/rules makefile for modules that use ExtUtils::MakeMaker, but don't have C/XS code. .IP "* rules.MakeMaker.xs" 4 .IX Item "rules.MakeMaker.xs" A debian/rules makefile for modules that use ExtUtils::MakerMaker and C/XS code. .IP "* rules.Module\-Build.noxs" 4 .IX Item "rules.Module-Build.noxs" A debian/rules makefile for modules that use Module::Build, but don't have C/XS code. .IP "* rules.Module\-Build.xs" 4 .IX Item "rules.Module-Build.xs" A debian/rules makefile for modules that use Module::Build and C/XS code. .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" \&\s-1HOME\s0 \- get user's home directory .PP \&\s-1DEBFULLNAME\s0 \- get the real name of the maintainer .PP \&\s-1LOGNAME\s0 or \s-1USER\s0 \- get the username .PP \&\s-1DEBEMAIL\s0 or \s-1EMAIL\s0 \- get the email address of the user .SH "BUGS" .IX Header "BUGS" Several, let me know when you find them. .SH "AUTHOR" .IX Header "AUTHOR" Paolo Molaro (\s-1MIA\s0) .PP Maintained for a time by Ivan Kohler . .PP Maintained for a time by Marc Brockschmdit . .PP Now maintained by Gunnar Wolf , and team-maintained by the Debian pkg-perl team, http://alioth.debian.org/projects/pkg\-perl .PP Patches from: .IP "Adam Sjoegren " 4 .IX Item "Adam Sjoegren " .PD 0 .IP "Adrian Phillips " 4 .IX Item "Adrian Phillips " .IP "Amos Shapira " 4 .IX Item "Amos Shapira " .IP "Christian Kurz " 4 .IX Item "Christian Kurz " .IP "Damyan Ivanov " 4 .IX Item "Damyan Ivanov " .IP "David Paleino " 4 .IX Item "David Paleino " .IP "David Pashley " 4 .IX Item "David Pashley " .IP "Edward Betts " 4 .IX Item "Edward Betts " .IP "Fermin Galan " 4 .IX Item "Fermin Galan " .IP "Geoff Richards " 4 .IX Item "Geoff Richards " .IP "Gergely Nagy " 4 .IX Item "Gergely Nagy " .IP "gregor herrmann " 4 .IX Item "gregor herrmann " .IP "Hilko Bengen " 4 .IX Item "Hilko Bengen " .IP "Kees Cook " 4 .IX Item "Kees Cook " .IP "Jesper Krogh " 4 .IX Item "Jesper Krogh " .IP "Johnny Morano " 4 .IX Item "Johnny Morano " .IP "Juerd " 4 .IX Item "Juerd " .IP "Marc Chantreux (mail withheld)" 4 .IX Item "Marc Chantreux (mail withheld)" .IP "Matt Hope " 4 .IX Item "Matt Hope " .IP "Noel Maddy " 4 .IX Item "Noel Maddy " .IP "Oliver Gorwits " 4 .IX Item "Oliver Gorwits " .IP "Peter Moerch " 4 .IX Item "Peter Moerch " .IP "Stephen Oberholtzer " 4 .IX Item "Stephen Oberholtzer " .IP "Ton Nijkes " 4 .IX Item "Ton Nijkes " .PD .PP \&... And others who, sadly, we have forgot to add :\-/