lb_config.1 35.2 KB
Newer Older
1
.TH LIVE\-BUILD 1 2014\-12\-10 5.0~a1-1 "Live Systems Project"
Daniel Baumann's avatar
Daniel Baumann committed
2
3

.SH NAME
4
\fBlb config\fR \- Create config directory
Daniel Baumann's avatar
Daniel Baumann committed
5
6

.SH SYNOPSIS
7
\fBlb config\fR [\fIlive\-build options\fR]
8
9
.PP
.\" FIXME
10
\fBlb config\fR
Daniel Baumann's avatar
Daniel Baumann committed
11
12
13
14
15
16
.br
	[\fB\-\-apt\fR apt|aptitude]
.br
	[\fB\-\-apt\-ftp\-proxy\fR \fIURL\fR]
.br
	[\fB\-\-apt\-http\-proxy\fR \fIURL\fR]
17
.br
18
	[\fB\-\-apt\-indices\fR true|false]
19
.br
20
	[\fB\-\-apt\-options\fR \fIOPTION\fR|"\fIOPTIONS\fR"]
21
.br
22
	[\fB\-\-aptitude\-options\fR \fIOPTION\fR|"\fIOPTIONS\fR"]
Daniel Baumann's avatar
Daniel Baumann committed
23
.br
24
	[\fB\-\-apt\-pipeline\fR \fIDEPTH\fR]
Daniel Baumann's avatar
Daniel Baumann committed
25
.br
26
	[\fB\-\-apt\-recommends\fR true|false]
Daniel Baumann's avatar
Daniel Baumann committed
27
.br
28
	[\fB\-\-apt\-secure\fR true|false]
29
.br
30
	[\fB\-\-apt\-source\-archives\fR true|false]
Daniel Baumann's avatar
Daniel Baumann committed
31
.br
32
	[\-a|\fB\-\-architectures\fR \fIARCHITECTURE\fR]
Daniel Baumann's avatar
Daniel Baumann committed
33
.br
34
	[\-b|\fB\-\-binary\-images\fR iso|iso\-hybrid|netboot|tar|hdd]
Daniel Baumann's avatar
Daniel Baumann committed
35
.br
36
	[\fB\-\-binary\-filesystem\fR fat16|fat32|ext2|ext3|ext4]
Daniel Baumann's avatar
Daniel Baumann committed
37
.br
38
	[\fB\-\-bootappend\-install\fR \fIPARAMETER\fR|\fI"PARAMETERS"\fR]
Daniel Baumann's avatar
Daniel Baumann committed
39
.br
40
	[\fB\-\-bootappend\-live\fR \fIPARAMETER\fR|\fI"PARAMETERS"\fR]
Daniel Baumann's avatar
Daniel Baumann committed
41
.br
42
	[\fB\-\-bootloader\fR grub|grub2|syslinux]
Daniel Baumann's avatar
Daniel Baumann committed
43
.br
44
	[\fB\-\-bootstrap\fR cdebootstrap|cdebootstrap-static|debootstrap]
Daniel Baumann's avatar
Daniel Baumann committed
45
.br
46
	[\fB\-\-cache\fR true|false]
Daniel Baumann's avatar
Daniel Baumann committed
47
.br
48
	[\fB\-\-cache\-indices\fR true|false]
Daniel Baumann's avatar
Daniel Baumann committed
49
.br
50
	[\fB\-\-cache\-packages\fR true|false]
Daniel Baumann's avatar
Daniel Baumann committed
51
.br
52
	[\fB\-\-cache\-stages\fR \fISTAGE\fR|\fI"STAGES"\fR]
Daniel Baumann's avatar
Daniel Baumann committed
53
.br
54
	[\fB\-\-checksums\fR md5|sha1|sha256|none]
55
56
.br
	[\fB\-\-compression\fR bzip2|gzip|lzip|none]
57
.br
58
	[\fB\-\-config\fR \fIGIT_URL::GIT_ID\fR]
Daniel Baumann's avatar
Daniel Baumann committed
59
.br
60
	[\fB\-\-build\-with\-chroot\fR true|false]
Daniel Baumann's avatar
Daniel Baumann committed
61
.br
62
	[\fB\-\-chroot\-filesystem\fR ext2|ext3|ext4|squashfs|jffs2|none]
63
.br
64
	[\fB\-\-clean\fR]
Daniel Baumann's avatar
Daniel Baumann committed
65
66
67
68
69
70
71
.br
	[\-c|\fB\-\-conffile\fR \fIFILE\fR]
.br
	[\fB\-\-debconf\-frontend\fR dialog|editor|noninteractive|readline]
.br
	[\fB\-\-debconf\-priority\fR low|medium|high|critical]
.br
72
	[\fB\-\-debian\-installer\fR true|cdrom|netinst|netboot|businesscard|live|false]
