aboutsummaryrefslogtreecommitdiff
path: root/pdebuild.1
blob: 5ce6cbb8a5860fb807613582832886fa03a3313a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
.TH "pdebuild" 1 "2006 May 24" "Debian" "pbuilder"
.SH NAME
pdebuild \- pbuilder way of doing debuild
.SH SYNOPSIS
.BI "pdebuild [" "pdebuild options" "] \-\- [" "pbuilder options" "]"
.PP
.SH DESCRIPTION
A convenience program for 
.B "pbuilder"
which invokes pbuilder after obtaining appropriate root privilege 
in a Debian source directory.
One must be inside the source tree containing the
.B "debian"
directory.

By default, build log file is stored in ../<package>_<version>_<arch>.build.


.SH "PDEBUILD OPTIONS"

The options have the form
.BI "\-\-" "option name"
which modify the operation semantics as explained below.  They are
applied from left to right, and when options conflict, the option that
appear later take precedence.

.TP
.BI "\-\-buildsourceroot [" "fakeroot" "]"
The command used to gain root privilege for 
invoking dpkg-buildpackage

.TP
.BI "\-\-pbuilderroot [" "sudo -E" "]"
The command used to gain root privilege for 
invoking pbuilder.

.TP
.BI "\-\-pbuildersatisfydepends [" "/usr/lib/pbuilder/pbuilder-satisfydepends" "]"
The command used to satisfy (i.e. install) build-dependencies.

.TP
.BI "\-\-architecture"

Set architecture.  This is currently required when it doesn't match the host
architecture.

.TP
.BI "\-\-auto\-debsign"

Invoke debsign at the end of pdebuild process.

.TP
.BI "\-\-debsign\-k [" "key\-id" "]"
Pass 
.B \-k
option to debsign to specify which key-id to sign with.

.TP
.BI "\-\-buildresult [" "Directory for build results" "]"

The place where the build result is stored.

Note that for pdebuild, buildresult needs to be specified as a pdebuild
option on the command-line, not as a pbuilder option.

Note that the default value for buildresult is what is defined for
pbuilder, which is
.B "/var/cache/pbuilder/result"
and not 
.B ".."

.TP
.BI "\-\-configfile [" "Extra config file to use" "]"

The configuration file is used, and passed on to
.BR "pbuilder" .

.TP
.BI "\-\-debbuildopts [" "options to pass to dpkg-buildpackage" "]"

The space-delimited list of options are passed to dpkg-buildpackage.
This option appends to pbuilder option
.B "\-\-debbuildopts"
and may also be used to reset the list of options by passing the empty
string.

Multiple options are delimited with spaces.

Note that for pdebuild, debbuildopts needs to be specified as a pdebuild
option in the command-line, not as a pbuilder option.

.TP
.BI "\-\-use\-pdebuild\-internal"
Uses a different implementation of pdebuild, which calls clean and build inside 
the chroot, using bind-mounts.

.B "pdebuild\-internal"
tries to run debian/rules clean inside the chroot.
To do so, the working directory is passed on inside the chroot,
in the form of bind-mounting and
.B debuild 
is run.

This option will not protect the working directory and its parent directories 
from the build scripts.

.TP
.BI "\-\-logfile [" "file to log" "]"
Specifies the build logfile to create. 
The messages generated during execution will be written to the file, 
as well as standard output.

.TP
.BI "\-\-pbuilder [" "pbuilder" "]"
Specifies which command to invoke as pbuilder.

.TP
.BI "\-\-help"

Show a brief help message.

.TP
.BI "\-\- [" "pbuilder options" "]"

After the 
.B "\-\-"
symbol, an arbitrary number of pbuilder options can be specified.
See pbuilder(8) for a full list of options.


There is an exception that
.B "\-\-buildresult"
and
.B "\-\-debbuildopts"
need to be specified as pdebuild options before the 
.B "\-\-"
in order to be effective.

.SH "FILES"
.TP
.I "/etc/pbuilderrc"
The configuration file for pbuilder, used in pdebuild.

.TP
.I "/usr/share/pbuilder/pbuilderrc"
The default configuration file for pbuilder, used in pdebuild.

.TP
.I "${HOME}/.pbuilderrc"
Configuration file for pbuilder, used in pdebuild.  It
overrides
.B /etc/pbuilderrc


.SH "EXAMPLES"

.TP
.B "pdebuild"

.nf
$ pwd
/home/dancer/DEBIAN/cowdancer/cowdancer
$ ls debian/rules
debian/rules
$ pdebuild
W: /home/dancer/.pbuilderrc does not exist
dpkg-buildpackage: source package is cowdancer
dpkg-buildpackage: source version is 0.26
dpkg-buildpackage: source changed by Junichi Uekawa <dancer@debian.org>
dpkg-buildpackage: source version without epoch 0.26
 fakeroot debian/rules clean
dh_testdir
dh_testroot
rm \-f build-stamp configure-stamp
/usr/bin/make clean
make[1]: Entering directory `/home/dancer/DEBIAN/cowdancer/cowdancer'
rm \-f *~ *.o *.lo libcowdancer.so cow-shell cowbuilder
make[1]: Leaving directory `/home/dancer/DEBIAN/cowdancer/cowdancer'
dh_clean
 dpkg-source \-b cowdancer
dpkg-source: warning: source directory `./cowdancer' is not <sourcepackage>-<upstreamversion> `cowdancer-0.26'
dpkg-source: building cowdancer in cowdancer_0.26.tar.gz
	.
	.
	.
.hy

.SH "BUGS"

pdebuild will accept all options that pbuilder accepts as pdebuild
option.  However, unless the option is documented in the manual page,
it may be ignored.

.SH "AUTHOR"
Initial coding and main maintenance is done by 
Junichi Uekawa <dancer@debian.org>.

The homepage is
.B "\%http://pbuilder.alioth.debian.org"

.SH "SEE ALSO"
.BR "/usr/share/doc/pbuilder/pbuilder-doc.html" ", "
.BR "pbuilder" "(8), "
.BR "pbuilderrc" "(5)"

\"  LocalWords:  pdebuild pbuilder debuild debian debsign buildresult