Manpages

NAME

lb_config - Create config directory

SYNOPSIS

lb config [live-build options]

lb config

DESCRIPTION

lb config is a high-level command (porcelain) of live-build(7), the live systems tool suite.

lb config populates the configuration directory for live-build. This directory is named ’config’ and is created in the current directory where lb config was executed.

Note: lb config tries to be smart and sets defaults for some options depending on the setting of other options. This means that when generating a new configuration, you should call lb config only once with all options specified. Calling it several times with only a subset of the options each can result in non working configurations. This is also caused by the fact that lb config called with one option only changes that option, and leaves everything else as is unless it is not defined. However, lb config does warn about know impossible or likely impossible combinations that would lead to non working live systems. If unsure, remove config/{binary,bootstrap,chroot,common,source} and call lb config again.

OPTIONS

In addition to its specific options lb config understands all generic live-build options. See live-build(7) for a complete list of all generic live-build options.
--apt apt|aptitude

defines if apt-get or aptitude is used to install packages when building the image. The default is apt.

--apt-ftp-proxy URL

sets the ftp proxy to be used by apt. By default, this is empty. Note that this variable is only for the proxy that gets used by apt internally within the chroot, it is not used for anything else.

--apt-http-proxy URL

sets the http proxy to be used by apt. By default, this is empty. Note that this variable is only for the proxy that gets used by apt internally within the chroot, it is not used for anything else.

--apt-indices true|false

defines if the resulting images should have apt indices or not and defaults to true.

--apt-options OPTION|"OPTIONS"

defines the default options that will be appended to every apt call that is made inside chroot during the building of the image. By default, this is set to --yes to allow non-interactive installation of packages.

--apt-pipeline DEPTH

sets the depth of the apt/aptitude pipeline. In cases where the remote server is not RFC conforming or buggy (such as Squid 2.0.2) this option can be a value from 0 to 5 indicating how many outstanding requests APT should send. A value of zero MUST be specified if the remote host does not properly linger on TCP connections - otherwise data corruption will occur. Hosts which require this are in violation of RFC 2068. By default, live-build does not set this option.

--apt-recommends true|false

defines if apt should install recommended packages automatically. By default, this is true.

--apt-secure true|false

defines if apt should check repository signatures. This is true by default.

--apt-source-archives true|false

defines if deb-src entries should be included in the resulting live image or not, defaults to true.

--aptitude-options OPTION|"OPTIONS"

defines the default options that will be appended to every aptitude call that is made inside chroot during building of the image. By default, this is set to --assume-yes to allow non-interactive installation of packages.

-a|--architectures ARCHITECTURE

defines the architecture of the to be build image. By default, this is set to the host architecture. Note that you cannot crossbuild for another architecture if your host system is not able to execute binaries for the target architecture natively. For example, building amd64 images on i386 and vice versa is possible if you have a 64bit capable i386 processor and the right kernel. But building powerpc images on an i386 system is not possible.

--archive-areas ARCHIVE_AREA|"ARCHIVE_AREAS"

defines which package archive areas of a debian packages archive should be used for configured debian package mirrors. By default, this is set to main. Remember to check the licenses of each packages with respect to their redistributability in your juristiction when enabling contrib or non-free with this mechanism.

--backports true|false

defines if debian backports package archives should be included in the image or not.

--binary-filesystem fat16|fat32|ext2|ext3|ext4|ntfs

defines the filesystem to be used in the image type. This only has an effect if the selected binary image type lets you choose a filesystem. For example, when selection iso the resulting CD/DVD has always the filesystem ISO9660. When building hdd images for usb sticks, this is active. Note that it defaults to fat16 on all architectures except sparc where it defaults to ext4. Also note that if you choose fat16 and your resulting binary image gets bigger than 2GB, the binary filesystem automatically gets switched to fat32.

-b|--binary-images iso|iso-hybrid|netboot|tar|hdd

defines the image type to build. By default, for images using syslinux this is set to iso-hybrid to build CD/DVD images that may also be used like hdd images, for non-syslinux images, it defaults to iso.

--bootappend-install PARAMETER|"PARAMETERS"

sets boot parameters specific to debian-installer, if included.

--bootappend-live PARAMETER|"PARAMETERS"

sets boot parameters specific to debian-live. A complete list of boot parameters can be found in the live-boot(7) and live-config(7) manual pages.

--bootappend-live-failsafe PARAMETER|"PARAMETERS"

sets boot parameters specific to debian-live failsafe boot entries. A complete list of boot parameters can be found in the live-boot(7) and live-config(7) manual pages.