73
74
.br
	[\fB\-\-debian\-installer\-distribution\fR daily|\fICODENAME\fR]
Daniel Baumann's avatar
Daniel Baumann committed
75
.br
76
	[\fB\-\-debian\-installer\-preseedfile\fR \fIFILE\fR|\fIURL\fR]
77
.br
78
	[\fB\-\-debian\-installer\-gui\fR true|false]
79
80
.br
	[\fB\-\-debug\fR]
Daniel Baumann's avatar
Daniel Baumann committed
81
82
.br
	[\-d|\fB\-\-distribution\fR \fICODENAME\fR]
83
84
.br
	[\fB\-\-parent\-distribution\fR \fICODENAME\fR]
85
86
.br
	[\fB\-\-parent\-debian\-installer\-distribution\fR \fICODENAME\fR]
Daniel Baumann's avatar
Daniel Baumann committed
87
.br
88
	[\fB\-\-dump\fR]
89
90
.br
	[\fB\-\-fdisk\fR fdisk|fdisk.dist]
91
92
93
94
.br
	[\fB\-\-firmware\-binary true|false\fR]
.br
	[\fB\-\-firmware\-chroot true|false\fR]
95
96
.br
	[\fB\-\-force\fR]
Daniel Baumann's avatar
Daniel Baumann committed
97
98
.br
	[\fB\-\-grub\-splash\fR \fIFILE\fR]
99
100
.br
	[\fB\-\-gzip\-options\fR \fIOPTION\fR|"\fIOPTIONS\fR"]
Daniel Baumann's avatar
Daniel Baumann committed
101
102
.br
	[\fB\-\-hooks\fR \fIFILE\fR]
103
104
.br
	[\fB\-\-ignore\-system\-defaults\fR]
Daniel Baumann's avatar
Daniel Baumann committed
105
.br
106
	[\fB\-\-initramfs\fR auto|none|live\-boot|casper]
107
108
.br
	[\fB\-\-initramfs\-compression\fR bzip2|gzip|lzma]
109
110
.br
	[\fB\-\-initsystem\fR sysvinit|runit|systemd|upstart|none]
Daniel Baumann's avatar
Daniel Baumann committed
111
112
.br
	[\fB\-\-interactive\fR shell]
113
114
.br
	[\fB\-\-isohybrid\-options\fR \fIOPTION\fR|"\fIOPTIONS\fR"]
Daniel Baumann's avatar
Daniel Baumann committed
115
116
117
118
119
120
121
122
.br
	[\fB\-\-iso\-application\fR \fINAME\fR]
.br
	[\fB\-\-iso\-preparer\fR \fINAME\fR]
.br
	[\fB\-\-iso\-publisher\fR \fINAME\fR]
.br
	[\fB\-\-iso\-volume\fR \fINAME\fR]
123
124
.br
	[\fB\-\-jffs2\-eraseblock\fR \fISIZE\fR]
Daniel Baumann's avatar
Daniel Baumann committed
125
.br
126
	[\fB\-\-keyring\-packages\fR \fIPACKAGE\fI|\fI"PACKAGES"\fR]
Daniel Baumann's avatar
Daniel Baumann committed
127
.br
128
	[\-k|\fB\-\-linux\-flavours\fR \fIFLAVOUR\fR|\fI"FLAVOURS"\fR]
Daniel Baumann's avatar
Daniel Baumann committed
129
.br
130
	[\fB\-\-linux\-packages\fR \fI"PACKAGES"\fR]
Daniel Baumann's avatar
Daniel Baumann committed
131
132
133
.br
	[\fB\-\-losetup\fR losetup|losetup.orig]
.br
134
	[\fB\-\-memtest\fR memtest86+|memtest86|none]
Daniel Baumann's avatar
Daniel Baumann committed
135
.br
136
	[\-m|\fB\-\-parent\-mirror\-bootstrap\fR \fIURL\fR]
137
.br
138
	[\fB\-\-parent\-mirror\-chroot\fR \fIURL\fR]
139
.br
140
	[\fB\-\-parent\-mirror\-chroot\-security\fR \fIURL\fR]
141
.br
142
	[\fB\-\-parent\-mirror\-chroot\-updates\fR \fIURL\fR]
143
.br
144
	[\fB\-\-parent\-mirror\-chroot\-backports\fR \fIURL\fR]
Daniel Baumann's avatar
Daniel Baumann committed
145
.br
146
	[\fB\-\-parent\-mirror\-binary\fR \fIURL\fR]
Daniel Baumann's avatar
Daniel Baumann committed
147
.br
148
	[\fB\-\-parent\-mirror\-binary\-security\fR \fIURL\fR]
149
.br
150
	[\fB\-\-parent\-mirror\-binary\-updates\fR \fIURL\fR]
Daniel Baumann's avatar
Daniel Baumann committed
151
.br
152
	[\fB\-\-parent\-mirror\-binary\-backports\fR \fIURL\fR]
