summaryrefslogtreecommitdiff
path: root/manpages
diff options
context:
space:
mode:
authorDaniel Baumann <daniel@debian.org>2007-09-23 10:04:49 +0200
committerDaniel Baumann <daniel@debian.org>2007-09-23 10:04:49 +0200
commitbf396ae4b8d2380bb8024f8d794771a7f3b48fa2 (patch)
tree58272f72528cedb7af31ee6e6c2c0f7fbd602160 /manpages
parent8762edaa61a21de7708d6293287e9eb306716578 (diff)
downloadvyos-live-build-bf396ae4b8d2380bb8024f8d794771a7f3b48fa2.tar.gz
vyos-live-build-bf396ae4b8d2380bb8024f8d794771a7f3b48fa2.zip
Adding live-helper 1.0~a5-1.
Diffstat (limited to 'manpages')
-rw-r--r--manpages/lh_binary.19
-rw-r--r--manpages/lh_bootstrap.113
-rw-r--r--manpages/lh_bootstrap_cdebootstrap.122
-rw-r--r--manpages/lh_bootstrap_debootstrap.122
-rw-r--r--manpages/lh_chroot.15
-rw-r--r--manpages/lh_clean.120
-rw-r--r--manpages/lh_testroot.15
-rw-r--r--manpages/live-helper.722
8 files changed, 63 insertions, 55 deletions
diff --git a/manpages/lh_binary.1 b/manpages/lh_binary.1
index 05f37757e..72c694a3c 100644
--- a/manpages/lh_binary.1
+++ b/manpages/lh_binary.1
@@ -1,4 +1,4 @@
-.TH LH_BINARY 1 "2007\-04\-02" "1.0~a4" "live\-helper"
+.TH LH_BINARY 1 "2007\-04\-09" "1.0~a5" "live\-helper"
.SH NAME
lh_binary \- meta-helper for lh_binary_*
@@ -9,9 +9,6 @@ lh_binary \- meta-helper for lh_binary_*
.SH DESCRIPTION
lh_binary is a meta-helper. It calls all necessary helpers to complete the binary stage.
-.SH OPTIONS
-lh_binary has no options (FIXME).
-
.SH BINARY HELPERS
Here is the complete list of available binary helper commands. See their man pages for additional documentation.
.IP "\fIlh_binary_chroot\fR(1)" 4
@@ -20,10 +17,10 @@ copies chroot into chroot.
encrypts the root filesystem.
.IP "\fIlh_binary_grub\fR(1)" 4
copies grub into the binary image.
-.IP "\fIlh_binary_includes\fR(1)" 4
-copies files into the binary image.
.IP "\fIlh_binary_hdd\fR(1)" 4
creates the harddisk binary tarball.
+.IP "\fIlh_binary_includes\fR(1)" 4
+copies files into the binary image.
.IP "\fIlh_binary_iso\fR(1)" 4
creates the CD/DVD binary image.
.IP "\fIlh_binary_linuximage\fR(1)" 4
diff --git a/manpages/lh_bootstrap.1 b/manpages/lh_bootstrap.1
index 0c71e857e..ff59cc016 100644
--- a/manpages/lh_bootstrap.1
+++ b/manpages/lh_bootstrap.1
@@ -1,4 +1,4 @@
-.TH LH_BOOTSTRAP 1 "2007\-04\-02" "1.0~a4" "live\-helper"
+.TH LH_BOOTSTRAP 1 "2007\-04\-09" "1.0~a5" "live\-helper"
.SH NAME
lh_bootstrap \- meta-helper for lh_bootstrap_*
@@ -9,17 +9,6 @@ lh_bootstrap \- meta-helper for lh_bootstrap_*
.SH DESCRIPTION
lh_bootstrap is a meta-helper. It calls all necessary helpers to complete the bootstrap stage.
-.SH CONFIGURATION FILE
-lh_bootstrap reads config/common if available. See ENVIRONMENT for the correct environment variables to use.
-
-.SH ENVIRONMENT
-lh_bootstrap respects the following environment variables if available, otherwise uses default values for it.
-.IP "\fI$LH_BOOTSTRAP\fR" 4
-select the bootstrap program (Default: cdebootstrap)
-
-.SH OPTIONS
-lh_bootstrap has no options (FIXME).
-
.SH BOOTSTRAP HELPERS
Here is the complete list of available bootstrap helper commands. See their man pages for additional documentation.
.IP "\fIlh_bootstrap_cdebootstrap\fR(1)" 4
diff --git a/manpages/lh_bootstrap_cdebootstrap.1 b/manpages/lh_bootstrap_cdebootstrap.1
index dfb66210e..2195a571f 100644
--- a/manpages/lh_bootstrap_cdebootstrap.1
+++ b/manpages/lh_bootstrap_cdebootstrap.1
@@ -1,4 +1,4 @@
-.TH LH_BOOTSTRAP_CDEBOOTSTRAP 1 "2007\-04\-02" "1.0~a4" "live\-helper"
+.TH LH_BOOTSTRAP_CDEBOOTSTRAP 1 "2007\-04\-09" "1.0~a5" "live\-helper"
.SH NAME
lh_bootstrap_cdebootstrap \- bootstrap a Debian system with \fIcdebootstrap\fR(1)
@@ -14,23 +14,21 @@ lh_bootstrap_cdebootstrap reads config/common and config/bootstrap if available.
.SH ENVIRONMENT
lh_bootstrap_cdebootstrap respects the following environment variables if available, otherwise uses default values for it.
+.IP "\fI$LH_BOOTSTRAP\fR" 4
+control the bootstrap program to be used (Default: cdebootstrap)
.IP "\fI$LH_CACHE\fR" 4
control if downloaded packages should be cached (Default: enabled)
-.IP "\fI$LH_ROOT\fR" 4
-set the root directory (Default: debian-live)
+.PP
.IP "\fI$LIVE_ARCHITECTURE\fR" 4
select the chroot architecture (Default: autodetected)
-.IP "\fI$LIVE_DISTRIBUTION\fR" 4
-select the distribution to use (Default: sid)
-.IP "\fI$LIVE_DISTRIBUTION_CONFIG\fR" 4
+.IP "\fI$LIVE_BOOTSTRAP_CONFIG\fR" 4
set distribution config directory (Default: empty)
-.IP "\fI$LIVE_FLAVOUR\fR" 4
+.IP "\fI$LIVE_BOOTSTRAP_FLAVOUR\fR" 4
select the flavour to use (Default: standard)
-.IP "\fI$LIVE_MIRROR_LOCAL\fR" 4
-set the local mirror to use (Default: http://ftp.debian.org/debian/)
-
-.SH OPTIONS
-lh_bootstrap_cdebootstrap has no options (FIXME).
+.IP "\fI$LIVE_DISTRIBUTION\fR" 4
+select the distribution to use (Default: sid)
+.IP "\fI$LIVE_MIRROR_BUILD\fR" 4
+set the mirror to use (Default: http://ftp.debian.org/debian/)
.SH SEE ALSO
\fIcdebootstrap\fR(1)
diff --git a/manpages/lh_bootstrap_debootstrap.1 b/manpages/lh_bootstrap_debootstrap.1
index a24dac301..0220278c9 100644
--- a/manpages/lh_bootstrap_debootstrap.1
+++ b/manpages/lh_bootstrap_debootstrap.1
@@ -1,4 +1,4 @@
-.TH LH_BOOTSTRAP_DEBOOTSTRAP 1 "2007\-04\-02" "1.0~a4" "live\-helper"
+.TH LH_BOOTSTRAP_DEBOOTSTRAP 1 "2007\-04\-09" "1.0~a5" "live\-helper"
.SH NAME
lh_bootstrap_debootstrap \- bootstrap a Debian system with \fIdebootstrap\fR(8)
@@ -14,23 +14,21 @@ lh_bootstrap_debootstrap reads config/common and config/bootstrap if available.
.SH ENVIRONMENT
lh_bootstrap_debootstrap respects the following environment variables if available, otherwise uses default values for it.
+.IP "\fI$LH_BOOTSTRAP\fR" 4
+control the bootstrap program to be used (Default: cdebootstrap)
.IP "\fI$LH_CACHE\fR" 4
control if downloaded packages should be cached (Default: enabled)
-.IP "\fI$LH_ROOT\fR" 4
-set the root directory (Default: debian-live)
+.PP
.IP "\fI$LIVE_ARCHITECTURE\fR" 4
select the chroot architecture (Default: autodetected)
-.IP "\fI$LIVE_DISTRIBUTION\fR" 4
-select the distribution to use (Default: sid)
-.IP "\fI$LIVE_DISTRIBUTION_CONFIG\fR" 4
+.IP "\fI$LIVE_BOOTSTRAP_CONFIG\fR" 4
set distribution config directory (Default: empty)
-.IP "\fI$LIVE_FLAVOUR\fR" 4
+.IP "\fI$LIVE_BOOTSTRAP_FLAVOUR\fR" 4
select the flavour to use (Default: standard)
-.IP "\fI$LIVE_MIRROR_LOCAL\fR" 4
-set the local mirror to use (Default: http://ftp.debian.org/debian/)
-
-.SH OPTIONS
-lh_bootstrap_debootstrap has no options (FIXME).
+.IP "\fI$LIVE_DISTRIBUTION\fR" 4
+select the distribution to use (Default: sid)
+.IP "\fI$LIVE_MIRROR_BUILD\fR" 4
+set the mirror to use (Default: http://ftp.debian.org/debian/)
.SH SEE ALSO
\fIdebootstrap\fR(8)
diff --git a/manpages/lh_chroot.1 b/manpages/lh_chroot.1
index 3e8413c62..9cb6854a8 100644
--- a/manpages/lh_chroot.1
+++ b/manpages/lh_chroot.1
@@ -1,4 +1,4 @@
-.TH LH_CHROOT 1 "2007\-04\-02" "1.0~a4" "live\-helper"
+.TH LH_CHROOT 1 "2007\-04\-09" "1.0~a5" "live\-helper"
.SH NAME
lh_chroot \- meta-helper for lh_chroot_*
@@ -9,9 +9,6 @@ lh_chroot \- meta-helper for lh_chroot_*
.SH DESCRIPTION
lh_chroot is a meta-helper. It calls all necessary helpers to complete the chroot stage.
-.SH OPTIONS
-lh_chroot has no options (FIXME).
-
.SH CHROOT HELPERS
Here is the complete list of available chroot helper commands. See their man pages for additional documentation.
.IP "\fIlh_chroot_apt\fR(1)" 4
diff --git a/manpages/lh_clean.1 b/manpages/lh_clean.1
index 1c5682495..18722b38b 100644
--- a/manpages/lh_clean.1
+++ b/manpages/lh_clean.1
@@ -1,4 +1,4 @@
-.TH LH_CLEAN 1 "2007\-04\-02" "1.0~a4" "live\-helper"
+.TH LH_CLEAN 1 "2007\-04\-09" "1.0~a5" "live\-helper"
.SH NAME
lh_clean \- clean up system build directories
@@ -11,7 +11,23 @@ lh_clean \- clean up system build directories
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.
.SH OPTIONS
-lh_clean has no options (FIXME).
+The following command line options are supported by lh_clean.
+.IP "\fBall\fR" 4
+removes chroot, binary, lock, stage, and source. This is the default operation.
+.IP "\fBcache\fR" 4
+removes all cache directories.
+.IP "\fBchroot\fR" 4
+unmounts and removes the chroot directory. If bootstrap cache is available, the system is reset to bootstrap stage.
+.IP "\fBbinary\fR" 4
+removes all binary related caches, directories, and stages files.
+.IP "\fBlock\fR" 4
+removes all lock files.
+.IP "\fBpurge\fR" 4
+removes everything (including cache) but config.
+.IP "\fBstage\fR" 4
+removes all stage files.
+.IP "\fBsource\fR" 4
+removes all source related caches, directories, and stage files.
.SH SEE ALSO
\fIlive\-helper\fR(7)
diff --git a/manpages/lh_testroot.1 b/manpages/lh_testroot.1
index 3c7963bbd..f924a0690 100644
--- a/manpages/lh_testroot.1
+++ b/manpages/lh_testroot.1
@@ -1,4 +1,4 @@
-.TH LH_TESTROOT 1 "2007\-04\-02" "1.0~a4" "live\-helper"
+.TH LH_TESTROOT 1 "2007\-04\-09" "1.0~a5" "live\-helper"
.SH NAME
lh_testroot \- ensure that a system is built as root
@@ -9,9 +9,6 @@ lh_testroot \- ensure that a system is built as root
.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, \fIfakeroot\fR(1) or \fIsudo\fR(8) does not work.
-.SH OPTIONS
-lh_testroot has no options (FIXME).
-
.SH SEE ALSO
\fIlive\-helper\fR(7)
.PP
diff --git a/manpages/live-helper.7 b/manpages/live-helper.7
index a80aefd9f..0046e01b4 100644
--- a/manpages/live-helper.7
+++ b/manpages/live-helper.7
@@ -1,4 +1,4 @@
-.TH LIVE\-HELPER 7 "2007\-04\-02" "1.0~a4" "live\-helper"
+.TH LIVE\-HELPER 7 "2007\-04\-09" "1.0~a5" "live\-helper"
.SH NAME
live\-helper \- Debian Live helper programs
@@ -31,10 +31,12 @@ meta-helper for lh_binary_*.
copies chroot into chroot.
.IP "\fIlh_binary_encryption\fR(1)" 4
encrypts the root filesystem.
-.IP "\fIlh_binary_includes\fR(1)" 4
-copies files into the binary image.
+.IP "\fIlh_binary_grub\fR(1)" 4
+copies grub into the binary image.
.IP "\fIlh_binary_hdd\fR(1)" 4
creates the harddisk binary tarball.
+.IP "\fIlh_binary_includes\fR(1)" 4
+copies files into the binary image.
.IP "\fIlh_binary_iso\fR(1)" 4
creates the CD/DVD binary image.
.IP "\fIlh_binary_linuximage\fR(1)" 4
@@ -75,6 +77,8 @@ does evil (temporary) hacks in the chroot.
executes additional commands in the chroot.
.IP "\fIlh_chroot_hosts\fR(1)" 4
configures /etc/hosts in the chroot.
+.IP "\fIlh_chroot_interactive\fR(1)" 4
+makes build interactive.
.IP "\fIlh_chroot_linuximage\fR(1)" 4
configures /etc/kernel-img.conf in the chroot.
.IP "\fIlh_chroot_localhooks\fR(1)" 4
@@ -134,12 +138,24 @@ checks for root privileges.
.SH LIVE\-HELPER OPTIONS
The following command line options are supported by all live\-helper programs.
+.IP "\fB\-\-breakpoints\fR" 4
+run with breakpoints
+.IP "\fB\-\-conffile\fR" 4
+use custom configuration file
+.IP "\fB\-\-debug\fR" 4
+show debug information
.IP "\fB\-\-force\fR" 4
force helper execution, even if stage file exists.
.IP "\fB\-h, \-\-help\fR" 4
display help and exit
+.IP "\fB\-\-logfile\fR" 4
+use custom log file
+.IP "\fB\-\-quiet\fR" 4
+be quiet
.IP "\fB\-u, \-\-usage\fR" 4
show usage and exit
+.IP "\fB\-\-verbose\fR" 4
+be verbose
.IP "\fB\-v, \-\-version\fR" 4
output version information and exit