summaryrefslogtreecommitdiff
path: root/manpages
diff options
context:
space:
mode:
authorDaniel Baumann <daniel@debian.org>2009-02-25 09:51:28 +0100
committerDaniel Baumann <daniel@debian.org>2011-03-09 19:09:42 +0100
commitf73041f2f0905a2bb6ee3b938a9e1fa0fc53a3e6 (patch)
tree517c37c1229fa05947a3515117c1bbdfd566f3a0 /manpages
parentef9121fc23c6eae86ff359cf429af3b096360075 (diff)
downloadvyos-live-build-f73041f2f0905a2bb6ee3b938a9e1fa0fc53a3e6.tar.gz
vyos-live-build-f73041f2f0905a2bb6ee3b938a9e1fa0fc53a3e6.zip
Adding initial support for virtual-hdd binary image type.
Diffstat (limited to 'manpages')
-rw-r--r--manpages/lh_binary_virtual-hdd.en.129
-rw-r--r--manpages/lh_config.en.18
-rw-r--r--manpages/lh_source_virtual-hdd.en.129
-rw-r--r--manpages/live-helper.en.74
4 files changed, 70 insertions, 0 deletions
diff --git a/manpages/lh_binary_virtual-hdd.en.1 b/manpages/lh_binary_virtual-hdd.en.1
new file mode 100644
index 000000000..8c1a58afa
--- /dev/null
+++ b/manpages/lh_binary_virtual-hdd.en.1
@@ -0,0 +1,29 @@
+.TH LH_BINARY_VIRTUAL\-HDD 1 "2009\-01\-23" "1.0.2" "live\-helper"
+
+.SH NAME
+lh_binary_virtual\-hdd \- build binary virtual\-hdd image
+
+.SH SYNOPSIS
+\fBlh_binary_virtual\-hdd\fR [\fIlive\-helper options\fR]
+
+.SH DESCRIPTION
+lh_binary_virtual\-hdd is a low\-level command (plumbing) of live\-helper, the Debian Live tool suite. It builds binary virtual\-hdd image.
+
+.SH OPTIONS
+lh_binary_virtual\-hdd 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
+\fIlh_binary\fR(1)
+.br
+\fIlive\-helper\fR(7)
+.PP
+This program is a part of live\-helper.
+
+.SH HOMEPAGE
+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.
diff --git a/manpages/lh_config.en.1 b/manpages/lh_config.en.1
index 63c1ab91b..322913cbe 100644
--- a/manpages/lh_config.en.1
+++ b/manpages/lh_config.en.1
@@ -186,6 +186,10 @@ lh_config \- create configuration for live\-helper
.br
[\fB\-\-union\-filesystem\fR aufs|unionfs]
.br
+ [\fB\-\-virtual\-root\-filesystem\fR ext3]
+.br
+ [\fB\-\-virtual\-root\-size \fIMB\fR]
+.br
[\fB\-\-exposed\-root\fR enabled|disabled]
.br
[\fB\-\-username\fR \fINAME\fR]
@@ -389,6 +393,10 @@ defines one or more package tasks to be installed in the live system. This is a
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\-\-virtual\-root\-filesystem\fR ext3" 4
+defines what filesystem to format the root filesystem when building virtual-hdd images.
+.IP "\fB\-\-virtual\-root\-size\fR MB" 4
+defines what size the virtual-hdd image should be. Note that although the default is set to 10000 (= 10GB), it will not need 10GB space on your harddisk as the files are created as sparse files.
.IP "\fB\-\-exposed\-root\fR enabled|disabled" 4
FIXME
.IP "\fB\-\-username\fR \fINAME\fR" 4
diff --git a/manpages/lh_source_virtual-hdd.en.1 b/manpages/lh_source_virtual-hdd.en.1
new file mode 100644
index 000000000..204baf4e8
--- /dev/null
+++ b/manpages/lh_source_virtual-hdd.en.1
@@ -0,0 +1,29 @@
+.TH LH_SOURCE_VIRTUAL\-HDD 1 "2009\-01\-23" "1.0.2" "live\-helper"
+
+.SH NAME
+lh_source_virtual\-hdd \- build source virtual-hdd image
+
+.SH SYNOPSIS
+\fBlh_source_virtual\-hdd\fR [\fIlive\-helper options\fR]
+
+.SH DESCRIPTION
+lh_source_virtual\-hdd is a low\-level command (plumbing) of live\-helper, the Debian Live tool suite. It builds source virtual-hdd image.
+
+.SH OPTIONS
+lh_source_virtual\-hdd 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
+\fIlh_source\fR(1)
+.br
+\fIlive\-helper\fR(7)
+.PP
+This program is a part of live\-helper.
+
+.SH HOMEPAGE
+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.
diff --git a/manpages/live-helper.en.7 b/manpages/live-helper.en.7
index bef929958..67fbebbbb 100644
--- a/manpages/live-helper.en.7
+++ b/manpages/live-helper.en.7
@@ -189,6 +189,8 @@ installs syslinux into binary
build harddisk binary image
.IP "\fBlh_binary_usb-hdd\fR(1)" 4
build binary usb-hdd image
+.IP "\fBlh_binary_virtual-hdd\fR(1)" 4
+build binary virtual-hdd image
.IP "\fBlh_binary_win32-loader\fR(1)" 4
installs win32-loader into binary
.IP "\fBlh_binary_yaboot\fR(1)" 4
@@ -210,6 +212,8 @@ build source net image
build source tarball
.IP "\fBlh_source_usb-hdd\fR(1)" 4
build source usb-hdd image
+.IP "\fBlh_source_virtual-hdd\fR(1)" 4
+build source virtual-hdd image
.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).