--bootloaders grub-legacy|grub-pc|syslinux|grub-efi

defines which bootloader is being used in the generated image. This has only an effect if the selected binary image type lets you choose the bootloader. For example, if you build a iso, always syslinux (or more precise, isolinux) is being used. Also note that some combinations of binary images types and bootloaders may be possible but live-build does not support them yet. lb config will fail to create such a not yet supported configuration and give a explanation about it. For hdd images on amd64 and i386, the default is syslinux.

--bootstrap-qemu-arch ARCH

sets the architectures to use foreign bootstrap. Defaults to empty.

--bootstrap-qemu-exclude PACKAGES

sets the packages to exclude during foreign bootstrap. Defaults to empty.

--bootstrap-qemu-static PATH

sets the static qemu binary for foreign bootstrap. Defaults to empty.

--breakpoints

inserts pauses during the generation of the image.

--build-with-chroot true|false

defines whether live-build should use the tools from within the chroot to build the binary image or not by using and including the host system’s tools. This is a very dangerous option, using the tools of the host system can lead to tainted and even non-bootable images if the host systems version of the required tools (mainly these are the bootloaders such as syslinux and grub, and the auxiliary tools such as dosfstools, xorriso, squashfs-tools and others) do not exactly match what is present at build-time in the target distribution. Never do disable this option unless you are exactly sure what you are doing and have completely understood its consequences.

--cache true|false

defines globally if any cache should be used at all. Different caches can be controlled through the their own options.

--cache-indices true|false

defines if downloaded package indices and lists should be cached which is false by default. Enabling it lets you rebuild an image completely offline, however, you would not get updates anymore then.

--cache-packages true|false

defines if downloaded packages files should be cached which is true by default. Disabling it does save space consumption in your build directory, but remember that you will cause much unnecessary traffic if you do a couple of rebuilds. In general you should always leave it true, however, in some particular rare build setups, it can be faster to refetch packages from the local network mirror rather than to utilize the local disk.

--cache-stages STAGE|"STAGES"

sets which stages should be cached. By default set to bootstrap. As an exception to the normal stage names, also rootfs can be used here which does only cache the generated root filesystem in filesystem.{dir,ext*,squashfs}. This is useful during development if you want to rebuild the binary stage but not regenerate the root filesystem all the time.

--checksums md5|sha1|sha224|sha256|sha384|sha512|none

defines if the binary image should contain a file called XXXsums.txt, where XXX is one of the mentioned checksum types. This file lists all files on the image together with their checksums. This in turn can be used by live-boot(7)’s built-in integrity-check to verify the medium if specified at boot prompt. In general, this should not be none and is an important feature of live system released to the public. However, during development of very big images it can save some time by not calculating the checksums.

--chroot-filesystem ext2|ext3|ext4|squashfs|jffs2|none

defines which filesystem type should be used for the root filesystem image. If you use none, then no filesystem image is created and the root filesystem content is copied on the binary image filesystem as flat files. Depending on what binary filesystem you have chosen, it may not be possible to build with such a plain root filesystem, e.g. fat16/fat32 will not work as linux does not support to run directly on them.

--clean

minimizes config directory by automatically removing unused and thus empty subdirectories.

--color

turns on color in the messages.

--compression bzip2|gzip|lzip|xz|none

defines the compression program to be used to compress tarballs. Defaults to none.

-c|--conffile FILE

uses a user specified alternative configuration file in addition to the normally used one in the config directory.

--config GIT_URL::GIT_BRANCH

bootstraps the config tree from a git repository, optionally appended by a Git Id (branch, commit, tag, etc.).

--debconf-frontend dialog|editor|noninteractive|readline

defines what value the debconf frontend should be set to inside the chroot. Note that setting it to anything but noninteractive, which is the default, makes your build asking questions during the build.

--debconf-priority low|medium|high|critical

defines what value the debconf priority should be set to inside the chroot. By default, it is set to critical, which means that almost no questions are displayed. Note that this only has an effect if you use any debconf frontend different from noninteractive.

--debian-installer true|cdrom|netinst|netboot|businesscard|live|false

defines which type, if any, of the debian-installer should be included in the resulting binary image. By default, no installer is included. All available flavours except live are the identical configurations used on the installer media produced by regular debian-cd. When live is chosen, the live-installer udeb is included so that debian-installer will behave different than usual - instead of installing the debian system from packages from the medium or the network, it installs the live system to the disk.

--debian-installer-distribution daily|CODENAME

defines the distribution where the debian-installer files should be taken out from. Normally, this should be set to the same distribution as the live system. However, some times, one wants to use a newer or even daily built installer.

