diff options
Diffstat (limited to 'manpages')
| -rw-r--r-- | manpages/lh.en.1 | 29 | ||||
| -rw-r--r-- | manpages/lh_binary.en.1 | 26 | ||||
| -rw-r--r-- | manpages/lh_bootstrap.en.1 | 26 | ||||
| -rw-r--r-- | manpages/lh_build.en.1 | 28 | ||||
| -rw-r--r-- | manpages/lh_chroot.en.1 | 26 | ||||
| -rw-r--r-- | manpages/lh_clean.en.1 | 37 | ||||
| -rw-r--r-- | manpages/lh_config.en.1 | 213 | ||||
| -rw-r--r-- | manpages/lh_source.en.1 | 26 | ||||
| -rw-r--r-- | manpages/lh_testroot.en.1 | 27 | ||||
| -rw-r--r-- | manpages/live-helper.en.7 | 338 |
10 files changed, 456 insertions, 320 deletions
diff --git a/manpages/lh.en.1 b/manpages/lh.en.1 index c26af2e..1166e21 100644 --- a/manpages/lh.en.1 +++ b/manpages/lh.en.1 @@ -1,32 +1,29 @@ -.TH LH 1 "2008\-08\-11" "1.0" "live\-helper" +.TH LH 1 "2009\-01\-23" "1.0.2" "live\-helper" .SH NAME live\-helper \- generic live\-helper wrapper .SH SYNOPSIS -\fBlh\fR COMMAND [COMMAND_OPTIONS] [\fIlive\-helper options\fR] +\fBlh\fR COMMAND [COMMAND_OPTIONS] +.PP +\fBlh\fR [\fIlive\-helper\ options\fR] .SH DESCRIPTION -lh is a generic wrapper for live\-helper programs. Instead of calling -"lh_command", it can also called through lh as "lh command", where command is a -name of a live\-helper program. See the man page of live\-helper for a list of -all available programs and the man page of lh_command for the documentation of -the actual helper. +lh is a high\-level command (porcelain) of live\-helper, the Debian Live tool suite. It is a a generic wrapper for live\-helper programs. Instead of calling "lh_\fICOMMAND\fR", it can also called through lh as "lh \fICOMMAND\fR", where command is a name of a live\-helper program. See the man page of live\-helper for a list of all available programs and the man page of lh_command for the documentation of the actual helper. + +.SH OPTIONS +lh has no specific options but understands all generic live\-helper options. See \fIlive\-helper\fR(7) for a complete list of all generic live\-helper options. .SH SEE ALSO \fIlive\-helper\fR(7) .PP This program is part of live\-helper. -.SH BUGS -Report bugs against live\-helper -<\fIhttp://packages.qa.debian.org/live\-helper\fR>. - .SH HOMEPAGE -More information about the Debian Live project can be found at -<\fIhttp://debian\-live.alioth.debian.org/\fR> and -<\fIhttp://wiki.debian.org/DebianLive/\fR>. +More information about live\-helper and the Debian Live project can be found in the homepage at <\fIhttp://debian\-live.alioth.debian.org/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>. + +.SH BUGS +Report bugs by submitting a bugreport for the live\-helper package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or write a mail to the mailinglist at <\fIdebian-live@lists.debian.org\fR>. .SH AUTHOR -live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the -Debian project. +live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project. diff --git a/manpages/lh_binary.en.1 b/manpages/lh_binary.en.1 index 5064982..a90f0e4 100644 --- a/manpages/lh_binary.en.1 +++ b/manpages/lh_binary.en.1 @@ -1,29 +1,27 @@ -.TH LH_BINARY 1 "2008\-08\-11" "1.0" "live\-helper" +.TH LH_BINARY 1 "2009\-01\-23" "1.0.2" "live\-helper" .SH NAME -lh_binary \- meta\-helper for lh_binary_* +lh_binary \- create the third stage by generating a binary image .SH SYNOPSIS \fBlh_binary\fR [\fIlive\-helper options\fR] .SH DESCRIPTION -lh_binary is a meta\-helper. It calls all necessary live\-helper programs in the -correct order to complete the binary stage. +lh_binary is a high\-level command (porcelain) of live\-helper, the Debian Live tool suite. It calls all necessary live\-helper programs in the correct order to complete the binary stage. + +.SH OPTIONS +lh_binary has no specific options but understands all generic live\-helper options. See \fIlive\-helper\fR(7) for a complete list of all generic live\-helper options. .SH SEE ALSO \fIlive\-helper\fR(7) .PP -This program is part of live\-helper. - -.SH BUGS -Report bugs against live\-helper -<\fIhttp://packages.qa.debian.org/live\-helper\fR>. +This program is a part of live\-helper. .SH HOMEPAGE -More information about the Debian Live project can be found at -<\fIhttp://debian\-live.alioth.debian.org/\fR> and -<\fIhttp://wiki.debian.org/DebianLive/\fR>. +More information about live\-helper and the Debian Live project can be found in the homepage at <\fIhttp://debian\-live.alioth.debian.org/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>. + +.SH BUGS +Report bugs by submitting a bugreport for the live\-helper package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or write a mail to the mailinglist at <\fIdebian-live@lists.debian.org\fR>. .SH AUTHOR -live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the -Debian project. +live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project. diff --git a/manpages/lh_bootstrap.en.1 b/manpages/lh_bootstrap.en.1 index d490a9a..d8ec68e 100644 --- a/manpages/lh_bootstrap.en.1 +++ b/manpages/lh_bootstrap.en.1 @@ -1,29 +1,27 @@ -.TH LH_BOOTSTRAP 1 "2008\-08\-11" "1.0" "live\-helper" +.TH LH_BOOTSTRAP 1 "2009\-01\-23" "1.0.2" "live\-helper" .SH NAME -lh_bootstrap \- meta\-helper for lh_bootstrap_* +lh_bootstrap \- create the first stage by bootstrapping a basic debian system .SH SYNOPSIS \fBlh_bootstrap\fR [\fIlive\-helper options\fR] .SH DESCRIPTION -lh_bootstrap is a meta\-helper. It calls all necessary live\-helper programs in -the correct order to complete the bootstrap stage. +lh_bootstrap is a high\-level command (porcelain) of live\-helper, the Debian Live tool suite. It calls all necessary live\-helper programs in the correct order to complete the bootstrap stage. + +.SH OPTIONS +lh_bootstrap has no specific options but understands all generic live\-helper options. See \fIlive\-helper\fR(7) for a complete list of all generic live\-helper options. .SH SEE ALSO \fIlive\-helper\fR(7) .PP -This program is part of live\-helper. - -.SH BUGS -Report bugs against live\-helper -<\fIhttp://packages.qa.debian.org/live\-helper\fR>. +This program is a part of live\-helper. .SH HOMEPAGE -More information about the Debian Live project can be found at -<\fIhttp://debian\-live.alioth.debian.org/\fR> and -<\fIhttp://wiki.debian.org/DebianLive/\fR>. +More information about live\-helper and the Debian Live project can be found in the homepage at <\fIhttp://debian\-live.alioth.debian.org/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>. + +.SH BUGS +Report bugs by submitting a bugreport for the live\-helper package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or write a mail to the mailinglist at <\fIdebian-live@lists.debian.org\fR>. .SH AUTHOR -live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the -Debian project. +live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project. diff --git a/manpages/lh_build.en.1 b/manpages/lh_build.en.1 index cdd25b0..148be63 100644 --- a/manpages/lh_build.en.1 +++ b/manpages/lh_build.en.1 @@ -1,29 +1,27 @@ -.TH LH_BUILD 1 "2008\-08\-11" "1.0" "live\-helper" +.TH LH_BUILD 1 "2009\-01\-23" "1.0.2" "live\-helper" .SH NAME -lh_build \- meta\-helper for lh_bootstrap, lh_chroot, lh_binary, and lh_source +lh_binary \- create the third stage by generating a binary image .SH SYNOPSIS -\fBlh_build\fR [\fIlive\-helper options\fR] +\fBlh_binary\fR [\fIlive\-helper options\fR] .SH DESCRIPTION -lh_build is a meta\-helper. It calls all necessary live\-helper programs in the -correct order to complete the bootstrap, chroot, binary, and source stage. +lh_build is a high\-level command (porcelain) of live\-helper, the Debian Live tool suite. It calls all necessary live\-helper programs in the correct order to complete the bootstrap, chroot, binary, and source stage. + +.SH OPTIONS +lh_build has no specific options but understands all generic live\-helper options. See \fIlive\-helper\fR(7) for a complete list of all generic live\-helper options. .SH SEE ALSO \fIlive\-helper\fR(7) .PP -This program is part of live\-helper. - -.SH BUGS -Report bugs against live\-helper -<\fIhttp://packages.qa.debian.org/live\-helper\fR>. +This program is a part of live\-helper. .SH HOMEPAGE -More information about the Debian Live project can be found at -<\fIhttp://debian\-live.alioth.debian.org/\fR> and -<\fIhttp://wiki.debian.org/DebianLive/\fR>. +More information about live\-helper and the Debian Live project can be found in the homepage at <\fIhttp://debian\-live.alioth.debian.org/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>. + +.SH BUGS +Report bugs by submitting a bugreport for the live\-helper package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or write a mail to the mailinglist at <\fIdebian-live@lists.debian.org\fR>. .SH AUTHOR -live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the -Debian project. +live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project. diff --git a/manpages/lh_chroot.en.1 b/manpages/lh_chroot.en.1 index 28fbd54..6a63f73 100644 --- a/manpages/lh_chroot.en.1 +++ b/manpages/lh_chroot.en.1 @@ -1,29 +1,27 @@ -.TH LH_CHROOT 1 "2008\-08\-11" "1.0" "live\-helper" +.TH LH_CHROOT 1 "2009\-01\-23" "1.0.2" "live\-helper" .SH NAME -lh_chroot \- meta\-helper for lh_chroot_* +lh_chroot \- create the second stage by customizing the chroot .SH SYNOPSIS \fBlh_chroot\fR [\fIlive\-helper options\fR] .SH DESCRIPTION -lh_chroot is a meta\-helper. It calls all necessary live\-helper programs in the -correct order to complete the chroot stage. +lh_chroot is a high\-level command (porcelain) of live\-helper, the Debian Live tool suite. It calls all necessary live\-helper programs in the correct order to complete the chroot stage. + +.SH OPTIONS +lh_chroot has no specific options but understands all generic live\-helper options. See \fIlive\-helper\fR(7) for a complete list of all generic live\-helper options. .SH SEE ALSO \fIlive\-helper\fR(7) .PP -This program is part of live\-helper. - -.SH BUGS -Report bugs against live\-helper -<\fIhttp://packages.qa.debian.org/live\-helper\fR>. +This program is a part of live\-helper. .SH HOMEPAGE -More information about the Debian Live project can be found at -<\fIhttp://debian\-live.alioth.debian.org/\fR> and -<\fIhttp://wiki.debian.org/DebianLive/\fR>. +More information about live\-helper and the Debian Live project can be found in the homepage at <\fIhttp://debian\-live.alioth.debian.org/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>. + +.SH BUGS +Report bugs by submitting a bugreport for the live\-helper package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or write a mail to the mailinglist at <\fIdebian-live@lists.debian.org\fR>. .SH AUTHOR -live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the -Debian project. +live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project. diff --git a/manpages/lh_clean.en.1 b/manpages/lh_clean.en.1 index 016b055..72d9c1a 100644 --- a/manpages/lh_clean.en.1 +++ b/manpages/lh_clean.en.1 @@ -1,32 +1,31 @@ -.TH LH_CLEAN 1 "2008\-08\-11" "1.0" "live\-helper" +.TH LH_CLEAN 1 "2009\-01\-23" "1.0.2" "live\-helper" .SH NAME lh_clean \- clean up system build directories .SH SYNOPSIS -.B lh_clean [\fIlive\-helper\ options\fR\] -[\fB\-\-all\fR] [\fB\-\-cache\fR] [\fB\-\-chroot\fR] [\fB\-\-binary\fR] -[\fB\-\-purge\fR] [\fB\-\-remove\fR] [\fB\-\-stage\fR] [\fB\-\-source\fR] +\fBlh_clean\fR [\fIlive\-helper\ options\fR\] [\fB\-\-all\fR] [\fB\-\-cache\fR] [\fB\-\-chroot\fR] [\fB\-\-binary\fR] [\fB\-\-purge\fR] [\fB\-\-remove\fR] [\fB\-\-stage\fR] [\fB\-\-source\fR] +.PP +\fBlh_clean\fR [\fIlive\-helper\ options\fR] .SH DESCRIPTION -lh_clean is a live\-helper program that is responsible for cleaning up after a -system is built. It removes the system build directories, and removes some other -files including stage files, and any detritus left behind by other live\-helper -commands. +lh_clean is a high\-level command (porcelain) of live\-helper, the Debian Live tool suite. It is responsible for cleaning up after a system is built. It removes the system build directories, and removes some other files including stage files, and any detritus left behind by other live\-helper commands. .SH OPTIONS +In addition to its specific options, lh_clean also understands all generic live\-helper options. See \fIlive\-helper\fR(7) for a complete list of all generic live\-helper options. +.br .IP "\fB\-\-all\fR" 4 -removes chroot, binary, stage, and source. This is the default operation. +removes chroot, binary, stage, and source, cache is kept. This is the default operation and will be processed if no argument is given. .IP "\fB\-\-cache\fR" 4 removes all cache directories. .IP "\fB\-\-chroot\fR" 4 -unmounts and removes the chroot directory. If bootstrap cache is available, the system is reset to bootstrap stage. +unmounts and removes the chroot directory. .IP "\fB\-\-binary\fR" 4 removes all binary related caches, directories, and stages files. .IP "\fB\-\-purge\fR" 4 -removes everything (including cache) but config. +removes everything (including cache). The config directory is kept. .IP "\fB\-\-remove\fR" 4 -removes everything (including package cache, but not stage cache) but config. +removes everything (including package cache, but not stage cache). The config directory is kept. .IP "\fB\-\-stage\fR" 4 removes all stage files. .IP "\fB\-\-source\fR" 4 @@ -37,15 +36,11 @@ removes all source related caches, directories, and stage files. .PP This program is a part of live\-helper. -.SH BUGS -Report bugs against live\-helper -<\fIhttp://packages.qa.debian.org/live\-helper\fR>. - .SH HOMEPAGE -More information about the Debian Live project can be found at -<\fIhttp://debian\-live.alioth.debian.org/\fR> and -<\fIhttp://wiki.debian.org/DebianLive/\fR>. +More information about live\-helper and the Debian Live project can be found in the homepage at <\fIhttp://debian\-live.alioth.debian.org/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>. + +.SH BUGS +Report bugs by submitting a bugreport for the live\-helper package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or write a mail to the mailinglist at <\fIdebian-live@lists.debian.org\fR>. .SH AUTHOR -live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the -Debian project. +live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project. diff --git a/manpages/lh_config.en.1 b/manpages/lh_config.en.1 index 085bbfa..dcb67fd 100644 --- a/manpages/lh_config.en.1 +++ b/manpages/lh_config.en.1 @@ -1,12 +1,10 @@ -.TH LH_CONFIG 1 "2008\-08\-11" "1.0" "live\-helper" +.TH LH_CONFIG 1 "2009\-01\-23" "1.0.2" "live\-helper" .SH NAME lh_config \- create configuration for live\-helper .SH SYNOPSIS -.B lh_config [\fIlive\-helper\ options\fR] -.PP -.B lh_config +\fBlh_config\fR .br [\fB\-\-apt\fR apt|aptitude] .br @@ -16,9 +14,9 @@ lh_config \- create configuration for live\-helper .br [\fB\-\-apt\-pdiffs\fR enabled|disabled] .br - [--aptitude-options OPTION|"OPTIONS"] + [\fB\-\-apt\-options\fR \fIOPTION\fR|"\fIOPTIONS\fR"] .br - [--apt-options OPTION|"OPTIONS"] + [\fB\-\-aptitude\-options\fR \fIOPTION\fR|"\fIOPTIONS\fR"] .br [\fB\-\-apt\-pipeline\fR \fIFIXME\fR] .br @@ -40,7 +38,7 @@ lh_config \- create configuration for live\-helper .br [\fB\-\-bootloader\fR grub|syslinux|yaboot] .br - [\fB\-\-bootstrap\fR cdebootstrap|debootstrap|copy] + [\fB\-\-bootstrap\fR cdebootstrap|cdebootstrap-static|debootstrap|copy] .br [\fB\-\-bootstrap\-config\fR \fIFILE\fR] .br @@ -60,7 +58,7 @@ lh_config \- create configuration for live\-helper .br [\fB\-\-chroot\-build\fR enabled|disabled] .br - [\fB\-\-chroot\-filesystem\fR ext2|ext3|squashfs|plain] + [\fB\-\-chroot\-filesystem\fR ext2|ext3|squashfs|plain|jffs2] .br [\-c|\fB\-\-conffile\fR \fIFILE\fR] .br @@ -78,9 +76,13 @@ lh_config \- create configuration for live\-helper .br [\-d|\fB\-\-distribution\fR \fICODENAME\fR] .br - [\-e|\fB\-\-encryption\fR aes128|aes192|aes256] + [\-\-\fBdump\fR] +.br + [\-e|\fB\-\-encryption\fR disabled|aes128|aes192|aes256] +.br + [\fB\-\-fdisk\fR fdisk|fdisk.dist] .br - [\fB\-\-fdisk\fR \fIPROGRAM\fR] + [\fB\-\-genisoimage\fR genisomage|mkisofs] .br [\fB\-\-grub\-splash\fR \fIFILE\fR] .br @@ -116,17 +118,19 @@ lh_config \- create configuration for live\-helper .br [\fB\-\-losetup\fR losetup|losetup.orig] .br - [\fB\-\-memtest\fR memtest86+|memtest86] + [\fB\-\-memtest\fR memtest86+|memtest86|none] .br - [\fB\-\-mirror\-binary\-security\fR \fIURL\fR] + [\-m|\fB\-\-mirror\-bootstrap\fR \fIURL\fR] .br [\fB\-\-mirror\-binary\fR \fIURL\fR] .br - [\-m|\fB\-\-mirror\-bootstrap\fR \fIURL\fR] + [\fB\-\-mirror\-binary\-security\fR \fIURL\fR] .br [\fB\-\-mirror\-chroot\fR \fIURL\fR] .br - [\fB\-\-mode\fR debian|debian\-edu] + [\fB\-\-mirror\-chroot\-security\fR \fIURL\fR] +.br + [\fB\-\-mode\fR debian|emdebian] .br [\fB\-\-net\-root\-filesystem\fR nfs|cfs] .br @@ -144,6 +148,8 @@ lh_config \- create configuration for live\-helper .br [\fB\-\-net\-cow\-server\fR \fIIP\fR|\fIHOSTNAME\fR] .br + [\fB\-\-net\-tarball\fR bzip2|gzip|tar|none] +.br [\-p|\fB\-\-packages\-lists\fR \fIFILE\fR] .br [\fB\-\-packages\fR \fIPACKAGE\fR|\fI"PACKAGES"\fR] @@ -181,79 +187,159 @@ lh_config \- create configuration for live\-helper [\fB\-\-exposed\-root\fR enabled|disabled] .br [\fB\-\-username\fR \fINAME\fR] +.br + [\fB\-\-win32\-loader enabled|disabled] +.PP +\fBlh_config\fR [\fIlive\-helper\ options\fR] .SH DESCRIPTION -lh_config is a script to populate the configuration directory for live\-helper. -By default, this directory is named 'config' and is created in the current -directory. +is a high\-level command (porcelain) of live\-helper, the Debian Live tool suite. It populates the configuration directory for live\-helper. By default, this directory is named 'config' and is created in the current directory where lh_config was executed. +.PP +\fBAttention:\fR lh_config tries to be smart and sets defaults for some options depending on the setting of other options (e.g. the to be used union filesystem depending on an etch system gets build or not). This means that when generating a new configuration, you should call lh_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 lh_config called with one option only changes that option, and leaves everything else as is unless its not defined. However, lh_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 lh_config again. .SH OPTIONS +In addition to its specific options, lh_config also understands all generic live\-helper options. See \fIlive\-helper\fR(7) for a complete list of all generic live\-helper options. +.br .IP "\fB\-\-apt\fR apt|aptitude" 4 +defines if apt-get or aptitude is used to install packages when building the image. When building etch images, this defaults to aptitude. Every other distribution defaults to apt. .IP "\fB\-\-apt\-ftp\-proxy\fR \fIURL\fR" 4 +sets the ftp proxy to be used by apt. By default, this is empty but if the host has the environment variable ftp_proxy set, apt-ftp-proxy gets automatically set to the value of ftp_proxy. .IP "\fB\-\-apt\-http\-proxy\fR \fIURL\fR" 4 +sets the http proxy to be used by apt. By default, this is empty but if the host has the environment variable http_proxy set, apt-http-proxy gets automatically set to the value of http_proxy. .IP "\fB\-\-apt\-pdiffs\fR enabled|disabled" 4 +defines whetever apt should use incremental package indices feature or not. This is enabled by default. +.IP "\fB\-\-apt\-options\fR \fIOPTION\fR|"\fIOPTIONS\fR"" 4 +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. +.IP "\fB\-\-aptitude\-options\fR \fIOPTION\fR|""\fIOPTIONS\fR""" 4 +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. .IP "\fB\-\-apt\-pipeline\fR \fIFIXME\fR" 4 +FIXME .IP "\fB\-\-apt\-recommends\fR enabled|disabled" 4 +defines if apt should install recommended packages automatically. By default, this is enable in the debian mode and disabled in emdebian mode. .IP "\fB\-\-apt\-secure\fR enabled|disabled" 4 +defines if apt should check repository signatures. This is enabled by default. .IP "\-a|\fB\-\-architecture\fR \fIARCHITECTURE\fR" 4 +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 possile if you have a 64bit capable i386 processor and the right kernel. But building powerpc images on an i386 system is not possible. .IP "\-b|\fB\-\-binary\-images\fR iso|net|tar|usb\-hdd" 4 -.IP "\fB\-\-binary\-filesystem\fR fat16|fat32" 4 +defines the image type to build. By default this is set to iso to build CD/DVD images. +.IP "\fB\-\-binary\-filesystem\fR fat16|fat32|ext2" 4 +defines the filesystem to be used in the image type. This only has an effect if the selected binary image type does allow to choose a filesystem. For example, when selection iso the resulting CD/DVD has always the filesystem ISO9660. When building usb-hdd images for usb sticks, this is active. Note that it defaults to fat16 on all architectures except sparc where it defaults to ext2. Also note that if you choose fat16 and your resulting binary image gets bigger than 2GB, the binary filesystem automatically gets switched to fat32. .IP "\fB\-\-binary\-indices\fR enabled|disabled" 4 +defines if the resulting images should have binary indices or not and defaults to enabled. .IP "\fB\-\-bootappend\-install\fR \fIPARAMETER\fR|\fI""PARAMETERS""\fR" 4 +sets boot parameters specific to debian-installer, if included. .IP "\fB\-\-bootappend\-live\fR \fIPARAMETER\fR|\fI""PARAMETERS""\fR" 4 +sets boot parameters specific to debian-live. A complete list of boot parameters can be found, for etch, in the manpage of casper, for all other distributions in the manpage of live-initramfs. On the images, a list of all parameters (without comments) is included in the /parameters.txt. .IP "\fB\-\-bootloader\fR grub|syslinux|yaboot" 4 -.IP "\fB\-\-bootstrap\fR cdebootstrap|debootstrap|copy" 4 +defines which bootloader is beeing used in the generated image. This has only an effect if the selected binary image type does allow to 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\-helper does not support them yet. lh_config will fail to create such a not yet supported configuration and give a explanation about it. For usb-hdd images on amd64 and i386, the default is syslinux. yaboot is only used on powerpc. +.IP "\fB\-\-bootstrap\fR cdebootstrap|cdebootstrap-static|debootstrap|copy" 4 +defines which program is used to bootstrap the debian chroot, default is debootstrap. Note that if you set the bootstrap program to copy, then your host system is copied. This can be usefull if you want to convert/clone your existing host system into a live system, however, make sure you do have enough free space as this can, depending on your host system, get quite big. .IP "\fB\-\-bootstrap\-config\fR \fIFILE\fR" 4 +sets a custom configuration file for the boostrap programm of choice and is empty by default. Refere to the documentation of debootstrap or cdebootstrap for more information about that. When the bootstrap program is set to copy, this has no effect. .IP "\-f|\fB\-\-bootstrap\-flavour\fR minimal|standard" 4 +defines if the bootstrap program should bootstrap the standard system (all packages of priority required and important, which is the default) or a minimal system (only packages of priority required, plus apt). .IP "\fB\-\-bootstrap\-keyring\fR \fIPACKAGE\fR" 4 +sets the archive keyring package to be used. Default is debian-archive-keyring. .IP "\fB\-\-cache\fR enabled|disabled" 4 +defines globally if any cache should be used at all. Different caches can be controled through the their own options. .IP "\fB\-\-cache\-indices\fR enabled|disabled" 4 +defines if downloaded package indices and lists should be cached which is disabled by default. Enabling it would allow to rebuild an image completely offline, however, you would not get updates anymore then. .IP "\fB\-\-cache\-packages\fR enabled|disabled" 4 -.IP "\fB\-\-cache\-stages\fR \fISTAGE\fR|\fI""STAGES""\fR" 4 +defines if downloaded packages files should be cached which is enabled by default. Disabling it does save space consumtion 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 enabled, 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. +.IP "\fB\-\-cache\-stages\fR enabled|disabled|\fISTAGE\fR|\fI""STAGES""\fR" 4 +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 usefull during development if you want to rebuild the binary stage but not regenerate the root filesystem all the time. .IP "\fB\-\-checksums\fR enabled|disabled" 4 +defines if the binary image should contain a file called md5sums.txt that lists all files on the image together with their md5 checksums. This in turn can be used by live-initramfs' built-in integrity-check to verify the medium if specified at boot prompt. In general, this should not be disabled 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. .IP "\fB\-\-chroot\-build\fR enabled|disabled" 4 -.IP "\fB\-\-chroot\-filesystem\fR ext2|ext3|squashfs|plain" 4 +defines whetever live-helper should use the tools from within the chroot to build the binary image or not by using and including the host systems 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, grub and yaboot, and the auxilliary tools such as dosfstools, genisoimage, squashfs-tools and others) do not \fBexactely\fR match what is present at build-time in the target distribution. Never do disable this option unless you are \fBexactely\fR sure what you are doing and have \fBcompletely\fI understood its consequences. +.IP "\fB\-\-chroot\-filesystem\fR ext2|ext3|squashfs|plain|jffs2" 4 +defines which filesystem type should be used for the root filesystem image. If you use plain, 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 choosen, it may not be possible to build with a plain root filesystem, e.g. fat16/fat32 and plain don't work as linux does not support to run on them. .IP "\-c|\fB\-\-conffile\fR \fIFILE\fR" 4 +using a user specified alternative configuration file in addition to the normally used one in the config directory. .IP "\fB\-\-debconf\-frontend\fR dialog|editor|noninteractive|readline" 4 +defines what value the debconf frontend should be set to inside the chroot. Note that setting it to anything by noninteractive, which is the default, makes your build asking questions during the build. .IP "\fB\-\-debconf\-nowarnings\fR enabled|disabled" 4 +defines if warnings of debconf should be displayed or not. Warnings from debconf are generally very rare and by default, we skipp them, if any, in order to keep the build process entirely non interactive. .IP "\fB\-\-debconf\-priority\fR low|medium|high|critical" 4 -.IP "\fB\-\-debian\-installer\fR enabled|disabled" 4 +defines what value the debconf priority shoul dbe set to inside the chroot. By default, it is set to critical, which means that almost none questions are displayed. Note that this only has an effect if you use any debconf frontend different from noninteractive. +.IP "\fB\-\-debian\-installer\fR enabled|cdrom|netinst|netboot|businesscard|live|disabled" 4 +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 choosen, 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. .IP "\fB\-\-debian\-installer\-distribution\fR daily|\fICODENAME\fR" 4 +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. +.IP "\fB\-\-debian\-installer\-preseedfile\fR \fIFILE\fR|\fIURL\fR" 4 +sets the filename or URL for an optionally used and included preseeding file for debian\-installer. .IP "\-d|\fB\-\-distribution\fR \fICODENAME\fR" 4 -.IP "\-e|\fB\-\-encryption\fR aes128|aes192|aes256" 4 -.IP "\fB\-\-fdisk\fR \fIPROGRAM\fR" 4 +defines the distribution of the resulting live system. +.IP "\-\-\fBdump\fR" 4 +prepares a report of the currently present live system configuration and the version of live\-helper used. This is usefull to provide if you submit bug reports, we do get all informations required for us to locate and replicate an error. +.IP "\-e|\fB\-\-encryption\fR disabled|aes128|aes192|aes256" 4 +defines if the root filesystem should be encrypted or not. By default, this is disabled. +.IP "\fB\-\-fdisk\fR fdisk|fdisk.dist" 4 +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. +.IP "\fB\-\-genisoimage\fR genisomage|mkisofs" 4 +sets the filename of the genisoimage binary from the host system that should be used. This is autodetected and does generally not need any customization. .IP "\fB\-\-grub\-splash\fR \fIFILE\fR" 4 +defines the name of an optional to be included splash screen graphic for the grub bootloader. .IP "\fB\-\-hooks\fR \fIFILE\fR" 4 +defines which hooks available in /usr/share/live-helper/examples/hooks should be activated. Normally, there are no hooks executed. Make sure you know and understood the hook before you enable it. .IP "\fB\-\-hostname\fR \fINAME\fR" 4 +sets the hostname of the live system. +.IP "\fB\-\-ignore\-system\-defaults\fR" 4 +lh_config by default reads system defaults from /etc/default/live-helper when generating a new live system config directory. This is usefull if you want to set global settings, such as mirror locations, and don't want to specify them all of the time. .IP "\fB\-\-includes\fR \fIPATH\fR" 4 +sets the path to the includes that live\-helper is going to use, e.g. additional minimal documentation that you want to have on all live systems. By default, this is set to /usr/share/live-helper/includes/. .IP "\fB\-\-initramfs\fR auto|live\-initramfs|casper" 4 +sets the name of package that contains the live system specific initramfs modification. By default, auto is used, which means that at build time of the image rather than on configuration time, the value will be expanded to casper when building etch systems and to live\-initramfs for all other systems. .IP "\fB\-\-interactive\fR shell" 4 +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 disabled. .IP "\fB\-\-iso\-application\fR \fINAME\fR" 4 -.IP "\fB\-\-iso\-preparer\fR \fINAME\fR" " 4 +sets the APPLICATION field in the header of a resulting CD/DVD image and defaults to "Debian Live" in debian mode, and to "Emdebian Live" in emdebian mode. +.IP "\fB\-\-iso\-preparer\fR \fINAME\fR" 4 +sets the PREPARER field in the header of a resulting CD/DVD image. By default this is set to "live-helper \fIVERSION\fR; http://packages.qa.debian.org/live-helper", whereas VERSION is exanded to the version of live-helper that was used to build the image. .IP "\fB\-\-iso\-publisher\fR \fINAME\fR" 4 +sets the PUBLISHED field in the header of a resulting CD/DVD image. By default, this is set to 'Debian Live project; http://debian-live.alioth.debian.org/; debian-live@lists.debian.org'. Remember to change this to the appropriate values at latest when you distributing custom and unofficial images. .IP "\fB\-\-iso\-volume\fR \fINAME\fR" 4 -.IP "\fB\-\-keyring\-packages\fR \fIPACKAGE\fI|\fI""PACKAGES""\fR" 4 +sets the VOLUME field in the header of a resulting CD/DVD and defaults to 'Debian Live (\fIDATE\fR)' in debian mode, and 'Emdebian Live (\fIDATE\fR)' in emdebian mode, whereas DATE is expanded with the current date and time of the generation. +.IP "\fB\-\-jffs2\-eraseblock\fR \fISIZE\fR" 4 +FIXME +.IP "[\fB\-\-keyring\-packages\fR \fIPACKAGE\fI|\fI"PACKAGES"\fR" 4 +sets the keyring package or additional keyring packages. By default this is set to debian-archive-keyring. .IP "\-l|\fB\-\-language\fR \fILANGUAGE\fR" 4 -.IP "\-k|\fB\-\-linux\-flavours\fR \fIFLAVOUR\fR|\fI""FLAVOURS""\fR" 4 -.IP "\fB\-\-linux\-packages\fR \fI""PACKAGES""\fR" 4 +sets the language of a live system by installing l10n related packages and enables generation of the correct locales through automatically setting the right boot parameters. +.IP "\-k|\fB\-\-linux\-flavours\fR \fIFLAVOUR\fR|\fI"FLAVOURS"\fR" 4 +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 bootet. +.IP "\fB\-\-linux\-packages\fR \fI"PACKAGES"\fR" 4 +sets the internal name of the kernel packges naming scheme. If you use debian kernel packges, 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 \fISTUB\fR-\fIFLAVOUR\fR results in a valid package name (for debian e.g. linux-image-2.6-486). 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. .IP "\fB\-\-losetup\fR losetup|losetup.orig" 4 -.IP "\fB\-\-memtest\fR memtest86+|memtest86" 4 -.IP "\-m|\fB\-\-mirror\-binary\-security\fR \fIURL\fR" 4 +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. +.IP "\fB\-\-memtest\fR memtest86+|memtest86|none" 4 +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+. +.IP "\-m|\fB\-\-mirror\-bootstrap\fR \fIURL\fR" 4 +sets the location of the debian package mirror that should be used to bootstrap from. .IP "\fB\-\-mirror\-binary\fR \fIURL\fR" 4 -.IP "\fB\-\-mirror\-bootstrap\-security\fR \fIURL\fR" 4 -.IP "\fB\-\-mirror\-bootstrap\fR \fIURL\fR" 4 -.IP "\fB\-\-mode\fR debian|debian\-edu" 4 +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. By default, the same value that is used for \-\-mirror\-chroot is used here unless specified different. +.IP "\fB\-\-mirror\-binary\-security\fR \fIURL\fR" 4 +sets the location of the debian security package mirror that should end up configuered in the final image. By default, the same value that is used for \-\-mirror\-chroot\-security is used here unless specified different. +.IP "\fB\-\-mirror\-chroot\fR \fIURL\fR" 4 +sets the location of the debian package mirror that will be used to fetch the packages in order to build the live system. By default, this points to http://ftp.us.debian.org/debian/ which may not be a good default if you live outside the U.S. +.IP "\fB\-\-mirror\-chroot\-security\fR \fIURL\fR" 4 +sets the location of the debian security package mirror that will be used to fetch the packages in order to build the live system. By default, this points to http://security.debian.org/debian/. +.IP "\fB\-\-mode\fR debian|emdebian" 4 +defines a global mode to load project specific defaults. By default this is set to debian. .IP "\fB\-\-net\-root\-filesystem\fR nfs|cfs" 4 +defines the filesystem that will be configured in the bootloader configuration for your netboot image. This defaults to nfs. .IP "\fB\-\-net\-root\-mountoptions\fR \fIOPTIONS\fR" 4 +sets additional options for mounting the root filesystem in netboot images and is by default empty. .IP "\fB\-\-net\-root\-path\fR \fIPATH\fR" 4 +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 to /srv/emebian-live when being in emdebian mode. .IP "\fB\-\-net\-root\-server\fR \fIIP\fR|\fIHOSTNAME\fR" 4 +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. .IP "\fB\-\-net\-cow\-filesystem\fR nfs|cfs" 4 +defines the filesystem type for the copy-on-write layer and defaults to nfs. .IP "\fB\-\-net\-cow\-mountoptions\fR \fIOPTIONS\fR" 4 - +sets additional options for mounting the copy-on-write layer in netboot images and is by default empty. .IP "\fB\-\-net\-cow\-path\fR \fIPATH\fR" 4 -Specify path to client writable filesystem. Anywhere that -\fBclient_mac_address\fR is specified in the path live\-initramfs will -substitute the MAC address of the client delimited with hyphens. +defines the path to client writable filesystem. Anywhere that \fIclient_mac_address\fR is specified in the path live\-initramfs will substitute the MAC address of the client delimited with hyphens. .PP .IP "" 4 Example: @@ -261,54 +347,69 @@ Example: /export/hosts/client_mac_address .br /export/hosts/00\-16\-D3\-33\-92\-E8 - .IP "\fB\-\-net\-cow\-server\fR \fIIP\fR|\fIHOSTNAME\fR" 4 +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. +.IP "\fB\-\-net\-tarball\fR bzip2|gzip|tar|none" 4 +defines the format of the netboot image. Choosing tar results in a not compressed tarball, bzip2 and gzip in a bzip2 resp. gzip compressed tarball. Choosing none leads to no tarball at all, the plain binary directory is considered the output in this case. Default is gzip. .IP "\-p|\fB\-\-packages\-lists\fR \fIFILE\fR" 4 +defines which lists available in /usr/share/live-helper/lists should be used. By default, this is set to standard. Note that in case you have local packages lists, you also need to list them here. Putting them into config/chroot_local-packageslists is not enough. .IP "\fB\-\-packages\fR \fIPACKAGE\fR|\fI""PACKAGES""\fR" 4 -.IP "\fB\-\-root\-command\fR sudo" 4 -.IP "\fB\-\-use\-fakeroot\fR enabled|disabled" 4 +defines one or more packages to be installed in the live system. This is a quick and convenient place to add a few packages when building an image (limited by the max length of shell). Packages that should be permanently installed should be put into a local packages list. +.IP "\fB\-\-root-command\fR sudo" 4 +controls if live-helper should use sudo internally to build the live image. Note that this is not well tested and that you should, when relaying on sudo, call the individual live\-helper command with sudo itself. +.IP "\fB\-\-use-fakeroot\fR enabled|disabled" 4 +FIXME .IP "\fB\-\-categories\fR \fICATEGORY\fR|\fI""CATEGORIES""\fR" 4 +defines which package categories 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. .IP "\fB\-\-security\fR enabled|disabled" 4 +defines if the security repositories specified in the security mirror options should be used or not. .IP "\fB\-\-source\fR enabled|disabled" 4 -.IP "\-s|\fB\-\-source\-images\fR iso|net|tar|usb\-hdd" 4 +defines if a corresponding source image to the binary image should be build. By default this is disabled 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. +.IP "\-s|\fB\-\-source\-images\fR iso|net|tar|usb-hdd" 4 +defines the image type for the source image. Default is tar. .IP "\fB\-\-symlinks\fR enabled|disabled" 4 +defines if the symlink hack should be enabled or disabled. The symlink hack converts all absolute symlinks to relative ones. By default this is disabled and in general there is no need or gain to enable it. If you are in a special situation that requires this, you will know. .IP "\fB\-\-syslinux\-splash\fR \fIFILE\fR" 4 +defines the file of the syslinux splash graphic that should be used instead of the default one. .IP "\fB\-\-syslinux\-timeout\fR \fISECONDS\fR" 4 +defines the timeout the syslinux bootloader should wait for input from the user at the bootprompt prior booting the default kernel. This defaults to 0 which means it will wait forever. .IP "\fB\-\-syslinux\-menu\fR enabled|disabled" 4 +defines if syslinux should be make use of the vgamenu capabilities or not. .IP "\fB\-\-sysvinit\fR enabled|disabled" 4 +defines it the sysvinit hack should be enabled or disabled. The sysvinit hack disables all non-essential services from starting up at bootup in order to reduce overall boottime. By default this is disabled and in general there you don't want to enable it. .IP "\fB\-\-tasksel\fR aptitude|tasksel" 4 +selects which program is used to install tasks. By default, this is set to tasksel. .IP "\fB\-\-tasks\fR \fITASK\fR" 4 +defines one or more package tasks to be installed in the live system. This is a quick and convenient way to get a reasonable default selection of packages suitable for most users when building an image, but it results in quite big images. If you want to have finer grained package selections, local packages lists should be used instead. .IP "\fB\-\-templates\fR \fIPATH\fR" 4 +sets the path to the templates that live\-helper is going to use, e.g. for bootloaders. By default, this is set to /usr/share/live-helper/templates/. .IP "\fB\-\-union\-filesystem\fR aufs|unionfs" 4 +defines whetever to use UnionFS or Aufs as stackable unification filesystem. When building etch images, this defaults to unionfs, everywhere else to aufs. .IP "\fB\-\-exposed\-root\fR enabled|disabled" 4 +FIXME .IP "\fB\-\-username\fR \fINAME\fR" 4 +sets the name of the account of the default user in the live system. +.IP "\fB\-\-win32\-loader enabled|disabled" 4 +defines if win32\-loader should be included in the binary image or not. .SH ENVIRONMENT -All command line switches can also be specified through the corresponding -environment variable. Environment variables are name LH_FOO, means, e.g. -\-\-apt\-ftp\-proxy becomes LH_APT_FTP_PROXY. +All command line switches can also be specified through the corresponding environment variable. Environment variables are name LH_FOO, means, e.g. \-\-apt\-ftp\-proxy becomes LH_APT_FTP_PROXY. However, this generally should not be used. .SH FILES .I /etc/default/live-helper .PP -An optional conffile for lh_config defaults, useful to specify a few system wide defaults, like -LH_MIRROR_BOOTSTRAP. This feature can be disabled by specifying the -\fB\-\-ignore\-system\-defaults\fR option. +An optional, global configuration file for lh_config variables. It is useful to specify a few system wide defaults, like LH_MIRROR_BOOTSTRAP. This feature can be disabled by specifying the \fB\-\-ignore\-system\-defaults\fR option. .SH SEE ALSO \fIlive\-helper\fR(7) .PP This program is a part of live\-helper. -.SH BUGS -Report bugs against live\-helper -<\fIhttp://packages.qa.debian.org/live\-helper\fR>. - .SH HOMEPAGE -More information about the Debian Live project can be found at -<\fIhttp://debian\-live.alioth.debian.org/\fR> and -<\fIhttp://wiki.debian.org/DebianLive/\fR>. +More information about live\-helper and the Debian Live project can be found in the homepage at <\fIhttp://debian\-live.alioth.debian.org/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>. + +.SH BUGS +Report bugs by submitting a bugreport for the live\-helper package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or write a mail to the mailinglist at <\fIdebian-live@lists.debian.org\fR>. .SH AUTHOR -live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the -Debian project. +live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project. diff --git a/manpages/lh_source.en.1 b/manpages/lh_source.en.1 index 0cd8266..ebd9eb5 100644 --- a/manpages/lh_source.en.1 +++ b/manpages/lh_source.en.1 @@ -1,29 +1,27 @@ -.TH LH_SOURCE 1 "2008\-08\-11" "1.0" "live\-helper" +.TH LH_SOURCE 1 "2009\-01\-23" "1.0.2" "live\-helper" .SH NAME -lh_source \- meta\-helper for lh_source_* +lh_source \- create the optional fourth stage by generating a source image .SH SYNOPSIS \fBlh_source\fR [\fIlive\-helper options\fR] .SH DESCRIPTION -lh_source is a meta\-helper. It calls all necessary live\-helper programs in the -correct order to complete the source stage. +lh_source is a high\-level command (porcelain) of live\-helper, the Debian Live tool suite. It calls all necessary live\-helper programs in the correct order to complete the source stage. + +.SH OPTIONS +lh_source has no specific options but understands all generic live\-helper options. See \fIlive\-helper\fR(7) for a complete list of all generic live\-helper options. .SH SEE ALSO \fIlive\-helper\fR(7) .PP -This program is part of live\-helper. - -.SH BUGS -Report bugs against live\-helper -<\fIhttp://packages.qa.debian.org/live\-helper\fR>. +This program is a part of live\-helper. .SH HOMEPAGE -More information about the Debian Live project can be found at -<\fIhttp://debian\-live.alioth.debian.org/\fR> and -<\fIhttp://wiki.debian.org/DebianLive/\fR>. +More information about live\-helper and the Debian Live project can be found in the homepage at <\fIhttp://debian\-live.alioth.debian.org/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>. + +.SH BUGS +Report bugs by submitting a bugreport for the live\-helper package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or write a mail to the mailinglist at <\fIdebian-live@lists.debian.org\fR>. .SH AUTHOR -live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the -Debian project. +live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project. diff --git a/manpages/lh_testroot.en.1 b/manpages/lh_testroot.en.1 index c2c9111..b8eea87 100644 --- a/manpages/lh_testroot.en.1 +++ b/manpages/lh_testroot.en.1 @@ -1,30 +1,29 @@ -.TH LH_TESTROOT 1 "2008\-08\-11" "1.0" "live\-helper" +.TH LH_TESTROOT 1 "2009\-01\-23" "1.0.2" "live\-helper" .SH NAME lh_testroot \- ensure that a system is built as root .SH SYNOPSIS -.B lh_testroot [\fIlive\-helper\ options\fR] +\fBlh_testroot\fR [\fIlive\-helper\ options\fR] .SH DESCRIPTION -lh_testroot simply checks to see if you are root. If not, it exits with an -error. Debian Live images must currently be built as real root, -support for \fIfakeroot\fR(1) and \fIsudo\fR(8) is still experimental. +lh is a high\-level command (porcelain) of live\-helper, the Debian Live tool suite. It simply checks to see if you are root. If not, it exits with an error. Debian Live images must currently be built as real root. +.PP +Support for using \fIfakeroot\fR(1) and \fIsudo\fR(8) internally in live\-helper itself is still experimental, however, calling a helper yourself with sudo is safe. + +.SH OPTIONS +lh_testroot has no specific options but understands all generic live\-helper options. See \fIlive\-helper\fR(7) for a complete list of all generic live\-helper options. .SH SEE ALSO \fIlive\-helper\fR(7) .PP This program is a part of live\-helper. -.SH BUGS -Report bugs against live\-helper -<\fIhttp://packages.qa.debian.org/live\-helper\fR>. - .SH HOMEPAGE -More information about the Debian Live project can be found at -<\fIhttp://debian\-live.alioth.debian.org/\fR> and -<\fIhttp://wiki.debian.org/DebianLive/\fR>. +More information about live\-helper and the Debian Live project can be found in the homepage at <\fIhttp://debian\-live.alioth.debian.org/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>. + +.SH BUGS +Report bugs by submitting a bugreport for the live\-helper package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or write a mail to the mailinglist at <\fIdebian-live@lists.debian.org\fR>. .SH AUTHOR -live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the -Debian project. +live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project. diff --git a/manpages/live-helper.en.7 b/manpages/live-helper.en.7 index 4a0415f..cbd93b5 100644 --- a/manpages/live-helper.en.7 +++ b/manpages/live-helper.en.7 @@ -1,138 +1,24 @@ -.TH LIVE\-HELPER 7 "2008\-08\-11" "1.0" "live\-helper" +.TH LIVE\-HELPER 7 "2009\-01\-23" "1.0.2" "live\-helper" .SH NAME live\-helper \- the Debian Live tool suite .SH SYNOPSIS -\fBlh_\fR\fI*\fR [\fB\-h|\-\-help\fR] [\fB\-u|\-\-usage\fR] [\fB\-v|\-\-version\fR] - -.SH DESCRIPTION -live\-helper is used to help you build a Debian Live system. The philosophy -behind live\-helper is to provide a collection of small, simple, and easily -understood tools that are used on a config directory to automate all aspects of -building a Debian Live image. - -.SH LIVE\-HELPER COMMANDS -Here is the complete list of available live\-helper commands. See their man -pages for additional documentation. -.IP "\fIlh\fR(1)" 4 -generic live\-helper wrapper -.IP "\fIlh_binary\fR(1)" 4 -meta\-helper for lh_binary_* -.IP "\fIlh_binary_chroot\fR(1)" 4 -.IP "\fIlh_binary_debian-installer\fR(1)" 4 -.IP "\fIlh_binary_disk\fR(1)" 4 -.IP "\fIlh_binary_encryption\fR(1)" 4 -.IP "\fIlh_binary_grub\fR(1)" 4 -.IP "\fIlh_binary_includes\fR(1)" 4 -.IP "\fIlh_binary_iso\fR(1)" 4 -.IP "\fIlh_binary_linux-image\fR(1)" 4 -.IP "\fIlh_binary_local-hooks\fR(1)" 4 -.IP "\fIlh_binary_local-includes\fR(1)" 4 -.IP "\fIlh_binary_local-packageslists\fR(1)" 4 -.IP "\fIlh_binary_manifest\fR(1)" 4 -.IP "\fIlh_binary_md5sum\fR(1)" 4 -.IP "\fIlh_binary_memtest\fR(1)" 4 -.IP "\fIlh_binary_net\fR(1)" 4 -.IP "\fIlh_binary_rootfs\fR(1)" 4 -.IP "\fIlh_binary_syslinux\fR(1)" 4 -.IP "\fIlh_binary_tar\fR(1)" 4 -.IP "\fIlh_binary_usb-hdd\fR(1)" 4 -.IP "\fIlh_binary_yaboot\fR(1)" 4 -.IP "\fIlh_bootstrap\fR(1)" 4 -meta\-helper for lh_bootstrap_* -.IP "\fIlh_bootstrap_cache\fR(1)" 4 -.IP "\fIlh_bootstrap_cdebootstrap\fR(1)" 4 -.IP "\fIlh_bootstrap_copy\fR(1)" 4 -.IP "\fIlh_bootstrap_debootstrap\fR(1)" 4 -.IP "\fIlh_build\fR(1)" 4 -meta\-helper for lh_bootstrap, lh_chroot, lh_binary, and lh_source -.IP "\fIlh_chroot\fR(1)" 4 -meta\-helper for lh_chroot_* -.IP "\fIlh_chroot_apt\fR(1)" 4 -.IP "\fIlh_chroot_cache\fR(1)" 4 -.IP "\fIlh_chroot_debianchroot\fR(1)" 4 -.IP "\fIlh_chroot_devpts\fR(1)" 4 -.IP "\fIlh_chroot_dpkg\fR(1)" 4 -.IP "\fIlh_chroot_hacks\fR(1)" 4 -.IP "\fIlh_chroot_hooks\fR(1)" 4 -.IP "\fIlh_chroot_hostname\fR(1)" 4 -.IP "\fIlh_chroot_hosts\fR(1)" 4 -.IP "\fIlh_chroot_interactive\fR(1)" 4 -.IP "\fIlh_chroot_linux-image\fR(1)" 4 -.IP "\fIlh_chroot_local-hooks\fR(1)" 4 -.IP "\fIlh_chroot_local-includes\fR(1)" 4 -.IP "\fIlh_chroot_local-packages\fR(1)" 4 -.IP "\fIlh_chroot_local-packageslists\fR(1)" 4 -.IP "\fIlh_chroot_local-preseed\fR(1)" 4 -.IP "\fIlh_chroot_localization\fR(1)" 4 -.IP "\fIlh_chroot_packages\fR(1)" 4 -.IP "\fIlh_chroot_packageslists\fR(1)" 4 -.IP "\fIlh_chroot_preseed\fR(1)" 4 -.IP "\fIlh_chroot_proc\fR(1)" 4 -.IP "\fIlh_chroot_resolv\fR(1)" 4 -.IP "\fIlh_chroot_sources\fR(1)" 4 -.IP "\fIlh_chroot_symlinks\fR(1)" 4 -.IP "\fIlh_chroot_sysfs\fR(1)" 4 -.IP "\fIlh_chroot_sysv-rc\fR(1)" 4 -.IP "\fIlh_chroot_sysvinit\fR(1)" 4 -.IP "\fIlh_chroot_tasks\fR(1)" 4 -.IP "\fIlh_clean\fR(1)" 4 -clean up build directories -.IP "\fIlh_config\fR(1)" 4 -create configuration directory -.IP "\fIlh_source\fR(1)" 4 -meta\-helper for lh_source_* -.IP "\fIlh_source_debian\fR(1)" 4 -.IP "\fIlh_source_debian-live\fR(1)" 4 -.IP "\fIlh_source_disk\fR(1)" 4 -.IP "\fIlh_source_iso\fR(1)" 4 -.IP "\fIlh_source_md5sum\fR(1)" 4 -.IP "\fIlh_source_net\fR(1)" 4 -.IP "\fIlh_source_tar\fR(1)" 4 -.IP "\fIlh_source_usb-hdd\fR(1)" 4 -.IP "\fIlh_testroot\fR(1)" 4 -ensure that a system is built as root -.PP -If a program's name starts with "lh_", and the program is not on the above list, -then it is not part of the live\-helper package, but it should still work like -the other programs described on this page. - -.SH LIVE\-HELPER CONFIG FILES -Many live\-helper 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\-helper commands, some additional files can be used to configure the -behavior of specific live\-helper 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). +\fBlh \fR\fICOMMAND\fR [\fB\-h|\-\-help\fR] [\fB\-u|\-\-usage\fR] [\fB\-v|\-\-version\fR] [\fB\-\-breakpoints\fR] [\fB\-\-conffile\fR] [\fB\-\-debug\fR] [\fB\-\-force\fR] [\fB\-\-quiet\fR] [\fB\-\-verbose\fR] .PP -For example, lh_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\-helper use pairs of values or slightly more -complicated variable assignments. +or .PP -Note that live\-helper 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\-helper will automatically set it to the -default value. +\fBlh_\fR\fICOMMAND\fR [\fB\-h|\-\-help\fR] [\fB\-u|\-\-usage\fR] [\fB\-v|\-\-version\fR] [\fB\-\-breakpoints\fR] [\fB\-\-conffile\fR] [\fB\-\-debug\fR] [\fB\-\-force\fR] [\fB\-\-quiet\fR] [\fB\-\-verbose\fR] + +.SH DESCRIPTION +live\-helper is a set of scripts to build Debian Live system images. The idea behind live-helper is a framework that uses a configuration directory to completely automate and customize all aspects of building a Live image. .PP -In some rare cases, you may want to have different versions of these files for -different architectures or distributions. If files named config/stage.arch or -config/stage_helper.arch, and config/stage.dist or config/stage_helper.dist -exist, where "arch" is the same as the output of "dpkg \-\-print\-architecture" -and "dist" is the same as the codename of the target distribution, then they -will be used in preference to other, more general files. +The \fICOMMAND\fR is a name of a live\-helper command (see below). .PP -All config files are shell scripts which are sourced by a live\-helper program. -That means they have to follow the normal shell syntax. You can also put -comments in these files; lines beginning with "#" are ignored. +More documentation about how to use live\-helper is available in the individual manpages for each helper and in the manual at <\fIhttp://live.debian.net/manual/\fR>. -.SH SHARED LIVE\-HELPER OPTIONS +.SH OPTIONS +.SS Shared live\-helper options The following command line options are supported by all live\-helper programs. .IP "\fB-h, --help\fR" 4 display help and exit. @@ -140,11 +26,8 @@ display help and exit. show usage and exit. .IP "\fB-v, --version\fR" 4 output version information and exit. - -.SH COMMON LIVE\-HELPER OPTIONS -The following command line options are supported by some live\-helper programs. -See the man page of each program for a complete explanation of what each option -does. +.SS Common live\-helper options +The following command line options are supported by most live\-helper programs. See the man page of each program for a complete explanation of what each option does. .IP "\fB\-\-breakpoints\fR" 4 run with breakpoints. .IP "\fB\-\-conffile\fR" 4 @@ -157,23 +40,194 @@ force helper execution, even if stage file exists. be quiet. .IP "\fB\-\-verbose\fR" 4 be verbose. +.PP +If a program's name starts with "lh_", and the program is not on the list below list, then it is not part of the live\-helper package, but it should still work like the other programs described on this page. -.SH SEE ALSO -\fIlive\-initramfs\fR(7) +.SH LIVE\-HELPER COMMANDS +We divide live\-helper into high level ("porcelain") commands and low level ("plumbing") commands. .PP -\fIlive\-initscripts\fR(7) +Here is the complete list of all available live\-helper commands. See their man +pages for additional documentation. + +.SH HIGH\-LEVEL COMMANDS (PORCELAIN) +We separate the porcelain commands into the main commands and some ancillary user utilities. +.SS Main porcelain commands +.IP "\fBlh_config\fR(1)" 4 +create configuration for live\-helper +.IP "\fBlh_bootstrap\fR(1)" 4 +create the first stage by bootstrapping a basic debian system +.IP "\fBlh_chroot\fR(1)" 4 +create the second stage by customizing the chroot +.IP "\fBlh_binary\fR(1)" 4 +create the third stage by generating a binary image +.IP "\fBlh_source\fR(1)" 4 +create the optional fourth stage by generating a source image +.IP "\fBlh_clean\fR(1)" 4 +clean up system build directories +.SS Ancillary Commands +.IP "\fBlh\fR(1)" 4 +generic live\-helper wrapper +.IP "\fBlh_build\fR(1)" 4 +alias for all stages +.IP "\fBlh_local\fR(1)" 4 +helper for using a local live\-helper +.IP "\fBlh_testroot\fR(1)" 4 +ensure that a system is built as root + +.SH LOW-LEVEL COMMANDS (PLUMBING) +The actual work of live\-helper 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\-helper commands in your own scripts, then the plumbings might be of interest for you. .PP -\fIlive\-webhelper\fR(7) +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 +.IP "\fBlh_bootstrap_cache\fR(1)" 4 +cache bootstrap stage +.IP "\fBlh_bootstrap_cdebootstrap\fR(1)" 4 +bootstrap a Debian system with cdebootstrap(1) +.IP "\fBlh_bootstrap_copy\fR(1)" 4 +bootstrap by copying the host system +.IP "\fBlh_bootstrap_debootstrap\fR(1)" 4 +bootstrap a Debian system with debootstrap(8) +.SS Chroot commands +.IP "\fBlh_chroot_apt\fR(1)" 4 +manage /etc/apt/apt.conf +.IP "\fBlh_chroot_cache\fR(1)" 4 +cache chroot stage +.IP "\fBlh_chroot_debianchroot\fR(1)" 4 +manage /etc/debian_chroot +.IP "\fBlh_chroot_devpts\fR(1)" 4 +mount /dev/pts +.IP "\fBlh_chroot_dpkg\fR(1)" 4 +manage /sbin/dpkg +.IP "\fBlh_chroot_hacks\fR(1)" 4 +execute hacks in chroot +.IP "\fBlh_chroot_hooks\fR(1)" 4 +execute hooks in chroot +.IP "\fBlh_chroot_hostname\fR(1)" 4 +manage /bin/hostname +.IP "\fBlh_chroot_hosts\fR(1)" 4 +manage /etc/hosts +.IP "\fBlh_chroot_install-packages\fR(1)" 4 +install queued packages into chroot +.IP "\fBlh_chroot_interactive\fR(1)" 4 +make build interactive +.IP "\fBlh_chroot_linux-image\fR(1)" 4 +manage /etc/kernel-img.conf +.IP "\fBlh_chroot_local-hooks\fR(1)" 4 +execute local hooks in chroot +.IP "\fBlh_chroot_local-includes\fR(1)" 4 +copy local files into chroot +.IP "\fBlh_chroot_localization\fR(1)" 4 +install localization packages into chroot +.IP "\fBlh_chroot_local-packages\fR(1)" 4 +queue install of local packages into chroot +.IP "\fBlh_chroot_local-patches\fR(1)" 4 +apply local patches against chroot +.IP "\fBlh_chroot_local-preseed\fR(1)" 4 +use debconf local preseeding file +.IP "\fBlh_chroot_packages\fR(1)" 4 +queue install of packages into chroot +.IP "\fBlh_chroot_packageslists\fR(1)" 4 +queue install of packages lists into chroot +.IP "\fBlh_chroot_preseed\fR(1)" 4 +use debconf preseeding file +.IP "\fBlh_chroot_proc\fR(1)" 4 +mount /proc +.IP "\fBlh_chroot_resolv\fR(1)" 4 +manage /etc/resolv.conf +.IP "\fBlh_chroot_selinuxfs\fR(1)" 4 +mount /selinux +.IP "\fBlh_chroot_sources\fR(1)" 4 +manage /etc/apt/sources.list +.IP "\fBlh_chroot_symlinks\fR(1)" 4 +convert symlinks +.IP "\fBlh_chroot_sysfs\fR(1)" 4 +mount /sys +.IP "\fBlh_chroot_sysvinit\fR(1)" 4 +configure sysvinit +.IP "\fBlh_chroot_sysv-rc\fR(1)" 4 +manage /usr/sbin/policy-rc.d +.IP "\fBlh_chroot_tasks\fR(1)" 4 +install tasks into chroot +.SS Binary commands +.IP "\fBlh_binary_chroot\fR(1)" 4 +copy chroot into chroot +.IP "\fBlh_binary_debian-installer\fR(1)" 4 +install debian-installer into binary +.IP "\fBlh_binary_disk\fR(1)" 4 +install disk information into binary +.IP "\fBlh_binary_encryption\fR(1)" 4 +encrypts rootfs +.IP "\fBlh_binary_grub\fR(1)" 4 +installs grub into binary +.IP "\fBlh_binary_includes\fR(1)" 4 +copy files into binary +.IP "\fBlh_binary_iso\fR(1)" 4 +build iso binary image +.IP "\fBlh_binary_linux-image\fR(1)" 4 +install linux-image into binary +.IP "\fBlh_binary_local-hooks\fR(1)" 4 +execute local hooks in binary +.IP "\fBlh_binary_local-includes\fR(1)" 4 +copy files into binary +.IP "\fBlh_binary_local-packageslists\fR(1)" 4 +install local packages lists into binary +.IP "\fBlh_binary_manifest\fR(1)" 4 +create manifest +.IP "\fBlh_binary_md5sum\fR(1)" 4 +create binary md5sums +.IP "\fBlh_binary_memtest\fR(1)" 4 +installs a memtest into binary +.IP "\fBlh_binary_net\fR(1)" 4 +build netboot binary image +.IP "\fBlh_binary_rootfs\fR(1)" 4 +build rootfs image +.IP "\fBlh_binary_silo\fR(1)" 4 +installs silo into binary +.IP "\fBlh_binary_syslinux\fR(1)" 4 +installs syslinux into binary +.IP "\fBlh_binary_tar\fR(1)" 4 +build harddisk binary image +.IP "\fBlh_binary_usb-hdd\fR(1)" 4 +build binary usb-hdd image +.IP "\fBlh_binary_yaboot\fR(1)" 4 +installs yaboot into binary +.SS Source commands +.IP "\fBlh_source_debian\fR(1)" 4 +download sources +.IP "\fBlh_source_debian-live\fR(1)" 4 +copy debian-live config into source +.IP "\fBlh_source_disk\fR(1)" 4 +install disk information into source +.IP "\fBlh_source_iso\fR(1)" 4 +build iso source image +.IP "\fBlh_source_md5sum\fR(1)" 4 +create source md5sum +.IP "\fBlh_source_net\fR(1)" 4 +build source net image +.IP "\fBlh_source_tar\fR(1)" 4 +build source tarball +.IP "\fBlh_source_usb-hdd\fR(1)" 4 +build source usb-hdd image -.SH BUGS -Report bugs against live\-helper -<\fIhttp://packages.qa.debian.org/live\-helper\fR>. +.SH CONFIG FILES +Many live\-helper 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\-helper commands, some additional files can be used to configure the behavior of specific live\-helper 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 +For example, lh_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\-helper use pairs of values or slightly more complicated variable assignments. +.PP +Note that live\-helper 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\-helper will automatically set it to the default value. +.PP +In some rare cases, you may want to have different versions of these files for different architectures or distributions. If files named config/stage.arch or config/stage_helper.arch, and config/stage.dist or config/stage_helper.dist exist, where "arch" is the same as the output of "dpkg \-\-print\-architecture" and "dist" is the same as the codename of the target distribution, then they will be used in preference to other, more general files. +.PP +All config files are shell scripts which are sourced by a live\-helper program. That means they have to follow the normal shell syntax. You can also put comments in these files; lines beginning with "#" are ignored. + +.SH SEE ALSO +\fIlive\-initramfs\fR(7) .SH HOMEPAGE -More information about the Debian Live project can be found at -<\fIhttp://debian\-live.alioth.debian.org/\fR> and -<\fIhttp://wiki.debian.org/DebianLive/\fR>. +More information about live\-helper and the Debian Live project can be found in the homepage at <\fIhttp://debian\-live.alioth.debian.org/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>. + +.SH BUGS +Report bugs by submitting a bugreport for the live\-helper package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or write a mail to the mailinglist at <\fIdebian-live@lists.debian.org\fR>. .SH AUTHOR -live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the -Debian project. +live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project. |