/usr/share/doc/live-manual/html/overview-of-tools.en.html is in live-manual-html 1:3.0~a9-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>
overview-of-tools -
Debian Live Manual
</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="dc.title" content="Debian Live Manual" />
<meta name="dc.author" content="Debian Live Project <debian-live@lists.debian.org>" />
<meta name="dc.publisher" content="Debian Live Project <debian-live@lists.debian.org>" />
<meta name="dc.date" content="2011-12-04" />
<meta name="dc.rights" content="Copyright (C) 2006-2011 Debian Live Project;<br> License: This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.<br><br>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<br><br>You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/. <br><br>The complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL-3 file." />
<meta name="generator" content="SiSU 3.1.9 of 2011w51/1 (2011-12-19) (n*x and Ruby!)" />
<link rel="generator" href="http://www.sisudoc.org/" />
<link rel="shortcut icon" href="../_sisu/image/rb7.ico" />
<link rel="stylesheet" href="../_sisu/css/html.css" type="text/css" />
</head>
<body bgcolor="#ffffff" text="#000000" link="#003090" lang="en" xml:lang="en">
<a name="top" id="top"></a>
<a name="up" id="up"></a>
<a name="start" id="start"></a><table summary="segment navigation band with banner" bgcolor="#ffffff" width="100%"><tr>
<td width="20%" align="left">
<table summary="band" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#ffffff"><a href="http://live.debian.net/" target="_top"><img border="0" src="../_sisu/image/debian_home.png" alt="Debian -->" /></a></td></tr>
</table>
</td>
<td width="75%" align="center">
<table summary="segment navigation available documents types: toc,doc,pdf,concordance" border="0" cellpadding="3" cellspacing="0">
<tr>
<td align="center" bgcolor="#ffffff">
<td align="center" bgcolor="#ffffff">
<a href="sisu_manifest.en.html" target="_top" >
<font face="verdana, arial, georgia, tahoma, sans-serif, helvetica, times, roman" size="2">
[ document manifest ]
</font>
</a>
</td>
</tr></table>
</td>
<td width="5%" align="right">
<table summary="segment navigation pre/next" border="0" cellpadding="3" cellspacing="0">
<tr>
<td align="center" bgcolor="#ffffff">
<a href="the-basics.en.html" target="_top" >
<img border="0" width="22" height="22" src="../_sisu/image_sys/arrow_prev_red.png" alt="<< previous" />
</a>
</td>
<td align="center" bgcolor="#ffffff">
<a href="toc.en.html" target="_top" >
<img border="0" width="22" height="22" src="../_sisu/image_sys/arrow_up_red.png" alt="TOC" />
</a>
</td>
<td align="center" bgcolor="#ffffff">
<a href="managing-a-configuration.en.html" target="_top" >
<img border="0" width="22" height="22" src="../_sisu/image_sys/arrow_next_red.png" alt="next >>" />
</a>
</td>
<td>
</td></tr>
</table>
</td></tr>
</table>
<table summary="segment hidden control pre and next" width="100%" border="0" cellpadding="0" bgcolor=#eeeeee align="center">
<tr><td align="left">
<a href="the-basics.en.html" target="_top" >
<img border="0" width="100%" height="20" src="../_sisu/image_sys/dot_white.png" alt="<" />
</a>
</td>
<td align="center">
<a href="toc.en.html" target="_top" >
<img border="0" width="100%" height="20" src="../_sisu/image_sys/dot_white.png" alt="^" />
</a>
</td>
<td align="right">
<a href="managing-a-configuration.en.html" target="_top" >
<img border="0" width="100%" height="20" src="../_sisu/image_sys/dot_white.png" alt=">" />
</a>
</td></tr>
</table><div class="content">
<h1 class="tiny">
Debian Live Manual
</h1>
</div><div class="content">
<h2 class="tiny">
User
</h2>
</div><div class="content"><div class="substance">
<label class="ocn"><a name="276" href="#276" class="lnkocn">276</a></label>
<h1 class="norm" id="o276"><a name="276"></a>
5. Overview of tools
</h1>
</div><div class="substance">
<label class="ocn"><a name="277" href="#277" class="lnkocn">277</a></label>
<p class="i0" id="o277">
This chapter contains an overview of the three main tools used in building Debian Live systems: <i>live-build</i>, <i>live-boot</i> and <i>live-config</i>.
</p>
</div><div class="substance">
<label class="ocn"><a name="278" href="#278" class="lnkocn">278</a></label>
<p class="bold" id="o278"><a name="278"></a> <a name="hlive-build" id="hlive-build"></a>
<a name="h5.1" ></a><a name="live-build" ></a>5.1 live-build
</p>
</div><div class="substance">
<label class="ocn"><a name="279" href="#279" class="lnkocn">279</a></label>
<p class="i0" id="o279">
<i>live-build</i> is a collection of scripts to build Debian Live systems. These scripts are also referred to as "commands".
</p>
</div><div class="substance">
<label class="ocn"><a name="280" href="#280" class="lnkocn">280</a></label>
<p class="i0" id="o280">
The idea behind <i>live-build</i> is to be a framework that uses a configuration directory to completely automate and customize all aspects of building a Live image.
</p>
</div><div class="substance">
<label class="ocn"><a name="281" href="#281" class="lnkocn">281</a></label>
<p class="i0" id="o281">
Many concepts are similar to those in the debhelper Debian package tools written by Joey Hess:
</p>
</div><div class="substance">
<label class="ocn"><a name="282" href="#282" class="lnkocn">282</a></label>
<li class="bullet" id="o282">
The scripts have a central location for configuring their operation. In debhelper, this is the <tt>debian/</tt> subdirectory of a package tree. For example, dh_install will look, amongst others, for a file called <tt>debian/install</tt> to determine which files should exist in a particular binary package. In much the same way, <i>live-build</i> stores its configuration entirely under a <tt>config/</tt> subdirectory.
</li>
</div><div class="substance">
<label class="ocn"><a name="283" href="#283" class="lnkocn">283</a></label>
<li class="bullet" id="o283">
The scripts are independent - that is to say, it is always safe to run each command.
</li>
</div><div class="substance">
<label class="ocn"><a name="284" href="#284" class="lnkocn">284</a></label>
<p class="i0" id="o284">
Unlike debhelper, <i>live-build</i> contains a tool to generate a skeleton configuration directory, <tt>lb config</tt>. This could be considered to be similar to tools such as <tt>dh-make</tt>. For more information about <tt>lb config</tt>, please see <a href="overview-of-tools.html#lb-config">The lb config command</a>.
</p>
</div><div class="substance">
<label class="ocn"><a name="285" href="#285" class="lnkocn">285</a></label>
<p class="i0" id="o285">
The remainder of this section discusses the three most important commands:
</p>
</div><div class="substance">
<label class="ocn"><a name="286" href="#286" class="lnkocn">286</a></label>
<li class="bullet" id="o286">
<b>lb config</b>: Responsible for initializing a Live system configuration directory. See <a href="overview-of-tools.html#lb-config">The lb config command</a> for more information.
</li>
</div><div class="substance">
<label class="ocn"><a name="287" href="#287" class="lnkocn">287</a></label>
<li class="bullet" id="o287">
<b>lb build</b>: Responsible for starting a Live system build. See <a href="overview-of-tools.html#lb-build">The lb build command</a> for more information.
</li>
</div><div class="substance">
<label class="ocn"><a name="288" href="#288" class="lnkocn">288</a></label>
<li class="bullet" id="o288">
<b>lb clean</b>: Responsible for removing parts of a Live system build. See <a href="overview-of-tools.html#lb-clean">The lb clean command</a> for more information.
</li>
</div><div class="substance">
<label class="ocn"><a name="289" href="#289" class="lnkocn">289</a></label>
<p class="bold" id="o289"><a name="289"></a> <a name="hlb-config" id="hlb-config"></a>
<a name="h5.1.1" ></a><a name="lb-config" ></a>5.1.1 The <tt>lb config</tt> command
</p>
</div><div class="substance">
<label class="ocn"><a name="290" href="#290" class="lnkocn">290</a></label>
<p class="i0" id="o290">
As discussed in <a href="overview-of-tools.html#live-build">live-build</a>, the scripts that make up <i>live-build</i> read their configuration with the <tt>source</tt> command from a single directory named <tt>config/</tt>. As constructing this directory by hand would be time-consuming and error-prone, the <tt>lb config</tt> command can be used to create skeleton configuration folders.
</p>
</div><div class="substance">
<label class="ocn"><a name="291" href="#291" class="lnkocn">291</a></label>
<p class="i0" id="o291">
Issuing <tt>lb config</tt> without any arguments creates a <tt>config/</tt> subdirectory which it populates with some default settings, and a skeleton <tt>auto/</tt> subdirectory tree.
</p>
</div><div class="substance">
<label class="ocn"><a name="292" href="#292" class="lnkocn">292</a></label>
<p class="code" id="o292">
$ lb config<br />
P: Considering defaults defined in /etc/live/build.conf<br />
P: Creating config tree<br /><br />
</p>
</div><div class="substance">
<label class="ocn"><a name="293" href="#293" class="lnkocn">293</a></label>
<p class="i0" id="o293">
Using <tt>lb config</tt> without any arguments would be suitable for users who need a very basic image, or who intend to later provide a more complete configuration via <tt>auto/config</tt> (see <a href="managing-a-configuration.html#managing-a-configuration">Managing a configuration</a> for details).
</p>
</div><div class="substance">
<label class="ocn"><a name="294" href="#294" class="lnkocn">294</a></label>
<p class="i0" id="o294">
Normally, you will want to specify some options. For example, to include the 'gnome' package list in your configuration:
</p>
</div><div class="substance">
<label class="ocn"><a name="295" href="#295" class="lnkocn">295</a></label>
<p class="code" id="o295">
$ lb config -p gnome<br /><br />
</p>
</div><div class="substance">
<label class="ocn"><a name="296" href="#296" class="lnkocn">296</a></label>
<p class="i0" id="o296">
It is possible to specify many options, such as:
</p>
</div><div class="substance">
<label class="ocn"><a name="297" href="#297" class="lnkocn">297</a></label>
<p class="code" id="o297">
$ lb config --binary-images net --hostname live-machine --username live-user ...<br /><br />
</p>
</div><div class="substance">
<label class="ocn"><a name="298" href="#298" class="lnkocn">298</a></label>
<p class="i0" id="o298">
A full list of options is available in the <tt>lb_config</tt> man page.
</p>
</div><div class="substance">
<label class="ocn"><a name="299" href="#299" class="lnkocn">299</a></label>
<p class="bold" id="o299"><a name="299"></a> <a name="hlb-build" id="hlb-build"></a>
<a name="h5.1.2" ></a><a name="lb-build" ></a>5.1.2 The <tt>lb build</tt> command
</p>
</div><div class="substance">
<label class="ocn"><a name="300" href="#300" class="lnkocn">300</a></label>
<p class="i0" id="o300">
The <tt>lb build</tt> command reads in your configuration from the <tt>config/</tt> directory. It then runs the lower level commands needed to build your Live system.
</p>
</div><div class="substance">
<label class="ocn"><a name="301" href="#301" class="lnkocn">301</a></label>
<p class="bold" id="o301"><a name="301"></a> <a name="hlb-clean" id="hlb-clean"></a>
<a name="h5.1.3" ></a><a name="lb-clean" ></a>5.1.3 The <tt>lb clean</tt> command
</p>
</div><div class="substance">
<label class="ocn"><a name="302" href="#302" class="lnkocn">302</a></label>
<p class="i0" id="o302">
It is the job of the <tt>lb clean</tt> command to remove various parts of a build so subsequent builds can start from a clean state. By default, <tt>chroot</tt>, <tt>binary</tt> and <tt>source</tt> stages are cleaned, but the cache is left intact. Also, individual stages can be cleaned. For example, if you have made changes that only affect the binary stage, use <tt>lb clean --binary</tt> prior to building a new binary. See the <tt>lb_clean</tt> man page for a full list of options.
</p>
</div><div class="substance">
<label class="ocn"><a name="303" href="#303" class="lnkocn">303</a></label>
<p class="bold" id="o303"><a name="303"></a> <a name="hlive-boot" id="hlive-boot"></a>
<a name="h5.2" ></a><a name="live-boot" ></a>5.2 The live-boot package
</p>
</div><div class="substance">
<label class="ocn"><a name="304" href="#304" class="lnkocn">304</a></label>
<p class="i0" id="o304">
<i>live-boot</i> is a collection of scripts providing hooks for the initramfs-tools, used to generate an initramfs capable of booting live systems, such as those created by <i>live-build</i>. This includes the Debian Live ISOs, netboot tarballs, and USB stick images.
</p>
</div><div class="substance">
<label class="ocn"><a name="305" href="#305" class="lnkocn">305</a></label>
<p class="i0" id="o305">
At boot time it will look for read-only media containing a <tt>/live/</tt> directory where a root filesystem (often a compressed filesystem image like squashfs) is stored. If found, it will create a writable environment, using aufs, for Debian like systems to boot from.
</p>
</div><div class="substance">
<label class="ocn"><a name="306" href="#306" class="lnkocn">306</a></label>
<p class="i0" id="o306">
More information on initial ramfs in Debian can be found in the Debian Linux Kernel Handbook at ‹<a href="http://kernel-handbook.alioth.debian.org/" target="_top">http://kernel-handbook.alioth.debian.org/</a>› in the chapter on initramfs.
</p>
</div><div class="substance">
<label class="ocn"><a name="307" href="#307" class="lnkocn">307</a></label>
<p class="bold" id="o307"><a name="307"></a> <a name="hlive-config" id="hlive-config"></a>
<a name="h5.3" ></a><a name="live-config" ></a>5.3 The live-config package
</p>
</div><div class="substance">
<label class="ocn"><a name="308" href="#308" class="lnkocn">308</a></label>
<p class="i0" id="o308">
<i>live-config</i> consists of the scripts that run at boot time after <i>live-boot</i> to configure the live system automatically. It handles such tasks as setting the hostname, locales and timezone, creating the live user, inhibiting cron jobs and performing autologin of the live user.
</p>
</div></div><br /><div class="main_column">
<table summary="segment navigation band" bgcolor="#ffffff" width="100%"><tr>
<td width="70%" align="center">
<table summary="segment navigation available documents types: toc,doc,pdf,concordance" border="0" cellpadding="3" cellspacing="0">
<tr>
<td align="center" bgcolor="#ffffff">
<td align="center" bgcolor="#ffffff">
<a href="sisu_manifest.en.html" target="_top" >
<font face="verdana, arial, georgia, tahoma, sans-serif, helvetica, times, roman" size="2">
[ document manifest ]
</font>
</a>
</td>
</tr></table>
</td>
<td width="5%" align="right">
<table summary="segment navigation pre/next" border="0" cellpadding="3" cellspacing="0">
<tr>
<td align="center" bgcolor="#ffffff">
<a href="the-basics.en.html" target="_top" >
<img border="0" width="22" height="22" src="../_sisu/image_sys/arrow_prev_red.png" alt="<< previous" />
</a>
</td>
<td align="center" bgcolor="#ffffff">
<a href="toc.en.html" target="_top" >
<img border="0" width="22" height="22" src="../_sisu/image_sys/arrow_up_red.png" alt="TOC" />
</a>
</td>
<td align="center" bgcolor="#ffffff">
<a href="managing-a-configuration.en.html" target="_top" >
<img border="0" width="22" height="22" src="../_sisu/image_sys/arrow_next_red.png" alt="next >>" />
</a>
</td>
<td>
</td></tr>
</table>
</td></tr>
</table>
<table summary="segment hidden control pre and next" width="100%" border="0" cellpadding="0" bgcolor=#eeeeee align="center">
<tr><td align="left">
<a href="the-basics.en.html" target="_top" >
<img border="0" width="100%" height="20" src="../_sisu/image_sys/dot_white.png" alt="<" />
</a>
</td>
<td align="center">
<a href="toc.en.html" target="_top" >
<img border="0" width="100%" height="20" src="../_sisu/image_sys/dot_white.png" alt="^" />
</a>
</td>
<td align="right">
<a href="managing-a-configuration.en.html" target="_top" >
<img border="0" width="100%" height="20" src="../_sisu/image_sys/dot_white.png" alt=">" />
</a>
</td></tr>
</table>
</div><div class="main_column">
<a name="bottom" id="bottom"></a>
<a name="down" id="down"></a>
<a name="end" id="end"></a>
<a name="finish" id="finish"></a>
<a name="stop" id="stop"></a>
<a name="credits" id="credits"></a>
</div></div></body>
</html>
|