BUILD(1)

BUILD(1) — the General Commands Manual page, but make it cute 💅

okay so bestie, this is the BUILD(1) manual from the General Commands Manual, and we're about to make package building make sense. no cap, it's giving "reproducible queen" energy the whole way through. ✨

✨ NAME ✨

build — build packages in a reproducible way.

🛠️ SYNOPSIS 🛠️

build [--clean|--no-init] [--repo dir_or_url] [--repo...]  [--root buildroot] [recipefile]
build --help
build --verify

🌸 DESCRIPTION 🌸

build is a tool to build binary packages in a safe and reproducible way. The default is to build in a chroot sandbox, but build also supports building in a virtual machine for better security. 💖

If a recipe file is specified on the command line, build will use this file and all other files in the directory for building the package. If no recipe argument is provided, build will search the current directory for a file. 🫶

The build tool understands the following recipe file types:

• spec — a specfile used to generate rpms.
• src.rpm — a source rpm, which will be unpacked for the build.
• kiwi — a kiwi config file used to generate a kiwi image.
• dsc — a dsc file used to generate Debian binary packages.
• PKGBUILD — a file used to generate Arch Linux binary packages.
• build.collax — a shell script used to generate a Collax binary package.

💅 OPTIONS 💅

• --clean — remove the build system and reinitialize it from scratch.
• --checks — run checks during build (default).
• --no-checks — don't run checks during build.
• --no-init — skip the build system initialization and start with build immediately.
• --repo dir_or_url — either a directory containing binary packages (optionally with repository metadata), or a url pointing to some remote repository. Multiple --repo options can be used to create a specific repository layering. Note that packages are searched in the specified repository order, i.e. the first repository containing a package with a specific name wins regardless of the version. 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.
• --dist distribution — set the distribution. If this option is not given, build tries to guess the distribution by looking at the available packages. The specified distribution can either be a string like "11.2" or "sles9", "debian7", or the pathname of the build configuration to use.
• --root buildroot — specifies where the build system is set up. Overrides the BUILD_ROOT environment variable.
• --help — print a short help text.
• --norootforbuild — force building with user abuild. Otherwise, build searches the recipe file for a "needsrootforbuild" hint to decide what user to use.
• --list-state — list packages that would be used to create a fresh build root. Does not create the build root or perform a build.
• --rpms path1:path2:path3... — where build can find the packages needed to create the build system. This option overrides the BUILD_RPMS environment variable. This option is deprecated, use --repo instead.
• --arch arch1:arch2:arch3... — what architectures to select from the RPMs. build automatically sets this to a sensible value for your host if you do not specify this option, so you should almost never need it.

🔥 RPM BUILD SPECIFIC OPTIONS 🔥

• --stage — set stage for rpmbuild. Defaults to 'a'. Append a trailing '=' to only run the specified stage. Append a trailing '+' to run the specified stage and all stages coming after it. With no suffix, stages up to and included the specified stage are run.
• --target — call rpmbuild with a target option. This can be used for cross building.
• --verify — verify the files in an existing build system.

🧚 VIRTUAL MACHINE SPECIFIC OPTIONS 🧚

• --xen, --kvm, --uml, --qemu, --emulator, --zvm, --lxc — sets a specific vm type.
• --vm-type type — as above.
• --vm-disk file — specifies the location of the disk image to use. If this option is not given, buildroot.img is used (e.g. /var/tmp/build-root.img).
• --vm-disk-size size_in_mb — specify the size of the disk image to create.
• --vm-disk-filesystem type — sets the filesystem type to use when creating the disk image. The default is to use the ext3 filesystem.
• --vm-swap file — specifies the location of the swap file to use. If this option is not given, buildroot.swap is used (e.g. /var/tmp/build-root.swap).
• --vm-swap-size size_in_mb — specify the size of the swap file to create.
• --vm-memory size_in_mb — sets the desired memory size of the virtual machine.
• --vm-kernel kernel_file — set a specific kernel to boot in the virtual machine.
• --vm-initrd initrd_file — set a specific kernel to boot in the virtual machine.
• --vm-disk-clean — force the recreation of the disk image.
• --vm-network — enables network inside for VM builds.
• --vm-telnet PORT — is forwarding PORT to a telnet session inside of the VM. Specify also needed extra packages via the -x parameter, usually: --vm-telnet 1234 -x telnet-server -x net-tools. And connect from the host via: telnet localhost 1234.

NOTE: The telnet server gets started after all packages got installed.

📝 RECIPE FILE OPTIONS 📝

The build command interprets some special control comments in the recipe file:

• # norootforbuild and # needsrootforbuild — build uses either user root or user 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 abuild. For 10.2 and before, the default build user is root. These two flags in the spec file allow to deviate from the defaults and force-set the build user to abuild and root (for # norootforbuild and # needsrootforbuild respectively).
• # needsbinariesforbuild — provide the binary rpms that have been used to set up the build root in /.build.binaries within the build root.

🌱 ENVIRONMENT 🌱

• BUILD_ROOT — the directory where build should install the chrooted build system. "/var/tmp/build-root" is used by default. See the --root option.
• BUILD_RPMS — this can be used instead of the --rpms option. Deprecated.
• BUILD_RPM_BUILD_STAGE — the rpm build stage (a, b, ...). See the --stage option for more information.

👀 SEE ALSO 👀

• rpm(8), dpkg(8), pacman(8), kiwi(8)
• Maximum RPM: http://www.rpm.org/max-rpm/
• cross distribution packaging: http://en.opensuse.org/openSUSE:Build_Service_cross_distribution_howto
• openSUSE packaging standards and guidelines: http://en.opensuse.org/Portal:Packaging

and that's the whole BUILD(1) vibe, bestie — footer says (c) 1997-2021 SUSE LLC, bye and slay 💋