unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (Debian-3.1)
Page:
Section:
Apropos / Subsearch:
optional field

pbuilder(8)                        pbuilder                        pbuilder(8)



NAME
       pbuilder - personal package builder

SYNOPSIS
       pbuilder create [options]

       pbuilder update [options]

       pbuilder build [options] .dsc-file

       pbuilder execute [options] script

       pbuilder clean

       pbuilder login [options]

DESCRIPTION
       Front  end program to the pbuilder suite of programs, used for creating
       and maintaining chroot environment and building Debian package  in  the
       chroot environment.

OPTIONS
       create Creates a base.tgz for the specified distribution.


       update Updates  the  base.tgz for the specified distribution.  Also, by
              specifying the  --override-config  option,  it  is  possible  to
              install  a  new apt-line using the given options and settings in
              the configuration file for the base.tgz.

              For example, to switch the distribution of an existing  base.tgz
              to  sarge,  specify  the  --distribution sarge --override-config
              options to update.


       build  Builds the package specified by .dsc-file in the chroot environ-
              ment created using the base.tgz


       clean  Cleans  up  the  directory specified by the configuration BUILD-
              PLACE and APTCACHE specified in /etc/pbuilderrc


       login  Logs into the chroot, and cleaned up  afterwards.   Any  changes
              you  make  will  not  be  kept.  Only use this for temporary and
              debugging purposes.   Do  not  bind-mount  filesystems  directly
              inside the chroot.  Use --bindmounts option to mount.


       execute
              Execute a script or command inside the chroot, in a similar man-
              ner to login

              The file specified in the command-line argument will  be  copied
              into the chroot, and invoked.

              The remaining arguments are passed on to the script.


       dumpconfig
              Dumps configuration information, used for debugging.


       debuild
              Builds a Debian package from the Debian source directory.  There
              needs to be a debian/ directory in the current directory.

              This command is a convenience script, and  it  does  not  accept
              most command-line options.  This may change in the future.


       --basetgz [basetgz-location]
              Specifies the location of base.tgz

              This  option  will define the default distribution and apt-lines
              when used in pbuilder update and pbuilder create


       --buildplace [location of build]
              Specifies the location where building and base.tgz updating  and
              creation takes place. This is a temporary work directory.

              A  subdirectory  of  that directory using the current PID of the
              process is used.


       --buildresult [location to put build result]
              Specifies the location the build result gets into  after  build-
              ing.   The  deb  files  and  other files that have resulted from
              build is copied there.  Note that the default value is  not  the
              current  directory,  or ..  but somewhere else entirely. This is
              to avoid overwriting already existing deb files with  the  newly
              generated ones.


       --mirror [mirror location]
              Specifies   the   url  of  Debian  mirror  to  be  specified  in
              sources.list inside the chroot.  This option is only valid  when
              distribution  is  being specified, for update and build targets.
              The format is something  like:  http://http.us.debian.org/debian
              which should point to your favorite mirror.

              This  option can optionally be omitted, and left blank, in which
              case, this part is skipped.

              Note that these URLs specified to pbuilder  will  be  used  from
              within  the  chroot,  and  specifying file:/somewhere/ will most
              probably fail.


       --nonusmirror [mirror location]
              The non-US mirror, specified like the --mirror option

       --othermirror [apt deb line | other deb lines... ]
              The lines which is added to the sources.list, delimited  with  |
              Like      deb      http://local/mirror      stable      main|deb
              file:/usr/local/mirror ./

              The deb lines here are the ones that will appear at the  top  of
              the sources.list inside the chroot.

              These  options  are  only valid when --override-config option is
              specified in update target, or when  pbuilder  create  is  being
              called.


       --http-proxy [proxy]
              Specifies     the     http    proxy    url.    Something    like
              http://xxx.xxx.xxx.xxx:8080/ should do.

       --distribution [distribution]
              Specifies the distribution used. Currently the supported  values
              are sid sarge and woody .

              This  option  is  only  effective  for  pbuilder  create or when
              pbuilder update is specified with --override-config option.


       --aptcache [location of retrieved package files]
              Specifies the location where  the  packages  downloaded  by  apt
              should  be  cached.  Use --aptcache "" if you want caching to be
              turned off.


       --removepackages [packages to remove]
              Removes the packages on creating the base.tgz.  Use this  option
              to  remove  potentially  dangerous or undesirable packages, like
              lilo which nobody will need to have inside a chroot.

              Packages should be specified in a space-delimited  manner,  sur-
              rounded in double quotations, like "lilo gcc mawk"


       --extrapackages [packages to add]
              Adds  packages specified as an addition to the default, which is
              build-essential by default.  This is used in  build  and  create
              (after successfully creating the initial chroot) and update.

              The packages should be specified as a space-delimited list.


       --configfile [configuration file to load]
              Loads the configuration file.




       --hookdir [location of user scripts]
              Specifies  the location where scripts for user intervention dur-
              ing the create and update process are stored. Currently  scripts
              are  executed at only one point, on exit from the chrooted envi-
              ronment, just before either a create or a build regenerated  the
              base.tgz   file.   The   script   names  must  be  in  the  form
              X<&lt;digit>&gt;<&lt;digit>&gt;<&lt;whatever-else-you-want>&gt; much like boot  scripts.
              The  scripts  must  be  executable and may be either binaries or
              interpreted scripts. If it is a  script  in  other  than  Bourne
              Shell  or  Perl,  it is up to the user to ensure the interpreter
              was previously installed in the chrooted environment. Files end-
              ing in ~ or .bak are ignored.

              Although  it  may  not  seem necessary, pbuilder update does not
              invoke the hooks if --hookdir is empty, so if you want to  avoid
              running hooks, run pbuilder with --hookdir ""

              If  there  is  a  distribution hook, for example, if there was a
              file sid inside the hook directory, and the script was  creating
              the  chroot for sid distribution, pbuilder will call debootstrap
              with that as the 4th parameter in the chroot  creation  process.
              This allows for use of custom debootstrap hook script.

              A<&lt;digit>&gt;<&lt;digit>&gt;<&lt;whatever-else-you-want>&gt; is for build target.  It
              is executed before build starts; after unpacking the build  sys-
              tem,  and  unpacking the source, and satisfying the build-depen-
              dency.

              B<&lt;digit>&gt;<&lt;digit>&gt;<&lt;whatever-else-you-want>&gt; is executed after  build
              system  finishes building, successfully, before copying back the
              build result.

              C<&lt;digit>&gt;<&lt;digit>&gt;<&lt;whatever-else-you-want>&gt; is executed after  build
              failure, before cleanup.

              D<&lt;digit>&gt;<&lt;digit>&gt;<&lt;whatever-else-you-want>&gt;   is   executed   before
              unpacking the source inside the chroot,  after  setting  up  the
              chroot environment.  Create $TMP, and $TMPDIR if necessary.

              This  is called before build-dependency is satisfied.  Also use-
              ful for calling apt-get update

              E<&lt;digit>&gt;<&lt;digit>&gt;<&lt;whatever-else-you-want>&gt;   is   executed    after
              pbuilder update
               and  pbuilder  create  finishes  apt-get  work with the chroot,
              before umounting kernel file systems (/proc)  and  creating  the
              tarball from the chroot.

              F<&lt;digit>&gt;<&lt;digit>&gt;<&lt;whatever-else-you-want>&gt;  is executed just before
              user logs in, or program starts executing, after chroot is  cre-
              ated in login or execute target.





       --debemail [maintainer-name &lt;email-address&gt;]

              Specifies  that  dpkg-buildpackage  be  called  with -m$DEBEMAIL
              instead of default value specified in the environment  variable,
              or pbuilderrc

              This option is almost obsolete, use --debbuildopts instead


       --debbuildopts [options]

              List  of  options that are passed on to dpkg-buildpackage. Over-
              rides  any  value  given  in  DEBBUILDOPTS   as   specified   in
              pbuilderrc.


       --logfile [file to log]
              Specifies  the logfile to create.  The messages generated during
              execution will be written to the file, instead of messages  com-
              ing to the standard output.


       --pkgname-logfile
              Alternative option to --logfile option.  Automatically creates a
              logfile that is named by the .dsc file name, only really  appli-
              cable for build target


       --aptconfdir [APT configuration directory to use]
              Uses the apt configuration file found in the specified directory
              as the chroot configuration.  /etc/apt is one example,  so  that
              the same configuration can be used inside the chroot.

              This  option  overrides other options, and may cause some incon-
              sistency problems.


       --timeout [timeout in sleep time]
              Time out building after sleeping set  time.   Specify  something
              like --timeout 10h in the command line.  Default is no timeout.



       --override-config

              Specify  to  use  different apt set up inside the chroot than it
              was used for creating the base.tgz.  Specify this when you  want
              to  do  pbuilder update with a different distribution target set
              up.



       --binary-arch

              Specify to build architecture specific targets  instead  of  all
              targets.   Setting  --debbuildopts after this option will re-set
              some parts of the effect.

              Use this option rather than using --debbuildopts -B


       --no-targz
              Not using base.tgz for operation.  The --buildplace will not  be
              deleted  and  reconstructed from a .tar.gz file.  Also, pbuilder
              will not add its process ID to the --buildplace  as  it  usually
              would.

              Useful  when  experimenting  with  chroots,  or trying to create
              chroots outside control of pbuilder.


       --preserve-buildplace
              Do not clean the --buildplace if it has the same contents as the
              .tar.gz file, and no modifications are done.

              As  with  --no-targz, suppresses appending pbuilder's process ID
              to the --buildplace.

              This is useful if you want to attempt to build a large number of
              packages  successively,  but you expect that many of them cannot
              have their build dependencies satisfied.

              It will clean up the build place on failure, or after a success-
              ful build.


       --bindmounts bind-mount-points
              Bind-mount  the  specified  directories  to  inside  the chroot.
              bind-mount-points is a space-delimited list  of  directories  to
              bind-mount.


       --debug

              Turn  on Debug mode of pbuilder, to be verbose about errors, and
              try to avoid cleanup processing when error happens in update
               and create targets.


       --debootstrapopts --variant=buildd
              Add extra command-line options to debootstrap.


       --save-after-login

       --save-after-exec
              Save the chroot image after exiting from the chroot  instead  of
              deleting changes.  Effective for login and exec session.


FILES
       /etc/pbuilderrc
              The system-wide configuration file for pbuilder.

       /usr/share/pbuilder/pbuilderrc
              The default settings for pbuilder, used as fallback for all val-
              ues that is not specified in /etc/pbuilderrc.

       ${HOME}/.pbuilderrc
              The personal configuration file for  pbuilder,  which  overrides
              settings set in other configuration files.


BUGS
       This program is starting to have too many options already.


AUTHOR
       Initial  coding,  and  main  maintenance  is  done  by  Junichi  Uekawa
       <dancerATdebian.org>.  User hooks code added by Dale Amon <amonATvnl.com>

       The homepage  is  available  at  http://www.netfort.gr.jp/~dancer/soft-
       ware/pbuilder.html


SEE ALSO
       pdebuild (1), pbuilderrc (5)




Debian                            2005 Feb 13                      pbuilder(8)