source: live-build/trunk/fuentes/manpages/en/live-build.7 @ 900

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

add original source

File size: 10.0 KB
Line 
1.TH LIVE\-BUILD 7 2012\-08\-10 3.0~a57-1 "Debian Live Project"
2
3.SH NAME
4\fBlive\-build\fR \- the Debian Live tool suite
5
6.SH SYNOPSIS
7.\" FIXME
8\fBlb \fR\fICOMMAND\fR [\fB\-h|\-\-help\fR] [\fB\-u|\-\-usage\fR] [\fB\-v|\-\-version\fR] [\fB\-\-breakpoints\fR] [\fB\-\-conffile\fR] [\fB\-\-debug\fR] [\fB\-\-force\fR] [\fB\-\-quiet\fR] [\fB\-\-verbose\fR]
9.\" FIXME
10
11.SH DESCRIPTION
12.\" FIXME
13live\-build is a set of scripts to build Debian Live system images. The idea behind live\-build is a tool suite that uses a configuration directory to completely automate and customize all aspects of building a Live image.
14.PP
15The \fICOMMAND\fR is a name of a live\-build command (see below).
16.PP
17More documentation about how to use live\-build is available in the individual manpages for each helper and in the manual at <\fIhttp://live.debian.net/manual/\fR>.
18.\" FIXME
19
20.SH OPTIONS
21.\" FIXME
22.SS Shared live\-build options
23The following command line options are supported by all live\-build programs.
24.IP "\fB-h, \-\-help\fR" 4
25display help and exit.
26.IP "\fB-u, \-\-usage\fR" 4
27show usage and exit.
28.IP "\fB-v, \-\-version\fR" 4
29output version information and exit.
30.SS Common live\-build options
31The following command line options are supported by most live\-build programs. See the man page of each program for a complete explanation of what each option does.
32.IP "\fB\-\-breakpoints\fR" 4
33run with breakpoints.
34.IP "\fB\-\-conffile\fR" 4
35use custom configuration file.
36.IP "\fB\-\-debug\fR" 4
37show debug information.
38.IP "\fB\-\-force\fR" 4
39force helper execution, even if stage file exists.
40.IP "\fB\-\-quiet\fR" 4
41be quiet.
42.IP "\fB\-\-verbose\fR" 4
43be verbose.
44.\" FIXME
45
46.SH LIVE\-BUILD COMMANDS
47.\" FIXME
48We divide live\-build into high level ("porcelain") commands and low level ("plumbing") commands.
49.PP
50Here is the complete list of all available live\-build commands. See their man
51pages for additional documentation.
52.\" FIXME
53
54.SH HIGH\-LEVEL COMMANDS (PORCELAIN)
55.\" FIXME
56We separate the porcelain commands into the main commands and some ancillary user utilities.
57.SS Main porcelain commands
58.IP "\fBlb_config\fR(1)" 4
59create configuration for live\-build
60.IP "\fBlb_bootstrap\fR(1)" 4
61create the first stage by bootstrapping a basic debian system
62.IP "\fBlb_chroot\fR(1)" 4
63create the second stage by customizing the chroot
64.IP "\fBlb_binary\fR(1)" 4
65create the third stage by generating a binary image
66.IP "\fBlb_source\fR(1)" 4
67create the optional fourth stage by generating a source image
68.IP "\fBlb_clean\fR(1)" 4
69clean up system build directories
70.SS Ancillary Commands
71.IP "\fBlb\fR(1)" 4
72generic live\-build wrapper
73.IP "\fBlb_build\fR(1)" 4
74alias for all stages
75.IP "\fBlb_local\fR(1)" 4
76helper for using a local live\-build
77.IP "\fBlb_testroot\fR(1)" 4
78ensure that a system is built as root
79.\" FIXME
80
81.SH LOW\-LEVEL COMMANDS (PLUMBING)
82.\" FIXME
83The actual work of live\-build is implemented in the low-level commands, called plumbing. They are not supposed to be used by end users, they should stick with porcelains as they ensure that all the different plumbing commands are executed in the right order. However, if you intend to reuse live\-build commands in your own scripts, then the plumbings might be of interest for you.
84.PP
85Note that the interface (set of options and the semantics) to these low\-level commands are meant to be a lot more stable than Porcelain level commands. The interface to Porcelain commands on the other hand are subject to change in order to improve the end user experience.
86.SS Bootstrap commands
87.IP "\fBlb_bootstrap_cache\fR(1)" 4
88cache bootstrap stage
89.IP "\fBlb_bootstrap_cdebootstrap\fR(1)" 4
90bootstrap a Debian system with cdebootstrap(1)
91.IP "\fBlb_bootstrap_copy\fR(1)" 4
92bootstrap by copying the host system
93.IP "\fBlb_bootstrap_debootstrap\fR(1)" 4
94bootstrap a Debian system with debootstrap(8)
95.SS Chroot commands
96.IP "\fBlb_chroot_apt\fR(1)" 4
97manage /etc/apt/apt.conf
98.IP "\fBlb_chroot_cache\fR(1)" 4
99cache chroot stage
100.IP "\fBlb_chroot_debianchroot\fR(1)" 4
101manage /etc/debian_chroot
102.IP "\fBlb_chroot_devpts\fR(1)" 4
103mount /dev/pts
104.IP "\fBlb_chroot_dpkg\fR(1)" 4
105manage /sbin/dpkg
106.IP "\fBlb_chroot_hacks\fR(1)" 4
107execute hacks in chroot
108.IP "\fBlb_chroot_hostname\fR(1)" 4
109manage /bin/hostname
110.IP "\fBlb_chroot_hosts\fR(1)" 4
111manage /etc/hosts
112.IP "\fBlb_chroot_install\-packages\fR(1)" 4
113install queued packages into chroot
114.IP "\fBlb_chroot_interactive\fR(1)" 4
115make build interactive
116.IP "\fBlb_chroot_linux\-image\fR(1)" 4
117manage /etc/kernel\-img.conf
118.IP "\fBlb_chroot_hooks\fR(1)" 4
119execute local hooks in chroot
120.IP "\fBlb_chroot_local\-includes\fR(1)" 4
121copy local files into chroot
122.IP "\fBlb_chroot_packages\fR(1)" 4
123queue install of packages into chroot
124.IP "\fBlb_chroot_local\-patches\fR(1)" 4
125apply local patches against chroot
126.IP "\fBlb_chroot_local\-preseed\fR(1)" 4
127use debconf local preseeding file
128.IP "\fBlb_chroot_packagelists\fR(1)" 4
129queue install of package lists into chroot
130.IP "\fBlb_chroot_proc\fR(1)" 4
131mount /proc
132.IP "\fBlb_chroot_resolv\fR(1)" 4
133manage /etc/resolv.conf
134.IP "\fBlb_chroot_selinuxfs\fR(1)" 4
135mount /selinux
136.IP "\fBlb_chroot_archives\fR(1)" 4
137manage /etc/apt/sources.list
138.IP "\fBlb_chroot_sysfs\fR(1)" 4
139mount /sys
140.IP "\fBlb_chroot_sysv\-rc\fR(1)" 4
141manage /usr/sbin/policy\-rc.d
142.IP "\fBlb_chroot_task\-lists\fR(1)" 4
143install task lists into chroot
144.SS Binary commands
145.IP "\fBlb_binary_chroot\fR(1)" 4
146copy chroot into chroot
147.IP "\fBlb_binary_debian\-installer\fR(1)" 4
148install debian\-installer into binary
149.IP "\fBlb_binary_disk\fR(1)" 4
150install disk information into binary
151.IP "\fBlb_binary_grub\fR(1)" 4
152installs grub into binary
153.IP "\fBlb_binary_grub2\fR(1)" 4
154installs grub2 into binary
155.IP "\fBlb_binary_includes\fR(1)" 4
156copy files into binary
157.IP "\fBlb_binary_iso\fR(1)" 4
158build iso binary image
159.IP "\fBlb_binary_linux\-image\fR(1)" 4
160install linux\-image into binary
161.IP "\fBlb_binary_local\-hooks\fR(1)" 4
162execute local hooks in binary
163.IP "\fBlb_binary_local\-includes\fR(1)" 4
164copy files into binary
165.IP "\fBlb_binary_local\-packagelists\fR(1)" 4
166install local package lists into binary
167.IP "\fBlb_binary_manifest\fR(1)" 4
168create manifest
169.IP "\fBlb_binary_checksums\fR(1)" 4
170create binary checksums (md5, sha1, and/or sha256)
171.IP "\fBlb_binary_memtest\fR(1)" 4
172installs a memtest into binary
173.IP "\fBlb_binary_net\fR(1)" 4
174build netboot binary image
175.IP "\fBlb_binary_rootfs\fR(1)" 4
176build rootfs image
177.IP "\fBlb_binary_silo\fR(1)" 4
178installs silo into binary
179.IP "\fBlb_binary_syslinux\fR(1)" 4
180installs syslinux into binary
181.IP "\fBlb_binary_tar\fR(1)" 4
182build harddisk binary image
183.IP "\fBlb_binary_hdd\fR(1)" 4
184build binary hdd image
185.IP "\fBlb_binary_virtual\-hdd\fR(1)" 4
186build binary virtual\-hdd image
187.IP "\fBlb_binary_win32\-loader\fR(1)" 4
188installs win32\-loader into binary
189.IP "\fBlb_binary_yaboot\fR(1)" 4
190installs yaboot into binary
191.SS Source commands
192.IP "\fBlb_source_debian\fR(1)" 4
193download sources
194.IP "\fBlb_source_debian\-live\fR(1)" 4
195copy debian\-live config into source
196.IP "\fBlb_source_disk\fR(1)" 4
197install disk information into source
198.IP "\fBlb_source_iso\fR(1)" 4
199build iso source image
200.IP "\fBlb_source_checksums\fR(1)" 4
201create source checksums (md5, sha1, and/or sha256)
202.IP "\fBlb_source_net\fR(1)" 4
203build source net image
204.IP "\fBlb_source_tar\fR(1)" 4
205build source tarball
206.IP "\fBlb_source_hdd\fR(1)" 4
207build source hdd image
208.IP "\fBlb_source_virtual\-hdd\fR(1)" 4
209build source virtual\-hdd image
210.\" FIXME
211
212.SH CONFIG FILES
213.\" FIXME
214Many live\-build commands make use of files in the \fIconfig/\fR directory to control what they do. Besides the common \fIconfig/common\fR, which is used by all live\-build commands, some additional files can be used to configure the behavior of specific live\-build commands. These files are typically named config/stage or config/stage_helper (where "stage" of course, is replaced with the name of the stage that they belong to, and "helper" with the name of the helper).
215.PP
216For example, lb_bootstrap_debootstrap uses files named config/bootstrap and config/bootstrap_debootstrap to read the options it will use. See the man pages of individual commands for details about the names and formats of the files they use. Generally, these files contain variables with values assigned, one variable per line. Some programs in live\-build use pairs of values or slightly more complicated variable assignments.
217.PP
218Note that live\-build will respect environment variables which are present in the context of the shell it is running. If variables can be read from config files, then they override environment variables, and if command line options are used, they override values from config files. If no value for a given variable can be found and thus is unset, live\-build will automatically set it to the default value.
219.PP
220In some rare cases, you may want to have different versions of these files for different architectures or distributions. If files named config/stage.arch or config/stage_helper.arch, and config/stage.dist or config/stage_helper.dist exist, where "arch" is the same as the output of "dpkg \-\-print\-architecture" and "dist" is the same as the codename of the target distribution, then they will be used in preference to other, more general files.
221.PP
222All config files are shell scripts which are sourced by a live\-build program. That means they have to follow the normal shell syntax. You can also put comments in these files; lines beginning with "#" are ignored.
223.\" FIXME
224
225.SH FILES
226.IP "\fB/etc/live/build.conf\fR" 4
227.IP "\fB/etc/live/build.d/\fR" 4
228
229.SH SEE ALSO
230\fIlive\-boot\fR(7)
231.PP
232\fIlive\-config\fR(7)
233.PP
234This program is a part of live\-build.
235
236.SH HOMEPAGE
237More 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>.
238
239.SH BUGS
240Bugs 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>.
241
242.SH AUTHOR
243live\-build was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project.
Note: See TracBrowser for help on using the repository browser.