[SCM] Debian Live manual branch, master, updated. 908d7ce365faf810468ac96eee491243fb718a2d
Daniel Baumann
daniel at debian.org
Tue Nov 11 17:58:34 UTC 2008
The following commit has been merged in the master branch:
commit 17179aa0ce1e270cbbcdd331d57a776af5280ef2
Author: Daniel Baumann <daniel at debian.org>
Date: Tue Nov 11 18:52:16 2008 +0100
Merging different customization chapters into one customization chapter.
diff --git a/chapters/customization.xml b/chapters/customization.xml
new file mode 100644
index 0000000..f09da84
--- /dev/null
+++ b/chapters/customization.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+ <!ENTITY % commondata SYSTEM "../ent/common.ent" > %commondata;
+]>
+<chapter id="customization">
+<title>Customization</title>
+
+<xi:include href="customization/packages.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+<xi:include href="customization/contents.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+<xi:include href="customization/bootup.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+<xi:include href="customization/binary.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+
+
+</chapter>
diff --git a/chapters/customisation-binary.xml b/chapters/customization/binary.xml
similarity index 94%
rename from chapters/customisation-binary.xml
rename to chapters/customization/binary.xml
index c7474b9..1483b4d 100644
--- a/chapters/customisation-binary.xml
+++ b/chapters/customization/binary.xml
@@ -1,14 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
- <!ENTITY % commondata SYSTEM "../ent/common.ent" > %commondata;
+ <!ENTITY % commondata SYSTEM "../../ent/common.ent" > %commondata;
]>
-<chapter id="binary">
+<sect1 id="binary">
<title>Customising the binary image</title>
<para>This chapter discusses FIXME</para>
-<section id="iso-metadata">
+<sect2 id="iso-metadata">
<title>ISO metadata</title>
<para>
When creating an ISO9660 binary image, you can use the following options to add various textual metadata for your image. This can help you easily identify the version or configuration of an image without booting it.
@@ -49,6 +49,6 @@
</varlistentry>
</variablelist>
-</section>
+</sect2>
-</chapter>
+</sect1>
diff --git a/chapters/customisation-bootup.xml b/chapters/customization/bootup.xml
similarity index 77%
rename from chapters/customisation-bootup.xml
rename to chapters/customization/bootup.xml
index 9e30a1f..e47cf94 100644
--- a/chapters/customisation-bootup.xml
+++ b/chapters/customization/bootup.xml
@@ -1,67 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
- <!ENTITY % commondata SYSTEM "../ent/common.ent" > %commondata;
+ <!ENTITY % commondata SYSTEM "../../ent/common.ent" > %commondata;
]>
-<chapter id="bootup">
+<sect1 id="bootup">
<title>Customising the bootup process</title>
<para>This chapter discusses customisation of bootup process of a live system, including kernel options, modifications to the bootloader, "splash" screens and startup scripts.</para>
<para>FIXME</para>
-<section id="kernel">
+<sect2 id="kernel">
<title>Kernel</title>
-</section>
+</sect2>
-<section id="bootloaders">
+<sect2 id="bootloaders">
<title>Bootloaders</title>
<para>
FIXME
</para>
-<section>
+<sect3>
<title>Choosing a bootloader</title>
<para>
FIXME
</para>
-</section>
+</sect3>
-<section id="syslinux">
+<sect3 id="syslinux">
<title>Syslinux</title>
<para>In the default configuration, Syslinux will pause indefinitely at its splash screen. To adjust this, modify the <computeroutput>LH_SYSLINUX_TIMEOUT</computeroutput> value or pass <computeroutput>--syslinux-timeout <replaceable>TIMEOUT</replaceable></computeroutput> to <filename>lh_config</filename>. The value is specified in units of 1/10s and the maximum possible timeout is 35996. A timeout of 0 (zero) disables the timeout completely. For more information please see syslinux(1).</para>
-</section>
+</sect3>
-<section>
+<sect3>
<title>Bootloader templates</title>
<para>
FIXME
</para>
-</section>
-</section>
+</sect3>
+</sect2>
-<section id="splash">
+<sect2 id="splash">
<title>Splash screens</title>
<para>
FIXME
</para>
-</section>
+</sect2>
-<section id="memtest">
+<sect2 id="memtest">
<title>Memtest</title>
<para>
FIXME
</para>
-</section>
+</sect2>
-<section id="startup-scripts">
+<sect2 id="startup-scripts">
<title>Startup scripts</title>
<para>
FIXME
</para>
-</section>
+</sect2>
-<section id="cheat-codes">
+<sect2 id="cheat-codes">
<title>Cheat codes</title>
<para>
FIXME
@@ -69,6 +69,6 @@
<para>
Checksums.
</para>
-</section>
+</sect2>
-</chapter>
+</sect1>
diff --git a/chapters/customisation-contents.xml b/chapters/customization/contents.xml
similarity index 88%
rename from chapters/customisation-contents.xml
rename to chapters/customization/contents.xml
index f446bcc..1819c2c 100644
--- a/chapters/customisation-contents.xml
+++ b/chapters/customization/contents.xml
@@ -1,14 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
- <!ENTITY % commondata SYSTEM "../ent/common.ent" > %commondata;
+ <!ENTITY % commondata SYSTEM "../../ent/common.ent" > %commondata;
]>
-<chapter id="contents">
+<sect1 id="contents">
<title>Customising contents</title>
<para>This chapter discusses further customisation of the live system.</para>
-<section>
+<sect2>
<title>Includes</title>
<para>Using includes, it is possible to add (or replace) arbitrary files in your Debian Live image. &live-helper; provides three mechanisms for using them:</para>
@@ -50,7 +50,7 @@
Please see <xref linkend="terms"/> for more information about the distinction between the "Live" and "binary" images.
</para>
-<section id="chroot-local-includes">
+<sect3 id="chroot-local-includes">
<title>Live/chroot local includes</title>
<para>
Chroot local includes can be used to add or replace files in the chroot/Live filesystem so that they are visible when the Live system is booted. Typical uses for them are to populate the skeleton user directory (<filename class="directory">/etc/skel</filename>) or adding configuration files where additional processing is not required.
@@ -83,52 +83,53 @@
<para>
Chroot local includes are installed after package installation so that files installed by packages are overwritten.
</para>
-</section>
+</sect3>
-<section id="binary-local-includes">
+<sect3 id="binary-local-includes">
<title>Binary local includes</title>
<para>
FIXME.
</para>
-</section>
+</sect3>
-<section id="binary-includes">
+<sect3 id="binary-includes">
<title>Binary includes</title>
<para>
FIXME.
</para>
-</section>
+</sect3>
-</section>
+</sect2>
-<section id="hooks">
+<sect2 id="hooks">
<title>Hooks</title>
<para>FIXME.</para>
<para>Enabling hooks</para>
-<section id="chroot-local-hooks">
+<sect3 id="chroot-local-hooks">
<title>Live/chroot local hooks</title>
<para>FIXME.</para>
-</section>
+</sect3>
-<section id="binary-local-hooks">
+<sect3 id="binary-local-hooks">
<title>Binary local hooks</title>
<para>FIXME.</para>
-</section>
+</sect3>
-</section>
+</sect2>
-<section id="debconf-preseed">
+<sect2 id="debconf-preseed">
<title>Preseeding Debconf questions</title>
<para>Files in the <filename class="directory">config/chroot_local-preseed</filename> directory are considered to be debconf preseed files and are installed by &live-helper; using <filename>debconf-set-selections</filename>.</para>
<para>For more information about debconf, please see debconf(7) in the <computeroutput>debconf</computeroutput> package.</para>
-</section>
+</sect2>
-<section id="symlinks">
+<sect2 id="symlinks">
<title>Symlink conversion</title>
<para>FIXME. (This is probably in the wrong section)</para>
-</section>
-</chapter>
+</sect2>
+
+</sect1>
diff --git a/chapters/customisation-packages.xml b/chapters/customization/packages.xml
similarity index 93%
rename from chapters/customisation-packages.xml
rename to chapters/customization/packages.xml
index af0efa5..a426932 100644
--- a/chapters/customisation-packages.xml
+++ b/chapters/customization/packages.xml
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
- <!ENTITY % commondata SYSTEM "../ent/common.ent" > %commondata;
+ <!ENTITY % commondata SYSTEM "../../ent/common.ent" > %commondata;
]>
-<chapter id="packages">
+<sect1 id="packages">
<title>Customising package installation</title>
<para>
@@ -15,14 +15,14 @@
<listitem><para>Installing modified packages</para></listitem>
</orderedlist>
-<section id="package-sources">
+<sect2 id="package-sources">
<title>Package sources</title>
<para>
FIXME
</para>
-</section>
+</sect2>
-<section id="package-installation">
+<sect2 id="package-installation">
<title>Package installation</title>
<para>
You can elect to use either <computeroutput>apt</computeroutput> or <computeroutput>aptitude</computeroutput> when installing packages. Which utility is used is governed by the <computeroutput>LH_APT</computeroutput> variable in <filename>config/chroot</filename> or by the <computeroutput>--apt</computeroutput> argument to <filename>lh_config</filename>:
@@ -53,9 +53,9 @@
</varlistentry>
</variablelist>
-</section>
+</sect2>
-<section>
+<sect2>
<title>Installing additional packages</title>
<para>
@@ -69,7 +69,7 @@
<listitem><para>Tasks</para></listitem>
</orderedlist>
-<section id="lh-packages">
+<sect3 id="lh-packages">
<title>The <computeroutput>LH_PACKAGES</computeroutput> variable</title>
<para>
To install additional packages, simply add them to the <computeroutput>LH_PACKAGES</computeroutput> variable in <filename>config/chroot</filename>. For example:
@@ -92,9 +92,9 @@ $ lh_config --packages "package1 package2 package3"
<para>
If you need to specify a large number of packages to be installed or you need flexibility regarding which packages to install, you should probably be using package lists. See <xref linkend="package-lists"/> for more information.
</para>
-</section>
+</sect3>
-<section id="package-lists">
+<sect3 id="package-lists">
<title>Package lists</title>
<para>
Package lists are a powerful way of expressing which packages should be installed. &live-helper; ships with a number of predefined package lists which provide sensible default package selections for the GNOME and KDE desktop environments, as well as standard systems.
@@ -108,7 +108,7 @@ LH_PACKAGES_LISTS="gnome"
<para>Packages lists that a distributed with &live-helper; reside in view in the <computeroutput>/usr/share/live-helper/lists</computeroutput> directory.</para>
-<section>
+<sect4>
<title>Local packages lists</title>
<para>
You may supplement the supplied lists using local package lists stored in <computeroutput>config/chroot_local-packageslists</computeroutput>.
@@ -117,9 +117,9 @@ LH_PACKAGES_LISTS="gnome"
Package lists that exist in this directory always override package lists distributed with &live-helper;. This can cause undesired effects when..
</para>
-</section>
+</sect4>
-<section>
+<sect4>
<title>Extending a provided package list using includes</title>
<para>FIXME.</para>
@@ -131,9 +131,9 @@ iceweasel
<para>
The package lists that are included with &live-helper; make extensive use of includes. They are available to view in the <computeroutput>/usr/share/live-helper/lists</computeroutput> directory.
</para>
-</section>
+</sect4>
-<section>
+<sect4>
<title>Using conditionals inside packages lists</title>
<para>FIXME</para>
@@ -174,18 +174,18 @@ vrms
The nesting of conditionals is not supported.
</para>
-</section>
+</sect4>
-</section>
+</sect3>
-<section id="tasks">
+<sect3 id="tasks">
<title>Tasks</title>
<para>FIXME</para>
-</section>
+</sect3>
-</section>
+</sect2>
-<section id="custom-packages">
+<sect2 id="custom-packages">
<title>Installing modified or third-party packages</title>
<para>Whilst it is against the philosophy of Debian Live, it may sometimes be necessary to build a Live system with modified versions of packages that are in the Debian repository. This may be to modify or support additional features, languages and branding, or even to remove elements of existing packages that are undesirable. Similarly, "third-party" packages may be used to add bespoke and/or proprietary functionality.</para>
@@ -200,7 +200,7 @@ vrms
<para>The <filename>chroot_local-packages</filename> is simpler to achieve and useful for "one-off" customisations but has a number of drawbacks, whilst using a custom APT repository is more time-consuming to setup.</para>
-<section id="local-packages">
+<sect3 id="local-packages">
<title>Using <filename>chroot_local-packages</filename> to install custom packages</title>
<para>To install a custom package, simply copy it to the <computeroutput>config/chroot_local-packages</computeroutput> directory. Packages that are inside this directory will be automatically installed into the live system during build - you do not need to specify them elsewhere.</para>
@@ -212,9 +212,9 @@ vrms
<listitem><para>You must install all appropriate packages in the <computeroutput>config/chroot_local-packages</computeroutput> directory</para></listitem>
<listitem><para>Does not lend itself to storing Debian Live configurations in revision control</para></listitem>
</orderedlist>
-</section>
+</sect3>
-<section id="custom-apt-repo">
+<sect3 id="custom-apt-repo">
<title>Using an APT repository to install custom packages</title>
<para>
FIXME
@@ -225,9 +225,9 @@ vrms
<para>
Whilst it may seem unnecessary effort to create an APT repository to install custom packages, the infrastructure can be easily re-used at a later date to offer updates of the modified package.
</para>
-</section>
+</sect3>
-<section id="custom-packages-apt">
+<sect3 id="custom-packages-apt">
<title>Custom packages and APT</title>
<para>
&live-helper; uses APT to install all packages into the live system so will therefore inherit behaviours from this program. One relevant example is that (assuming a default configuration) given a package is available in two different repositories, APT will elect to install the package with a higher version number over one with the lower.
@@ -237,9 +237,9 @@ vrms
Because of this. you may wish to increment the version number in your custom packages' <computeroutput>debian/changelog</computeroutput> files to ensure that your modified version is installed over one in the official Debian repositories. This may also be achieved by altering the live system's APT pinning preferences - see <xref linkend="apt-preferences"/> for more information.
</para>
-</section>
+</sect3>
-<section id="apt-preferences">
+<sect3 id="apt-preferences">
<title>Altering APT preferences during Live system</title>
<para>
FIXME
@@ -247,8 +247,8 @@ vrms
<para>
Whilst it may seem unnecessary effort to create an APT repository to install custom packages, the infrastructure can be easily re-used at a later date to offer updates of the modified package.
</para>
-</section>
+</sect3>
-</section>
+</sect2>
-</chapter>
+</sect1>
diff --git a/index.xml b/index.xml
index 0c13e99..5127878 100644
--- a/index.xml
+++ b/index.xml
@@ -55,10 +55,7 @@ Document Format (PDF).
<xi:include href="chapters/installation.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<xi:include href="chapters/basics.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<xi:include href="chapters/overview.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
-<xi:include href="chapters/customisation-packages.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
-<xi:include href="chapters/customisation-contents.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
-<xi:include href="chapters/customisation-bootup.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
-<xi:include href="chapters/customisation-binary.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
+<xi:include href="chapters/customization.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<xi:include href="chapters/common-tasks.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<xi:include href="chapters/live-environment.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<xi:include href="chapters/faq.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
--
Debian Live manual
More information about the debian-live-changes
mailing list