153
.br
154
	[\fB\-\-parent\-mirror\-debian\-installer\fR \fIURL\fR]
155
156
157
158
159
160
161
.br
	[\fB\-\-mirror\-bootstrap\fR \fIURL\fR]
.br
	[\fB\-\-mirror\-chroot\fR \fIURL\fR]
.br
	[\fB\-\-mirror\-chroot\-security\fR \fIURL\fR]
.br
162
	[\fB\-\-mirror\-chroot\-updates\fR \fIURL\fR]
163
164
165
166
167
168
169
.br
	[\fB\-\-mirror\-chroot\-backports\fR \fIURL\fR]
.br
	[\fB\-\-mirror\-binary\fR \fIURL\fR]
.br
	[\fB\-\-mirror\-binary\-security\fR \fIURL\fR]
.br
170
	[\fB\-\-mirror\-binary\-updates\fR \fIURL\fR]
171
172
173
174
.br
	[\fB\-\-mirror\-binary\-backports\fR \fIURL\fR]
.br
	[\fB\-\-mirror\-debian\-installer\fR \fIURL\fR]
175
.br
176
	[\fB\-\-mode\fR debian|progress-linux|ubuntu]
177
178
.br
	[\fB\-\-system\fR live|normal]
Daniel Baumann's avatar
Daniel Baumann committed
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
.br
	[\fB\-\-net\-root\-filesystem\fR nfs|cfs]
.br
	[\fB\-\-net\-root\-mountoptions\fR \fIOPTIONS\fR]
.br
	[\fB\-\-net\-root\-path\fR \fIPATH\fR]
.br
	[\fB\-\-net\-root\-server\fR \fIIP\fR|\fIHOSTNAME\fR]
.br
	[\fB\-\-net\-cow\-filesystem\fR nfs|cfs]
.br
	[\fB\-\-net\-cow\-mountoptions\fR \fIOPTIONS\fR]
.br
	[\fB\-\-net\-cow\-path\fR \fIPATH\fR]
.br
	[\fB\-\-net\-cow\-server\fR \fIIP\fR|\fIHOSTNAME\fR]
195
.br
196
	[\fB\-\-net\-tarball\fR true|false]
197
.br
198
	[\fB\-\-quiet\fR]
Daniel Baumann's avatar
Daniel Baumann committed
199
.br
200
	[\fB\-\-archive\-areas\fR \fIARCHIVE_AREA\fR|\fI"ARCHIVE_AREAS"\fR]
201
202
.br
	[\fB\-\-parent\-archive\-areas\fR \fIPARENT_ARCHIVE_AREA\fR|\fI"PARENT_ARCHIVE_AREAS"\fR]
Daniel Baumann's avatar
Daniel Baumann committed
203
.br
204
	[\fB\-\-security\fR true|false]
Daniel Baumann's avatar
Daniel Baumann committed
205
.br
206
	[\fB\-\-source\fR true|false]
Daniel Baumann's avatar
Daniel Baumann committed
207
.br
208
	[\-s|\fB\-\-source\-images\fR iso|netboot|tar|hdd]
Daniel Baumann's avatar
Daniel Baumann committed
209
.br
210
	[\fB\-\-tasksel\fR apt|aptitude|tasksel]
Daniel Baumann's avatar
Daniel Baumann committed
211
212
.br
	[\fB\-\-templates\fR \fIPATH\fR]
213
.br
214
	[\fB\-\-hdd\-size \fIMB\fR]
215
.br
216
	[\fB\-\-updates\fR true|false]
217
218
219
220
.br
	[\fB\-\-backports\fR true|false]
.br
	[\fB\-\-verbose\fR]
221
.br
222
	[\fB\-\-win32\-loader true|false]
223
.\" FIXME
Daniel Baumann's avatar
Daniel Baumann committed
224
225

.SH DESCRIPTION
226
\fBlb config\fR is a high\-level command (porcelain) of \fIlive\-build\fR(7), the live systems tool suite.
227
228
.PP
.\" FIXME
229
\fBlb config\fR populates the configuration directory for live\-build. By default, this directory is named 'config' and is created in the current directory where \fBlb config\fR was executed.
230
.PP
231
Note: Currently \fBlb config\fR tries to be smart and sets defaults for some options depending on the setting of other options (e.g. which linux packages to be used depending on if a wheezy system gets build or not). This means that when generating a new configuration, you should call \fBlb config\fR 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 \fBlb config\fR called with one option only changes that option, and leaves everything else as is unless its not defined. However, \fBlb config\fR 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 \fBlb config\fR again.
232
.\" FIXME
Daniel Baumann's avatar
Daniel Baumann committed
233
234

