- fix building in btrfs VMs
[platform/upstream/build.git] / build.1
diff --git a/build.1 b/build.1
index 7d12881..53cfcea 100644 (file)
--- a/build.1
+++ b/build.1
@@ -1,4 +1,10 @@
-.TH build 1 "(c) 1997-2005 SuSE Linux AG Nuernberg, Germany"
+.de TQ \"follow a TP item with several TQ items to define several
+.      \"entities with one shared description.
+.br
+.ns
+.TP \\$1
+..
+.TH build 1 "(c) 1997-2008 SuSE Linux AG Nuernberg, Germany"
 .SH NAME
 build \- build SuSE Linux RPMs in a chroot environment
 .SH SYNOPSIS
@@ -43,6 +49,7 @@ automatically unpacks it for the build.
 If neither is given,
 .B build
 will use all the specfiles in the current directory.
+.P
 .SH OPTIONS
 .TP
 .B --clean
@@ -66,22 +73,73 @@ What architectures to select from the RPMs.
 automatically sets this to a sensible value for your host if you
 don't specify this option.
 .TP
+.BI "\-\-repo " url_or_dir
+Also use the specified repository to create the build system.
+The repositories may be either of type rpmmd, yast2 (susetags),
+or a simple directory. Multiple --repo options may be given.
+As a special form, 'zypp://reponame' can be used to specify
+a system repository. 'zypp://' selects all enabled system
+repositories. This is also the default if BUILD_RPMS is not
+set and no --rpms or --repo option is used.
+.TP
 .BI "\-\-root " buildroot
 Specifies where the build system is set up. Overrides the
 BUILD_ROOT enviroment variable.
 .TP
-.B "\-\-useusedforbuild"
+.B --useusedforbuild
 Tell build not to do dependency expansion, but to extract the
-list of packages to install from "usedforbuild" lines or, if none
-are found, from all "BuildRequires" lines. This option is useful
+list of packages to install from "usedforbuild" lines or, if none
+are found, from all "BuildRequires" lines.  This option is useful
 if you want to re-build a package from a srcrpm with exactly the
 same packages used for the srcrpm build.
 .TP
+.B --norootforbuild
+
+.TP
 .B --help
 Print a short help text.
 .TP
 .B --verify
 verify the files in an existing build system.
+.TP
+.BI "\-\--dist " distribution
+Set the distribution. If this option is not given, build tries to
+calculate the distribution by looking at the rpm package used in the
+build.
+The specified distribution can either be a string
+like "11.2" or "sles9", or the pathname of the build configuration to
+use.
+
+.SH .spec FILE OPTIONS
+The
+.B build
+command interprets some special control comments in the specfile:
+.TP
+.B # norootforbuild
+.TQ
+.B # needsrootforbuild
+.B build
+uses either user
+.I root
+or user
+.I abuild
+in the build system to do the build.  For non-SUSE distros as well as
+since SUSE 10.2, the default build user is
+.I abuild.
+For 10.2 and before, the default build user is
+.I root.
+These two flags in the spec file allow to deviate from the defaults
+and force-set the build user to
+.I abuild
+and
+.I root
+.RI "(for " "#\ norootforbuild" " and " "#\ needsrootforbuild" " respectively."
+.TP
+.B # needsbinariesforbuild
+provide the binary rpms that have been used to set up the build root
+in
+.I /.build.binaries
+within the build root.
 .SH ENVIRONMENT
 .TP
 .B BUILD_ROOT
@@ -90,8 +148,7 @@ The directory where build should install the chrooted build system.
 .TP
 .B BUILD_RPMS
 Where build can find the SuSE Linux RPMs.  build needs them to create the
-build system.  "/media/dvd/suse" is the default value which will do
-the trick if you have the SuSE Linux DVD mounted.
+build system.
 .TP
 .B BUILD_RPM_BUILD_STAGE
 The rpm build stage (-ba, -bb, ...).  This is just passed through to
@@ -100,7 +157,13 @@ rpm, check the rpm manpage for a complete list and descriptions.
 You can use this to add more options to RPM.
 
 .SH SEE ALSO
-.BR rpm (1),
+.BR rpm (8),
 .TP
 .BR "Maximum RPM":
 .I http://www.rpm.org/max-rpm/
+.TP
+.BR "cross distribution packaging":
+.I http://en.opensuse.org/openSUSE:Build_Service_cross_distribution_howto
+.TP
+.BR "openSUSE packaging standards and guidelines":
+.I http://en.opensuse.org/Portal:Packaging