~ubuntu-branches/ubuntu/maverick/ubuntu-dev-tools/maverick-proposed

« back to all changes in this revision

Viewing changes to doc/pbuilder-dist.1

  • Committer: Bazaar Package Importer
  • Author(s): Luca Falavigna
  • Date: 2009-11-28 18:48:35 UTC
  • mfrom: (18.1.66 lucid)
  • Revision ID: james.westby@ubuntu.com-20091128184835-0ot21cscixychr6b
Tags: 0.83debian1
* Merge from Ubuntu Lucid, local Debian changes:
  - Adjust Maintainer and Uploaders.
  - Depend on python-lazr.restfulclient.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\"     Title: pbuilder-dist
2
 
.\"     Author: Siegfried-Angel Gevatter Pujals
3
 
.\" Contact details: siggi.gevatter@gmail.com
4
 
.\"
5
 
.TH PBUILDER\-DIST 1 "August 16, 2007"
6
 
.\"
 
1
.TH PBUILDER\-DIST 1 "January 10, 2008" "ubuntu-dev-tools"
 
2
 
7
3
.SH NAME
8
 
pbuilder\-dist \- multi-distribution pbuilder wrapper
9
 
.\"
 
4
pbuilder\-dist, cowbuilder\-dist \- multi-distribution pbuilder/cowbuilder wrapper
 
5
 
10
6
.SH SYNOPSIS
11
 
\fBpbuilder\-dist\fP \fIdistribution\fR [\fBi386\fP|\fBamd64\fP] [\fBmainonly\fP|\fBallcomp\fP]
12
 
[\fBwithlog\fP|\fBnolog\fP] \fIoperation\fR [\fI...\fR]
13
 
.\"
 
7
\fBpbuilder\-dist\fP \fIdistribution\fR [\fBi386\fP|\fBamd64\fP] [\fBmainonly\fP]
 
8
\fIoperation\fR [\fI...\fR]
 
9
 
 
10
\fBcowbuilder\-dist\fP \fIdistribution\fR [\fBi386\fP|\fBamd64\fP] [\fBmainonly\fP]
 
11
\fIoperation\fR [\fI...\fR]
 
12
 
14
13
.SH DESCRIPTION
15
14
\fBpbuilder\-dist\fP is a wrapper that makes it easy to use pbuilder with many different 
16
15
versions of Ubuntu and/or Debian. 
18
17
It is common to symlink this script in order to give it many names in the form of
19
18
\fBpbuilder\-\fIdistribution\fP\fR (\fBpbuilder\-\fIdistribution\fR\-\fIarchitecture\fP\fR on amd64
20
19
systems), like for example \fBpbuilder\-feisty\fP, \fBpbuilder\-sid\fP, \fBpbuilder\-gutsy\-i386\fP, etc.
21
 
.\"
 
20
.PP
 
21
The same applies to \fBcowbuilder\-dist\fP, which uses cowbuilder. The main
 
22
difference between both is that pbuilder compresses the created chroot as a
 
23
a tarball, thus using less disc space but needing to uncompress (and possibly
 
24
compress) its contents again on each run, and cowbuilder doesn't do this.
 
25
 
22
26
.SH USAGE
23
 
There are many arguments listed on the synopsis.
24
 
Each of them, if used, has to be used exactly in the same order as it
25
 
appears there.
 
27
There are many arguments listed on the synopsis; each of them, if used, has to be used exactly in
 
28
the same order as it appears there.
26
29
In case you renamed the script to \fBpbuilder\-\fIdistribution\fP\fR, do not
27
30
use the \fBdistribution\fP parameter; same with \fBi386\fP / \fBamd64\fP if
28
31
the name also contains \-\fIarchitecture\fR.
35
38
This is optional; default is \fBamd64\fP.
36
39
If \fBi386\fP is specified, an i386 environment will be used.
37
40
.TP
38
 
\fBmainonly\fP / \fBallcomp\fP
39
 
This is optional; default is \fBallcomp\fP.
 
41
\fBmainonly\fP
40
42
If you specify \fBmainonly\fP, only packages from the main (in Debian) or
41
 
main and restricted (in Ubuntu) components will be used.
42
 
With the latter one, all official components will be enabled.
43
 
This only has effect when creating a new environment.
44
 
.TP
45
 
\fBwithlog\fP / \fBnolog\fP
46
 
This is optional; default is \fBnolog\fP.
47
 
When \fBwithlog\fP is used, \fBpbuilder\fP will save the output produced by
48
 
the current action in a dot-file called \fB.lastlog\fP in its base directory
49
 
(see the FILES section).
50
 
If this file already exists, it will be overwritten.
 
43
main and restricted (in Ubuntu) components will be used. By default, all
 
44
official components are enabled. This only has effect when creating a new
 
45
environment.
51
46
.TP
52
47
\fBoperation\fP
53
 