--debian-installer-gui true|false

defines if the debian-installer graphical GTK interface should be true or not. In Debian mode and for most versions of Ubuntu, this option is true, whereas otherwise false, by default.

--debian-installer-preseedfile FILE|URL

sets the filename or URL for an optionally used and included preseeding file for debian-installer. If config/binary_debian-installer/preseed.cfg exists, it will be used by default.

--debootstrap-options OPTIONS

passes the given options to debootstrap when setting up the base system.

--debootstrap-script SCRIPT

tells debootstrap to use an alternate bootstrap script (last parameter to debootstrap).

--debug

turns on debugging informational messages.

-d|--distribution CODENAME

defines the distribution of the resulting live system.

--distribution-binary CODENAME

defines the distribution enabled in the resulting live system (defaults to the value set in --distribution)

--distribution-chroot CODENAME

defines the distribution used to build the live system (defaults to the value set in --distribution)

--dump

prepares a report of the currently present live system configuration and the version of live-build used. This is useful to provide if you submit bug reports, we do get all information required for us to locate and replicate an error.

--fdisk fdisk|fdisk.dist

sets the filename of the fdisk binary from the host system that should be used. This is autodetected and does generally not need any customization.

--firmware-binary true|false

includes firmware packages in debian-installer. Defaults to true.

--firmware-chroot true|false

includes firmware packages in debian-installer. Defaults to true.

--force

forces re-execution of already run stages. Use only if you know what you are doing. It is generally safer to use lb clean to clean up before re-executing lb build.

--grub-splash FILE

defines the name of an optional to be included splash screen graphic for the grub bootloader.

--gzip-options OPTION|"OPTIONS"

defines the default options that will be appended to (almost) every gzip call during the building of the image. By default, this is set to --best to use highest (but slowest) compression. Dynamically, if the host system supports it, also --rsyncable is added.

--hdd-label LABEL

defines the label for the hdd target. Defaults to DEBIAN_LIVE.

--hdd-partition-start START

sets the start of the partition for the hdd target for BIOSes that expect a specific boot partition start (e.g. "63s"). If empty, use optimal layout. Defaults to empty.

--hdd-size SIZE

defines the size for the hdd target. The unit is MiB. Defaults to auto, which generates the smallest possible image.

--ignore-system-defaults

