.\" 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 "GIT-PBUILDER 1"
.TH GIT-PBUILDER 1 "2017-02-07" "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"
git\-pbuilder \- Wrapper around cowbuilder/qemubuilder for gbp buildpackage
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
DIST=\fIdistribution\fR ARCH=\fIarchitecture\fR [BUILDER=(pbuilder|qemubuilder)] \e
\fBgit-pbuilder\fR \fIdebbuild-options\fR
.PP
DIST=\fIdistribution\fR ARCH=\fIarchitecture\fR [BUILDER=(pbuilder|qemubuilder)] \e
\fBgit-pbuilder\fR (update | create | login) \fIcowbuilder-options\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBgit-pbuilder\fR is a wrapper around \fBpdebuild\fR intended for use by
\&\fBgbp buildpackage\fR. It configures \fBpdebuild\fR to use \fBcowbuilder\fR by
default, passes appropriate options to \fBdebbuild\fR, and sets the base path
for \fBcowbuilder\fR based on the environment variable \s-1DIST\s0 and, if set, the
environment variable \s-1ARCH. \s0\fBqemubuilder\fR can be selected instead by
setting the environment variable \s-1BUILDER\s0 to \f(CW\*(C`qemubuilder\*(C'\fR, and
\&\fBpbuilder\fR can be selected by setting \s-1BUILDER\s0 to \f(CW\*(C`pbuilder\*(C'\fR.
.PP
By default, \fBgit-pbuilder\fR assumes the target distribution is \f(CW\*(C`sid\*(C'\fR, the
same architecture as the \fBcowbuilder\fR default, and uses
\&\fI/var/cache/pbuilder/base\-sid.cow\fR if it exists. If it doesn't,
\&\fI/var/cache/pbuilder/base.cow\fR is tried. If \s-1DIST\s0 is set, its value is
the target distribution and \fI/var/cache/pbuilder/base\-\fIdist\fI.cow\fR is
used instead. If \s-1DIST\s0 is \f(CW\*(C`etch\*(C'\fR or \f(CW\*(C`ebo\*(C'\fR, \fB\-\-debian\-etch\-workaround\fR
is also passed to \fBcowbuilder\fR. If \s-1ARCH\s0 is set, its value is the target
architecture and \fI/var/cache/pbuilder/base\-\fIdist\fI\-\fIarch\fI.cow\fR is used,
with \fIdist\fR being set to \f(CW\*(C`sid\*(C'\fR if \s-1DIST\s0 was not set.
.PP
If \fBqemubuilder\fR is used as the builder, no base directory is used.
Instead, \fBqemubuilder\fR is invoked with the \fB\-\-config\fR option pointing to
the file \fI/var/cache/pbuilder/qemubuilder\-\fIarch\fI\-\fIdist\fI.conf\fR
.PP
If \fBpbuilder\fR is used as the builder, \fBgit-pbuilder\fR instead looks for
\&\fI/var/cache/pbuilder/base\-sid.tgz\fR by default and
\&\fI/var/cache/pbuilder/base.tgz\fR if it doesn't exist. If \s-1DIST\s0 or \s-1ARCH\s0 are
set, they are used to form the expected name of the tgz file in the same
way as they're used to form the expected base directory for \fBcowbuilder\fR.
Similar to \fBcowbuilder\fR, \fB\-\-debian\-etch\-workaround\fR is passed to
\&\fBpbuilder\fR if from the \s-1DIST\s0 setting it looks like the target distribution
is etch.
.PP
If \fBgit-pbuilder\fR is invoked via a name that starts with \f(CW\*(C`git\-*\-\*(C'\fR, the
part between the hyphens is taken to be the default name of the builder to
use. However, \f(CW\*(C`pbuilder\*(C'\fR is mapped to \fBcowbuilder\fR for backward
compatibility; if you want to use \fBpbuilder\fR, you have to explicitly set
\&\s-1BUILDER. \s0 The part after the last hyphen is taken to be the default
distribution (if it contains no additional hyphen) or the default
distribution followed by the default architecture (if it contains a
hyphen). One can therefore create symlinks like \f(CW\*(C`git\-pbuilder\-squeeze\*(C'\fR
pointing to \fBgit-pbuilder\fR and use that name when wanting to use a
distribution of \f(CW\*(C`squeeze\*(C'\fR, or \f(CW\*(C`git\-qemubuilder\-sid\-armel\*(C'\fR to use
\&\fBqemubuilder\fR to build for the \f(CW\*(C`armel\*(C'\fR architecture and the \f(CW\*(C`sid\*(C'\fR
distribution. Explicit settings of \s-1BUILDER, DIST,\s0 or \s-1ARCH\s0 always override
any guesses from the command name. (But note that \fBgbp buildpackage\fR
does not pass on environment variables when run with \fB\-\-git\-pbuilder\fR;
see below.)
.PP
Any arguments are passed as-is to \fBdpkg-buildpackage\fR via the
\&\fB\-\-debbuildopts\fR option to \fBpdebuild\fR. To pass arguments to the builder
instead, put them in the environment variable \s-1GIT_PBUILDER_OPTIONS.\s0
.PP
To disable all attempts to discover the base path, tarball, or
configuration file and set up the pbuilder options and instead rely on the
settings in .pbuilderrc, set \s-1GIT_PBUILDER_AUTOCONF\s0 to \f(CW\*(C`no\*(C'\fR.
.PP
Normally, one does not run this script directly. Instead, it's used as
the builder script for \fBgbp buildpackage\fR via the \fB\-\-git\-pbuilder\fR
command-line option. When run this way, you should use the \fB\-\-git\-dist\fR,
\&\fB\-\-git\-arch\fR, \fB\-\-git\-qemubuilder\fR, \fB\-\-git\-pbuilder\-autoconf\fR, and
\&\fB\-\-git\-pbuilder\-options\fR flags instead of setting the \s-1DIST, ARCH, BUILDER,
GIT_PBUILDER_AUTOCONF,\s0 and \s-1GIT_PBUILDER_OPTIONS\s0 environment variables. See
\&\fIgbp\-buildpackage\fR\|(1) for more information.
.PP
Alternately, \fBgit-pbuilder\fR may be called with an argument of \f(CW\*(C`update\*(C'\fR,
\&\f(CW\*(C`create\*(C'\fR, or \f(CW\*(C`login\*(C'\fR. In this case, it calls \fBcowbuilder\fR (or the
configured builder as described above) using \fBsudo\fR and passes the
corresponding command to the builder, using the same logic as above to
determine the base directory and distribution. If the distribution (set
in \s-1DIST\s0) ends in \f(CW\*(C`\-backports\*(C'\fR, one of the following will be added as an
\&\fB\-\-othermirror\fR parameter to the builder:
.PP
.Vb 2
\& deb http://ftp.debian.org/debian $DIST main
\& deb http://backports.debian.org/debian\-backports $DIST main
.Ve
.PP
The first will be used for most distributions, and the second for
\&\f(CW\*(C`squeeze\-backports\*(C'\fR. If the distribution ends in \f(CW\*(C`\-lts\*(C'\fR, the following will
be added as an \fB\-\-othermirror\fR parameter to the builder:
.PP
.Vb 1
\& deb http://ftp.debian.org/debian $DIST main
.Ve
.PP
to support building for Long Term Support releases.
.PP
Any additional arguments to \fBgit-pbuilder\fR are passed along to the
builder. Due to how \fBsudo\fR works, invoking the builder with an action
will not read the user's \fI.pbuilderrc\fR by default, so in this case
\&\fBgit-pbuilder\fR will add an explicit \fB\-\-configfile\fR option pointing to
the user's \fI.pbuilderrc\fR if it exists.
.PP
If you use \fBgit-pbuilder\fR with one of these arguments, you must have
the \f(CW\*(C`sudo\*(C'\fR package installed, and you must configure \fBsudo\fR to let the
current user run the appropriate builder command.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
.IP "\s-1ARCH\s0" 4
.IX Item "ARCH"
Sets the target architecture. For a \fBcowbuilder\fR builder, this sets both
the base path and is passed as the \fB\-\-architecture\fR option. With
\&\fBqemubuilder\fR, this controls the path to the configuration file. With
\&\fBpbuilder\fR, this sets the tgz path and is passed as \fB\-\-architecture\fR.
.IP "\s-1BUILDER\s0" 4
.IX Item "BUILDER"
Sets the builder to use. The only supported settings are \f(CW\*(C`cowbuilder\*(C'\fR
(the default), \f(CW\*(C`qemubuilder\*(C'\fR, and \f(CW\*(C`pbuilder\*(C'\fR.
.IP "\s-1COWBUILDER_BASE\s0" 4
.IX Item "COWBUILDER_BASE"
Set this environment variable to change the default location for the
cowbuilder base directories (\fI/var/cache/pbuilder\fR).
.IP "\s-1DIST\s0" 4
.IX Item "DIST"
Sets the target distribution. This is used primarily to determine the
base path for \fBcowbuilder\fR or \fBpbuilder\fR or the configuration file path
for \fBqemubuilder\fR, but it's also used to determine whether to pass
\&\fB\-\-debian\-etch\-workaround\fR to \fBcowbuilder\fR or \fBpbuilder\fR.
.IP "\s-1GIT_PBUILDER_AUTOCONF\s0" 4
.IX Item "GIT_PBUILDER_AUTOCONF"
If set to \f(CW\*(C`no\*(C'\fR, disable the logic that constructs the base path, tarball,
or configuration file and all other logic to determine the options to pass
to the builder. Instead, just run the configured builder and assume its
configuration is handled elsewhere (such as in \fI.pbuilderrc\fR). This also
suppresses setting \fB\-\-buildresult\fR, so the user will need to ensure that
the configuration still puts packages where \fBgbp buildpackage\fR expects
them.
.IP "\s-1GIT_PBUILDER_OPTIONS\s0" 4
.IX Item "GIT_PBUILDER_OPTIONS"
Add additional options for the builder. These options are passed as-is to
\&\fBcowbuilder\fR, \fBqemubuilder\fR, or \fBpbuilder\fR via \fBpdebuild\fR. The
contents of this variable will undergo shell expansion, so any arguments
containing shell metacharacters or whitespace need to be quoted in the
value of the environment variable.
.IP "\s-1GIT_PBUILDER_OUTPUT_DIR\s0" 4
.IX Item "GIT_PBUILDER_OUTPUT_DIR"
Where to put the result of the build. The default is \f(CW\*(C`..\*(C'\fR (the parent
directory). This setting is ignored if \s-1GIT_PBUILDER_AUTOCONF\s0 is set to
\&\f(CW\*(C`no\*(C'\fR.
.IP "\s-1GIT_PBUILDER_PDEBUILDOPTIONS\s0" 4
.IX Item "GIT_PBUILDER_PDEBUILDOPTIONS"
Add additional options for \fBpdebuild\fR itself (such as
\&\fB\-\-use\-pdebuild\-internal\fR). The contents of this variable will undergo
shell expansion, so any arguments containing shell metacharacters or
whitespace need to be quoted in the value of the environment variable.
.IP "\s-1PBUILDER_BASE\s0" 4
.IX Item "PBUILDER_BASE"
Set this environment variable to change the default location for the
pbuilder tgz files (\fI/var/cache/pbuilder\fR) when \s-1BUILDER\s0 is set to
\&\f(CW\*(C`pbuilder\*(C'\fR.
.SH "FILES"
.IX Header "FILES"
.IP "/var/cache/pbuilder/base\-sid.cow" 4
.IX Item "/var/cache/pbuilder/base-sid.cow"
.PD 0
.IP "/var/cache/pbuilder/base.cow" 4
.IX Item "/var/cache/pbuilder/base.cow"
.PD
The default \f(CW\*(C`cowbuilder \-\-basepath\*(C'\fR directories, searched for in that
order, if neither \s-1DIST\s0 nor \s-1ARCH\s0 is set.
.IP "/var/cache/pbuilder/base\-sid\-$ARCH.cow" 4
.IX Item "/var/cache/pbuilder/base-sid-$ARCH.cow"
The \f(CW\*(C`cowbuilder \-\-basepath\*(C'\fR directory used if \s-1ARCH\s0 is set and \s-1DIST\s0 is not
set.
.IP "/var/cache/pbuilder/base\-$DIST.cow" 4
.IX Item "/var/cache/pbuilder/base-$DIST.cow"
The \f(CW\*(C`cowbuilder \-\-basepath\*(C'\fR directory used if \s-1DIST\s0 is set and \s-1ARCH\s0 is
not.
.IP "/var/cache/pbuilder/base\-$DIST\-$ARCH.cow" 4
.IX Item "/var/cache/pbuilder/base-$DIST-$ARCH.cow"
The \f(CW\*(C`cowbuilder \-\-basepath\*(C'\fR directory used if \s-1DIST\s0 and \s-1ARCH\s0 are both set.
.IP "/var/cache/pbuilder/base\-sid.tgz" 4
.IX Item "/var/cache/pbuilder/base-sid.tgz"
.PD 0
.IP "/var/cache/pbuilder/base.tgz" 4
.IX Item "/var/cache/pbuilder/base.tgz"
.IP "/var/cache/pbuilder/base\-sid\-$ARCH.tgz" 4
.IX Item "/var/cache/pbuilder/base-sid-$ARCH.tgz"
.IP "/var/cache/pbuilder/base\-$DIST.tgz" 4
.IX Item "/var/cache/pbuilder/base-$DIST.tgz"
.IP "/var/cache/pbuilder/base\-$DIST\-$ARCH.tgz" 4
.IX Item "/var/cache/pbuilder/base-$DIST-$ARCH.tgz"
.PD
Similar to the above, the \f(CW\*(C`pbuilder \-\-basetgz\*(C'\fR path used for various
settings of \s-1DIST\s0 and \s-1ARCH\s0 if \s-1BUILDER\s0 is set to \f(CW\*(C`pbuilder\*(C'\fR.
.IP "/var/cache/pbuilder/qemubuilder\-$ARCH\-$DIST.conf" 4
.IX Item "/var/cache/pbuilder/qemubuilder-$ARCH-$DIST.conf"
The \f(CW\*(C`qemubuilder \-\-config\*(C'\fR file used. \f(CW$ARCH\fR defaults to \f(CW\*(C`armel\*(C'\fR and
\&\f(CW$DIST\fR defaults to \f(CW\*(C`sid\*(C'\fR if not set.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIcowbuilder\fR\|(8), \fIdpkg\-buildpackage\fR\|(1), \fIgbp\-buildpackage\fR\|(1), \fIpbuilder\fR\|(8),
\&\fIpdebuild\fR\|(1), \fIqemubuilder\fR\|(8), \fIsudo\fR\|(8)
.PP
The latest version of this script is available from
.
.SH "AUTHOR"
.IX Header "AUTHOR"
Russ Allbery