Replace this with the action you want \fBpbuilder\fP to do (create, update, build, clean, login
54
 
or execute).
 
48
Replace this with the action you want \fBpbuilder\fP to do (create, update,
 
49
build, clean, login or execute).
 
50
If you don't specify any action, but the next argument is a .dsc file, it
 
51
will assume that it should build.
55
52
Check its manpage for more details.
56
53
.TP
57
54
\fB[...]\fP
58
55
.br
59
56
Replace this with other parameters, if needed.
60
57
For example, if \fBbuild\fP is the option, you will need to also specify
61
 
a .dsc file.
62
 
.PP
63
 
The default value of all optional parameters (except the architecture) can be changed by
64
 
editing the first lines of the script.
65
 
.\"
 
58
a .dsc file. As a special feature, if you specify a .dsc file you can
 
59
skip the \fBbuild\fP option and this script will automatically assume that
 
60
building is the action you want to do.
 
61
.br
 
62
You may also specify \fB--debug-echo\fP so that the \fBpbuilder\fP/
 
63
\fBcowbuilder\fP command which would normally be executed is just printed
 
64
on the standard output instead. This is useful for debugging
 
65
\fBpbuilder-dist\fP.
 
66
 
66
67
.SH EXAMPLES
67
68
.TP
68
69
pbuilder\-dist gutsy create
79
80
.TP
80
81
pbuilder\-etch i386 update
81
82
Updates an existing i386-architecture Debian Etch environment on an amd64 system.
82
 
.\"
83
 
.SH FILES
84
 
By default, \fBpbuilder\-dist\fP will store all the files it generates in \fB~/pbuilder/\fP.
85
 
This can be changed by modifying the BASE_DIR value on the top of the script
86
 
to any other directory you want.
87
 
If it doesn't exist, it will be created on the run.
88
 
.\"
 
83
.TP
 
84
cowbuilder-experimental create
 
85
Creates a \fBcowbuilder\fP environment for Debian Experimental.
 
86
 
 
87
.SH FILES AND ENVIRONMENT VARIABLES
 
88
By default, \fBpbuilder\-dist\fP will store all the files it generates in
 
89
\fB~/pbuilder/\fP. This can be changed by setting the $PBUILDFOLDER global
 
90
variable. If the directory doesn't exist, it will be created on the run.
 
91
.PP
 
92
A file with the log of the last operation, called last_operation.log, will be
 
93
saved in the results subdirectory of each build environment.
 
94
.PP
 
95
The default authentication method is \fBsudo\fP. You can change this by
 
96
setting the $PBUILDAUTH variable.
 
97
 
89
98
.SH BUGS
90
 
There are no known bugs at the moment.
91
 
If you experience any problem with this script contact me on
92
 
siggi.gevatter@gmail.com.
 
99
If you experience any problem with this script contact me on rainct@ubuntu.com
 
100
or file a bug at https://bugs.launchpad.net/ubuntu/+source/ubuntu-dev-tools.
 
101
.PP
93
102
Please ensure first that the problem is really this script and not an issue
94
 
with \fBpbuilder\fP.
95
 
.\"
 
103
with \fBpbuilder\fP or \fBcowbuilder\fP themselves.
 
104
 
 
105
.SH SEE ALSO
 
106
\fBpbuilder\fR, \fBpbuilderrc\fR, \fBcowbuilder\fR
 
107
 
96
108
.SH AUTHORS
97
 
\fBpbuilder\-dist\fP was originally written by Jamin W. Collins <jcollins@asgardsrealm.net> and
98
 
Jordan Mantha <mantha@ubuntu.com>.
99
 
.PP 
100
 
On August 2007 it was mostly rewritten, and extended, by Siegfried-Angel Gevatter Pujals
101
 
<siggi.gevatter@gmail.com>.
102
 
.\"
103
 
.SH SEE ALSO
104
 
\fBpbuilder\fR, \fBpbuilderrc\fR
105
 
.\"
106
 
.SH COPYRIGHT
107
 
This manual page was written by Siegfried-Angel Gevatter Pujals (RainCT)
108
 
<siggi.gevatter@gmail.com> for YOU.
109
 
Permission is granted to copy, distribute and/or modify this document
110
 
under the terms of the GNU General Public License,
111
 
Version 2 or any later version published by the Free Software Foundation.
112
 
.PP
113
 
On Debian based systems, the complete text of the GNU General Public
114
 
License can be found in \fB/usr/share/common\-licenses/GPL\fP.
 
109
\fBpbuilder\-dist\fP was written by Siegfried-A. Gevatter <rainct@ubuntu.com>
 
110
and includes patches by Iain Lane <iain@orangesquash.org.uk>. This manual page
 
111
has been written by Siegfried-A. Gevatter <rainct@ubuntu.com>.
 
112
 
 
113
\fBpbuilder\-dist\fP is released under the GNU General Public License, version
 
114
2 or later.