diff options
Diffstat (limited to 'manpages/en/lb_config.1')
| -rw-r--r-- | manpages/en/lb_config.1 | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/manpages/en/lb_config.1 b/manpages/en/lb_config.1 index 7e09e44..a1a8d81 100644 --- a/manpages/en/lb_config.1 +++ b/manpages/en/lb_config.1 @@ -1,13 +1,13 @@ .TH LIVE\-BUILD 1 2010\-09\-02 2.0~a23 "Debian Live Project" .SH NAME -\fBlh config\fR \- Create config directory +\fBlb config\fR \- Create config directory .SH SYNOPSIS -\fBlh config\fR [\fIlive\-helper options\fR] +\fBlb config\fR [\fIlive\-build options\fR] .PP .\" FIXME -\fBlh config\fB +\fBlb config\fB .br [\fB\-\-apt\fR apt|aptitude] .br @@ -205,16 +205,16 @@ .\" FIXME .SH DESCRIPTION -\fBlh config\fR is a high\-level command (porcelain) of \fIlive\-helper\fR(7), the Debian Live tool suite. +\fBlb config\fR is a high\-level command (porcelain) of \fIlive\-build\fR(7), the Debian Live tool suite. .PP .\" FIXME -\fBlh config\fR populates the configuration directory for live\-helper. By default, this directory is named 'config' and is created in the current directory where \fBlh config\fR was executed. +\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. .PP -Note: Currently \fBlh 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 lenny system gets build or not). This means that when generating a new configuration, you should call \fBlh 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 \fBlh config\fR called with one option only changes that option, and leaves everything else as is unless its not defined. However, \fBlh 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 \fBlh config\fR again. +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 lenny 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. .\" FIXME .SH OPTIONS -In addition to its specific options \fBlh config\fR understands all generic live\-helper options. See \fIlive\-helper\fR(7) for a complete list of all generic live\-helper options. +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. .PP .\" FIXME .IP "\fB\-\-apt\fR apt|aptitude" 4 @@ -230,7 +230,7 @@ defines the default options that will be appended to every apt call that is made .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. .IP "\fB\-\-apt\-pipeline\fR \fIDEPTH\fR" 4 -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\-helper does not set this option. +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. .IP "\fB\-\-apt\-recommends\fR true|false" 4 defines if apt should install recommended packages automatically. By default, this is true except in emdebian mode. .IP "\fB\-\-apt\-secure\fR true|false" 4 @@ -248,7 +248,7 @@ sets boot parameters specific to debian\-installer, if included. .IP "\fB\-\-bootappend\-live\fR \fIPARAMETER\fR|""\fIPARAMETERS\fR""" 4 sets boot parameters specific to debian\-live. A complete list of boot parameters can be found, for etch, in the manpage of casper, for all other distributions in the manpage of live\-initramfs. On the images, a list of all parameters (without comments) is included in the /parameters.txt. .IP "\fB\-\-bootloader\fR grub|syslinux|yaboot" 4 -defines which bootloader is beeing 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\-helper does not support them yet. \fBlh config\fR will fail to create such a not yet supported configuration and give a explanation about it. For usb\-hdd images on amd64 and i386, the default is syslinux. yaboot is only used on powerpc. +defines which bootloader is beeing 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 usb\-hdd images on amd64 and i386, the default is syslinux. yaboot is only used on powerpc. .IP "\fB\-\-bootstrap\fR cdebootstrap|cdebootstrap-static|debootstrap|copy" 4 defines which program is used to bootstrap the debian chroot, default is debootstrap. Note that if you set the bootstrap program to copy, then your host system is copied. This can be useful if you want to convert/clone your existing host system into a live system, however, make sure you do have enough free space as this can, depending on your host system, get quite big. .IP "\fB\-\-bootstrap\-config\fR \fIFILE\fR" 4 @@ -268,7 +268,7 @@ sets which stages should be cached. By default set to bootstrap. As an exception .IP "\fB\-\-checksums\fR md5|sha1|sha256|none" 4 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\-initramfs' 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. .IP "\fB\-\-build\-with\-chroot\fR true|false" 4 -defines whetever live\-helper should use the tools from within the chroot to build the binary image or not by using and including the host systems 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, grub and yaboot, and the auxilliary tools such as dosfstools, genisoimage, squashfs-tools and others) do not \fBexactely\fR match what is present at build-time in the target distribution. Never do disable this option unless you are \fBexactely\fR sure what you are doing and have \fBcompletely\fI understood its consequences. +defines whetever live\-build should use the tools from within the chroot to build the binary image or not by using and including the host systems 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, grub and yaboot, and the auxilliary tools such as dosfstools, genisoimage, squashfs-tools and others) do not \fBexactely\fR match what is present at build-time in the target distribution. Never do disable this option unless you are \fBexactely\fR sure what you are doing and have \fBcompletely\fI understood its consequences. .IP "\fB\-\-chroot\-filesystem\fR ext2|ext3|squashfs|plain|jffs2" 4 defines which filesystem type should be used for the root filesystem image. If you use plain, 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 choosen, it may not be possible to build with a plain root filesystem, e.g. fat16/fat32 and plain don't work as linux does not support to run on them. .IP "\fB\-\-clean\fR" 4 @@ -292,7 +292,7 @@ defines if the debian\-installer graphical GTK interface should be true or not. .IP "\-d|\fB\-\-distribution\fR \fICODENAME\fR" 4 defines the distribution of the resulting live system. .IP "\-\-\fBdump\fR" 4 -prepares a report of the currently present live system configuration and the version of live\-helper 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. +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 @@ -306,9 +306,9 @@ defines which hooks available in /usr/share/live/build/examples/hooks should be .IP "\fB\-\-hostname\fR \fINAME\fR" 4 sets the hostname of the live system. .IP "\fB\-\-ignore\-system\-defaults\fR" 4 -\fBlh config\fR by default reads system defaults from /etc/default/live\-helper 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. +\fBlb config\fR by default reads system defaults from /etc/default/live\-build 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. .IP "\fB\-\-includes\fR \fIPATH\fR" 4 -sets the path to the includes that live\-helper 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/. +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|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 and to live\-initramfs for all other systems. .IP "\fB\-\-interactive\fR shell" 4 @@ -316,7 +316,7 @@ defines if after the chroot stage and before the beginning of the binary stage, .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 -sets the PREPARER field in the header of a resulting CD/DVD image. By default this is set to "live\-helper \fIVERSION\fR; http://packages.qa.debian.org/live\-helper", whereas VERSION is expanded to the version of live\-helper that was used to build the image. +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", whereas VERSION is expanded to the version of live\-build that was used to build the image. .IP "\fB\-\-iso\-publisher\fR \fINAME\fR" 4 sets the PUBLISHED field in the header of a resulting CD/DVD image. By default, this is set to 'Debian Live project; http:/live.debian.net/; debian\-live@lists.debian.org'. Remember to change this to the appropriate values at latest when you distributing custom and unofficial images. .IP "\fB\-\-iso\-volume\fR \fINAME\fR" 4 @@ -381,9 +381,9 @@ defines one or more packages to be installed in the live system. This is a quick .IP "\fB\-r, \-\-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\-helper 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\-helper command with sudo itself. +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. .IP "\fB\-\-use-fakeroot\fR true|false" 4 -controls if live\-helper should utilize fakeroot and fakechroot to try and avoid requiring root privillages where possible. By default, this option is false. +controls if live\-build should utilize fakeroot and fakechroot to try and avoid requiring root privillages where possible. By default, this option is false. .IP "\fB\-\-archive\-areas\fR \fIARCHIVE_AREA\fR|""\fIARCHIVE_AREAS\fR""" 4 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. .IP "\fB\-\-security\fR true|false" 4 @@ -407,7 +407,7 @@ selects which program is used to install tasks. By default, this is set to tasks .IP "\fB\-\-tasks\fR \fITASK\fR|""\fITASKS\fR""" 4 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 packages lists should be used instead. .IP "\fB\-\-templates\fR \fIPATH\fR" 4 -sets the path to the templates that live\-helper is going to use, e.g. for bootloaders. By default, this is set to /usr/share/live/build/templates/. +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 @@ -428,20 +428,20 @@ All command line switches can also be specified through the corresponding enviro .SH FILES .\" FIXME .IP "\fBauto/config\fR" 4 -.IP "\fB/etc/default/live\-helper\fR" 4 -An optional, global configuration file for \fBlh config\fR variables. It is useful to specify a few system wide defaults, like LH_MIRROR_BOOTSTRAP. This feature can be false by specifying the \fB\-\-ignore\-system\-defaults\fR option. +.IP "\fB/etc/default/live\-build\fR" 4 +An optional, global configuration file for \fBlb config\fR variables. It is useful to specify a few system wide defaults, like LH_MIRROR_BOOTSTRAP. This feature can be false by specifying the \fB\-\-ignore\-system\-defaults\fR option. .\" FIXME .SH SEE ALSO -\fIlive\-helper\fR(7) +\fIlive\-build\fR(7) .PP -This program is a part of live\-helper. +This program is a part of live\-build. .SH HOMEPAGE -More information about live\-helper and the Debian Live project can be found on the homepage at <\fIhttp://live.debian.net/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>. +More information about live\-build and the Debian Live project can be found on the homepage at <\fIhttp://live.debian.net/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>. .SH BUGS -Bugs can be reported by submitting a bugreport for the live\-helper package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or by writing a mail to the Debian Live mailing list at <\fIdebian\-live@lists.debian.org\fR>. +Bugs can be reported by submitting a bugreport for the live\-build package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or by writing a mail to the Debian Live mailing list at <\fIdebian\-live@lists.debian.org\fR>. .SH AUTHOR -live\-helper was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project. +live\-build was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project. |