MK-SBUILD(1)

💖 MK-SBUILD(1) — the manual, but make it make sense 💖

okay bestie, so this is mk-sbuild, section 1 of the manual (General Commands Manual, if you're keeping track 🎀). She's the little script that spins up chroots for you using schroot and sbuild, and honestly? She's iconic for it. Let's go. ✨

---

🌸 NAME 🌸

mk-sbuild — creates chroots via schroot and sbuild. that's the whole job. she builds chroots. via schroot. and sbuild. periodt. 💅

---

✨ SYNOPSIS ✨

mk-sbuild [options...] <release>

---

🦋 DESCRIPTION 🦋

mk-sbuild creates chroots via schroot and sbuild.

yeah, that's literally the description. no notes. she does the thing. 🫶

---

💅 OPTIONS 💅

here's the full lineup, no skipping, we read every single one. (iykyk)

• --arch=ARCH — which architecture we picking? defaults to the native architecture, i.e. whatever your machine already is. 🏠
• --target=ARCH — sets the chroot up as a cross-building environment that targets the architecture you name. 👑
• --name=NAME — the base name for the schroot. the arch gets appended to it, so don't go thinking you're naming the whole thing yourself. 😌
• --personality=PERSONALITY — what personality to use. defaults to matching --arch, because consistency is hot. 🌈
• --debug — turn on script debugging. all the messy details, out loud. 🔥
• --skip-updates — do not include the -updates pocket in the installed sources.list. bye babe. 👋
• --skip-proposed — do not include the -proposed pocket in the installed sources.list. also bye. 👋
• --source-template=FILE — use FILE as the sources.list template. defaults to $HOME/.mk-sbuild.sources. 📄
• --debootstrap-mirror=URL — use URL as the debootstrap source. defaults to http://ports.ubuntu.com where that's appropriate, and the official Ubuntu repositories for the supported architectures. 🌍
• --debootstrap-include=alpha,beta — passes a comma separated list of packages straight through to debootstrap's --include argument. see debootstrap(8) for more details. 📦
• --debootstrap-exclude=alpha,beta — passes a comma separated list of packages through to debootstrap's --exclude argument. ⚠️ WARNING: be careful using this option, because you can end up excluding an essential package. see debootstrap(8) for more details. 🚨
• --debootstrap-keyring=keyring — passes along the path to a gpg keyring file to debootstrap's --keyring argument. see debootstrap(8) for more details. 🔑
• --debootstrap-no-check-gpg — disables checking gpg signatures of downloaded Release files by using debootstrap's --no-check-gpg option. see debootstrap(8) for more details. 🙈
• --debootstrap-proxy=PROXY — use PROXY as the apt proxy. 🛰️
• --eatmydata — install and use eatmydata. this is the default, she's already on. 🍓
• --skip-eatmydata — don't install and use eatmydata. opting out, respect. 🙅
• --distro=DISTRO — enable distro-specific logic. when you don't provide it, the distribution gets determined from release. currently known distros: "debian" and "ubuntu". 🐧
• --vg=VOLUME_GROUP — specify a volume group, and subsequently use a default SCHROOT_TYPE of "lvm-snapshot" rather than "directory" (via overlayfs or aufs) mounts. 🗂️
• --zfs-dataset=DATASET — specify a zfs dataset, and subsequently use a default SCHROOT_TYPE of "zfs-snapshot" rather than "directory" (via overlayfs or aufs) mounts. 🗂️✨
• --type=SHROOT_TYPE — specify a SCHROOT_TYPE. supported values are "directory" (the default if --vg isn't specified), "lvm-snapshot" (the default if --vg is specified), "btrfs-snapshot", "zfs-snapshot" and "file". 👑
• --ccache — enable usage of ccache by default. see ccache(1) for more details. ⚡
• --ccache-dir=PATH — use PATH as the schroot ccache directory. this directory can be safely shared by multiple schroots, but heads up: they will all use the same CCACHE_MAXSIZE. defaults to /var/cache/ccache-sbuild. see ccache(1) for more details. 📁
• --ccache-size=SIZE — sets SIZE as the schroot CCACHE_DIR max-size used by ccache. see ccache(1) for more details. 📏

---

🌈 ENVIRONMENT VARIABLES 🌈

the vibes you can set in your environment instead of on the command line, bestie:

• LV_SIZE — size of source LVs. defaults to 5G. 💾
• SNAPSHOT_SIZE — size of snapshot LVs. defaults to 4G. 💾
• SCHROOT_CONF_SUFFIX — lines to append to schroot entries. ➕
• SCHROOT_PROFILE — profile to use with schroot. defaults to sbuild. 🎭
• SKIP_UPDATES — do not include the -updates pocket (same as --skip-updates). 👋
• SKIP_PROPOSED — do not include the -proposed pocket (same as --skip-proposed). 👋
• DEBOOTSTRAP_MIRROR — mirror location (same as --debootstrap-mirror). 🌍
• DEBOOTSTRAP_INCLUDE — comma separated list of packages to include when bootstrapping (same as --debootstrap-include). 📦
• DEBOOTSTRAP_EXCLUDE — comma separated list of packages to exclude when bootstrapping (same as --debootstrap-exclude; see warning above). 🚨
• DEBOOTSTRAP_KEYRING — keyring file to use for checking gpg signatures of retrieved release files (same as --debootstrap-keyring). 🔑
• DEBOOTSTRAP_NO_CHECK_GPG — disable gpg verification of retrieved release files (same as --debootstrap-no-check-gpg). 🙈
• DEBOOTSTRAP_PROXY — proxy to use for apt. (same as --debootstrap-proxy). 🛰️
• EATMYDATA — enable or disable eatmydata usage, see --eatmydata and --skip-eatmydata. 🍓
• SOURCE_CHROOTS_DIR — use SOURCE_CHROOTS_DIR as home of schroot source directories. (default /var/lib/schroot/chroots). 🏠
• SOURCE_CHROOTS_TGZ — use SOURCE_CHROOTS_TGZ as home of schroot source tarballs. (default /var/lib/schroot/tarballs). 🗜️
• CHROOT_SNAPSHOT_DIR — use CHROOT_SNAPSHOT_DIR as home of mounted btrfs snapshots. (default /var/lib/schroot/snapshots). 📸
• CCACHE — enable ccache(1) by default. (defaults to 0). ⚡
• CCACHE_DIR — use CCACHE_DIR as the ccache(1) directory. (default /var/cache/ccache-sbuild). 📁
• CCACHE_SIZE — use CCACHE_SIZE as the ccache(1) max-size. (defaults to 4G). 📏

---

🎀 FILES 🎀

the little config besties she reads:

• $HOME/.mk-sbuild.rc — sourced for environment variables (the ones defined above, yeah those ones). 📜
• $HOME/.mk-sbuild.sources[.$DISTRO] — can contain a customized sources.list. it will be read when creating the schroot. if a file with ".ubuntu" or ".debian" is found (as appropriate) it will use used instead. see sources.list(5) for more details on the format. 📝
• $HOME/.mk-sbuild.schroot.conf[.$SCHROOT_TYPE] — can contain a customized configuration section to be inserted into /etc/schroot/schroot.conf. if a file with ".lvm-snapshot", ".directory", ".file", or "btrfs-snapshot" is found (as appropriate) that file will use used instead. see schroot.conf(5) for more details on the format. 📝

---

🫶 USING THE CHROOTS 🫶

okay this is the part you're actually here for. the workflow. the lore.

• to CHANGE the golden image: sudo schroot -c ${SCHROOT_NAME}-source -u root
• to ENTER an image snapshot: schroot -c $SCHROOT_NAME
• to BUILD within a snapshot: sbuild -A -d $SCHROOT_NAME $PACKAGE*.dsc

for example, to update the packages in a sid-amd64 golden image:

schroot -c sid-amd64-source -u root -- sh -c "apt-get -qq update
&& apt-get -qy upgrade && apt-get clean" </dev/null

slay. 💅

---

⭐ SEE ALSO ⭐

sbuild-setup(7), sources.list(5), schroot.conf(5), https://help.ubuntu.com/community/SbuildLVMHowto

---

💜 AUTHOR 💜

mk-sbuild was written by Kees Cook <kees@ubuntu.com>. this man page was written by Ryan Kavanagh <ryanakca@kubuntu.org>. both are released under the GNU General Public License, version 3 or later. 👑

---

and that's the whole thing, bestie — brought to you by ubuntu-dev-tools, dated 09 February 2010, in manual section MK-SBUILD(1). go build something cute. mwah. 💖✨🎀🦋🌸