lb config by default reads system defaults from /etc/live/build.conf and /etc/live/build/* when generating a new live system config directory. This is useful if you want to set global settings, such as mirror locations, and don’t want to specify them all of the time.

--image-name NAME

sets the base name of the image. Defaults to live-image.

--initramfs none|live-boot

sets the name of the package that contains the live system specific initramfs modification and defaults to live-boot. Using ’none’ is useful if the resulting system image should not be a live image (experimental).

--initramfs-compression bzip2|gzip|lzma]

defines the compression program to be used to compress the initramfs. Defaults to gzip.

--initsystem sysvinit|systemd|none]

defines the init system. Defaults to systemd.

--interactive shell

defines if after the chroot stage and before the beginning of the binary stage, a interactive shell login should be spawned in the chroot in order to allow you to do manual customizations. Once you close the shell with logout or exit, the build will continue as usual. Note that it’s strongly discouraged to use this for anything else than testing. Modifications that should be present in all builds of a live system should be properly made through hooks. Everything else destroys the beauty of being able to completely automatise the build process and making it non interactive. By default, this is of course false.

--iso-application NAME

sets the APPLICATION field in the header of a resulting CD/DVD image and defaults to "Debian Live" in debian mode, and "Ubuntu Live" in ubuntu mode.

--iso-preparer NAME

sets the PREPARER field in the header of a resulting CD/DVD image. By default this is set to "live-build VERSION; https://salsa.debian.org/live-team/live-build";, where VERSION is expanded to the version of live-build that was used to build the image.

--iso-publisher NAME

sets the PUBLISHED field in the header of a resulting CD/DVD image. By default, this is set to ’Live Systems project; https://wiki.debian.org/DebianLive; debian-live [AT] lists.org’. Remember to change this to the appropriate values at latest when you distributing custom and unofficial images.

--iso-volume NAME

sets the VOLUME field in the header of a resulting CD/DVD and defaults to ’(MODE) (DISTRIBUTION) (DATE)’ whereas MODE is expanded to the name of the mode in use, DISTRIBUTION the distribution name, and DATE with the current date and time of the generation.

--isohybrid-options OPTION|"OPTIONS"

defines options to pass to isohybrid.

--jffs2-eraseblock SIZE

sets the eraseblock size for a JFFS2 (Second Journaling Flash File System) filesystem. The default is 64 KiB. If you use an erase block size different than the erase block size of the target MTD device, JFFS2 may not perform optimally. If the SIZE specified is below 4096, the units are assumed to be KiB.

--keyring-packages PACKAGE|"PACKAGES"

sets the keyring package or additional keyring packages. By default this is set to debian-archive-keyring.

-k|--linux-flavours FLAVOUR|"FLAVOURS"

sets the kernel flavours to be installed. Note that in case you specify more than that the first will be configured the default kernel that gets booted. Optionally you can use an architecture qualifier, e.g. amd64:amd64. Given an i386 system you can enable amd64 foreign architecture thanks to the commands: "dpkg --add-architecture amd64 ; apt-get update". This enables you to use "686 amd64:amd64" as a linux flavour. The amd64 kernel will be installed alongside the i386’s 686 kernel.

--linux-packages "PACKAGES"

sets the internal name of the kernel packages naming scheme. If you use debian kernel packages, you will not have to adjust it. If you decide to use custom kernel packages that do not follow the debian naming scheme, remember to set this option to the stub of the packages only (for debian this is linux-image-2.6), so that STUB-FLAVOUR results in a valid package name (for debian e.g. linux-image-686-pae). Preferably you use the meta package name, if any, for the stub, so that your configuration is ABI independent. Also don’t forget that you have to include stubs of the binary modules packages for unionfs or aufs, and squashfs if you built them out-of-tree.

--loadlin true|false

sets loadlin. Defaults to false, except when the debian-installer is included for x86_64 or i386.

--losetup losetup|losetup.orig

sets the filename of the losetup binary from the host system that should be used. This is autodetected and does generally not need any customization.

--memtest memtest86+|memtest86|none

defines if memtest, memtest86+ or no memory tester at all should be included as secondary bootloader configuration. This is only available on amd64 and i386 and defaults to memtest86+.

--mirror-binary URL

sets the location of the derivative package mirror that should end up configured in the final image and which is the one a user would see and use. This has not necessarily to be the same that is used to build the image, e.g. if you use a local mirror but want to have an official mirror in the image. This defaults to http://deb.debian.org/debian/.

--mirror-binary-security URL

sets the location of the derivatives security package mirror that should end up configured in the final image. This defaults to http://security.debian.org/.

--mirror-bootstrap URL

sets the location of the debian package mirror that should be used to bootstrap the derivative from. This defaults to http://deb.debian.org/debian/.

--mirror-chroot URL

sets the location of the debian package mirror that will be used to fetch the packages of the derivative in order to build the live system. By default, this is set to the value of --mirror-bootstrap.

--mirror-chroot-security URL

sets the location of the debian security package mirror that will be used to fetch the packages of the derivative in order to build the live system. By default, this points to http://security.debian.org/.

--mirror-debian-installer URL

sets the location of the mirror that will be used to fetch the debian installer images of the derivative. By default, this points to the same mirror used to build the live system, i.e. the value of --mirror-chroot.

--mode debian|progress-linux

defines a global mode to load project specific defaults. By default this is set to debian.

--net-cow-filesystem nfs|cfs

defines the filesystem type for the copy-on-write layer and defaults to nfs.

--net-cow-mountoptions OPTIONS

sets additional options for mounting the copy-on-write layer in netboot images and is by default empty.

--net-cow-path PATH

defines the path to client writable filesystem. Anywhere that client_mac_address is specified in the path live-boot will substitute the MAC address of the client delimited with hyphens.

/export/hosts/client_mac_address
/export/hosts/00-16-D3-33-92-E8

--net-cow-server IP|HOSTNAME

sets the IP or hostname that will be configured in the bootloader configuration for the copy-on-write filesystem of your netboot image and is by default empty.

--net-root-filesystem nfs|cfs

defines the filesystem that will be configured in the bootloader configuration for your netboot image. This defaults to nfs.

--net-root-mountoptions OPTIONS

sets additional options for mounting the root filesystem in netboot images and is by default empty.

--net-root-path PATH

sets the file path that will be configured in the bootloader configuration for your netboot image. This defaults to /srv/debian-live in debian mode, and /srv/ubuntu-live when in ubuntu mode.

--net-root-server IP|HOSTNAME

sets the IP or hostname that will be configured in the bootloader configuration for the root filesystem of your netboot image. This defaults to 192.168.1.1.

--net-tarball true|false

defines if a compressed tarball should be created. Disabling this options leads to no tarball at all, the plain binary directory is considered the output in this case. Default is true.

--onie true|false

defines if an ONIE.bin image is generated. ONIE binaries can be loaded by supported systems, and will in turn boot the live image. Note that iso or hybrid-iso are the only formats supported. For more information visit <http://onie.org/>. Default is false.

--onie-kernel-cmdline "OPTION1 OPTION2"

defines additional kernel command line options that the ONIE system will use when booting the image. Default is empty string.

--parent-archive-areas ARCHIVE_AREA|"ARCHIVE_AREAS"

defines the archive areas for derivatives of the resulting live system.

--parent-debian-installer-distribution CODENAME

defines the parent debian-installer distribution for derivatives of the resulting live system.

--parent-distribution CODENAME

defines the parent distribution for derivatives of the resulting live system.

--parent-distribution-binary CODENAME

defines the derivative’s parent distribution enabled in the resulting live system.

--parent-distribution-chroot CODENAME

defines the derivative’s parent distribution used to build the live system.

--parent-mirror-binary URL

sets the location of the debian package mirror that should end up configured in the final image and which is the one a user would see and use. This has not necessarily to be the same that is used to build the image, e.g. if you use a local mirror but want to have an official mirror in the image. This defaults to the value of --mirror-binary.

--parent-mirror-binary-security URL

sets the location of the debian security package mirror that should end up configured in the final image. This defaults to the value of --mirror-binary-security.

-m|--parent-mirror-bootstrap URL

sets the location of the debian package mirror that should be used to bootstrap from. This defaults to the value of --mirror-tstrap.

--parent-mirror-chroot URL

sets the location of the debian package mirror that will be used to fetch the packages in order to build the live system. This defaults to the value of --parent-mirror-bootstrap.

--parent-mirror-chroot-security URL

sets the location of the debian security package mirror that will be used to fetch the packages in order to build the live system. This defaults to the value of --mirror-chroot-security.

--parent-mirror-debian-installer URL

sets the location of the mirror that will be used to fetch the debian installer images. This defaults to the value of --parent-mirror-chroot.

--quiet

reduces the verbosity of messages output by lb build.

--security true|false

defines if the security repositories specified in the security mirror options should be used or not.

--source true|false

defines if a corresponding source image to the binary image should be build. By default this is false because most people do not require this and would require to download quite a few source packages. However, once you start distributing your live image, you should make sure you build it with a source image alongside.

-s|--source-images iso|netboot|tar|hdd

defines the image type for the source image. Default is tar.

--swap-file-path PATH

defines the path to a swap file to create in the binary image. Default is not to create a swap file.

--swap-file-size MB

defines what size in megabytes the swap file should be, if one is to be created. Default is 512MB.

--system live|normal

defines if the resulting system image should a live system or a normal, non-live system.

--tasksel apt|aptitude|tasksel

selects which program is used to install tasks. By default, this is set to tasksel.

--uefi-secure-boot auto|enable|disable

enables or disables Secure Boot support when using grub-efi, by installing signed shim and grub-efi packages. By default, this is set to auto, which means if the packages are available they will be installed, but if not only a warning will be printed and the normal non-signed grub-efi will be used.

--updates true|false

defines if debian updates package archives should be included in the image or not.

--verbose

increases the verbosity of messages output by lb build.

--win32-loader true|false

defines if win32-loader should be included in the binary image or not.

--zsync true|false

defines whether a file for distributing the image in zsync(1) format will be generated. Defaults to true.

ENVIRONMENT

Currently, command line switches can also be specified through the corresponding environment variable. However, this generally should not be relied upon, as it is an implementation detail that is subject to change in future releases. For options applying directly to live-build, environment variables are named LB_FOO, meaning, e.g. --apt-ftp-proxy becomes LB_APT_FTP_PROXY (the exception being internal options such as --debug). For options passed to another program, as in APT_OPTIONS or GZIP_OPTIONS, no LB_ prefix is used.

FILES

auto/config
/etc/live/build.conf, /etc/live/build/*

An optional, global configuration file for lb config variables. It is useful to specify a few system wide defaults, like LB_PARENT_MIRROR_BOOTSTRAP. This feature can be false by specifying the --ignore-system-defaults option.

SEE ALSO

live-build(7)

live-boot(7)

live-config(7)

This program is a part of live-build.

HOMEPAGE

More information about live-build and the Live Systems project can be found on the homepage at <https://wiki.debian.org/DebianLive>.

BUGS

Bugs can be reported by submitting a bugreport for the live-build package in the Bug Tracking System at <http://bugs.debian.org/> or by writing a mail to the Live Systems mailing list at <debian-live [AT] lists.org>.

AUTHOR

live-build was written by Daniel Baumann <mail [AT] daniel-baumann.ch>.