[SCM] UNNAMED PROJECT branch, master, updated. 20090201-1-23-g6b49020
Daniel Baumann
daniel at debian.org
Sat Feb 14 20:29:42 UTC 2009
The following commit has been merged in the master branch:
commit 51e9821db8d447a356f79cf4bd765828bde12784
Author: Richard Nelson <unixabg at gmail.com>
Date: Fri Feb 13 12:41:52 2009 -0600
Tag cleanup on Chapter 3
diff --git a/xml/chapters/basics.xml b/xml/chapters/basics.xml
index 4ffefab..b784828 100644
--- a/xml/chapters/basics.xml
+++ b/xml/chapters/basics.xml
@@ -6,109 +6,56 @@
<chapter id="basics">
<title>The basics</title>
-<para>
- This chapter contains a brief overview of the build process as well as containing instructions on how to boot the various binary image types.
-</para>
+<para>This chapter contains a brief overview of the build process as well as containing instructions on how to boot the various binary image types.</para>
<section>
<title>What is a live system?</title>
-<para>A live system usually means an OS booted on a computer from a
- removable support (as CD-ROM, USB stick, or network), ready to use
- without any installation on the usual drive(s), with an
- auto-configuration done at runtime.
-</para>
+<para>A live system usually means an OS booted on a computer from a removable support (as CD-ROM, USB stick, or network), ready to use without any installation on the usual drive(s), with an auto-configuration done at runtime.</para>
+
+<para>With Debian Live, it's a Debian GNU/Linux OS, built for one of the supported architectures (currently amd64, i386, powerpc and sparc). It is made from following parts:</para>
-<para>With Debian Live, it's a Debian GNU/Linux OS, built for one of
- the supported architectures (currently amd64, i386, powerpc and sparc).
- It is made from following parts:
<variablelist>
-<varlistentry><term>a Linux kernel</term>
-<listitem><para>
-the Linux image, usually named <filename>vmlinuz*</filename>.
-</para></listitem>
+<varlistentry>
+<term>a Linux kernel</term>
+<listitem><para>the Linux image, usually named <filename>vmlinuz*</filename>.</para></listitem>
</varlistentry>
-<varlistentry><term>an initial RAM disk image (initrd)</term>
-<listitem><para>
-RAM disk setup for the Linux boot, containing modules possibly need to
-mount the filesystem's image and some scripts to do it.
-</para></listitem>
+<varlistentry>
+<term>an initial RAM disk image (initrd)</term>
+<listitem><para>RAM disk setup for the Linux boot, containing modules possibly need to mount the filesystem's image and some scripts to do it.</para></listitem>
</varlistentry>
<varlistentry>
<term>a system image</term>
-<listitem><para>
-The O.S. image. Debian Live uses a SquashFS image, a compressed
-filesystem, to minimize its size. Note that it's read-only, so during
-boot, the Debian Live system will uses RAM disk and 'union' mechanism
-to be able to write files on the system, but all modifications will be
-lost when shutdown, until using optional persistence partition(s)
-(see <xref linkend="persistence"/>).
-</para></listitem>
+<listitem><para>The O.S. image. Debian Live uses a SquashFS image, a compressed filesystem, to minimize its size. Note that it's read-only, so during boot, the Debian Live system will uses RAM disk and 'union' mechanism to be able to write files on the system, but all modifications will be lost when shutdown, until using optional persistence partition(s) (see <xref linkend="persistence"/>).</para></listitem>
</varlistentry>
<varlistentry>
<term>a bootloader</term>
-<listitem><para>
-A small piece of code, crafted to boot up from the chosen media,
-possibly proposing a prompt or menu to let select
-options/configuration, then loading the Linux kernel and its initrd to
-let it run with associated filesystem image. Different solutions can
-be proposed depending of the target media and fornat of filesystem
-containing the previous components: Isolinux to boot from a CD or
-DVD in ISO9660 format, syslinux for HDD or USB drive boot from a VFAT
-partition, GRUB for ext2/3 partition, pxelinux for PXE netboot...
-</para></listitem>
+<listitem><para>A small piece of code, crafted to boot up from the chosen media, possibly proposing a prompt or menu to let select options/configuration, then loading the Linux kernel and its initrd to let it run with associated filesystem image. Different solutions can be proposed depending of the target media and fornat of filesystem containing the previous components: Isolinux to boot from a CD or DVD in ISO9660 format, syslinux for HDD or USB drive boot from a VFAT partition, GRUB for ext2/3 partition, pxelinux for PXE netboot...</para></listitem>
</varlistentry>
-</variablelist>
-</para>
-<para>
-The Debian Live tools will build the system image from your
-specifications, setup a Linux kernel and its initrd, a bootloader to
-run them, all in one media-dependant format(ISO9660 image, disk image, ...).
-</para>
+</variablelist>
+<para>The Debian Live tools will build the system image from your specifications, setup a Linux kernel and its initrd, a bootloader to run them, all in one media-dependant format(ISO9660 image, disk image, ...).</para>
</section>
<section>
<title>First steps: building an ISO image</title>
-<para>
- The following sequence of commands will create a basic ISO image containing just the Debian standard system without X.org. It is suitable for burning to CD or DVD media.
-</para>
-
-<para>
- First, we must configure our Live system:
-</para>
-
-<screen>
-$ lh_config
-</screen>
-
-<para>
- Passing no parameters indicated that we wish to use the default binary image type. You will see that &live-helper; created a <filename>"config/"</filename> hierarchy in your current directory - this is used by the rest of &live-helper; to build your live image.
-</para>
-
-<para>
- We can then build the image with <filename>lh_build</filename> as root:
-</para>
-
-<screen>
-# lh_build
-</screen>
-
-<para>
- This process can take a while, depending on the speed of your network connection.
-</para>
+<para>The following sequence of commands will create a basic ISO image containing just the Debian standard system without X.org. It is suitable for burning to CD or DVD media.</para>
+<para>First, we must configure our Live system:</para>
+<screen>$ lh_config</screen>
+<para>Passing no parameters indicated that we wish to use the default binary image type. You will see that &live-helper; created a <filename>"config/"</filename> hierarchy in your current directory - this is used by the rest of &live-helper; to build your live image.</para>
+<para>We can then build the image with <filename>lh_build</filename> as root:</para>
+<screen># lh_build</screen>
+<para>This process can take a while, depending on the speed of your network connection.</para>
<section>
<title>Testing an ISO image with Qemu</title>
-<para>
- Testing an ISO is simple:
-</para>
+<para>Testing an ISO is simple:</para>
<screen>
# apt-get install qemu
$ qemu -cdrom binary.iso
@@ -117,65 +64,33 @@ $ qemu -cdrom binary.iso
<section>
<title>Burning an ISO image to physical medium</title>
-<para>Burning an ISO image is easy:</para>
+<para>Burning an ISO image is easy:</para>
<screen>
# apt-get install wodim
$ wodim binary.iso
</screen>
</section>
-
</section>
<section>
<title>Building an USB/HDD image</title>
-<para>
- The following sequence of commands will create a basic USB/HDD image containing just the Debian standard system without X.org. It is suitable for booting from USB sticks, hard drives and various other portable storage devices.
-</para>
-
-<para>
- Note if an iso image had been previously built, you will need to clean live-helper:
-</para>
-
-<screen>
-$ lh_clean --binary
-</screen>
-
-<para>
- First, we must configure &live-helper; to create a USD/HDD image type:
-</para>
-<screen>
-$ lh_config -b usb-hdd
-</screen>
-
-<para>
- We can then build the image with <filename>lh_build</filename> as root:
-</para>
-
-<screen>
-# lh_build
-</screen>
+<para>The following sequence of commands will create a basic USB/HDD image containing just the Debian standard system without X.org. It is suitable for booting from USB sticks, hard drives and various other portable storage devices.</para>
+<para>Note if an iso image had been previously built, you will need to clean live-helper:</para>
+<screen>$ lh_clean --binary</screen>
+<para>First, we must configure &live-helper; to create a USD/HDD image type:</para>
+<screen>$ lh_config -b usb-hdd</screen>
+<para>We can then build the image with <filename>lh_build</filename> as root:</para>
+<screen># lh_build</screen>
<section>
<title>Copying USB/HDD image to a USB stick</title>
-The generated binary image contains a <acronym>VFAT</acronym>
-partition and the <command>syslinux</command> bootloader,
-ready to be directly written on an USB stick. Plug in an USB stick with a
-size larger than <filename>binary.img</filename>'s one, and type:
-
-<screen>
-$ dd if=binary.img of=${USBSTICK}
-</screen>
-
-where <replaceable>${USBSTICK}</replaceable> is the device file of your key,
-like <filename>/dev/sda</filename> (not a partition like
-<filename>/dev/sda1</filename>!); you can find the right device name by looking
-in <command>dmesg</command>'s output after plugging the stick, for example).
-
-<important>This will definitely overwrite any previous contents on your
-stick!</important>
+<para>The generated binary image contains a <acronym>VFAT</acronym> partition and the <command>syslinux</command> bootloader, ready to be directly written on an USB stick. Plug in an USB stick with a size larger than <filename>binary.img</filename>'s one, and type:
+<screen>$ dd if=binary.img of=${USBSTICK}</screen>
+where <replaceable>${USBSTICK}</replaceable> is the device file of your key, like <filename>/dev/sda</filename> (not a partition like <filename>/dev/sda1</filename>!); you can find the right device name by looking in <command>dmesg</command>'s output after plugging the stick, for example).</para>
+<important>This will definitely overwrite any previous contents on youro stick!</important>
</section>
<section>
@@ -190,73 +105,22 @@ $ qemu -hda binary.img
<section>
<title>Building a netboot image</title>
-<para>
- First, we configure our Live system:
-</para>
-
-<screen>
-$ lh_config -b net --net-root-path "/srv/debian-live" --net-root-server "192.168.0.1"
-</screen>
-
-<para>
- In contrast with the ISO and USB hdd images, netbooting does not
- support serving a filesystem image with the client so the files must be
- served via NFS. The <replaceable>net-root-path</replaceable>
- and <replaceable>net-root-server</replaceable> options specify the
- location and server respectfully of the NFS server where the filesytem
- image will be located at boot-time.
-</para>
-
-<para>
- We can then build the image with <filename>lh_build</filename> as root:
-</para>
-
-<screen>
-# lh_build
-</screen>
-
-<para>
- In a net boot, a client runs a small piece of software, usually on
- the <acronym>EEPROM</acronym> of the Ethernet card, which send
- a <abbrev>DHCP</abbrev> request to get an
- <abbrev>IP</abbrev> address and also information about what to do
- next : usually getting (through <abbrev>TFTP</abbrev> protocol) a
- higher level boot software like <application>Grub</application>
- or <application>PXLINUX</application>, or directly an operating
- system like <application>Linux</application>.
-</para>
-
-<para>
- For example, you can extract the generated
- <filename>binary-net.tar.gz</filename> archive
- in the <filename>/srv/debian-live</filename> directory; you'll get
- the filesystem image
- in <filename>live/filesystem.squashfs</filename>, the kernel,
- initrd and PXE Linux bootloader
- in <filename>tftpboot/debian-live/i386</filename>.
-</para>
-
-<para>
- We must now configure three services on the server:
-</para>
+<para>First, we configure our Live system:</para>
+<screen>$ lh_config -b net --net-root-path "/srv/debian-live" --net-root-server "192.168.0.1"</screen>
+<para>In contrast with the ISO and USB hdd images, netbooting does not support serving a filesystem image with the client so the files must be served via NFS. The <replaceable>net-root-path</replaceable> and <replaceable>net-root-server</replaceable> options specify the location and server respectfully of the NFS server where the filesytem image will be located at boot-time.</para>
+<para>We can then build the image with <filename>lh_build</filename> as root:</para>
+<screen># lh_build</screen>
+<para>In a net boot, a client runs a small piece of software, usually on the <acronym>EEPROM</acronym> of the Ethernet card, which send a <abbrev>DHCP</abbrev> request to get an <abbrev>IP</abbrev> address and also information about what to do next : usually getting (through <abbrev>TFTP</abbrev> protocol) a higher level boot software like <application>Grub</application> or <application>PXLINUX</application>, or directly an operating system like <application>Linux</application>.</para>
+<para>For example, you can extract the generated <filename>binary-net.tar.gz</filename> archive in the <filename>/srv/debian-live</filename> directory; you'll get the filesystem image in <filename>live/filesystem.squashfs</filename>, the kernel, initrd and PXE Linux bootloader in <filename>tftpboot/debian-live/i386</filename>.</para>
+<para>We must now configure three services on the server:</para>
<variablelist>
-<varlistentry><term>DHCP server</term>
+<varlistentry>
+<term>DHCP server</term>
<listitem>
-<para>
- We must configure our network's DHCP server to be sure to give a
- <abbrev>IP</abbrev> address to the computer netbooting, and to
- advertise the location of the PXE bootloader.
-</para>
-
-<para>
- Here is an example for inspiration, written for the ISC DHCP server
- (package <literal>dhcp3-server</literal>)
- in the <filename>/etc/dhcp3/dhcpd.conf</filename> configuration file :
-</para>
-
+<para>We must configure our network's DHCP server to be sure to give a <abbrev>IP</abbrev> address to the computer netbooting, and to advertise the location of the PXE bootloader.</para>
+<para>Here is an example for inspiration, written for the ISC DHCP server (package <literal>dhcp3-server</literal>) in the <filename>/etc/dhcp3/dhcpd.conf</filename> configuration file :</para>
<screen>
-
# Options DHCP spécifiques à Pxelinux:
option space pxelinux;
option pxelinux.magic code 208 = string;
@@ -308,60 +172,30 @@ subnet 192.168.1.0 netmask 255.255.255.0 { # 192.168.1.0/24
</listitem>
</varlistentry>
-<varlistentry><term>TFTPd server</term>
+<varlistentry>
+<term>TFTPd server</term>
<listitem>
-<para>
- This serves the kernel and initial ramdisk to the system at run-time.
-</para>
-<para>
- You should install the <command>tftpd-hpa</command> package. It can
- serve all files contained inside a root directory,
- usually <filename>/var/lib/tftpboot/</filename>, as defined with its
- <option>-s</option> option. To let it serves files
- inside <filename>/srv/debian-live/tftpboot</filename>, modify its
- start definition in <filename>/etc/inetd.conf</filename> with :
-
-<screen>
-tftp dgram udp wait root /usr/sbin/in.tftpd /usr/sbin/in.tftpd -s /srv/debian-live/tftpboot -r blksize -v -v
-</screen>
-and reload the super server with
-<command>/etc/init.d/openbsd-inetd reload</command>.
+<para>This serves the kernel and initial ramdisk to the system at run-time.</para>
+<para>You should install the <command>tftpd-hpa</command> package. It can serve all files contained inside a root directory, usually <filename>/var/lib/tftpboot/</filename>, as defined with its <option>-s</option> option. To let it serves files inside <filename>/srv/debian-live/tftpboot</filename>, modify its start definition in <filename>/etc/inetd.conf</filename> with:
+<screen>tftp dgram udp wait root /usr/sbin/in.tftpd /usr/sbin/in.tftpd -s /srv/debian-live/tftpboot -r blksize -v -v</screen>
+and reload the super server with <command>/etc/init.d/openbsd-inetd reload</command>.
</para>
</listitem>
</varlistentry>
<varlistentry><term>NFS server</term>
<listitem>
-<para>
- Once the guest computer will have downloaded and booted a Linux
- kernel and its initrd, it will try to mount the Live filesystem image
- through a NFS server.
-</para>
-
-<para>
- You should install the <command>nfs-kernel-server</command> server package -- <command>nfs-user-server</command> does not function correctly with netboot.
-</para>
-
-<para>Then, declare that the directory of the filesystem image is
- available through NFS, by writing
- in <filename>/etc/exports</filename> :</para>
-<screen>
-/srv/debian-live *(ro,async,subtree_check,no_root_squash)
-</screen>
-
+<para>Once the guest computer will have downloaded and booted a Linux kernel and its initrd, it will try to mount the Live filesystem image through a NFS server.</para>
+<para>You should install the <command>nfs-kernel-server</command> server package -- <command>nfs-user-server</command> does not function correctly with netboot.</para>
+<para>Then, declare that the directory of the filesystem image is available through NFS, by writing in <filename>/etc/exports</filename> :</para>
+<screen>/srv/debian-live *(ro,async,subtree_check,no_root_squash)</screen>
<para>and let the NFS server knowing it typing following command :</para>
-<screen>
-# exportfs -rv
-</screen>
-
+<screen># exportfs -rv</screen>
</listitem>
</varlistentry>
</variablelist>
-<para>Setting all these services is quite error prone, you'll need
- some patience to let all of them working together.</para>
-
+<para>Setting all these services is quite error prone, you'll need some patience to let all of them working together.</para>
</section>
-
</chapter>
--
UNNAMED PROJECT
More information about the debian-live-changes
mailing list