git.maemo.org Git - dh-make-perl/blob - dev/arm/dh-make-perl/dh-make-perl-0.47/dh-make-perl.1

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "DH-MAKE-PERL 1"
 132 .TH DH-MAKE-PERL 1 "2008-06-17" "perl v5.8.4" "debian"
 133 .SH "NAME"
 134 \&\fBdh\-make\-perl\fR \- Create debian source packages from perl modules
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 \&\fBdh-make-perl\fR [\fB\s-1SOURCE_DIR\s0\fR | \fB\-\-cpan\fR \fI\s-1MODULE\s0\fR]
 138 .PP
 139 \&\fBdh-make-perl\fR \fB\-\-refresh\fR
 140 .PP
 141 You can modify \fBdh-make-perl\fR's behaviour with some switches:
 142 .IP "\fB\-\-desc\fR \fI\s-1SHORT\s0 \s-1DESCRIPTION\s0\fR" 4
 143 .IX Item "--desc SHORT DESCRIPTION"
 144 Uses the argument to \-\-desc as short description for the package.
 145 .IP "\fB\-\-arch\fR \fIany\fR | \fIall\fR" 4
 146 .IX Item "--arch any | all"
 147 This switches between arch-dependent and arch-independet packages. If \fB\-\-arch\fR
 148 isn't used, \fBdh-make-perl\fR uses a relatively good-working algorithms to
 149 decide this alone.
 150 .IP "\fB\-\-version\fR \fI\s-1VERSION\s0\fR" 4
 151 .IX Item "--version VERSION"
 152 Specifies the version of the resulting package.
 153 .IP "\fB\-\-email\fR | \fB\-e\fR \fI\s-1EMAIL\s0\fR" 4
 154 .IX Item "--email | -e EMAIL"
 155 Manually specify the Maintainer email address to use in debian/control and
 156 in debian/changelog.
 157 .IP "\fB\-\-packagename\fR | \fB\-p\fR \fI\s-1PACKAGENAME\s0\fR" 4
 158 .IX Item "--packagename | -p PACKAGENAME"
 159 Manually specify the Package Name, useful when the module has dashes in its
 160 name.
 161 .IP "\fB\-\-closes\fR \fI\s-1ITPBUG\s0\fR" 4
 162 .IX Item "--closes ITPBUG"
 163 Manually specify the \s-1ITP\s0 bug number that this package closes. If not
 164 given, dh-make-perl will try to connect to bugs.debian.org to fetch the
 165 appropriate bug number, using WWW::Mechanize.
 166 .IP "\fB\-\-depends\fR \fI\s-1DEPENDS\s0\fR" 4
 167 .IX Item "--depends DEPENDS"
 168 Manually specify the string to be used for the module's dependencies. This
 169 should be used when building modules where dh-make-perl cannot guess the Perl
 170 dependencies (such as modules built using Module::Install), or when the
 171 Perl code depends on non-Perl binaries or libraries. Usually, dh-make-perl
 172 will figure out the dependencies by itself. If you need to pass dh-make-perl
 173 dependency information, you must do it using the debian package format. i.e.
 174 .Sp
 175 dh-make-perl \-\-depends libtest-more-perl
 176 .IP "\fB\-\-bdepends\fR \fIBUILD-DEPENDS\fR" 4
 177 .IX Item "--bdepends BUILD-DEPENDS"
 178 Manually specify the string to be used for the module's build-dependencies
 179 (that is, the packages and their versions that have to be installed in order to
 180 successfully build the package). Keep in mind that packages generated by
 181 dh-make-perl require debhelper to be specified as a build dependency. Same note
 182 as for \-\-depends applies here \- Use only when needed.
 183 .IP "\fB\-\-bdependsi\fR \fIBUILD-DEPENDS-INDEP\fR" 4
 184 .IX Item "--bdependsi BUILD-DEPENDS-INDEP"
 185 Manually specify the string to be used for the module's build-dependencies
 186 for architecture-independent builds. Same notes as those for the \-\-depends
 187 and \-\-bdepends options apply here.
 188 .Sp
 189 Note that for \-\-depends, \-\-bdepends and \-\-bdependsi you can also specify that
 190 the field should not appear in debian/rules (if you really mean it, of course
 191 ;\-) ) by giving it an empty string as an argument.
 192 .IP "\fB\-\-pkg\-perl\fR" 4
 193 .IX Item "--pkg-perl"
 194 Useful when preparing a package for the Debian Perl Group
 195 <http://pkg\-perl.alioth.debian.org>.
 196 .Sp
 197 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
 198 debian/control accordingly.
 199 .IP "\fB\-\-cpan\-mirror\fR \fI\s-1MIRROR\s0\fR" 4
 200 .IX Item "--cpan-mirror MIRROR"
 201 Specifies a \s-1CPAN\s0 site to use as mirror.
 202 .IP "\fB\-\-exclude\fR | \fB\-i\fR [\fI\s-1REGEX\s0\fR]" 4
 203 .IX Item "--exclude | -i [REGEX]"
 204 This allows you to specify a \s-1PCRE\s0 to exclude some files from the search for
 205 docs and stuff like that. If no argument is given (but the switch is specified
 206 \&\- not specifying the switch will include everything), it defaults to exclude
 207 \&\s-1CVS\s0 and .svn directories.
 208 .IP "\fB\-\-build\fR" 4
 209 .IX Item "--build"
 210 Builds the package after setting it up.
 211 .Sp
 212 \&\s-1NB:\s0 This builds only a binary package (by calling \*(L"fakeroot debian/rules
 213 binary\*(R") and does not sign the package. It is meant for a quick local
 214 install of a package, not for creating a package ready for submission to the
 215 Debian archive.
 216 .IP "\fB\-\-install\fR" 4
 217 .IX Item "--install"
 218 Installs the freshly built package. Specifying \-\-install implies \-\-build \- The
 219 package will not be installed unless it was built (obviously ;\-) )
 220 .IP "\fB\-\-notest\fR" 4
 221 .IX Item "--notest"
 222 Does not run the automatic testing of the module as part of the build script.
 223 This is mostly useful when packaging buggy or incomplete software.
 224 .IP "\fB\-\-basepkgs\fR" 4
 225 .IX Item "--basepkgs"
 226 Explicitly gives a comma-separated list of packages to consider \*(L"base\*(R"
 227 packages (i.e. packages that should always be available in Debian
 228 systems). This option defaults to \f(CW\*(C`perl,perl\-base,perl\-modules\*(C'\fR \- It
 229 is used to check for module dependencies. If a needed module is in the
 230 \&\f(CW\*(C`basepkgs\*(C'\fR, it won't be mentioned in the \f(CW\*(C`depends:\*(C'\fR field of
 231 \&\f(CW\*(C`debian/control\*(C'\fR.
 232 .Sp
 233 If this option is specified, the above mentioned default packages will
 234 not be included (but will be mentioned as explicit dependencies in the
 235 resulting package). You can, of course, mention your own modules
 236 and explicitly specify the default values.
 237 .Sp
 238 Note that this option should be used sparsingly and with care, as it
 239 might lead to packages not being rebuildable because of unfulfilled
 240 dependencies.
 241 .IP "\fB\-\-requiredeps\fR" 4
 242 .IX Item "--requiredeps"
 243 Fail if a dependency perl package was not found (dependency tracking
 244 requires the apt-file package installed and updated)
 245 .IP "\fB\-\-core\-ok\fR" 4
 246 .IX Item "--core-ok"
 247 Allows building core Perl modules. By default, dh-make-perl will not allow
 248 building a module that is shipped as part of the standard Perl library; by
 249 specifying this option, dh-make-perl will build them anyway.
 250 .Sp
 251 Note that, although it is not probable, this might break unrelated items in
 252 your system \- If a newer version of a core module breaks the \s-1API\s0, all kinds
 253 of daemons might get upset ;\-)
 254 .IP "\fB\-\-refresh\fR" 4
 255 .IX Item "--refresh"
 256 Refresh mode.
 257 .Sp
 258 Instead of creating new debian/ directory, \fB\-\-refresh\fR makes \fBdh-make-perl\fR
 259 to re-create only \fBdebian/rules\fR according to the current templates.
 260 .Sp
 261 This is useful when \fBdebian/rules\fR was created using older templates and
 262 doesn't contain much customisations. As always, you're strongly encouraged to
 263 verify if \fBdebian/rules\fR looks sane.
 264 .RE
 265 .IP "\fB\-\-dh ver\fR"
 266 .IX Item "--dh ver"
 267 Set desired debhelper version. If \f(CW\*(C`ver\*(C'\fR is 7, generated debian/rules is
 268 minimalistic, using the auto-mode of debhelper. Also, any additional
 269 documentation and examples are listed in additional files under debian/, instead
 270 of being listed in debian/rules
 271 .SH "DESCRIPTION"
 272 .IX Header "DESCRIPTION"
 273 \&\fBdh-make-perl\fR will create the files required to build
 274 a debian source package out of a perl package.
 275 This works for most simple packages and is also useful
 276 for getting started with packaging perl modules.
 277 .PP
 278 You can specify a module name with the \fB\-\-cpan\fR switch
 279 and \fBdh-make-perl\fR will download the module for you from
 280 a \s-1CPAN\s0 mirror, or you can specify the directory with the
 281 already unpacked sources. If neither \-\-cpan nor a directory
 282 is given as argument, dh-make-perl tries to create a
 283 perl package from the data in \fI.\fR
 284 .PP
 285 There is an override mechanism in place to handle most of
 286 the little changes that may be needed for some modules
 287 (this hasn't been tested much, though, and the override
 288 database needs to be filled in).
 289 .PP
 290 You can build and install the debian package using the \-\-build
 291 and \-\-install command line switches.
 292 .PP
 293 Using this program is no excuse for not reading the
 294 debian developer documentation, including the Debian policy,
 295 the perl policy, the packaging manual and so on.
 296 .SH "FILES"
 297 .IX Header "FILES"
 298 The following directories will be searched to find additional files
 299 required by dh\-make\-perl:
 300 .PP
 301 .Vb 2
 302 \&        /usr/share/dh-make-perl/
 303 \&        $HOME/.dh-make-perl/
 304 .Ve
 305 .IP "* overrides" 4
 306 .IX Item "overrides"
 307 File that overrides information retreived (or guessed) about the package.
 308 All the files in the library directories are loaded: entries in the home
 309 take precedence. See the distributed overrides file for usage information.
 310 .IP "* rules.MakeMaker.noxs" 4
 311 .IX Item "rules.MakeMaker.noxs"
 312 A debian/rules makefile for modules that use ExtUtils::MakeMaker, but don't
 313 have C/XS code.
 314 .IP "* rules.MakeMaker.xs" 4
 315 .IX Item "rules.MakeMaker.xs"
 316 A debian/rules makefile for modules that use ExtUtils::MakerMaker and
 317 C/XS code.
 318 .IP "* rules.Module\-Build.noxs" 4
 319 .IX Item "rules.Module-Build.noxs"
 320 A debian/rules makefile for modules that use Module::Build, but don't have
 321 C/XS code.
 322 .IP "* rules.Module\-Build.xs" 4
 323 .IX Item "rules.Module-Build.xs"
 324 A debian/rules makefile for modules that use Module::Build and C/XS code.
 325 .SH "ENVIRONMENT"
 326 .IX Header "ENVIRONMENT"
 327 \&\s-1HOME\s0 \- get user's home directory
 328 .PP
 329 \&\s-1DEBFULLNAME\s0 \- get the real name of the maintainer
 330 .PP
 331 \&\s-1LOGNAME\s0 or \s-1USER\s0 \- get the username
 332 .PP
 333 \&\s-1DEBEMAIL\s0 or \s-1EMAIL\s0 \- get the email address of the user
 334 .SH "BUGS"
 335 .IX Header "BUGS"
 336 Several, let me know when you find them.
 337 .SH "AUTHOR"
 338 .IX Header "AUTHOR"
 339 Paolo Molaro <lupus@debian.org> (\s-1MIA\s0)
 340 .PP
 341 Maintained for a time by Ivan Kohler <ivan\-debian@420.am>.
 342 .PP
 343 Maintained for a time by Marc Brockschmdit <marc@dch\-faq.de>.
 344 .PP
 345 Now maintained by Gunnar Wolf <gwolf@gwolf.org>, and team-maintained
 346 by the Debian pkg-perl team, http://alioth.debian.org/projects/pkg\-perl
 347 .PP
 348 Patches from:
 349 .IP "Adam Sjoegren <asjo@koldfront.dk>" 4
 350 .IX Item "Adam Sjoegren <asjo@koldfront.dk>"
 351 .PD 0
 352 .IP "Adrian Phillips <adrianp@powertech.no>" 4
 353 .IX Item "Adrian Phillips <adrianp@powertech.no>"
 354 .IP "Amos Shapira <amos.shapira@gmail.com>" 4
 355 .IX Item "Amos Shapira <amos.shapira@gmail.com>"
 356 .IP "Christian Kurz <shorty@debian.org>" 4
 357 .IX Item "Christian Kurz <shorty@debian.org>"
 358 .IP "Damyan Ivanov <divanov@creditreform.bg>" 4
 359 .IX Item "Damyan Ivanov <divanov@creditreform.bg>"
 360 .IP "David Paleino <d.paleino@gmail.com>" 4
 361 .IX Item "David Paleino <d.paleino@gmail.com>"
 362 .IP "David Pashley <david@davidpashley.com>" 4
 363 .IX Item "David Pashley <david@davidpashley.com>"
 364 .IP "Edward Betts <edward@debian.org>" 4
 365 .IX Item "Edward Betts <edward@debian.org>"
 366 .IP "Fermin Galan <galan@dit.upm.es>" 4
 367 .IX Item "Fermin Galan <galan@dit.upm.es>"
 368 .IP "Geoff Richards <qef@ungwe.org>" 4
 369 .IX Item "Geoff Richards <qef@ungwe.org>"
 370 .IP "Gergely Nagy <algernon@bonehunter.rulez.org>" 4
 371 .IX Item "Gergely Nagy <algernon@bonehunter.rulez.org>"
 372 .IP "gregor herrmann <gregoa@debian.org>" 4
 373 .IX Item "gregor herrmann <gregoa@debian.org>"
 374 .IP "Hilko Bengen <bengen@debian.org>" 4
 375 .IX Item "Hilko Bengen <bengen@debian.org>"
 376 .IP "Kees Cook <keex@outflux.net>" 4
 377 .IX Item "Kees Cook <keex@outflux.net>"
 378 .IP "Jesper Krogh <jesper@krogh.cc>" 4
 379 .IX Item "Jesper Krogh <jesper@krogh.cc>"
 380 .IP "Johnny Morano <jmorano@moretrix.com>" 4
 381 .IX Item "Johnny Morano <jmorano@moretrix.com>"
 382 .IP "Juerd <juerd@ouranos.juerd.net>" 4
 383 .IX Item "Juerd <juerd@ouranos.juerd.net>"
 384 .IP "Marc Chantreux (mail withheld)" 4
 385 .IX Item "Marc Chantreux (mail withheld)"
 386 .IP "Matt Hope <dopey@debian.org>" 4
 387 .IX Item "Matt Hope <dopey@debian.org>"
 388 .IP "Noel Maddy <noel@zhtwn.com>" 4
 389 .IX Item "Noel Maddy <noel@zhtwn.com>"
 390 .IP "Oliver Gorwits <oliver.gorwits@oucs.ox.ac.uk>" 4
 391 .IX Item "Oliver Gorwits <oliver.gorwits@oucs.ox.ac.uk>"
 392 .IP "Peter Moerch <mn3k66i02@sneakemail.com>" 4
 393 .IX Item "Peter Moerch <mn3k66i02@sneakemail.com>"
 394 .IP "Stephen Oberholtzer <oliverklozoff@gmail.com>" 4
 395 .IX Item "Stephen Oberholtzer <oliverklozoff@gmail.com>"
 396 .IP "Ton Nijkes <tonn@wau.mis.ah.nl>" 4
 397 .IX Item "Ton Nijkes <tonn@wau.mis.ah.nl>"
 398 .PD
 399 .PP
 400 \&... And others who, sadly, we have forgot to add :\-/