summaryrefslogtreecommitdiff
path: root/manpages
diff options
context:
space:
mode:
authorLyndon Brown <jnqnfe@gmail.com>2020-04-28 18:51:45 +0100
committerLyndon Brown <jnqnfe@gmail.com>2020-04-29 10:34:54 +0100
commit931f42fa39bd8efa364bc31af33e350de7a0b8f7 (patch)
treed39d6b66fc7d3d4522e165b7d736f9826764d451 /manpages
parent4f765f3fc017ccfec835a14bb46479ccd87e7e1d (diff)
downloadvyos-live-build-931f42fa39bd8efa364bc31af33e350de7a0b8f7.tar.gz
vyos-live-build-931f42fa39bd8efa364bc31af33e350de7a0b8f7.zip
manpages: more formatting fixes
make variables and options in descriptions bold Gbp-Dch: Ignore
Diffstat (limited to 'manpages')
-rw-r--r--manpages/en/lb_config.124
1 files changed, 12 insertions, 12 deletions
diff --git a/manpages/en/lb_config.1 b/manpages/en/lb_config.1
index 48ae236a2..5497e8a9b 100644
--- a/manpages/en/lb_config.1
+++ b/manpages/en/lb_config.1
@@ -329,7 +329,7 @@ prepares a report of the currently present live system configuration and the ver
.IP "\fB\-\-firmware\-binary\fR true|false" 4
includes firmware packages in debian-installer. Defaults to true.
.IP "\fB\-\-firmware\-chroot\fR true|false" 4
-includes firmware packages in the live image. Defaults to true. Beware that some firmware packages are non-free and will only be included if the non-free archive area is included in \-\-archive\-areas (and \-\-parent\-archive\-areas). This is particularly relevant if you want working wifi for instance.
+includes firmware packages in the live image. Defaults to true. Beware that some firmware packages are non-free and will only be included if the non-free archive area is included in \fB\-\-archive\-areas\fR (and \fB\-\-parent\-archive\-areas\fR). This is particularly relevant if you want working wifi for instance.
.IP "\fB\-\-force\fR" 4
forces re\-execution of already run stages. Use only if you know what you are doing. It is generally safer to use \fBlb clean\fR to clean up before re\-executing \fBlb build\fR.
.IP "\fB\-\-gzip\-options\fR \fIOPTION\fR|""\fIOPTIONS\fR""" 4
@@ -367,7 +367,7 @@ sets the keyring package or additional keyring packages (a space separated list)
.IP "\fB\-k\fR|\fB\-\-linux\-flavours\fR \fIFLAVOUR\fR|""\fIFLAVOURS\fR""" 4
sets the kernel flavours to be installed (a space separated list). Note that in case you specify more than one the first will be configured as the default kernel that gets booted. Optionally you can use an architecture qualifier, e.g. amd64:amd64. Given an i386 system you can enable amd64 foreign architecture thanks to the commands: "dpkg \-\-add\-architecture amd64 ; apt\-get update". This enables you to use "686 amd64:amd64" as a linux flavour. The amd64 kernel will be installed alongside the i386's 686 kernel.
.IP "\fB\-\-linux\-packages\fR \fIPACKAGE\fR|""\fIPACKAGES\fR""" 4
-defines a space separated list of partial kernel package names. For each name given and for each flavour in LB_LINUX_FLAVOURS_WITH_ARCH (\-\-linux-flavours), '\-FLAVOUR' will be appended to the name to get the names of kernel packages to be included. By default this is 'linux\-image'. So for instance if this is set to "linux\-image linux\-headers" and LB_LINUX_FLAVOURS_WITH_ARCH is "i386 amd64:amd64" then you will get the four packages "linux\-image\-i386", "linux\-image\-amd64:amd64", "linux\-headers\-i386" and "linux\-headers\-amd64:amd64". You can specify "none" to disable the kernel installation step.
+defines a space separated list of partial kernel package names. For each name given and for each flavour in \fBLB_LINUX_FLAVOURS_WITH_ARCH\fR (\fB\-\-linux-flavours\fR), '\-FLAVOUR' will be appended to the name to get the names of kernel packages to be included. By default this is 'linux\-image'. So for instance if this is set to "linux\-image linux\-headers" and \fBLB_LINUX_FLAVOURS_WITH_ARCH\fR is "i386 amd64:amd64" then you will get the four packages "linux\-image\-i386", "linux\-image\-amd64:amd64", "linux\-headers\-i386" and "linux\-headers\-amd64:amd64". You can specify "none" to disable the kernel installation step.
.IP "\fB\-\-loadlin\fR true|false" 4
sets loadlin. Defaults to false, except when the debian-installer is included for x86_64 or i386.
.IP "\fB\-\-memtest\fR memtest86+|memtest86|none" 4
@@ -379,11 +379,11 @@ sets the location of the derivatives security package mirror that should end up
.IP "\fB\-\-mirror\-bootstrap\fR \fIURL\fR" 4
sets the location of the debian package mirror that should be used to bootstrap the derivative from. This defaults to 'http://deb.debian.org/debian/'.
.IP "\fB\-\-mirror\-chroot\fR \fIURL\fR" 4
-sets the location of the debian package mirror that will be used to fetch the packages of the derivative in order to build the live system. By default, this is set to the value of \-\-mirror\-bootstrap.
+sets the location of the debian package mirror that will be used to fetch the packages of the derivative in order to build the live system. By default, this is set to the value of \fB\-\-mirror\-bootstrap\fR.
.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 of the derivative in order to build the live system. By default, this points to 'http://security.debian.org/'.
.IP "\fB\-\-mirror\-debian\-installer\fR \fIURL\fR" 4
-sets the location of the mirror that will be used to fetch the debian installer images of the derivative. By default, this points to the same mirror used to build the live system, i.e. the value of \-\-mirror\-chroot.
+sets the location of the mirror that will be used to fetch the debian installer images of the derivative. By default, this points to the same mirror used to build the live system, i.e. the value of \fB\-\-mirror\-chroot\fR.
.IP "\fB\-\-mode\fR debian" 4
defines a global mode to load project specific defaults. By default this is set to debian.
.IP "\fB\-\-net\-tarball\fR true|false" 4
@@ -405,17 +405,17 @@ defines the derivative's parent distribution enabled in the resulting live syste
.IP "\fB\-\-parent\-distribution\-chroot\fR \fICODENAME\fR" 4
defines the derivative's parent distribution used to build the live system.
.IP "\fB\-\-parent\-mirror\-binary\fR \fIURL\fR" 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. This defaults to the value of \-\-mirror\-binary.
+sets the location of the debian package mirror that should end up configured in the final image and which is the one a user would see and use. This has not necessarily to be the same that is used to build the image, e.g. if you use a local mirror but want to have an official mirror in the image. This defaults to the value of \fB\-\-mirror\-binary\fR.
.IP "\fB\-\-parent\-mirror\-binary\-security\fR \fIURL\fR" 4
-sets the location of the debian security package mirror that should end up configured in the final image. This defaults to the value of \-\-mirror\-binary\-security.
+sets the location of the debian security package mirror that should end up configured in the final image. This defaults to the value of \fB\-\-mirror\-binary\-security\fR.
.IP "\-m|\fB\-\-parent\-mirror\-bootstrap\fR \fIURL\fR" 4
-sets the location of the debian package mirror that should be used to bootstrap from. This defaults to the value of \-\-mirror\-bootstrap.
+sets the location of the debian package mirror that should be used to bootstrap from. This defaults to the value of \fB\-\-mirror\-bootstrap\fR.
.IP "\fB\-\-parent\-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. This defaults to the value of \-\-parent\-mirror\-bootstrap.
+sets the location of the debian package mirror that will be used to fetch the packages in order to build the live system. This defaults to the value of \fB\-\-parent\-mirror\-bootstrap\fR.
.IP "\fB\-\-parent\-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. This defaults to the value of \-\-mirror\-chroot\-security.
+sets the location of the debian security package mirror that will be used to fetch the packages in order to build the live system. This defaults to the value of \fB\-\-mirror\-chroot\-security\fR.
.IP "\fB\-\-parent\-mirror\-debian\-installer\fR \fIURL\fR" 4
-sets the location of the mirror that will be used to fetch the debian installer images. This defaults to the value of \-\-parent\-mirror\-chroot.
+sets the location of the mirror that will be used to fetch the debian installer images. This defaults to the value of \fB\-\-parent\-mirror\-chroot\fR.
.IP "\fB\-\-quiet\fR" 4
reduces the verbosity of messages output by \fBlb build\fR.
.IP "\fB\-\-security\fR true|false" 4
@@ -444,12 +444,12 @@ defines if win32\-loader should be included in the binary image or not.
defines whether a file for distributing the image in \fIzsync\fR(1) format will be generated. Defaults to true.
.SH ENVIRONMENT
-Currently, command line switches can also be specified through the corresponding environment variable. However, this generally should not be relied upon, as it is an implementation detail that is subject to change in future releases. For options applying directly to live\-build, environment variables are named LB_FOO, meaning, e.g. \fB\-\-apt\-ftp\-proxy\fR becomes LB_APT_FTP_PROXY (the exception being internal options such as \fB\-\-debug\fR). For options passed to another program, as in APT_OPTIONS or GZIP_OPTIONS, no LB_ prefix is used.
+Currently, command line switches can also be specified through the corresponding environment variable. However, this generally should not be relied upon, as it is an implementation detail that is subject to change in future releases. For options applying directly to live\-build, environment variables are named LB_FOO, meaning, e.g. \fB\-\-apt\-ftp\-proxy\fR becomes \fBLB_APT_FTP_PROXY\fR (the exception being internal options such as \fB\-\-debug\fR). For options passed to another program, as in APT_OPTIONS or GZIP_OPTIONS, no LB_ prefix is used.
.SH FILES
.IP "\fBauto/config\fR" 4
.IP "\fB/etc/live/build.conf, /etc/live/build/*\fR" 4
-An optional, global configuration file for \fBlb config\fR variables. It is useful to specify a few system wide defaults, like LB_PARENT_MIRROR_BOOTSTRAP. This feature can be disabled by using the \fB\-\-ignore\-system\-defaults\fR option.
+An optional, global configuration file for \fBlb config\fR variables. It is useful to specify a few system wide defaults, like \fBLB_PARENT_MIRROR_BOOTSTRAP\fR. This feature can be disabled by using the \fB\-\-ignore\-system\-defaults\fR option.
.SH SEE ALSO
\fIlive\-build\fR(7)