manuel
/
live-build
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Manual pages updates 

Thanks to jnqnfe for the patch.

Closes: #774730
This commit is contained in:
Raphaël Hertzog 2016-11-28 18:32:08 +01:00
parent 164f23368e
commit 6c6f34d92d
3 changed files with 186 additions and 133 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
debian/changelog vendored
View File

@ -28,6 +28,7 @@ live-build (1:20160105) UNRELEASED; urgency=medium
* Support “lb config --debootstrap-script <script>” to use an alternate * Support “lb config --debootstrap-script <script>” to use an alternate
bootstrap script when running debootstrap. Thanks to Sjoerd Simons bootstrap script when running debootstrap. Thanks to Sjoerd Simons
<sjoerd@debian.org> for the initial patch. Closes: #790033 <sjoerd@debian.org> for the initial patch. Closes: #790033
* Manual pages updates by jnqnfe. Closes: #774730
[ Kristian Klausen ] [ Kristian Klausen ]
* Include ext{3,4} journal size when calculating image size. Closes: #801712 * Include ext{3,4} journal size when calculating image size. Closes: #801712

32
manpages/en/lb_installer.1 Normal file
View File

@ -0,0 +1,32 @@
.TH LIVE\-BUILD 1 2015\-01\-04 5.0~a1-1 "Live Systems Project"
.SH NAME
\fBlb installer\fR \- Complete the installer stage
.SH SYNOPSIS
\fBlb installer\fR [\fIlive\-build options\fR]
.SH DESCRIPTION
\fBlb installer\fR is a high\-level command (porcelain) of \fIlive\-build\fR(7), the live systems tool suite.
.PP
\fBlb installer\fR calls all necessary live\-build programs in the correct order to complete the installer stage.
.SH OPTIONS
\fBlb installer\fR has no specific options but understands all generic live\-build options. See \fIlive\-build\fR(7) for a complete list of all generic live\-build options.
.SH FILES
.IP "\fBnone\fR" 4
.SH SEE ALSO
\fIlive\-build\fR(7)
.PP
This program is a part of live\-build.
.SH HOMEPAGE
More information about live\-build and the Live Systems project can be found on the homepage at <\fIhttp://live-systems.org/\fR> and in the manual at <\fIhttp://live-systems.org/manual/\fR>.
.SH BUGS
Bugs can be reported by submitting a bugreport for the live\-build package in the Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or by writing a mail to the Live Systems mailing list at <\fIdebian-live@lists.debian.org\fR>.
.SH AUTHOR
live\-build was written by Daniel Baumann <\fImail@daniel-baumann.ch\fR>.

286
manpages/en/live-build.7
View File