.SH OPTIONS
235
In addition to its specific options \fBlb config\fR understands all generic live\-build options. See \fIlive\-build\fR(7) for a complete list of all generic live\-build options.
236
237
.PP
.\" FIXME
Daniel Baumann's avatar
Daniel Baumann committed
238
.IP "\fB\-\-apt\fR apt|aptitude" 4
239
defines if apt\-get or aptitude is used to install packages when building the image. The default is apt.
Daniel Baumann's avatar
Daniel Baumann committed
240
.IP "\fB\-\-apt\-ftp\-proxy\fR \fIURL\fR" 4
241
sets the ftp proxy to be used by apt. By default, this is empty. Note that this variable is only for the proxy that gets used by apt internally within the chroot, it is not used for anything else.
Daniel Baumann's avatar
Daniel Baumann committed
242
.IP "\fB\-\-apt\-http\-proxy\fR \fIURL\fR" 4
243
sets the http proxy to be used by apt. By default, this is empty. Note that this variable is only for the proxy that gets used by apt internally within the chroot, it is not used for anything else.
244
245
.IP "\fB\-\-apt\-indices\fR true|false|none" 4
defines if the resulting images should have apt indices or not and defaults to true. If set to none, no indices are included at all.
246
.IP "\fB\-\-apt\-options\fR \fIOPTION\fR|""\fIOPTIONS\fR""" 4
247
248
249
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.
250
.IP "\fB\-\-apt\-pipeline\fR \fIDEPTH\fR" 4
251
sets the depth of the apt/aptitude pipeline. In cases where the remote server is not RFC conforming or buggy (such as Squid 2.0.2) this option can be a value from 0 to 5 indicating how many outstanding requests APT should send. A value of zero MUST be specified if the remote host does not properly linger on TCP connections \- otherwise data corruption will occur. Hosts which require this are in violation of RFC 2068. By default, live\-build does not set this option.
252
.IP "\fB\-\-apt\-recommends\fR true|false" 4
253
defines if apt should install recommended packages automatically. By default, this is true.
254
255
.IP "\fB\-\-apt\-secure\fR true|false" 4
defines if apt should check repository signatures. This is true by default.
256
.IP "\fB\-\-apt\-source\-archives\fR true|false" 4
victory's avatar
victory committed
257
defines if deb-src entries should be included in the resulting live image or not, defaults to true.
258
.IP "\-a|\fB\-\-architectures\fR \fIARCHITECTURE\fR" 4
victory's avatar
victory committed
259
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 possible if you have a 64bit capable i386 processor and the right kernel. But building powerpc images on an i386 system is not possible.
260
.IP "\-b|\fB\-\-binary\-images\fR iso|iso\-hybrid|netboot|tar|hdd" 4
261
defines the image type to build. By default, for images using syslinux this is set to iso\-hybrid to build CD/DVD images that may also be used like hdd images, for non\-syslinux images, it defaults to iso.
262
.IP "\fB\-\-binary\-filesystem\fR fat16|fat32|ext2|ext3|ext4" 4
263
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 hdd images for usb sticks, this is active. Note that it defaults to fat16 on all architectures except sparc where it defaults to ext4. Also note that if you choose fat16 and your resulting binary image gets bigger than 2GB, the binary filesystem automatically gets switched to fat32.
264
.IP "\fB\-\-bootappend\-install\fR \fIPARAMETER\fR|""\fIPARAMETERS\fR""" 4
265
sets boot parameters specific to debian\-installer, if included.
266
.IP "\fB\-\-bootappend\-live\fR \fIPARAMETER\fR|""\fIPARAMETERS\fR""" 4
267
sets boot parameters specific to debian\-live. A complete list of boot parameters can be found in the \fIlive\-boot\fR(7) and \fIlive\-config\fR(7) manual pages.
268
.IP "\fB\-\-bootloader\fR grub|grub2|syslinux" 4
victory's avatar
victory committed
269
defines which bootloader is being 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\-build does not support them yet. \fBlb config\fR will fail to create such a not yet supported configuration and give a explanation about it. For hdd images on amd64 and i386, the default is syslinux.
270
271
.IP "\fB\-\-bootstrap\fR cdebootstrap|cdebootstrap-static|debootstrap" 4
defines which program is used to bootstrap the debian chroot, default is debootstrap.
272
.IP "\fB\-\-cache\fR true|false" 4
victory's avatar
victory committed
273
defines globally if any cache should be used at all. Different caches can be controlled through the their own options.
274
275
276
.IP "\fB\-\-cache\-indices\fR true|false" 4
defines if downloaded package indices and lists should be cached which is false 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 true|false" 4
victory's avatar
victory committed
277
defines if downloaded packages files should be cached which is true by default. Disabling it does save space consumption 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 true, 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.
278
.IP "\fB\-\-cache\-stages\fR true|false|\fISTAGE\fR|""\fISTAGES\fR""" 4
279
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 useful during development if you want to rebuild the binary stage but not regenerate the root filesystem all the time.
280
.IP "\fB\-\-checksums\fR md5|sha1|sha256|none" 4
victory's avatar
victory committed
281
defines if the binary image should contain a file called md5sums.txt, sha1sums.txt and/or sha256sums.txt. These lists all files on the image together with their checksums. This in turn can be used by live\-boot's built\-in integrity\-check to verify the medium if specified at boot prompt. In general, this should not be false 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.
282
283
.IP "\fB\-\-compression\fR bzip2|gzip|lzip|none" 4
defines the compression program to be used to compress tarballs. Defaults to gzip.
284
285
.IP "\fB\-\-config\fR \fIGIT_URL\fR::\fIGIT_ID\fR" 4
allows to bootstrap a config tree from a git repositories, optionally appended by a Git Id (branch, commit, tag, etc.).
286
.IP "\fB\-\-build\-with\-chroot\fR true|false" 4
victory's avatar
victory committed
287
defines whether live\-build should use the tools from within the chroot to build the binary image or not by using and including the host system's 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 and grub, and the auxiliary tools such as dosfstools, xorriso, squashfs-tools and others) do not \fBexactly\fR match what is present at build-time in the target distribution. Never do disable this option unless you are \fBexactly\fR sure what you are doing and have \fBcompletely\fI understood its consequences.
288
.IP "\fB\-\-chroot\-filesystem\fR ext2|ext3|ext4|squashfs|jffs2|none" 4
victory's avatar
victory committed
289
defines which filesystem type should be used for the root filesystem image. If you use none, 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 chosen, it may not be possible to build with such a plain root filesystem, e.g. fat16/fat32 will not work as linux does not support to run directly on them.
290
291
.IP "\fB\-\-clean\fR" 4
minimizes config directory by automatically removing unused and thus empty subdirectories.
Daniel Baumann's avatar
Daniel Baumann committed
292
.IP "\-c|\fB\-\-conffile\fR \fIFILE\fR" 4
293
using a user specified alternative configuration file in addition to the normally used one in the config directory.
Daniel Baumann's avatar
Daniel Baumann committed
294
.IP "\fB\-\-debconf\-frontend\fR dialog|editor|noninteractive|readline" 4
victory's avatar
victory committed
295
defines what value the debconf frontend should be set to inside the chroot. Note that setting it to anything but noninteractive, which is the default, makes your build asking questions during the build.
Daniel Baumann's avatar
Daniel Baumann committed
296
.IP "\fB\-\-debconf\-priority\fR low|medium|high|critical" 4
victory's avatar
victory committed
297
defines what value the debconf priority should be set to inside the chroot. By default, it is set to critical, which means that almost no questions are displayed. Note that this only has an effect if you use any debconf frontend different from noninteractive.
298
.IP "\fB\-\-debian\-installer\fR true|cdrom|netinst|netboot|businesscard|live|false" 4
victory's avatar
victory committed
299
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 chosen, 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.
300
.IP "\fB\-\-debian\-installer\-distribution\fR daily|\fICODENAME\fR" 4
301
302
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
303
sets the filename or URL for an optionally used and included preseeding file for debian\-installer. If config/binary_debian\-installer/preseed.cfg exists, it will be used by default. 
304
305
.IP "\fB\-\-debian\-installer\-gui\fR true|false" 4
defines if the debian\-installer graphical GTK interface should be true or not. In Debian mode and for most versions of Ubuntu, this option is true, whereas otherwise false, by default.
306
307
.IP "\fB\-\-debug\fR" 4
turn on debugging informational messages.
Daniel Baumann's avatar
Daniel Baumann committed
308
.IP "\-d|\fB\-\-distribution\fR \fICODENAME\fR" 4
309
defines the distribution of the resulting live system.
310
311
.IP "\-d|\fB\-\-parent\-distribution\fR \fICODENAME\fR" 4
defines the parent distribution for derivatives of the resulting live system.
312
313
.IP "\-d|\fB\-\-parent\-debian\-installer\-distribution\fR \fICODENAME\fR" 4
defines the parent debian\-installer distribution for derivatives of the resulting live system.
314
.IP "\fB\-\-dump\fR" 4
315
prepares a report of the currently present live system configuration and the version of live\-build used. This is useful to provide if you submit bug reports, we do get all informations required for us to locate and replicate an error.
316
317
.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.
318
319
.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.
Daniel Baumann's avatar
Daniel Baumann committed
320
.IP "\fB\-\-grub\-splash\fR \fIFILE\fR" 4
321
defines the name of an optional to be included splash screen graphic for the grub bootloader.
322
.IP "\fB\-\-gzip\-options\fR \fIOPTION\fR|""\fIOPTIONS\fR""" 4
323
defines the default options that will be appended to (almost) every gzip call during the building of the image. By default, this is set to \-\-best to use highest (but slowest) compression. Dynamically, if the host system supports it, also \-\-rsyncable is added.
Daniel Baumann's avatar
Daniel Baumann committed
324
.IP "\fB\-\-hooks\fR \fIFILE\fR" 4
325
defines which hooks available in /usr/share/live/build/examples/hooks should be activated. Normally, there are no hooks executed. Make sure you know and understood the hook before you enable it.
326
.IP "\fB\-\-ignore\-system\-defaults\fR" 4
327
\fBlb config\fR by default reads system defaults from \fI/etc/live/build.conf\fR and \fI/etc/live/build/*\fR when generating a new live system config directory. This is useful if you want to set global settings, such as mirror locations, and don't want to specify them all of the time.
328
329
.IP "\fB\-\-initramfs\fR auto|none|live\-boot|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 ubuntu systems, to live\-boot for all other systems. Using 'none' is useful if the resulting system image should not be a live image (experimental).
330
331
.IP "\fB\-\-initramfs\-compression\fR bzip2|gzip|lzma]
defines the compression program to be used to compress the initramfs. Defaults to gzip.
Daniel Baumann's avatar
Daniel Baumann committed
332
.IP "\fB\-\-interactive\fR shell" 4
333
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 false.
334
335
.IP "\fB\-\-isohybrid\-options\fR \fIOPTION\fR|""\fIOPTIONS\fR""" 4
defines options to pass to isohybrid.
Daniel Baumann's avatar
Daniel Baumann committed
336
.IP "\fB\-\-iso\-application\fR \fINAME\fR" 4
337
sets the APPLICATION field in the header of a resulting CD/DVD image and defaults to "Debian Live" in debian mode, and "Ubuntu Live" in ubuntu mode.
338
.IP "\fB\-\-iso\-preparer\fR \fINAME\fR" 4
victory's avatar
victory committed
339
sets the PREPARER field in the header of a resulting CD/DVD image. By default this is set to "live\-build \fIVERSION\fR; http://packages.qa.debian.org/live\-build", where VERSION is expanded to the version of live\-build that was used to build the image.
Daniel Baumann's avatar
Daniel Baumann committed
340
.IP "\fB\-\-iso\-publisher\fR \fINAME\fR" 4
341
sets the PUBLISHED field in the header of a resulting CD/DVD image. By default, this is set to 'Live Systems project; http:/live-systems.org/; debian\-live@lists.debian.org'. Remember to change this to the appropriate values at latest when you distributing custom and unofficial images.
Daniel Baumann's avatar
Daniel Baumann committed
342
.IP "\fB\-\-iso\-volume\fR \fINAME\fR" 4
343
sets the VOLUME field in the header of a resulting CD/DVD and defaults to '(\fIMODE\fR) (\fIDISTRIBUTION\fR) (\fIDATE\fR)' whereas MODE is expanded to the name of the mode in use, DISTRIBUTION the distribution name, and DATE with the current date and time of the generation.
344
.IP "\fB\-\-jffs2\-eraseblock\fR \fISIZE\fR" 4
victory's avatar
victory committed
345
sets the eraseblock size for a JFFS2 (Second Journaling Flash File System) filesystem. The default is 64 KiB. If you use an erase block size different than the erase block size of the target MTD device, JFFS2 may not perform optimally. If the SIZE specified is below 4096, the units are assumed to be KiB.
346
.IP "\fB\-\-keyring\-packages\fR \fIPACKAGE\fI|""\fIPACKAGES\fR""" 4
347
sets the keyring package or additional keyring packages. By default this is set to debian\-archive\-keyring.
348
.IP "\-k|\fB\-\-linux\-flavours\fR \fIFLAVOUR\fR|""\fIFLAVOURS\fR""" 4
349
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 booted.
350
.IP "\fB\-\-linux\-packages\fR ""\fIPACKAGES\fR""" 4
351
sets the internal name of the kernel packages naming scheme. If you use debian kernel packages, 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.
Daniel Baumann's avatar
Daniel Baumann committed
352
.IP "\fB\-\-losetup\fR losetup|losetup.orig" 4
353
354
355
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+.
356
.IP "\-m|\fB\-\-parent\-mirror\-bootstrap\fR \fIURL\fR" 4
357
sets the location of the debian package mirror that should be used to bootstrap from. This defaults to http://ftp.de.debian.org/debian/ which may not be a good default if you live outside of Europe.
358
359
360
.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. By default, this is set to the value of \-\-parent\-mirror\-bootstrap.
.IP "\fB\-\-parent\-mirror\-chroot\-security\fR \fIURL\fR" 4
361
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/.
362
363
.IP "\fB\-\-parent\-mirror\-chroot\-updates\fR \fIURL\fR" 4
sets the location of the debian updates package mirror that will be used to fetch packages in order to build the live system. By default, this is set to the value of \-\-parent\-mirror\-chroot.
364
.IP "\fB\-\-parent\-mirror\-chroot\-backports\fR \fIURL\fR" 4
365
sets the location of the debian backports package mirror that will be used to fetch packages in order to build the live system. By default, this points to http://backports.debian.org/debian-backports/.
366
.IP "\fB\-\-parent\-mirror\-binary\fR \fIURL\fR" 4
367
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, 'http://http.debian.net/debian/' is used.
368
.IP "\fB\-\-parent\-mirror\-binary\-security\fR \fIURL\fR" 4
369
sets the location of the debian security package mirror that should end up configured in the final image. By default, 'http://security.debian.org/' is used.
370
371
.IP "\fB\-\-parent\-mirror\-binary\-updates\fR \fIURL\fR" 4
sets the location of the debian updates package mirror that should end up configured in the final image. By default, the value of \-\-parent\-mirror\-binary is used.
372
.IP "\fB\-\-parent\-mirror\-binary\-backports\fR \fIURL\fR" 4
373
sets the location of the debian backports package mirror that should end up configured in the final image. By default, 'http://backports.debian.org/debian-backports/' is used.
374
375
.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. By default, this points to the same mirror used to build the live system, i.e. the value of \-\-parent\-mirror\-bootstrap.
376
.IP "\fB\-\-mirror\-bootstrap\fR \fIURL\fR" 4
377
378
379
380
381
sets the location of the debian package mirror that should be used to bootstrap the derivative from. This defaults to http://ftp.de.debian.org/debian/ which may not be a good default if you live outside of Europe.
.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.
.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/debian/.
382
383
.IP "\fB\-\-mirror\-chroot\-updates\fR \fIURL\fR" 4
sets the location of the debian updates package mirror that will be used to fetch packages of the derivative in order to build the live system. By default, this is set to the value of \-\-mirror\-chroot.
384
385
386
387
388
389
.IP "\fB\-\-mirror\-chroot\-backports\fR \fIURL\fR" 4
sets the location of the debian backports package mirror that will be used to fetch packages of the derivative in order to build the live system. By default, this points to http://backports.debian.org/debian-backports/.
.IP "\fB\-\-mirror\-binary\fR \fIURL\fR" 4
sets the location of the derivative 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.
.IP "\fB\-\-mirror\-binary\-security\fR \fIURL\fR" 4
sets the location of the derivatives security package mirror that should end up configured in the final image.
390
391
.IP "\fB\-\-mirror\-binary\-updates\fR \fIURL\fR" 4
sets the location of the derivatives updates package mirror that should end up configured in the final image.
392
393
394
395
.IP "\fB\-\-mirror\-binary\-backports\fR \fIURL\fR" 4
sets the location of the derivatives backports package mirror that should end up configured in the final image.
.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\-bootstrap.
396
.IP "\fB\-\-mode\fR debian|progress|ubuntu" 4
397
defines a global mode to load project specific defaults. By default this is set to debian.
398
399
.IP "\fB\-\-system\fR live|normal" 4
defines if the resulting system image should a live system or a normal, non-live system.
400
.IP "\fB\-\-net\-root\-filesystem\fR nfs|cfs" 4
401
defines the filesystem that will be configured in the bootloader configuration for your netboot image. This defaults to nfs.
Daniel Baumann's avatar
Daniel Baumann committed
402
.IP "\fB\-\-net\-root\-mountoptions\fR \fIOPTIONS\fR" 4
403
sets additional options for mounting the root filesystem in netboot images and is by default empty.
404
.IP "\fB\-\-net\-root\-path\fR \fIPATH\fR" 4
405
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 /srv/ubuntu-live when in ubuntu mode.
Daniel Baumann's avatar
Daniel Baumann committed
406
.IP "\fB\-\-net\-root\-server\fR \fIIP\fR|\fIHOSTNAME\fR" 4
407
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.
Daniel Baumann's avatar
Daniel Baumann committed
408
.IP "\fB\-\-net\-cow\-filesystem\fR nfs|cfs" 4
409
defines the filesystem type for the copy\-on\-write layer and defaults to nfs.
Daniel Baumann's avatar
Daniel Baumann committed
410
.IP "\fB\-\-net\-cow\-mountoptions\fR \fIOPTIONS\fR" 4
411
sets additional options for mounting the copy\-on\-write layer in netboot images and is by default empty.
412
.IP "\fB\-\-net\-cow\-path\fR \fIPATH\fR" 4
413
defines the path to client writable filesystem. Anywhere that \fIclient_mac_address\fR is specified in the path live\-boot will substitute the MAC address of the client delimited with hyphens.
Daniel Baumann's avatar
Daniel Baumann committed
414
415
416
417
.PP
.IP "" 4
Example:
.br
418
419
/export/hosts/client_mac_address
.br
Daniel Baumann's avatar
Daniel Baumann committed
420
421
/export/hosts/00\-16\-D3\-33\-92\-E8
.IP "\fB\-\-net\-cow\-server\fR \fIIP\fR|\fIHOSTNAME\fR" 4
422
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.
423
424
.IP "\fB\-\-net\-tarball\fR true|false" 4
defines if a compressed tarball should be created. Disabling this options leads to no tarball at all, the plain binary directory is considered the output in this case. Default is true.
425
426
.IP "\fB\-\-quiet\fR" 4
reduces the verbosity of messages output by \fBlb build\fR.
427
.IP "\fB\-\-archive\-areas\fR \fIARCHIVE_AREA\fR|""\fIARCHIVE_AREAS\fR""" 4
428
defines which package archive areas 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.
429
430
.IP "\fB\-\-parent\-archive\-areas\fR \fIPARENT_ARCHIVE_AREA\fR|""\fIPARENT_ARCHIVE_AREAS\fR""" 4
defines the archive areas for derivatives of the resulting live system.
431
.IP "\fB\-\-security\fR true|false" 4
432
defines if the security repositories specified in the security mirror options should be used or not.
433
434
.IP "\fB\-\-source\fR true|false" 4
defines if a corresponding source image to the binary image should be build. By default this is false 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.
435
.IP "\-s|\fB\-\-source\-images\fR iso|netboot|tar|hdd" 4
436
defines the image type for the source image. Default is tar.
437
438
439
440
.IP "\fB\-\-firmware\-binary\fR true|false" 4
defines if firmware packages should be automatically included into the binary pool for debian\-installer. Note that only firmware packages available within the configured archive areas are included, e.g. an image with packages from main only will not automatically include firmware from non\-free. This option does not interfere with explicitly listed packages in binary package lists.
.IP "\fB\-\-firmware\-chroot\fR true|false" 4
defines if firmware packages should be automatically included into the live image. Note that only firmware packages available within the configured archive areas are included, e.g. an image with packages from main only will not automatically include firmware from non\-free. This option does not interfere with explicitly listed packages in chroot package lists.
441
442
443
444
.IP "\fB\-\-swap\-file\-path\fR \fIPATH\fR" 4
defines the path to a swap file to create in the binary image. Default is not to create a swap file.
.IP "\fB\-\-swap\-file\-size\fR \fIMB\fR" 4
defines what size in megabytes the swap file should be, if one is to be created. Default is 512MB.
445
.IP "\fB\-\-tasksel\fR apt|aptitude|tasksel" 4
446
selects which program is used to install tasks. By default, this is set to tasksel.
Daniel Baumann's avatar
Daniel Baumann committed
447
.IP "\fB\-\-templates\fR \fIPATH\fR" 4
448
sets the path to the templates that live\-build is going to use, e.g. for bootloaders. By default, this is set to /usr/share/live/build/templates/.
449
450
.IP "\fB\-\-hdd\-size\fR MB" 4
defines what size the 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.
451
452
.IP "\fB\-\-updates\fR true|false" 4
defines if debian updates package archives should be included in the image or not.
453
454
455
456
.IP "\fB\-\-backports\fR true|false" 4
defines if debian backports package archives should be included in the image or not.
.IP "\fB\-\-verbose\fR" 4
increases the verbosity of messages output by \fBlb build\fR.
457
.IP "\fB\-\-win32\-loader true|false" 4
458
defines if win32\-loader should be included in the binary image or not.
459
.\" FIXME
Daniel Baumann's avatar
Daniel Baumann committed
460
461

.SH ENVIRONMENT
462
.\" FIXME
463
464
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.
\" FIXME
Daniel Baumann's avatar
Daniel Baumann committed
465

466
.SH FILES
467
468
.\" FIXME
.IP "\fBauto/config\fR" 4
469
.IP "\fB/etc/live/build.conf, /etc/live/build/*\fR" 4
470
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 false by specifying the \fB\-\-ignore\-system\-defaults\fR option.
471
.\" FIXME
472

Daniel Baumann's avatar
Daniel Baumann committed
473
.SH SEE ALSO
474
475
476
477
478
\fIlive\-build\fR(7)
.PP
\fIlive\-boot\fR(7)
.PP
\fIlive\-config\fR(7)
Daniel Baumann's avatar
Daniel Baumann committed
479
.PP
480
This program is a part of live\-build.
Daniel Baumann's avatar
Daniel Baumann committed
481
482

.SH HOMEPAGE
483
More information about live\-build and the Live Systems project can be found on the homepage at <\fIhttp://live-systems.org/\fR> and in the manual at <\fIhttp://live-systems.org/manual/\fR>.
484
485

.SH BUGS
486
Bugs can be reported by submitting a bugreport for the live\-build package in the Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or by writing a mail to the Live Systems mailing list at <\fIdebian-live@lists.debian.org\fR>.
Daniel Baumann's avatar
Daniel Baumann committed
487
488

.SH AUTHOR
489
live\-build was written by Daniel Baumann <\fImail@daniel-baumann.ch\fR>.