diff options
Diffstat (limited to 'manpages/en/lb_config.1')
| -rw-r--r-- | manpages/en/lb_config.1 | 90 |
1 files changed, 65 insertions, 25 deletions
diff --git a/manpages/en/lb_config.1 b/manpages/en/lb_config.1 index f557db4cb..ddc82f40d 100644 --- a/manpages/en/lb_config.1 +++ b/manpages/en/lb_config.1 @@ -1,4 +1,4 @@ -.TH LIVE\-BUILD 1 2010\-12\-05 3.0~a8 "Debian Live Project" +.TH LIVE\-BUILD 1 2010\-12\-06 3.0~a8 "Debian Live Project" .SH NAME \fBlb config\fR \- Create config directory @@ -7,7 +7,7 @@ \fBlb config\fR [\fIlive\-build options\fR] .PP .\" FIXME -\fBlb config\fB +\fBlb config\fR .br [\fB\-\-apt\fR apt|aptitude] .br @@ -63,7 +63,7 @@ .br [\fB\-\-chroot\-filesystem\fR ext2|ext3|squashfs|plain|jffs2] .br - [\fB\-\-clean] + [\fB\-\-clean\fR] .br [\-c|\fB\-\-conffile\fR \fIFILE\fR] .br @@ -81,14 +81,18 @@ .br [\fB\-\-debian\-installer\-gui\fR true|false] .br + [\fB\-\-debug\fR] +.br [\-d|\fB\-\-distribution\fR \fICODENAME\fR] .br - [\-\-\fBdump\fR] + [\fB\-\-dump\fR] .br [\-e|\fB\-\-encryption\fR false|aes128|aes192|aes256] .br [\fB\-\-fdisk\fR fdisk|fdisk.dist] .br + [\fB\-\-force\fR] +.br [\fB\-\-grub\-splash\fR \fIFILE\fR] .br [\fB\-\-gzip\-options\fR \fIOPTION\fR|"\fIOPTIONS\fR"] @@ -105,6 +109,8 @@ .br [\fB\-\-interactive\fR shell] .br + [\fB\-\-isohybrid\-options\fR \fIOPTION\fR|"\fIOPTIONS\fR"] +.br [\fB\-\-iso\-application\fR \fINAME\fR] .br [\fB\-\-iso\-preparer\fR \fINAME\fR] @@ -129,13 +135,21 @@ .br [\-m|\fB\-\-mirror\-bootstrap\fR \fIURL\fR] .br + [\fB\-\-mirror\-chroot\fR \fIURL\fR] +.br + [\fB\-\-mirror\-chroot\-security\fR \fIURL\fR] +.br + [\fB\-\-mirror\-chroot\-volatile\fR \fIURL\fR] +.br + [\fB\-\-mirror\-chroot\-backports\fR \fIURL\fR] +.br [\fB\-\-mirror\-binary\fR \fIURL\fR] .br [\fB\-\-mirror\-binary\-security\fR \fIURL\fR] .br - [\fB\-\-mirror\-chroot\fR \fIURL\fR] + [\fB\-\-mirror\-binary\-volatile\fR \fIURL\fR] .br - [\fB\-\-mirror\-chroot\-security\fR \fIURL\fR] + [\fB\-\-mirror\-binary\-backports\fR \fIURL\fR] .br [\fB\-\-mirror\-debian\-installer\fR \fIURL\fR] .br @@ -163,7 +177,9 @@ .br [\fB\-\-packages\fR \fIPACKAGE\fR|\fI"PACKAGES"\fR] .br - [\fB\-r, \-\-repositories \fIREPOSITORY\fR|\fI"REPOSITORIES"\fR] + [\fB\-\-quiet\fR] +.br + [\-r|\fB\-\-repositories \fIREPOSITORY\fR|\fI"REPOSITORIES"\fR] .br [\fB\-\-root-command\fR sudo] .br @@ -191,14 +207,18 @@ .br [\fB\-\-templates\fR \fIPATH\fR] .br - [\fB\-\-virtual\-root\-filesystem\fR ext3] -.br [\fB\-\-virtual\-root\-size \fIMB\fR] .br + [\fB\-\-volatile\fR true|false] +.br + [\fB\-\-backports\fR true|false] +.br [\fB\-\-exposed\-root\fR true|false] .br [\fB\-\-username\fR \fINAME\fR] .br + [\fB\-\-verbose\fR] +.br [\fB\-\-win32\-loader true|false] .\" FIXME @@ -216,7 +236,7 @@ In addition to its specific options \fBlb config\fR understands all generic live .PP .\" FIXME .IP "\fB\-\-apt\fR apt|aptitude" 4 -defines if apt\-get or aptitude is used to install packages when building the image. When building etch images, this defaults to aptitude. Every other distribution defaults to apt. +defines if apt\-get or aptitude is used to install packages when building the image. The default is apt. .IP "\fB\-\-apt\-ftp\-proxy\fR \fIURL\fR" 4 sets the ftp proxy to be used by apt. By default, this is empty but if the host has the environment variable ftp_proxy set, apt\-ftp\-proxy gets automatically set to the value of ftp_proxy. .IP "\fB\-\-apt\-http\-proxy\fR \fIURL\fR" 4 @@ -238,7 +258,7 @@ defines if apt should check repository signatures. This is true by default. .IP "\-a|\fB\-\-architectures\fR \fIARCHITECTURE\fR" 4 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 possile if you have a 64bit capable i386 processor and the right kernel. But building powerpc images on an i386 system is not possible. .IP "\-b|\fB\-\-binary\-images\fR iso|iso\-hybrid|net|tar|usb\-hdd" 4 -defines the image type to build. By default this is set to iso to build CD/DVD images, for squeeze and newer it defaults to iso\-hybrid. +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 usb\-hdd images, for legacy lenny and non\-syslinux images, it defaults to iso. .IP "\fB\-\-binary\-filesystem\fR fat16|fat32|ext2" 4 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 usb\-hdd images for usb sticks, this is active. Note that it defaults to fat16 on all architectures except sparc where it defaults to ext2. Also note that if you choose fat16 and your resulting binary image gets bigger than 2GB, the binary filesystem automatically gets switched to fat32. .IP "\fB\-\-bootappend\-install\fR \fIPARAMETER\fR|""\fIPARAMETERS\fR""" 4 @@ -287,14 +307,18 @@ defines the distribution where the debian\-installer files should be taken out f sets the filename or URL for an optionally used and included preseeding file for debian\-installer. .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. +.IP "\fB\-\-debug\fR" 4 +turn on debugging informational messages. .IP "\-d|\fB\-\-distribution\fR \fICODENAME\fR" 4 defines the distribution of the resulting live system. -.IP "\-\-\fBdump\fR" 4 +.IP "\fB\-\-dump\fR" 4 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. .IP "\-e|\fB\-\-encryption\fR false|aes128|aes192|aes256" 4 defines if the root filesystem should be encrypted or not. By default, this is false. .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. +.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\-\-grub\-splash\fR \fIFILE\fR" 4 defines the name of an optional to be included splash screen graphic for the grub bootloader. .IP "\fB\-\-gzip\-options\fR \fIOPTION\fR|""\fIOPTIONS\fR""" 4 @@ -308,9 +332,11 @@ sets the hostname of the live system. .IP "\fB\-\-includes\fR \fIPATH\fR" 4 sets the path to the includes that live\-build is going to use, e.g. additional minimal documentation that you want to have on all live systems. By default, this is set to /usr/share/live/build/includes/. .IP "\fB\-\-initramfs\fR auto|none|live\-boot|live\-initramfs|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 etch systems or ubuntu systems, to live\-initramfs for all other systems up to squeeze, and to live\-boot for wheezy and newer. Using 'none' is usefull if the resulting system image should not be a live image (experimental). +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\-initramfs for legacy lenny, and to live\-boot for squeeze and newer. Using 'none' is useful if the resulting system image should not be a live image (experimental). .IP "\fB\-\-interactive\fR shell" 4 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. +.IP "\fB\-\-isohybrid\-options\fR \fIOPTION\fR|""\fIOPTIONS\fR""" 4 +defines options to pass to isohybrid. .IP "\fB\-\-iso\-application\fR \fINAME\fR" 4 sets the APPLICATION field in the header of a resulting CD/DVD image and defaults to "Debian Live" in debian mode, and to "Emdebian Live" in emdebian mode, and "Ubuntu Live" in ubuntu mode. .IP "\fB\-\-iso\-preparer\fR \fINAME\fR" 4 @@ -334,17 +360,25 @@ sets the filename of the losetup binary from the host system that should be used .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+. .IP "\-m|\fB\-\-mirror\-bootstrap\fR \fIURL\fR" 4 -sets the location of the debian package mirror that should be used to bootstrap from. -.IP "\fB\-\-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. By default, 'http://cdn.debian.net/debian/' is used. -.IP "\fB\-\-mirror\-binary\-security\fR \fIURL\fR" 4 -sets the location of the debian security package mirror that should end up configuered in the final image. By default, 'http://cdn.debian.net/debian-security/' is used. +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. .IP "\fB\-\-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 points to http://ftp.de.debian.org/debian/ which may not be a good default if you live outside the U.S. +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 \-\-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 in order to build the live system. By default, this points to http://security.debian.org/debian/. +.IP "\fB\-\-mirror\-chroot\-volatile\fR \fIURL\fR" 4 +sets the location of the debian volatile 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 \-\-mirror\-chroot. +.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 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 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://cdn.debian.net/debian/' is used. +.IP "\fB\-\-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. By default, 'http://cdn.debian.net/debian-security/' is used. +.IP "\fB\-\-mirror\-binary\-volatile\fR \fIURL\fR" 4 +sets the location of the debian volatile package mirror that should end up configured in the final image. By default, the value of \-\-mirror\-binary is used. +.IP "\fB\-\-mirror\-binary\-backports\fR \fIURL\fR" 4 +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. .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. By default, this points to the same mirror used to build the live system. +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 \-\-mirror\-bootstrap. .IP "\fB\-\-mode\fR debian|emdebian|ubuntu" 4 defines a global mode to load project specific defaults. By default this is set to debian. .IP "\fB\-\-net\-root\-filesystem\fR nfs|cfs" 4 @@ -376,7 +410,9 @@ defines the format of the netboot image. Choosing tar results in a not compresse defines which lists available in /usr/share/live/build/lists should be used. By default, this is set to standard. Note that in case you have local package lists, you don't need to list them here. Putting them into config/chroot_local-packagelists is enough (the filename needs to have the .list suffix though). .IP "\fB\-\-packages\fR \fIPACKAGE\fR|""\fIPACKAGES\fR""" 4 defines one or more packages to be installed in the live system. This is a quick and convenient place to add a few packages when building an image (limited by the max length of shell). Packages that should be permanently installed should be put into a local packages list. -.IP "\fB\-r, \-\-repositories\fR \fIREPOSITORY\fR|""\fIREPOSITORIES\fR""" 4 +.IP "\fB\-\-quiet\fR" 4 +reduces the verbosity of messages output by \fBlb build\fR. +.IP "-r|\fB\-\-repositories\fR \fIREPOSITORY\fR|""\fIREPOSITORIES\fR""" 4 enables one of available third-party repository configurations in /usr/share/live/build/repositories. .IP "\fB\-\-root-command\fR sudo" 4 controls if live\-build should use sudo internally to build the live image. Note that this is not well tested and that you should, when relying on sudo, call the individual live\-build command with sudo itself. @@ -404,22 +440,26 @@ selects which program is used to install tasks. By default, this is set to tasks defines one or more package tasks to be installed in the live system. This is a quick and convenient way to get a reasonable default selection of packages suitable for most users when building an image, but it results in quite big images. If you want to have finer grained package selections, local package lists should be used instead. .IP "\fB\-\-templates\fR \fIPATH\fR" 4 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/. -.IP "\fB\-\-virtual\-root\-filesystem\fR ext3" 4 -defines what filesystem to format the root filesystem when building virtual\-hdd images. .IP "\fB\-\-virtual\-root\-size\fR MB" 4 defines what size the virtual\-hdd image should be. Note that although the default is set to 10000 (= 10GB), it will not need 10GB space on your harddisk as the files are created as sparse files. +.IP "\fB\-\-volatile\fR true|false" 4 +defines if debian volatile package archives should be included in the image or not. +.IP "\fB\-\-backports\fR true|false" 4 +defines if debian backports package archives should be included in the image or not. .IP "\fB\-\-exposed\-root\fR true|false" 4 defines whether to expose the root filesystem as read only and not covered by the union filesystem. This has useful implications for certain speciality setups such as LTSP. By default, this option is false. .IP "\fB\-\-username\fR \fINAME\fR" 4 sets the name of the account of the default user in the live system. +.IP "\fB\-\-verbose\fR" 4 +increases the verbosity of messages output by \fBlb build\fR. .IP "\fB\-\-win32\-loader true|false" 4 defines if win32\-loader should be included in the binary image or not. .\" FIXME .SH ENVIRONMENT .\" FIXME -All command line switches can also be specified through the corresponding environment variable. Environment variables are name LB_FOO, means, e.g. \-\-apt\-ftp\-proxy becomes LB_APT_FTP_PROXY. However, this generally should not be used. -.\" FIXME +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 .SH FILES .\" FIXME |