@ -55,153 +55,173 @@ pages for additional documentation.
.\" FIXME .\" FIXME
We separate the porcelain commands into the main commands and some ancillary user utilities. We separate the porcelain commands into the main commands and some ancillary user utilities.
.SS Main porcelain commands .SS Main porcelain commands
.IP "\fBlb_config\fR(1)" 4 .IP "\fBlb config\fR(1)" 4
create configuration for live\-build creates configuration for live\-build
.IP "\fBlb_bootstrap\fR(1)" 4 .IP "\fBlb bootstrap\fR(1)" 4
create the first stage by bootstrapping a basic debian system executes the first build stage, creating (bootstraping) a basic Debian root filesystem
.IP "\fBlb_chroot\fR(1)" 4 .IP "\fBlb chroot\fR(1)" 4
create the second stage by customizing the chroot executes the second build stage, building the live OS filesystem
.IP "\fBlb_binary\fR(1)" 4 .IP "\fBlb installer\fR(1)" 4
create the third stage by generating a binary image executes the third build stage, obtaining installer components (optional)
.IP "\fBlb_source\fR(1)" 4 .IP "\fBlb binary\fR(1)" 4
create the optional fourth stage by generating a source image executes the fourth build stage, generating a binary image
.IP "\fBlb_clean\fR(1)" 4 .IP "\fBlb source\fR(1)" 4
clean up system build directories executes the fifth build stage, generating a source image (optional)
.IP "\fBlb clean\fR(1)" 4
cleans up system build directories
.SS Ancillary Commands .SS Ancillary Commands
.IP "\fBlb\fR(1)" 4 .IP "\fBlb\fR(1)" 4
generic live\-build wrapper generic live\-build script execution wrapper
.IP "\fBlb_build\fR(1)" 4 .IP "\fBlb build\fR(1)" 4
alias for all stages alias for all build stages
.IP "\fBlb_local\fR(1)" 4
helper for using a local live\-build
.IP "\fBlb_testroot\fR(1)" 4
ensure that a system is built as root
.\" FIXME .\" FIXME
.SH LOW\-LEVEL COMMANDS (PLUMBING) .SH LOW\-LEVEL COMMANDS (PLUMBING) - BUILD STAGE COMPONENTS
.\" FIXME .\" FIXME
The actual work of live\-build is implemented in the low-level commands, called plumbing. They are not supposed to be used by end users, they should stick with porcelains as they ensure that all the different plumbing commands are executed in the right order. However, if you intend to reuse live\-build commands in your own scripts, then the plumbings might be of interest for you. The actual work of live\-build is implemented in the low-level commands, called plumbing. They are not supposed to be used by end users, they should stick with porcelains as they ensure that all the different plumbing commands are executed in the right order. However, if you intend to reuse live\-build commands in your own scripts, then the plumbings might be of interest for you.
.PP .PP
Note that the interface (set of options and the semantics) to these low\-level commands are meant to be a lot more stable than Porcelain level commands. The interface to Porcelain commands on the other hand are subject to change in order to improve the end user experience. Note that the interface (set of options and the semantics) to these low\-level commands are meant to be a lot more stable than Porcelain level commands. The interface to Porcelain commands on the other hand are subject to change in order to improve the end user experience.
.SS Bootstrap commands .SS Bootstrap stage specific commands
.IP "\fBlb_bootstrap_cache\fR(1)" 4 .IP "\fBlb bootstrap_archive\-keys\fR(1)" 4
cache bootstrap stage installs derivative distribution archive keys into bootstrap directory (currently applies to progress-linux builds only)
.IP "\fBlb_bootstrap_debootstrap\fR(1)" 4 .IP "\fBlb bootstrap_archives\fR(1)" 4
bootstrap a Debian system with debootstrap(8) applies apt archive configuration
.SS Chroot commands .IP "\fBlb bootstrap_cache\fR(1)" 4
.IP "\fBlb_chroot_apt\fR(1)" 4 in save mode, saves to cache a copy of the generated bootstrap directory, and in restore mode, restores from cache a previously generated copy
manage /etc/apt/apt.conf .IP "\fBlb bootstrap_cdebootstrap\fR(1)" 4
.IP "\fBlb_chroot_cache\fR(1)" 4 creates (bootstrap) a basic Debian root filesystem using cdebootstrap(8)
cache chroot stage .IP "\fBlb bootstrap_debootstrap\fR(1)" 4
.IP "\fBlb_chroot_debianchroot\fR(1)" 4 creates (bootstrap) a basic Debian root filesystem using debootstrap(8)
manage /etc/debian_chroot .SS Chroot stage specific commands
.IP "\fBlb_chroot_devpts\fR(1)" 4 .PP
mount /dev/pts Note: The following chroot_ prefixed commands are used in building the live OS filesystem. Another set of similarly prefixed files are listed separately (see further down).
.IP "\fBlb_chroot_dpkg\fR(1)" 4 .IP "\fBlb chroot_cache\fR(1)" 4
manage /sbin/dpkg in save mode, saves to cache a copy of the chroot directory, and in restore mode, restores from cache a previously generated copy
.IP "\fBlb_chroot_hacks\fR(1)" 4 .IP "\fBlb chroot_firmware\fR(1)" 4
execute hacks in chroot compiles a list of firmware packages to be installed in the live OS root filesystem
.IP "\fBlb_chroot_hostname\fR(1)" 4 .IP "\fBlb chroot_hacks\fR(1)" 4
manage /bin/hostname executes local hacks against the live OS root filesystem, if any are provided
.IP "\fBlb_chroot_hosts\fR(1)" 4 .IP "\fBlb chroot_hooks\fR(1)" 4
manage /etc/hosts executes local hooks against the live OS root filesystem, if any are provided
.IP "\fBlb_chroot_install\-packages\fR(1)" 4 .IP "\fBlb chroot_includes\fR(1)" 4
install queued packages into chroot copies a set of local files from the config directory into the live OS root filesystem, if any are provided
.IP "\fBlb_chroot_interactive\fR(1)" 4 .IP "\fBlb chroot_install\-packages\fR(1)" 4
make build interactive installs into the live OS root filesystem any packages listed in local package lists
.IP "\fBlb_chroot_linux\-image\fR(1)" 4 .IP "\fBlb chroot_interactive\fR(1)" 4
manage /etc/kernel\-img.conf pauses the build process and starts an interactive shell from the live OS root filesystem, providing an oportunity for manual modifications or testing; note that this is (currently) usually executed with several chroot prep modifications applied (see description of these further down)
.IP "\fBlb_chroot_hooks\fR(1)" 4 .IP "\fBlb chroot_linux\-image\fR(1)" 4
execute local hooks in chroot compiles a list of kernel images to be installed in the live OS root filesystem
.IP "\fBlb_chroot_local\-includes\fR(1)" 4 .IP "\fBlb chroot_live\-packages\fR(1)" 4
copy local files into chroot installs a set of live system specific packages to the live OS root filesystem
.IP "\fBlb_chroot_packages\fR(1)" 4 .IP "\fBlb chroot_package\-lists\fR(1)" 4
queue install of packages into chroot compiles a list of packages provided in the user\' local config to be installed in the live OS root filesystem
.IP "\fBlb_chroot_local\-patches\fR(1)" 4 .IP "\fBlb chroot_preseed\fR(1)" 4
apply local patches against chroot installs pre-configured answers to certain install prompts into the live OS root filesystem
.IP "\fBlb_chroot_local\-preseed\fR(1)" 4 .SS Installer stage specific commands
use debconf local preseeding file .IP "\fBlb installer_debian\-installer\fR(1)" 4
.IP "\fBlb_chroot_packagelists\fR(1)" 4 obtains and sets up Debian installer(d-i) components
queue install of package lists into chroot .IP "\fBlb installer_preseed\fR(1)" 4
.IP "\fBlb_chroot_proc\fR(1)" 4 installs pre-configured answers to certain install prompts
mount /proc .SS Binary stage specific commands
.IP "\fBlb_chroot_resolv\fR(1)" 4 .IP "\fBlb binary_checksums\fR(1)" 4
manage /etc/resolv.conf creates checksums (md5, sha1, and/or sha256) for live image content
.IP "\fBlb_chroot_selinuxfs\fR(1)" 4 .IP "\fBlb binary_chroot\fR(1)" 4
mount /selinux duplicates the chroot directory, to place a copy of what whould be the completed live OS root filesystem to one side, allowing the original to continue to be used in executing certain parts of the remainder of the build process
.IP "\fBlb_chroot_archives\fR(1)" 4 .IP "\fBlb binary_disk\fR(1)" 4
manage /etc/apt/sources.list creates disk information files to be added to live image
.IP "\fBlb_chroot_sysfs\fR(1)" 4 .IP "\fBlb binary_grub\fR(1)" 4
mount /sys installs grub into live image to provide image boot capability
.IP "\fBlb_chroot_sysv\-rc\fR(1)" 4 .IP "\fBlb binary_grub2\fR(1)" 4
manage /usr/sbin/policy\-rc.d installs grub2 into live image to provide image boot capability
.IP "\fBlb_chroot_task\-lists\fR(1)" 4 .IP "\fBlb binary_hdd\fR(1)" 4
install task lists into chroot compiles the final live image into an hdd image file
.SS Binary commands .IP "\fBlb binary_hooks\fR(1)" 4
.IP "\fBlb_binary_chroot\fR(1)" 4 executes local hooks against the live image, if any are provided
copy chroot into chroot .IP "\fBlb binary_includes\fR(1)" 4
.IP "\fBlb_binary_debian\-installer\fR(1)" 4 copies a set of local files from the config directory into the live image, if any are provided
install debian\-installer into binary .IP "\fBlb binary_iso\fR(1)" 4
.IP "\fBlb_binary_disk\fR(1)" 4 compiles the final live image into an iso file
install disk information into binary .IP "\fBlb binary_linux\-image\fR(1)" 4
.IP "\fBlb_binary_grub\fR(1)" 4 copies the linux\-image into the live image
installs grub into binary .IP "\fBlb binary_loadlin\fR(1)" 4
.IP "\fBlb_binary_grub2\fR(1)" 4 bundles a copy of loadlin into the live image
installs grub2 into binary .IP "\fBlb binary_manifest\fR(1)" 4
.IP "\fBlb_binary_includes\fR(1)" 4 creates manifest of packages installed into live OS filesystem, and list of packages to be excluded by a persistence mechanism installing the live OS to disk
copy files into binary .IP "\fBlb binary_memtest\fR(1)" 4
.IP "\fBlb_binary_iso\fR(1)" 4 bundles a copy of memtest into the live image
build iso binary image .IP "\fBlb binary_netboot\fR(1)" 4
.IP "\fBlb_binary_linux\-image\fR(1)" 4 compiles the final live image into a netboot tar archive
install linux\-image into binary .IP "\fBlb binary_package\-lists\fR(1)" 4
.IP "\fBlb_binary_local\-hooks\fR(1)" 4 processes local lists of packages to obtain and bundle into image (from which they could later be installed if not already)
execute local hooks in binary .IP "\fBlb binary_rootfs\fR(1)" 4
.IP "\fBlb_binary_local\-includes\fR(1)" 4 wraps up the completed live OS root filesystem into a virtual file system image
copy files into binary .IP "\fBlb binary_syslinux\fR(1)" 4
.IP "\fBlb_binary_local\-packagelists\fR(1)" 4 installs syslinux into live image to provide image boot capability
install local package lists into binary .IP "\fBlb binary_tar\fR(1)" 4
.IP "\fBlb_binary_manifest\fR(1)" 4 compiles the final live image into a tar archive
create manifest .IP "\fBlb binary_win32\-loader\fR(1)" 4
.IP "\fBlb_binary_checksums\fR(1)" 4 bundles a copy of win32\-loader into the live image and creates an autorun.inf file
create binary checksums (md5, sha1, and/or sha256) .IP "\fBlb binary_zsync\fR(1)" 4
.IP "\fBlb_binary_memtest\fR(1)" 4 builds zsync control files
installs a memtest into binary .SS Source stage specific commands
.IP "\fBlb_binary_net\fR(1)" 4 .IP "\fBlb source_checksums\fR(1)" 4
build netboot binary image creates checksums (md5, sha1, and/or sha256) for source image content
.IP "\fBlb_binary_rootfs\fR(1)" 4 .IP "\fBlb source_debian\fR(1)" 4
build rootfs image downloads source packages for bundling into source image
.IP "\fBlb_binary_syslinux\fR(1)" 4 .IP "\fBlb source_disk\fR(1)" 4
installs syslinux into binary creates disk information files to be added to source image
.IP "\fBlb_binary_tar\fR(1)" 4 .IP "\fBlb source_hdd\fR(1)" 4
build harddisk binary image compiles the final source image into an hdd image file
.IP "\fBlb_binary_hdd\fR(1)" 4 .IP "\fBlb source_hooks\fR(1)" 4
build binary hdd image executes local hooks against the source image, if any are provided
.IP "\fBlb_binary_win32\-loader\fR(1)" 4 .IP "\fBlb source_iso\fR(1)" 4
installs win32\-loader into binary compiles the final source image into an iso file
.SS Source commands .IP "\fBlb source_live\fR(1)" 4
.IP "\fBlb_source_debian\fR(1)" 4 copies live-build config into source
download sources .IP "\fBlb source_tar\fR(1)" 4
.IP "\fBlb_source_debian\-live\fR(1)" 4 compiles the final source image into a tar archive
copy debian\-live config into source .\" FIXME
.IP "\fBlb_source_disk\fR(1)" 4
install disk information into source .SH LOW\-LEVEL COMMANDS (PLUMBING) - CHROOT PREP COMPONENTS
.IP "\fBlb_source_iso\fR(1)" 4 .\" FIXME
build iso source image The notes above under the section regarding build-stage specific low-level plumbing commands also apply here.
.IP "\fBlb_source_checksums\fR(1)" 4 .PP
create source checksums (md5, sha1, and/or sha256) The following chroot_ prefixed commands are used throughout the various primary stages of the build process to apply and remove modifications to a chroot root filesystem. Generally these are used to apply modification that setup the chroot for use (execution of programs within it) during the build process, and later to remove those modification, unmounting things that were mounted, and making the chroot suitable for use as the root filesystem of the live OS to be bundled into the live image.
.IP "\fBlb_source_net\fR(1)" 4 .IP "\fBlb chroot_apt\fR(1)" 4
build source net image manages apt configuration; in apply mode it applies configuration for use during build process, and in remove mode removes that configuration
.IP "\fBlb_source_tar\fR(1)" 4 .IP "\fBlb chroot_archives\fR(1)" 4
build source tarball manages apt archive source lists; in apply mode it applies source list configurations suitable for use of the chroot in the build process, and in remove mode replaces that with a configuration suitable for the final live OS
.IP "\fBlb_source_hdd\fR(1)" 4 .IP "\fBlb chroot_debianchroot\fR(1)" 4
build source hdd image manages a /etc/debian_chroot file
.IP "\fBlb chroot_devpts\fR(1)" 4
manages mounting of /dev/pts
.IP "\fBlb chroot_dpkg\fR(1)" 4
manages dpkg; in apply mode disabling things like the start-stop-daemon, and in remove mode enabling them again
.IP "\fBlb chroot_hostname\fR(1)" 4
manages the hostname configuration
.IP "\fBlb chroot_hosts\fR(1)" 4
manages the /etc/hosts file
.IP "\fBlb chroot_proc\fR(1)" 4
manages mounting of /proc
.IP "\fBlb chroot_resolv\fR(1)" 4
manages configuration of the /etc/resolv.conf file
.IP "\fBlb chroot_selinuxfs\fR(1)" 4
manages mounting of /sys/fs/selinux
.IP "\fBlb chroot_sysfs\fR(1)" 4
manages mounting of /sys
.IP "\fBlb chroot_sysv\-rc\fR(1)" 4
manages the /usr/sbin/policy\-rc.d file
.IP "\fBlb chroot_tmpfs\fR(1)" 4
manages configuration of dpkg to use a tmpfs filesystem
.IP "\fBlb chroot_upstart\fR(1)" 4
manages use of upstart /sbin/initctl program; in apply mode blocking execution through a dpkg diversion, and in remove mode enabling execution again
.\" FIXME .\" FIXME
.SH CONFIG FILES .SH CONFIG FILES
.\" FIXME .\" FIXME
Many live\-build commands make use of files in the \fIconfig/\fR directory to control what they do. Besides the common \fIconfig/common\fR, which is used by all live\-build commands, some additional files can be used to configure the behavior of specific live\-build commands. These files are typically named config/stage or config/stage_helper (where "stage" of course, is replaced with the name of the stage that they belong to, and "helper" with the name of the helper). Many live\-build commands make use of files in the \fIconfig/\fR directory to control what they do. Besides the common \fIconfig/common\fR, which is used by all live\-build commands, some additional files can be used to configure the behavior of specific live\-build commands. These files are typically named config/stage or config/stage_helper (where "stage" of course, is replaced with the name of the stage that they belong to, and "helper" with the name of the helper).
.PP .PP
For example, lb_bootstrap_debootstrap uses files named config/bootstrap and config/bootstrap_debootstrap to read the options it will use. See the man pages of individual commands for details about the names and formats of the files they use. Generally, these files contain variables with values assigned, one variable per line. Some programs in live\-build use pairs of values or slightly more complicated variable assignments. For example, lb bootstrap_debootstrap uses files named config/bootstrap and config/bootstrap_debootstrap to read the options it will use. See the man pages of individual commands for details about the names and formats of the files they use. Generally, these files contain variables with values assigned, one variable per line. Some programs in live\-build use pairs of values or slightly more complicated variable assignments.
.PP .PP
Note that live\-build will respect environment variables which are present in the context of the shell it is running. If variables can be read from config files, then they override environment variables, and if command line options are used, they override values from config files. If no value for a given variable can be found and thus is unset, live\-build will automatically set it to the default value. Note that live\-build will respect environment variables which are present in the context of the shell it is running. If variables can be read from config files, then they override environment variables, and if command line options are used, they override values from config files. If no value for a given variable can be found and thus is unset, live\-build will automatically set it to the default value.
.PP .PP