.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .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. \*(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- .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" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" 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_COMPONENTS 1p" .TH DH_COMPONENTS 1p "2018-09-09" "perl v5.24.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" dh_components \- build additional components .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBdh_components\fR [\fIdebhelper\ options\fR] [\fB\-\-components\fR \fIcomp\fR[,\fIcomp\fR,...]] [\fB\-\-build_stages\fR \fIstage\fR[,\fIstage\fR,...]] [\fB\-\-rules_locations\fR \fIdir\fR[,\fIdir\fR,...]] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`dh_components\*(C'\fR is a debhelper program that is responsible for handling additional components that come from separate upstream sources. The aim is to turn each component into a \*(L"mini Debian package\*(R". It takes the following actions: .IP "Run through the various build stages for each package and component." 4 .IX Item "Run through the various build stages for each package and component." .PD 0 .IP "Optionally stitch together the Debian copyright files." 4 .IX Item "Optionally stitch together the Debian copyright files." .ie n .IP "Generate the ""substvar"" file from the component control files." 4 .el .IP "Generate the \f(CWsubstvar\fR file from the component control files." 4 .IX Item "Generate the substvar file from the component control files." .IP "Purge the components working directory (unless the \fI\-\-no\-purge\fR option is set)." 4 .IX Item "Purge the components working directory (unless the --no-purge option is set)." .PD .SH "FILES" .IX Header "FILES" .IP "debian/\fIpackage\fR.components" 4 .IX Item "debian/package.components" .PD 0 .IP "debian/components" 4 .IX Item "debian/components" .PD These directories contain all the component data for a given binary package. The second form only works for the first binary in a source package and is overridden by the equivalent first form. .IP "debian/[\fIpackage\fR.]components/\fIcomponent\fR" 4 .IX Item "debian/[package.]components/component" This is a directory that contains the files specific to that component. In some ways it is like a cut-down version of the debian directory. .IP "debian/[\fIpackage\fR.]components/\fIcomponent\fR" 4 .IX Item "debian/[package.]components/component" .PD 0 .IP "debian/[\fIpackage\fR.]components/" 4 .IX Item "debian/[package.]components/" .IP "/usr/share/pkg\-components/build_stages" 4 .IX Item "/usr/share/pkg-components/build_stages" .PD These are the default locations of the build stage scripts in the order of precedence with highest first. These can be overridden using the \&\f(CW\*(C`\-\-rules_locations\*(C'\fR. .IP "debian/[\fIpackage\fR.]components/copyright.in" 4 .IX Item "debian/[package.]components/copyright.in" This file provides the \s-1DEP\-5\s0 copyright stanzas for the package but without any of the component stanzas. It forms the basis for the \fIpackage\fR.copyright file. .IP "debian/[\fIpackage\fR.]components/\fIcomponent\fR/copyright" 4 .IX Item "debian/[package.]components/component/copyright" This file provides a \s-1DEP\-5\s0 fragment of the Debian copyright for this component. It will be merged into the main copyright file at \fIpackage\fR.copyright. Any duplicate \f(CW\*(C`License\*(C'\fR clauses will be shown only once. .IP "debian/[\fIpackage\fR.]components/\fIcomponent\fR/control" 4 .IX Item "debian/[package.]components/component/control" If present this file should look like a Debian control file for the component. The package name of the binary stanza should match the component name. The \f(CW\*(C`Depends\*(C'\fR, \f(CW\*(C`Recommends\*(C'\fR, \f(CW\*(C`Suggests\*(C'\fR, \f(CW\*(C`Enhances\*(C'\fR, \f(CW\*(C`Replaces\*(C'\fR, \&\f(CW\*(C`Pre\-Depends\*(C'\fR, \f(CW\*(C`Conflicts\*(C'\fR, \f(CW\*(C`Breaks\*(C'\fR fields are read and turned into substitution variables. So if you have a component \f(CW\*(C`X\*(C'\fR which declares a Depends on \f(CW\*(C`Y\*(C'\fR, then a substvar variable \f(CW\*(C`X:Depends\*(C'\fR will be created with the value \f(CW\*(C`Y\*(C'\fR. The source package stanza is ignored but can be used to document which build dependencies are due to the component. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-build_stages b1,b2,...\fR" 4 .IX Item "--build_stages b1,b2,..." If this option is listed the sequence described will be used instead of the normal one. .IP "\fB\-\-components c1,c2,...\fR" 4 .IX Item "--components c1,c2,..." If this option is listed only those components listed will be considered. .IP "\fB\-\-rules_locations r1,r2,...\fR" 4 .IX Item "--rules_locations r1,r2,..." If this option is listed the specified locations will be used instead of the default ones. One can use \f(CW\*(C`%\*(C'\fR to mean the component. Thus to explicitly specify the default one would set: .Sp .Vb 1 \& \-\-rules_locations debian/components/%,debian/components,/usr/share/pkg\-components/build_stages .Ve .SH "CONFIGURATION" .IX Header "CONFIGURATION" To enable this functionality it is necessary to pass the argument \&\f(CW\*(C`\-\-with components\*(C'\fR to the \f(CW\*(C`dh\*(C'\fR programa in the \f(CW\*(C`debian/rules\*(C'\fR file. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIdebhelper\fR\|(1) .PP This program is used with debhelper. .PP \&\fIquilt\fR\|(1) .SH "AUTHOR" .IX Header "AUTHOR" Nicholas Bamber