source: live-build/trunk/fuentes/manpages/de/lb_config.de.1 @ 900

Last change on this file since 900 was 900, checked in by kbut, 3 years ago

add original source

File size: 38.7 KB
Line 
1.\"*******************************************************************
2.\"
3.\" This file was generated with po4a. Translate the source file.
4.\"
5.\"*******************************************************************
6.TH LIVE\-BUILD 1 2012\-08\-10 3.0~a57\-1 "Debian Live Project"
7
8.SH NAME
9\fBlb config\fP \- Create config directory
10
11.SH SYNOPSIS
12\fBlb config\fP [\fIlive\-build options\fP]
13.PP
14.\" FIXME
15\fBlb config\fP
16.br
17  [\fB\-\-apt\fP apt|aptitude]
18.br
19  [\fB\-\-apt\-ftp\-proxy\fP \fIURL\fP]
20.br
21  [\fB\-\-apt\-http\-proxy\fP \fIURL\fP]
22.br
23  [\fB\-\-apt\-indices\fP true|false|none]
24.br
25  [\fB\-\-apt\-options\fP \fIOPTION\fP|"\fIOPTIONS\fP"]
26.br
27  [\fB\-\-aptitude\-options\fP \fIOPTION\fP|"\fIOPTIONS\fP"]
28.br
29  [\fB\-\-apt\-pipeline\fP \fIDEPTH\fP]
30.br
31  [\fB\-\-apt\-recommends\fP true|false]
32.br
33  [\fB\-\-apt\-secure\fP true|false]
34.br
35  [\fB\-\-apt\-source\-archives\fP true|false]
36.br
37  [\-a|\fB\-\-architectures\fP \fIARCHITECTURE\fP]
38.br
39  [\-b|\fB\-\-binary\-images\fP iso|iso\-hybrid|netboot|tar|hdd|virtual\-hdd]
40.br
41  [\fB\-\-binary\-filesystem\fP fat16|fat32|ext2|ext3|ext4]
42.br
43  [\fB\-\-bootappend\-install\fP \fIPARAMETER\fP|\fI"PARAMETERS"\fP]
44.br
45  [\fB\-\-bootappend\-live\fP \fIPARAMETER\fP|\fI"PARAMETERS"\fP]
46.br
47  [\fB\-\-bootloader\fP grub|syslinux|yaboot]
48.br
49  [\fB\-\-bootstrap\fP cdebootstrap|cdebootstrap\-static|debootstrap|copy]
50.br
51  [\-f|\fB\-\-bootstrap\-flavour\fP minimal|standard]
52.br
53  [\fB\-\-bootstrap\-keyring\fP \fIPACKAGE\fP]
54.br
55  [\fB\-\-cache\fP true|false]
56.br
57  [\fB\-\-cache\-indices\fP true|false]
58.br
59  [\fB\-\-cache\-packages\fP true|false]
60.br
61  [\fB\-\-cache\-stages\fP \fISTAGE\fP|\fI"STAGES"\fP]
62.br
63  [\fB\-\-checksums\fP md5|sha1|sha256|none]
64.br
65  [\fB\-\-compression\fP bzip2|gzip|lzip|none]
66.br
67  [\fB\-\-config\fP \fIGIT_URL::GIT_ID\fP]
68.br
69  [\fB\-\-build\-with\-chroot\fP true|false]
70.br
71  [\fB\-\-chroot\-filesystem\fP ext2|ext3|ext4|squashfs|jffs2|none]
72.br
73  [\fB\-\-clean\fP]
74.br
75  [\-c|\fB\-\-conffile\fP \fIFILE\fP]
76.br
77  [\fB\-\-debconf\-frontend\fP dialog|editor|noninteractive|readline]
78.br
79  [\fB\-\-debconf\-nowarnings\fP true|false]
80.br
81  [\fB\-\-debconf\-priority\fP low|medium|high|critical]
82.br
83  [\fB\-\-debian\-installer\fP true|cdrom|netinst|netboot|businesscard|live|false]
84.br
85  [\fB\-\-debian\-installer\-distribution\fP daily|\fICODENAME\fP]
86.br
87  [\fB\-\-debian\-installer\-preseedfile\fP \fIFILE\fP|\fIURL\fP]
88.br
89  [\fB\-\-debian\-installer\-gui\fP true|false]
90.br
91  [\fB\-\-debug\fP]
92.br
93  [\-d|\fB\-\-distribution\fP \fICODENAME\fP]
94.br
95  [\fB\-\-parent\-distribution\fP \fICODENAME\fP]
96.br
97  [\fB\-\-parent\-debian\-installer\-distribution\fP \fICODENAME\fP]
98.br
99  [\fB\-\-dump\fP]
100.br
101  [\fB\-\-fdisk\fP fdisk|fdisk.dist]
102.br
103  [\fB\-\-firmware\-binary true|false\fP]
104.br
105  [\fB\-\-firmware\-chroot true|false\fP]
106.br
107  [\fB\-\-force\fP]
108.br
109  [\fB\-\-grub\-splash\fP \fIFILE\fP]
110.br
111  [\fB\-\-gzip\-options\fP \fIOPTION\fP|"\fIOPTIONS\fP"]
112.br
113  [\fB\-\-hooks\fP \fIFILE\fP]
114.br
115  [\fB\-\-ignore\-system\-defaults\fP]
116.br
117  [\fB\-\-initramfs\fP auto|none|live\-boot|casper]
118.br
119  [\fB\-\-initramfs\-compression\fP bzip2|gzip|lzma]
120.br
121  [\fB\-\-initsystem\fP sysvinit|runit|systemd|upstart|none]
122.br
123  [\fB\-\-interactive\fP shell]
124.br
125  [\fB\-\-isohybrid\-options\fP \fIOPTION\fP|"\fIOPTIONS\fP"]
126.br
127  [\fB\-\-iso\-application\fP \fINAME\fP]
128.br
129  [\fB\-\-iso\-preparer\fP \fINAME\fP]
130.br
131  [\fB\-\-iso\-publisher\fP \fINAME\fP]
132.br
133  [\fB\-\-iso\-volume\fP \fINAME\fP]
134.br
135  [\fB\-\-jffs2\-eraseblock\fP \fISIZE\fP]
136.br
137  [\fB\-\-keyring\-packages\fP \fIPACKAGE|"PACKAGES"\fP]
138.br
139  [\-k|\fB\-\-linux\-flavours\fP \fIFLAVOUR\fP|\fI"FLAVOURS"\fP]
140.br
141  [\fB\-\-linux\-packages\fP \fI"PACKAGES"\fP]
142.br
143  [\fB\-\-losetup\fP losetup|losetup.orig]
144.br
145  [\fB\-\-memtest\fP memtest86+|memtest86|none]
146.br
147  [\-m|\fB\-\-parent\-mirror\-bootstrap\fP \fIURL\fP]
148.br
149  [\fB\-\-parent\-mirror\-chroot\fP \fIURL\fP]
150.br
151  [\fB\-\-parent\-mirror\-chroot\-security\fP \fIURL\fP]
152.br
153  [\fB\-\-parent\-mirror\-chroot\-volatile\fP \fIURL\fP]
154.br
155  [\fB\-\-parent\-mirror\-chroot\-backports\fP \fIURL\fP]
156.br
157  [\fB\-\-parent\-mirror\-binary\fP \fIURL\fP]
158.br
159  [\fB\-\-parent\-mirror\-binary\-security\fP \fIURL\fP]
160.br
161  [\fB\-\-parent\-mirror\-binary\-volatile\fP \fIURL\fP]
162.br
163  [\fB\-\-parent\-mirror\-binary\-backports\fP \fIURL\fP]
164.br
165  [\fB\-\-parent\-mirror\-debian\-installer\fP \fIURL\fP]
166.br
167  [\fB\-\-mirror\-bootstrap\fP \fIURL\fP]
168.br
169  [\fB\-\-mirror\-chroot\fP \fIURL\fP]
170.br
171  [\fB\-\-mirror\-chroot\-security\fP \fIURL\fP]
172.br
173  [\fB\-\-mirror\-chroot\-volatile\fP \fIURL\fP]
174.br
175  [\fB\-\-mirror\-chroot\-backports\fP \fIURL\fP]
176.br
177  [\fB\-\-mirror\-binary\fP \fIURL\fP]
178.br
179  [\fB\-\-mirror\-binary\-security\fP \fIURL\fP]
180.br
181  [\fB\-\-mirror\-binary\-volatile\fP \fIURL\fP]
182.br
183  [\fB\-\-mirror\-binary\-backports\fP \fIURL\fP]
184.br
185  [\fB\-\-mirror\-debian\-installer\fP \fIURL\fP]
186.br
187  [\fB\-\-mode\fP debian|emdebian|progress|ubuntu|kubuntu]
188.br
189  [\fB\-\-system\fP live|normal]
190.br
191  [\fB\-\-net\-root\-filesystem\fP nfs|cfs]
192.br
193  [\fB\-\-net\-root\-mountoptions\fP \fIOPTIONS\fP]
194.br
195  [\fB\-\-net\-root\-path\fP \fIPATH\fP]
196.br
197  [\fB\-\-net\-root\-server\fP \fIIP\fP|\fIHOSTNAME\fP]
198.br
199  [\fB\-\-net\-cow\-filesystem\fP nfs|cfs]
200.br
201  [\fB\-\-net\-cow\-mountoptions\fP \fIOPTIONS\fP]
202.br
203  [\fB\-\-net\-cow\-path\fP \fIPATH\fP]
204.br
205  [\fB\-\-net\-cow\-server\fP \fIIP\fP|\fIHOSTNAME\fP]
206.br
207  [\fB\-\-net\-tarball\fP true|false]
208.br
209  [\-p|\fB\-\-package\-lists\fP \fILIST\fP|\fI"LISTS"\fP]
210.br
211  [\fB\-\-quiet\fP]
212.br
213  [\fB\-\-root\-command\fP sudo]
214.br
215  [\fB\-\-use\-fakeroot\fP true|false]
216.br
217  [\fB\-\-archives\fP \fIARCHIVE\fP|\fI"ARCHIVES"\fP]
218.br
219  [\fB\-\-archive\-areas\fP \fIARCHIVE_AREA\fP|\fI"ARCHIVE_AREAS"\fP]
220.br
221  [\fB\-\-parent\-archive\-areas\fP
222\fIPARENT_ARCHIVE_AREA\fP|\fI"PARENT_ARCHIVE_AREAS"\fP]
223.br
224  [\fB\-\-security\fP true|false]
225.br
226  [\fB\-\-source\fP true|false]
227.br
228  [\-s|\fB\-\-source\-images\fP iso|netboot|tar|hdd]
229.br
230  [\fB\-\-syslinux\-theme\fP \fITHEME_SUFFIX\fP]
231.br
232  [\fB\-\-tasksel\fP apt|aptitude|tasksel]
233.br
234  [\fB\-\-templates\fP \fIPATH\fP]
235.br
236  [\fB\-\-hdd\-size \fP\fIMB\fP]
237.br
238  [\fB\-\-volatile\fP true|false]
239.br
240  [\fB\-\-backports\fP true|false]
241.br
242  [\fB\-\-exposed\-root\fP true|false]
243.br
244  [\fB\-\-verbose\fP]
245.br
246.\" FIXME
247  [\fB\-\-win32\-loader true|false]\fP
248
249.SH DESCRIPTION
250\fBlb config\fP is a high\-level command (porcelain) of \fIlive\-build\fP(7), the
251Debian Live tool suite.
252.PP
253.\" FIXME
254\fBlb config\fP populates the configuration directory for live\-build. By
255default, this directory is named 'config' and is created in the current
256directory where \fBlb config\fP was executed.
257.PP
258.\" FIXME
259Note: Currently \fBlb config\fP tries to be smart and sets defaults for some
260options depending on the setting of other options (e.g. which linux packages
261to be used depending on if a squeeze system gets build or not). This means
262that when generating a new configuration, you should call \fBlb config\fP only
263once with all options specified. Calling it several times with only a subset
264of the options each can result in non working configurations. This is also
265caused by the fact that \fBlb config\fP called with one option only changes
266that option, and leaves everything else as is unless its not
267defined. However, \fBlb config\fP does warn about know impossible or likely
268impossible combinations that would lead to non working live systems. If
269unsure, remove config/{binary,bootstrap,chroot,common,source} and call \fBlb
270config\fP again.
271
272.SH OPTIONS
273In addition to its specific options \fBlb config\fP understands all generic
274live\-build options. See \fIlive\-build\fP(7) for a complete list of all generic
275live\-build options.
276.PP
277.\" FIXME
278.IP "\fB\-\-apt\fP apt|aptitude" 4
279defines if apt\-get or aptitude is used to install packages when building the
280image. The default is apt.
281.IP "\fB\-\-apt\-ftp\-proxy\fP \fIURL\fP" 4
282sets the ftp proxy to be used by apt. By default, this is empty. Note that
283this variable is only for the proxy that gets used by apt internally within
284the chroot, it is not used for anything else.
285.IP "\fB\-\-apt\-http\-proxy\fP \fIURL\fP" 4
286sets the http proxy to be used by apt. By default, this is empty. Note that
287this variable is only for the proxy that gets used by apt internally within
288the chroot, it is not used for anything else.
289.IP "\fB\-\-apt\-indices\fP true|false|none" 4
290defines if the resulting images should have apt indices or not and defaults
291to true. If set to none, no indices are included at all.
292.IP "\fB\-\-apt\-options\fP \fIOPTION\fP|\(dq\fIOPTIONS\fP\(dq" 4
293defines the default options that will be appended to every apt call that is
294made inside chroot during the building of the image. By default, this is set
295to \-\-yes to allow non\-interactive installation of packages.
296.IP "\fB\-\-aptitude\-options\fP \fIOPTION\fP|\(dq\fIOPTIONS\fP\(dq" 4
297defines the default options that will be appended to every aptitude call
298that is made inside chroot during building of the image. By default, this is
299set to \-\-assume\-yes to allow non\-interactive installation of packages.
300.IP "\fB\-\-apt\-pipeline\fP \fIDEPTH\fP" 4
301sets the depth of the apt/aptitude pipeline. In cases where the remote
302server is not RFC conforming or buggy (such as Squid 2.0.2) this option can
303be a value from 0 to 5 indicating how many outstanding requests APT should
304send. A value of zero MUST be specified if the remote host does not properly
305linger on TCP connections \- otherwise data corruption will occur. Hosts
306which require this are in violation of RFC 2068. By default, live\-build does
307not set this option.
308.IP "\fB\-\-apt\-recommends\fP true|false" 4
309defines if apt should install recommended packages automatically. By
310default, this is true except in emdebian mode.
311.IP "\fB\-\-apt\-secure\fP true|false" 4
312defines if apt should check repository signatures. This is true by default.
313.IP "\fB\-\-apt\-source\-archives\fP true|false" 4
314defines if deb\-src entries should be included in the resulting live image or
315not, defaults to on.
316.IP "\-a|\fB\-\-architectures\fP \fIARCHITECTURE\fP" 4
317defines the architecture of the to be build image. By default, this is set
318to the host architecture. Note that you cannot crossbuild for another
319architecture if your host system is not able to execute binaries for the
320target architecture natively. For example, building amd64 images on i386 and
321vice versa is possile if you have a 64bit capable i386 processor and the
322right kernel. But building powerpc images on an i386 system is not possible.
323.IP "\-b|\fB\-\-binary\-images\fP iso|iso\-hybrid|netboot|tar|hdd" 4
324defines the image type to build. By default, for images using syslinux this
325is set to iso\-hybrid to build CD/DVD images that may also be used like hdd
326images, for non\-syslinux images, it defaults to iso.
327.IP "\fB\-\-binary\-filesystem\fP fat16|fat32|ext2|ext3|ext4" 4
328defines the filesystem to be used in the image type. This only has an effect
329if the selected binary image type does allow to choose a filesystem. For
330example, when selection iso the resulting CD/DVD has always the filesystem
331ISO9660. When building hdd images for usb sticks, this is active. Note that
332it defaults to fat16 on all architectures except sparc where it defaults to
333ext4. Also note that if you choose fat16 and your resulting binary image
334gets bigger than 2GB, the binary filesystem automatically gets switched to
335fat32.
336.IP "\fB\-\-bootappend\-install\fP \fIPARAMETER\fP|\(dq\fIPARAMETERS\fP\(dq" 4
337sets boot parameters specific to debian\-installer, if included.
338.IP "\fB\-\-bootappend\-live\fP \fIPARAMETER\fP|\(dq\fIPARAMETERS\fP\(dq" 4
339sets boot parameters specific to debian\-live. A complete list of boot
340parameters can be found in the \fIlive\-boot\fP(7) and \fIlive\-config\fP(7) manual
341pages.
342.IP "\fB\-\-bootloader\fP grub|syslinux|yaboot" 4
343defines which bootloader is beeing used in the generated image. This has
344only an effect if the selected binary image type does allow to choose the
345bootloader. For example, if you build a iso, always syslinux (or more
346precise, isolinux) is being used. Also note that some combinations of binary
347images types and bootloaders may be possible but live\-build does not support
348them yet. \fBlb config\fP will fail to create such a not yet supported
349configuration and give a explanation about it. For hdd images on amd64 and
350i386, the default is syslinux. yaboot is only used on powerpc.
351.IP "\fB\-\-bootstrap\fP cdebootstrap|cdebootstrap\-static|debootstrap|copy" 4
352defines which program is used to bootstrap the debian chroot, default is
353debootstrap. Note that if you set the bootstrap program to copy, then your
354host system is copied. This can be useful if you want to convert/clone your
355existing host system into a live system, however, make sure you do have
356enough free space as this can, depending on your host system, get quite big.
357.IP "\-f|\fB\-\-bootstrap\-flavour\fP minimal|standard" 4
358defines if the bootstrap program should bootstrap the standard system (all
359packages of priority required and important, which is the default) or a
360minimal system (only packages of priority required, plus apt).
361.IP "\fB\-\-bootstrap\-keyring\fP \fIPACKAGE\fP" 4
362sets the archive keyring package to be used. Default is
363debian\-archive\-keyring.
364.IP "\fB\-\-cache\fP true|false" 4
365defines globally if any cache should be used at all. Different caches can be
366controled through the their own options.
367.IP "\fB\-\-cache\-indices\fP true|false" 4
368defines if downloaded package indices and lists should be cached which is
369false by default. Enabling it would allow to rebuild an image completely
370offline, however, you would not get updates anymore then.
371.IP "\fB\-\-cache\-packages\fP true|false" 4
372defines if downloaded packages files should be cached which is true by
373default. Disabling it does save space consumtion in your build directory,
374but remember that you will cause much unnecessary traffic if you do a couple
375of rebuilds. In general you should always leave it true, however, in some
376particular rare build setups, it can be faster to refetch packages from the
377local network mirror rather than to utilize the local disk.
378.IP "\fB\-\-cache\-stages\fP true|false|\fISTAGE\fP|\(dq\fISTAGES\fP\(dq" 4
379sets which stages should be cached. By default set to bootstrap. As an
380exception to the normal stage names, also rootfs can be used here which does
381only cache the generated root filesystem in
382filesystem.{dir,ext*,squashfs}. This is useful during development if you
383want to rebuild the binary stage but not regenerate the root filesystem all
384the time.
385.IP "\fB\-\-checksums\fP md5|sha1|sha256|none" 4
386defines if the binary image should contain a file called md5sums.txt,
387sha1sums.txt and/or sha256sums.txt. These lists all files on the image
388together with their checksums. This in turn can be used by live\-boots
389built\-in integrity\-check to verify the medium if specified at boot
390prompt. In general, this should not be false and is an important feature of
391live system released to the public. However, during development of very big
392images it can save some time by not calculating the checksums.
393.IP "\fB\-\-compression\fP bzip2|gzip|lzip|none" 4
394defines the compression program to be used to compress tarballs. Defaults to
395gzip.
396.IP "\fB\-\-config\fP \fIGIT_URL\fP::\fIGIT_ID\fP" 4
397allows to bootstrap a config tree from a git repositories, optionally
398appended by a Git Id (branch, commit, tag, etc.).
399.IP "\fB\-\-build\-with\-chroot\fP true|false" 4
400defines whetever live\-build should use the tools from within the chroot to
401build the binary image or not by using and including the host systems
402tools. This is a very dangerous option, using the tools of the host system
403can lead to tainted and even non\-bootable images if the host systems version
404of the required tools (mainly these are the bootloaders such as syslinux,
405grub and yaboot, and the auxilliary tools such as dosfstools, genisoimage,
406squashfs\-tools and others) do not \fBexactely\fP match what is present at
407build\-time in the target distribution. Never do disable this option unless
408you are \fBexactely\fP sure what you are doing and have \fBcompletely\fP\fI
409understood its consequences.\fP
410.IP "\fB\-\-chroot\-filesystem\fP ext2|ext3|ext4|squashfs|jffs2|none" 4
411defines which filesystem type should be used for the root filesystem
412image. If you use none, then no filesystem image is created and the root
413filesystem content is copied on the binary image filesystem as flat
414files. Depending on what binary filesystem you have choosen, it may not be
415possible to build with such a plain root filesystem, e.g. fat16/fat32 will
416not work as linux does not support to run directly on them.
417.IP \fB\-\-clean\fP 4
418minimizes config directory by automatically removing unused and thus empty
419subdirectories.
420.IP "\-c|\fB\-\-conffile\fP \fIFILE\fP" 4
421using a user specified alternative configuration file in addition to the
422normally used one in the config directory.
423.IP "\fB\-\-debconf\-frontend\fP dialog|editor|noninteractive|readline" 4
424defines what value the debconf frontend should be set to inside the
425chroot. Note that setting it to anything by noninteractive, which is the
426default, makes your build asking questions during the build.
427.IP "\fB\-\-debconf\-nowarnings\fP true|false" 4
428defines if warnings of debconf should be displayed or not. Warnings from
429debconf are generally very rare and by default, we skip them, if any, in
430order to keep the build process entirely non interactive.
431.IP "\fB\-\-debconf\-priority\fP low|medium|high|critical" 4
432defines what value the debconf priority shoul dbe set to inside the
433chroot. By default, it is set to critical, which means that almost no
434questions are displayed. Note that this only has an effect if you use any
435debconf frontend different from noninteractive.
436.IP "\fB\-\-debian\-installer\fP true|cdrom|netinst|netboot|businesscard|live|false" 4
437defines which type, if any, of the debian\-installer should be included in
438the resulting binary image. By default, no installer is included. All
439available flavours except live are the identical configurations used on the
440installer media produced by regular debian\-cd. When live is choosen, the
441live\-installer udeb is included so that debian\-installer will behave
442different than usual \- instead of installing the debian system from packages
443from the medium or the network, it installs the live system to the disk.
444.IP "\fB\-\-debian\-installer\-distribution\fP daily|\fICODENAME\fP" 4
445defines the distribution where the debian\-installer files should be taken
446out from. Normally, this should be set to the same distribution as the live
447system. However, some times, one wants to use a newer or even daily built
448installer.
449.IP "\fB\-\-debian\-installer\-preseedfile\fP \fIFILE\fP|\fIURL\fP" 4
450sets the filename or URL for an optionally used and included preseeding file
451for debian\-installer. If config/binary_debian\-installer/preseed.cfg exists,
452it will be used by default.
453.IP "\fB\-\-debian\-installer\-gui\fP true|false" 4
454defines if the debian\-installer graphical GTK interface should be true or
455not. In Debian mode and for most versions of Ubuntu, this option is true,
456whereas otherwise false, by default.
457.IP \fB\-\-debug\fP 4
458turn on debugging informational messages.
459.IP "\-d|\fB\-\-distribution\fP \fICODENAME\fP" 4
460defines the distribution of the resulting live system.
461.IP "\-d|\fB\-\-parent\-distribution\fP \fICODENAME\fP" 4
462defines the parent distribution for derivatives of the resulting live
463system.
464.IP "\-d|\fB\-\-parent\-debian\-installer\-distribution\fP \fICODENAME\fP" 4
465defines the parent debian\-installer distribution for derivatives of the
466resulting live system.
467.IP \fB\-\-dump\fP 4
468prepares a report of the currently present live system configuration and the
469version of live\-build used. This is useful to provide if you submit bug
470reports, we do get all informations required for us to locate and replicate
471an error.
472.IP "\fB\-\-fdisk\fP fdisk|fdisk.dist" 4
473sets the filename of the fdisk binary from the host system that should be
474used. This is autodetected and does generally not need any customization.
475.IP \fB\-\-force\fP 4
476forces re\-execution of already run stages. Use only if you know what you are
477doing. It is generally safer to use \fBlb clean\fP to clean up before
478re\-executing \fBlb build\fP.
479.IP "\fB\-\-grub\-splash\fP \fIFILE\fP" 4
480defines the name of an optional to be included splash screen graphic for the
481grub bootloader.
482.IP "\fB\-\-gzip\-options\fP \fIOPTION\fP|\(dq\fIOPTIONS\fP\(dq" 4
483defines the default options that will be appended to (almost) every gzip
484call during the building of the image. By default, this is set to \-\-best to
485use highest (but slowest) compression. Dynamically, if the host system
486supports it, also \-\-rsyncable is added.
487.IP "\fB\-\-hooks\fP \fIFILE\fP" 4
488defines which hooks available in /usr/share/live/build/examples/hooks should
489be activated. Normally, there are no hooks executed. Make sure you know and
490understood the hook before you enable it.
491.IP \fB\-\-ignore\-system\-defaults\fP 4
492\fBlb config\fP by default reads system defaults from /etc/live/build.conf and
493/etc/live/build.d when generating a new live system config directory. This
494is useful if you want to set global settings, such as mirror locations, and
495don't want to specify them all of the time.
496.IP "\fB\-\-initramfs\fP auto|none|live\-boot|casper" 4
497sets the name of package that contains the live system specific initramfs
498modification. By default, auto is used, which means that at build time of
499the image rather than on configuration time, the value will be expanded to
500casper when building ubuntu systems, to live\-boot for all other
501systems. Using 'none' is useful if the resulting system image should not be
502a live image (experimental).
503.IP "\fB\-\-initramfs\-compression\fP bzip2|gzip|lzma]"
504defines the compression program to be used to compress the
505initramfs. Defaults to gzip.
506.IP "\fB\-\-interactive\fP shell" 4
507defines if after the chroot stage and before the beginning of the binary
508stage, a interactive shell login should be spawned in the chroot in order to
509allow you to do manual customizations. Once you close the shell with logout
510or exit, the build will continue as usual. Note that it's strongly
511discouraged to use this for anything else than testing. Modifications that
512should be present in all builds of a live system should be properly made
513through hooks. Everything else destroys the beauty of being able to
514completely automatise the build process and making it non interactive. By
515default, this is of course false.
516.IP "\fB\-\-isohybrid\-options\fP \fIOPTION\fP|\(dq\fIOPTIONS\fP\(dq" 4
517defines options to pass to isohybrid.
518.IP "\fB\-\-iso\-application\fP \fINAME\fP" 4
519sets the APPLICATION field in the header of a resulting CD/DVD image and
520defaults to "Debian Live" in debian mode, and to "Emdebian Live" in emdebian
521mode, and "Ubuntu Live" in ubuntu mode.
522.IP "\fB\-\-iso\-preparer\fP \fINAME\fP" 4
523sets the PREPARER field in the header of a resulting CD/DVD image. By
524default this is set to "live\-build \fIVERSION\fP;
525http://packages.qa.debian.org/live\-build", whereas VERSION is expanded to
526the version of live\-build that was used to build the image.
527.IP "\fB\-\-iso\-publisher\fP \fINAME\fP" 4
528sets the PUBLISHED field in the header of a resulting CD/DVD image. By
529default, this is set to 'Debian Live project; http:/live.debian.net/;
530debian\-live@lists.debian.org'. Remember to change this to the appropriate
531values at latest when you distributing custom and unofficial images.
532.IP "\fB\-\-iso\-volume\fP \fINAME\fP" 4
533sets the VOLUME field in the header of a resulting CD/DVD and defaults to
534\&'(\fIMODE\fP) (\fIDISTRIBUTION\fP) (\fIDATE\fP)' whereas MODE is expanded to the name
535of the mode in use, DISTRIBUTION the distribution name, and DATE with the
536current date and time of the generation.
537.IP "\fB\-\-jffs2\-eraseblock\fP \fISIZE\fP" 4
538sets the eraseblock size for a JFFS2 (Second Journalling Flash File System)
539filesystem. The default is 64 KiB. If you use an erase block size different
540than the erase block size of the target MTD device, JFFS2 may not perform
541optimally. If the SIZE specified is below 4096, the units are assumed to be
542KiB.
543.IP "\fB\-\-keyring\-packages\fP \fIPACKAGE|\(dqPACKAGES\fP\(dq" 4
544sets the keyring package or additional keyring packages. By default this is
545set to debian\-archive\-keyring.
546.IP "\-k|\fB\-\-linux\-flavours\fP \fIFLAVOUR\fP|\(dq\fIFLAVOURS\fP\(dq" 4
547sets the kernel flavours to be installed. Note that in case you specify more
548than that the first will be configured the default kernel that gets booted.
549.IP "\fB\-\-linux\-packages\fP \(dq\fIPACKAGES\fP\(dq" 4
550sets the internal name of the kernel packages naming scheme. If you use
551debian kernel packages, you will not have to adjust it. If you decide to use
552custom kernel packages that do not follow the debian naming scheme, remember
553to set this option to the stub of the packages only (for debian this is
554linux\-image\-2.6), so that \fISTUB\fP\-\fIFLAVOUR\fP results in a valid package name
555(for debian e.g. linux\-image\-2.6\-486). Preferably you use the meta package
556name, if any, for the stub, so that your configuration is ABI
557independent. Also don't forget that you have to include stubs of the binary
558modules packages for unionfs or aufs, and squashfs if you built them
559out\-of\-tree.
560.IP "\fB\-\-losetup\fP losetup|losetup.orig" 4
561sets the filename of the losetup binary from the host system that should be
562used. This is autodetected and does generally not need any customization.
563.IP "\fB\-\-memtest\fP memtest86+|memtest86|none" 4
564defines if memtest, memtest86+ or no memory tester at all should be included
565as secondary bootloader configuration. This is only available on amd64 and
566i386 and defaults to memtest86+.
567.IP "\-m|\fB\-\-parent\-mirror\-bootstrap\fP \fIURL\fP" 4
568sets the location of the debian package mirror that should be used to
569bootstrap from. This defaults to http://ftp.de.debian.org/debian/ which may
570not be a good default if you live outside of Europe.
571.IP "\fB\-\-parent\-mirror\-chroot\fP \fIURL\fP" 4
572sets the location of the debian package mirror that will be used to fetch
573the packages in order to build the live system. By default, this is set to
574the value of \-\-parent\-mirror\-bootstrap.
575.IP "\fB\-\-parent\-mirror\-chroot\-security\fP \fIURL\fP" 4
576sets the location of the debian security package mirror that will be used to
577fetch the packages in order to build the live system. By default, this
578points to http://security.debian.org/debian/.
579.IP "\fB\-\-parent\-mirror\-chroot\-volatile\fP \fIURL\fP" 4
580sets the location of the debian volatile package mirror that will be used to
581fetch packages in order to build the live system. By default, this is set to
582the value of \-\-parent\-mirror\-chroot.
583.IP "\fB\-\-parent\-mirror\-chroot\-backports\fP \fIURL\fP" 4
584sets the location of the debian backports package mirror that will be used
585to fetch packages in order to build the live system. By default, this points
586to http://backports.debian.org/debian\-backports/.
587.IP "\fB\-\-parent\-mirror\-binary\fP \fIURL\fP" 4
588sets the location of the debian package mirror that should end up configured
589in the final image and which is the one a user would see and use. This has
590not necessarily to be the same that is used to build the image, e.g. if you
591use a local mirror but want to have an official mirror in the image. By
592default, 'http://cdn.debian.net/debian/' is used.
593.IP "\fB\-\-parent\-mirror\-binary\-security\fP \fIURL\fP" 4
594sets the location of the debian security package mirror that should end up
595configured in the final image. By default,
596\&'http://cdn.debian.net/debian\-security/' is used.
597.IP "\fB\-\-parent\-mirror\-binary\-volatile\fP \fIURL\fP" 4
598sets the location of the debian volatile package mirror that should end up
599configured in the final image. By default, the value of
600\-\-parent\-mirror\-binary is used.
601.IP "\fB\-\-parent\-mirror\-binary\-backports\fP \fIURL\fP" 4
602sets the location of the debian backports package mirror that should end up
603configured in the final image. By default,
604\&'http://backports.debian.org/debian\-backports/' is used.
605.IP "\fB\-\-parent\-mirror\-debian\-installer\fP \fIURL\fP" 4
606sets the location of the mirror that will be used to fetch the debian
607installer images. By default, this points to the same mirror used to build
608the live system, i.e. the value of \-\-parent\-mirror\-bootstrap.
609.IP "\fB\-\-mirror\-bootstrap\fP \fIURL\fP" 4
610sets the location of the debian package mirror that should be used to
611bootstrap the derivative from. This defaults to
612http://ftp.de.debian.org/debian/ which may not be a good default if you live
613outside of Europe.
614.IP "\fB\-\-mirror\-chroot\fP \fIURL\fP" 4
615sets the location of the debian package mirror that will be used to fetch
616the packages of the derivative in order to build the live system. By
617default, this is set to the value of \-\-mirror\-bootstrap.
618.IP "\fB\-\-mirror\-chroot\-security\fP \fIURL\fP" 4
619sets the location of the debian security package mirror that will be used to
620fetch the packages of the derivative in order to build the live system. By
621default, this points to http://security.debian.org/debian/.
622.IP "\fB\-\-mirror\-chroot\-volatile\fP \fIURL\fP" 4
623sets the location of the debian volatile package mirror that will be used to
624fetch packages of the derivative in order to build the live system. By
625default, this is set to the value of \-\-mirror\-chroot.
626.IP "\fB\-\-mirror\-chroot\-backports\fP \fIURL\fP" 4
627sets the location of the debian backports package mirror that will be used
628to fetch packages of the derivative in order to build the live system. By
629default, this points to http://backports.debian.org/debian\-backports/.
630.IP "\fB\-\-mirror\-binary\fP \fIURL\fP" 4
631sets the location of the derivative package mirror that should end up
632configured in the final image and which is the one a user would see and
633use. This has not necessarily to be the same that is used to build the
634image, e.g. if you use a local mirror but want to have an official mirror in
635the image.
636.IP "\fB\-\-mirror\-binary\-security\fP \fIURL\fP" 4
637sets the location of the derivatives security package mirror that should end
638up configured in the final image.
639.IP "\fB\-\-mirror\-binary\-volatile\fP \fIURL\fP" 4
640sets the location of the derivatives volatile package mirror that should end
641up configured in the final image.
642.IP "\fB\-\-mirror\-binary\-backports\fP \fIURL\fP" 4
643sets the location of the derivatives backports package mirror that should
644end up configured in the final image.
645.IP "\fB\-\-mirror\-debian\-installer\fP \fIURL\fP" 4
646sets the location of the mirror that will be used to fetch the debian
647installer images of the derivative. By default, this points to the same
648mirror used to build the live system, i.e. the value of \-\-mirror\-bootstrap.
649.IP "\fB\-\-mode\fP debian|emdebian|progress|ubuntu" 4
650defines a global mode to load project specific defaults. By default this is
651set to debian.
652.IP "\fB\-\-system\fP live|normal" 4
653defines if the resulting system image should a live system or a normal,
654non\-live system.
655.IP "\fB\-\-net\-root\-filesystem\fP nfs|cfs" 4
656defines the filesystem that will be configured in the bootloader
657configuration for your netboot image. This defaults to nfs.
658.IP "\fB\-\-net\-root\-mountoptions\fP \fIOPTIONS\fP" 4
659sets additional options for mounting the root filesystem in netboot images
660and is by default empty.
661.IP "\fB\-\-net\-root\-path\fP \fIPATH\fP" 4
662sets the file path that will be configured in the bootloader configuration
663for your netboot image. This defaults to /srv/debian\-live in debian mode and
664to /srv/emebian\-live when being in emdebian mode, and /srv/ubuntu\-live when
665in ubuntu mode.
666.IP "\fB\-\-net\-root\-server\fP \fIIP\fP|\fIHOSTNAME\fP" 4
667sets the IP or hostname that will be configured in the bootloader
668configuration for the root filesystem of your netboot image. This defaults
669to 192.168.1.1.
670.IP "\fB\-\-net\-cow\-filesystem\fP nfs|cfs" 4
671defines the filesystem type for the copy\-on\-write layer and defaults to nfs.
672.IP "\fB\-\-net\-cow\-mountoptions\fP \fIOPTIONS\fP" 4
673sets additional options for mounting the copy\-on\-write layer in netboot
674images and is by default empty.
675.IP "\fB\-\-net\-cow\-path\fP \fIPATH\fP" 4
676defines the path to client writable filesystem. Anywhere that
677\fIclient_mac_address\fP is specified in the path live\-boot will substitute the
678MAC address of the client delimited with hyphens.
679.PP
680.IP "" 4
681Example:
682.br
683/export/hosts/client_mac_address
684.br
685/export/hosts/00\-16\-D3\-33\-92\-E8
686.IP "\fB\-\-net\-cow\-server\fP \fIIP\fP|\fIHOSTNAME\fP" 4
687sets the IP or hostname that will be configured in the bootloader
688configuration for the copy\-on\-write filesystem of your netboot image and is
689by default empty.
690.IP "\fB\-\-net\-tarball\fP true|false" 4
691defines if a compressed tarball should be created. Disabling this options
692leads to no tarball at all, the plain binary directory is considered the
693output in this case. Default is true.
694.IP "\-p|\fB\-\-package\-lists\fP \fILIST\fP|\(dq\fILISTS\fP\(dq" 4
695defines which lists available in /usr/share/live/build/package\-lists should
696be used. By default, this is set to standard. Note that in case you have
697local package lists, you don't need to list them here. Putting them into
698config/package\-lists is enough (the filename needs to have the .list suffix
699though).
700.IP \fB\-\-quiet\fP 4
701reduces the verbosity of messages output by \fBlb build\fP.
702.IP "\fB\-\-archives\fP \fIARCHIVE\fP|\(dq\fIARCHIVES\fP\(dq" 4
703enables one of available third\-party archive configurations in
704/usr/share/live/build/archives.
705.IP "\fB\-\-root\-command\fP sudo" 4
706controls if live\-build should use sudo internally to build the live
707image. Note that this is not well tested and that you should, when relying
708on sudo, call the individual live\-build command with sudo itself.
709.IP "\fB\-\-use\-fakeroot\fP true|false" 4
710controls if live\-build should utilize fakeroot and fakechroot to try and
711avoid requiring root privillages where possible. By default, this option is
712false.
713.IP "\fB\-\-archive\-areas\fP \fIARCHIVE_AREA\fP|\(dq\fIARCHIVE_AREAS\fP\(dq" 4
714defines which package archive areas of a debian packages archive should be
715used for configured debian package mirrors. By default, this is set to
716main. Remember to check the licenses of each packages with respect to their
717redistributability in your juristiction when enabling contrib or non\-free
718with this mechanism.
719.IP "\fB\-\-parent\-archive\-areas\fP \fIPARENT_ARCHIVE_AREA\fP|\(dq\fIPARENT_ARCHIVE_AREAS\fP\(dq" 4
720defines the archive areas for derivatives of the resulting live system.
721.IP "\fB\-\-security\fP true|false" 4
722defines if the security repositories specified in the security mirror
723options should be used or not.
724.IP "\fB\-\-source\fP true|false" 4
725defines if a corresponding source image to the binary image should be
726build. By default this is false because most people do not require this and
727would require to download quite a few source packages. However, once you
728start distributing your live image, you should make sure you build it with a
729source image alongside.
730.IP "\-s|\fB\-\-source\-images\fP iso|netboot|tar|hdd" 4
731defines the image type for the source image. Default is tar.
732.IP "\fB\-\-firmware\-binary\fP true|false" 4
733defines if firmware packages should be automatically included into the
734binary pool for debian\-installer. Note that only firmware packages available
735within the configured archive areas are included, e.g. an image with
736packages from main only will not automatically include firmware from
737non\-free. This option does not interfere with explicitly listed packages in
738binary package lists.
739.IP "\fB\-\-firmware\-chroot\fP true|false" 4
740defines if firmware packages should be automatically included into the live
741image. Note that only firmware packages available within the configured
742archive areas are included, e.g. an image with packages from main only will
743not automatically include firmware from non\-free. This option does not
744interfere with explicitly listed packages in chroot package lists.
745.IP "\fB\-\-swap\-file\-path\fP \fIPATH\fP" 4
746defines the path to a swap file to create in the binary image. Default is
747not to create a swap file.
748.IP "\fB\-\-swap\-file\-size\fP \fIMB\fP" 4
749defines what size in megabytes the swap file should be, if one is to be
750created. Default is 512MB.
751.IP "\fB\-\-syslinux\-theme\fP \fITHEME_SUFFIX\fP" 4
752defines the syslinux theme to use. The theme suffix is the name of a
753directory in /usr/share/syslinux/themes/ provided by a package named
754syslinux\-theme\- plus the suffix. In debian mode, this defaults to
755debian\-squeeze.
756.IP "\fB\-\-tasksel\fP apt|aptitude|tasksel" 4
757selects which program is used to install tasks. By default, this is set to
758tasksel.
759.IP "\fB\-\-templates\fP \fIPATH\fP" 4
760sets the path to the templates that live\-build is going to use, e.g. for
761bootloaders. By default, this is set to /usr/share/live/build/templates/.
762.IP "\fB\-\-hdd\-size\fP MB" 4
763defines what size the hdd image should be. Note that although the default is
764set to 10000 (= 10GB), it will not need 10GB space on your harddisk as the
765files are created as sparse files.
766.IP "\fB\-\-volatile\fP true|false" 4
767defines if debian volatile package archives should be included in the image
768or not.
769.IP "\fB\-\-backports\fP true|false" 4
770defines if debian backports package archives should be included in the image
771or not.
772.IP "\fB\-\-exposed\-root\fP true|false" 4
773defines whether to expose the root filesystem as read only and not covered
774by the union filesystem. This has useful implications for certain speciality
775setups such as LTSP. By default, this option is false.
776.IP \fB\-\-verbose\fP 4
777increases the verbosity of messages output by \fBlb build\fP.
778.IP "\fB\-\-win32\-loader true|false\fP" 4
779.\" FIXME
780defines if win32\-loader should be included in the binary image or not.
781
782.SH ENVIRONMENT
783.\" FIXME
784Currently, command line switches can also be specified through the
785corresponding environment variable. However, this generally should not be
786relied upon, as it is an implementation detail that is subject to change in
787future releases. For options applying directly to live\-build, environment
788variables are named LB_FOO, meaning, e.g. \fB\-\-apt\-ftp\-proxy\fP becomes
789LB_APT_FTP_PROXY (the exception being internal options such as
790\fB\-\-debug\fP). For options passed to another program, as in APT_OPTIONS or
791GZIP_OPTIONS, no LB_ prefix is used.
792
793
794.\" FIXME
795.SH FILES
796.\" FIXME
797.IP \fBauto/config\fP 4
798.IP "\fB/etc/live/build.conf, /etc/live/build.d\fP" 4
799.\" FIXME
800An optional, global configuration file for \fBlb config\fP variables. It is
801useful to specify a few system wide defaults, like
802LB_PARENT_MIRROR_BOOTSTRAP. This feature can be false by specifying the
803\fB\-\-ignore\-system\-defaults\fP option.
804
805.SH "SEE ALSO"
806\fIlive\-build\fP(7)
807.PP
808\fIlive\-boot\fP(7)
809.PP
810\fIlive\-config\fP(7)
811.PP
812This program is a part of live\-build.
813
814.SH HOMEPAGE
815More information about live\-build and the Debian Live project can be found
816on the homepage at <\fIhttp://live.debian.net/\fP> and in the manual at
817<\fIhttp://live.debian.net/manual/\fP>.
818
819.SH BUGS
820Bugs can be reported by submitting a bugreport for the live\-build package in
821the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fP> or by
822writing a mail to the Debian Live mailing list at
823<\fIdebian\-live@lists.debian.org\fP>.
824
825.SH AUTHOR
826live\-build was written by Daniel Baumann <\fIdaniel@debian.org\fP> for
827the Debian project.
Note: See TracBrowser for help on using the repository browser.