[SCM] Debian Live manual branch, master, updated. 2044709bd4608b89111ef3367cda68196a32b3c1
Daniel Baumann
daniel at debian.org
Fri Nov 21 07:18:09 UTC 2008
The following commit has been merged in the master branch:
commit 2044709bd4608b89111ef3367cda68196a32b3c1
Author: Daniel Baumann <daniel at debian.org>
Date: Fri Nov 21 08:18:03 2008 +0100
Replacing computeroutput tag with short command synonym.
diff --git a/xml/chapters/about/manual.xml b/xml/chapters/about/manual.xml
index 9c7a4f3..50dee5e 100644
--- a/xml/chapters/about/manual.xml
+++ b/xml/chapters/about/manual.xml
@@ -9,7 +9,7 @@
<para>
The main goal of this manual is to serve as a single access point to all documentation related to the Debian Live project. It does not include end-user documentation for using a Debian Live system.</para>
-<para>Some of the commands mentioned in the text must be executed with superuser privileges, either by becoming the root user or by using <filename>sudo</filename>. To distinguish between commands which may be executed by an unprivileged user and those requiring superuser privileges, commands are prepended by <computeroutput>$</computeroutput> or <computeroutput>#</computeroutput> respectively. This symbol is not a part of the command.</para>
+<para>Some of the commands mentioned in the text must be executed with superuser privileges, either by becoming the root user or by using <filename>sudo</filename>. To distinguish between commands which may be executed by an unprivileged user and those requiring superuser privileges, commands are prepended by <command>$</command> or <command>#</command> respectively. This symbol is not a part of the command.</para>
<sect2 id="terms">
<title>Terms</title>
diff --git a/xml/chapters/basics.xml b/xml/chapters/basics.xml
index 69b90c7..ee01f72 100644
--- a/xml/chapters/basics.xml
+++ b/xml/chapters/basics.xml
@@ -145,7 +145,7 @@ $ lh_config -b net --net-root-path "/srv/debian-live" --net-root-server "192.168
This contains the Live filesystem image which the system will use at run-time.
</para>
<para>
- You should install the <computeroutput>nfs-kernel-server</computeroutput> server package -- <computeroutput>nfs-user-server</computeroutput> does not function correctly with netboot.
+ You should install the <command>nfs-kernel-server</command> server package -- <command>nfs-user-server</command> does not function correctly with netboot.
</para>
<para>
FIXME
@@ -163,7 +163,7 @@ $ lh_config -b net --net-root-path "/srv/debian-live" --net-root-server "192.168
This serves the kernel and initial ramdisk to the system at run-time.
</para>
<para>
- You should install the <computeroutput>tftpd-hpa</computeroutput> package.
+ You should install the <command>tftpd-hpa</command> package.
</para>
<screen>
diff --git a/xml/chapters/common-tasks.xml b/xml/chapters/common-tasks.xml
index 01ad454..48db0c0 100644
--- a/xml/chapters/common-tasks.xml
+++ b/xml/chapters/common-tasks.xml
@@ -32,7 +32,7 @@
This is a normal Debian Live image with a seperate kernel and initrd which (when selected from the appropriate bootloader) launches into a standard Debian Installer instance, just as if you had downloaded a CD image of Debian and booted it.
</para>
<para>
- This means that Debian is installed by fetching and installing <computeroutput>.deb</computeroutput> packages using <filename>debootstrap</filename> or <filename>cdebootstrap</filename>, from the local media or some network-base network, resulting in a standard Debian system being installed to the hard disk.
+ This means that Debian is installed by fetching and installing <command>.deb</command> packages using <filename>debootstrap</filename> or <filename>cdebootstrap</filename>, from the local media or some network-base network, resulting in a standard Debian system being installed to the hard disk.
</para>
<para>
This whole process can be preseeded and customised in a number of ways; see the relevant "DebianInstaller" wiki page and installation guide for more. This is operational now withing &live-helper;.
diff --git a/xml/chapters/customization/binary.xml b/xml/chapters/customization/binary.xml
index 191a511..6803ed1 100644
--- a/xml/chapters/customization/binary.xml
+++ b/xml/chapters/customization/binary.xml
@@ -16,7 +16,7 @@
<variablelist>
<varlistentry>
- <term><computeroutput>LH_ISO_APPLICATION</computeroutput> / <computeroutput>--iso-application <replaceable>NAME</replaceable></computeroutput></term>
+ <term><command>LH_ISO_APPLICATION</command> / <command>--iso-application <replaceable>NAME</replaceable></command></term>
<listitem>
<para>
This should describe the application that will be on the image. The maximum length for this field is 128 characters.
@@ -24,7 +24,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><computeroutput>LH_ISO_PREPARER</computeroutput> / <computeroutput>--iso-preparer <replaceable>NAME</replaceable></computeroutput></term>
+ <term><command>LH_ISO_PREPARER</command> / <command>--iso-preparer <replaceable>NAME</replaceable></command></term>
<listitem>
<para>
This should describe the preparer of the image, usually with some contact details. The default for this option is the &live-helper; version you are using, which may help with debugging later. The maximum length for this field is 128 characters.
@@ -32,7 +32,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><computeroutput>LH_ISO_PUBLISHER</computeroutput> / <computeroutput>--iso-publisher <replaceable>NAME</replaceable></computeroutput></term>
+ <term><command>LH_ISO_PUBLISHER</command> / <command>--iso-publisher <replaceable>NAME</replaceable></command></term>
<listitem>
<para>
This should describe the publisher of the image, usually with some contact details. The maximum length for this field is 128 characters.
@@ -40,7 +40,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><computeroutput>LH_ISO_VOLUME</computeroutput> / <computeroutput>--iso-volume <replaceable>NAME</replaceable></computeroutput></term>
+ <term><command>LH_ISO_VOLUME</command> / <command>--iso-volume <replaceable>NAME</replaceable></command></term>
<listitem>
<para>
This should specify the volume ID of the image. This is used as a user-visible label on some platforms such as Windows and Apple Mac OS. The maximum length for this field is 32 characters.
diff --git a/xml/chapters/customization/bootup.xml b/xml/chapters/customization/bootup.xml
index 2de7acd..46389f4 100644
--- a/xml/chapters/customization/bootup.xml
+++ b/xml/chapters/customization/bootup.xml
@@ -29,7 +29,7 @@
<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>
+ <para>In the default configuration, Syslinux will pause indefinitely at its splash screen. To adjust this, modify the <command>LH_SYSLINUX_TIMEOUT</command> value or pass <command>--syslinux-timeout <replaceable>TIMEOUT</replaceable></command> 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>
</sect3>
<sect3>
diff --git a/xml/chapters/customization/contents.xml b/xml/chapters/customization/contents.xml
index b6636bf..dce05d7 100644
--- a/xml/chapters/customization/contents.xml
+++ b/xml/chapters/customization/contents.xml
@@ -124,7 +124,7 @@
<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>
+ <para>For more information about debconf, please see debconf(7) in the <command>debconf</command> package.</para>
</sect2>
<sect2 id="symlinks">
diff --git a/xml/chapters/customization/packages.xml b/xml/chapters/customization/packages.xml
index 7c17150..e9cb21d 100644
--- a/xml/chapters/customization/packages.xml
+++ b/xml/chapters/customization/packages.xml
@@ -25,12 +25,12 @@
<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>:
+ You can elect to use either <command>apt</command> or <command>aptitude</command> when installing packages. Which utility is used is governed by the <command>LH_APT</command> variable in <filename>config/chroot</filename> or by the <command>--apt</command> argument to <filename>lh_config</filename>:
</para>
<variablelist>
-<varlistentry><term><computeroutput>apt</computeroutput></term>
+<varlistentry><term><command>apt</command></term>
<listitem>
<para>
Specifying a missing package causes package installation to fail, which may not be the desired behaviour.
@@ -41,7 +41,7 @@
</listitem>
</varlistentry>
-<varlistentry><term><computeroutput>aptitude</computeroutput></term>
+<varlistentry><term><command>aptitude</command></term>
<listitem>
<para>
Specifying a missing package causes package installation to succeed, which may not be the desired behaviour.
@@ -63,16 +63,16 @@
</para>
<orderedlist>
-<listitem><para>The <computeroutput>LH_PACKAGES</computeroutput> variable</para></listitem>
+<listitem><para>The <command>LH_PACKAGES</command> variable</para></listitem>
<listitem><para>Package lists</para></listitem>
<listitem><para>Local packages (<filename>chroot_local-packages/</filename>)</para></listitem>
<listitem><para>Tasks</para></listitem>
</orderedlist>
<sect3 id="lh-packages">
-<title>The <computeroutput>LH_PACKAGES</computeroutput> variable</title>
+<title>The <command>LH_PACKAGES</command> variable</title>
<para>
- To install additional packages, simply add them to the <computeroutput>LH_PACKAGES</computeroutput> variable in <filename>config/chroot</filename>. For example:
+ To install additional packages, simply add them to the <command>LH_PACKAGES</command> variable in <filename>config/chroot</filename>. For example:
</para>
<screen>
@@ -100,18 +100,18 @@ $ lh_config --packages "package1 package2 package3"
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.
</para>
-<para>To specify a package list, add the name of the list to the <computeroutput>LH_PACKAGES_LISTS</computeroutput> variable in <filename>config/chroot</filename>. For example:</para>
+<para>To specify a package list, add the name of the list to the <command>LH_PACKAGES_LISTS</command> variable in <filename>config/chroot</filename>. For example:</para>
<screen>
LH_PACKAGES_LISTS="gnome"
</screen>
-<para>Packages lists that a distributed with &live-helper; reside in view in the <computeroutput>/usr/share/live-helper/lists</computeroutput> directory.</para>
+<para>Packages lists that a distributed with &live-helper; reside in view in the <command>/usr/share/live-helper/lists</command> directory.</para>
<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>.
+ You may supplement the supplied lists using local package lists stored in <command>config/chroot_local-packageslists</command>.
</para>
<para>
Package lists that exist in this directory always override package lists distributed with &live-helper;. This can cause undesired effects when..
@@ -129,7 +129,7 @@ iceweasel
</screen>
<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.
+ The package lists that are included with &live-helper; make extensive use of includes. They are available to view in the <command>/usr/share/live-helper/lists</command> directory.
</para>
</sect4>
@@ -143,7 +143,7 @@ ia32-libs
#endif
</screen>
-<para>or if <computeroutput>LH_ARCHITECTURE</computeroutput> is set to <computeroutput>i386</computeroutput> or <computeroutput>amd64</computeroutput>:</para>
+<para>or if <command>LH_ARCHITECTURE</command> is set to <command>i386</command> or <command>amd64</command>:</para>
<screen>
#if ARCHITECTURE i386 amd64
@@ -151,7 +151,7 @@ memtest86+
#endif
</screen>
-<para>or if <computeroutput>LH_SECTIONS</computeroutput> contains either <computeroutput>contrib</computeroutput> or <computeroutput>non-free</computeroutput>:</para>
+<para>or if <command>LH_SECTIONS</command> contains either <command>contrib</command> or <command>non-free</command>:</para>
<screen>
#if SECTIONS contrib non-free
@@ -159,7 +159,7 @@ vrms
#endif
</screen>
-<para>A conditional may surround an <computeroutput>#include</computeroutput> directive:</para>
+<para>A conditional may surround an <command>#include</command> directive:</para>
<screen>
#if ARCHITECTURE amd64
@@ -168,7 +168,7 @@ vrms
</screen>
<para>
- Any &live-helper; configuration variable that begins with <computeroutput>LH_</computeroutput> can be tested in this way.
+ Any &live-helper; configuration variable that begins with <command>LH_</command> can be tested in this way.
</para>
<para>
The nesting of conditionals is not supported.
@@ -202,14 +202,14 @@ vrms
<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>
+<para>To install a custom package, simply copy it to the <command>config/chroot_local-packages</command> 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>
-<para>Packages <emphasis>must</emphasis> be named in the prescribed way. One simple way to is to use <computeroutput>dpkg-name</computeroutput>. FIXME</para>
+<para>Packages <emphasis>must</emphasis> be named in the prescribed way. One simple way to is to use <command>dpkg-name</command>. FIXME</para>
<para>Using <filename>chroot_local-packages</filename> for installation of custom packages has two disadvantages:</para>
<orderedlist>
<listitem><para>It is not possible to use secure APT</para></listitem>
-<listitem><para>You must install all appropriate packages in the <computeroutput>config/chroot_local-packages</computeroutput> directory</para></listitem>
+<listitem><para>You must install all appropriate packages in the <command>config/chroot_local-packages</command> directory</para></listitem>
<listitem><para>Does not lend itself to storing Debian Live configurations in revision control</para></listitem>
</orderedlist>
</sect3>
@@ -234,7 +234,7 @@ vrms
</para>
<para>
- 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.
+ Because of this. you may wish to increment the version number in your custom packages' <command>debian/changelog</command> 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>
</sect3>
diff --git a/xml/chapters/installation.xml b/xml/chapters/installation.xml
index 6541fb9..a916b9b 100644
--- a/xml/chapters/installation.xml
+++ b/xml/chapters/installation.xml
@@ -15,8 +15,8 @@
<orderedlist>
<listitem><para>Super user (root) access</para></listitem>
<listitem><para>An up-to-date version of &live-helper;</para></listitem>
-<listitem><para>A POSIX-compliant shell, such as <computeroutput>bash</computeroutput> or <computeroutput>dash</computeroutput>.</para></listitem>
-<listitem><para><computeroutput>debootstrap</computeroutput> or <computeroutput>cdebootstrap</computeroutput></para></listitem>
+<listitem><para>A POSIX-compliant shell, such as <command>bash</command> or <command>dash</command>.</para></listitem>
+<listitem><para><command>debootstrap</command> or <command>cdebootstrap</command></para></listitem>
<listitem><para>Linux 2.6.x</para></listitem>
</orderedlist>
@@ -65,7 +65,7 @@
<title>From source</title>
<para>
- &live-helper; is developed using the Git revision control system. On Debian systems, this is provided by the <computeroutput>git-core</computeroutput> package. To check out the latest code, execute:
+ &live-helper; is developed using the Git revision control system. On Debian systems, this is provided by the <command>git-core</command> package. To check out the latest code, execute:
</para>
<screen>
@@ -111,7 +111,7 @@
<para>Whilst &live-helper; and friends are currently not a part of Debian stable relase, they will work on &etch; as well. You will need the following programs:</para>
<orderedlist>
-<listitem><para>An <emphasis>etch</emphasis> backport of <computeroutput>cdebootstrap</computeroutput> from backports.org</para></listitem>
+<listitem><para>An <emphasis>etch</emphasis> backport of <command>cdebootstrap</command> from backports.org</para></listitem>
<listitem><para>The <emphasis>lenny</emphasis> or <emphasis>sid</emphasis> version of &live-helper;</para></listitem>
</orderedlist>
@@ -131,7 +131,7 @@ deb http://www.backports.org/debian etch-backports main
apt-get update
</screen></listitem>
-<listitem><para>Install <computeroutput>cdebootstrap</computeroutput>:</para>
+<listitem><para>Install <command>cdebootstrap</command>:</para>
<screen>
apt-get install -t etch-backports cdebootstrap
@@ -189,8 +189,8 @@ $ git clone git://git.debian.net/git/debian-live/live-initramfs.git
</listitem>
<listitem>
-<para>Build a &live-initramfs; <computeroutput>.deb</computeroutput></para>
-<para>You must build either on your target distribution or in a chroot containing your target platform: this means if your target is lenny then you should build against lenny. You can use a personal builder such as <computeroutput>pbuilder</computeroutput> to automate building packages in chroot. To build directly on the target platform, use <computeroutput>dpkg-buildpackage</computeroutput> (provided by the <computeroutput>dpkg-dev</computeroutput> package):</para>
+<para>Build a &live-initramfs; <command>.deb</command></para>
+<para>You must build either on your target distribution or in a chroot containing your target platform: this means if your target is lenny then you should build against lenny. You can use a personal builder such as <command>pbuilder</command> to automate building packages in chroot. To build directly on the target platform, use <command>dpkg-buildpackage</command> (provided by the <command>dpkg-dev</command> package):</para>
<screen>
$ cd live-initramfs
@@ -199,9 +199,9 @@ $ dpkg-buildpackage -b -uc -us
</listitem>
<listitem>
-<para>Use the generated &live-initramfs; <computeroutput>.deb</computeroutput></para>
+<para>Use the generated &live-initramfs; <command>.deb</command></para>
-<para>As &live-initramfs; is installed by the build system, installing the package in the host system is not sufficient: you should treat the generated <computeroutput>.deb</computeroutput> like another custom package. Please see <xref linkend="custom-packages"/> for more information. You should pay particular attention to <xref linkend="custom-packages-apt"/>.</para>
+<para>As &live-initramfs; is installed by the build system, installing the package in the host system is not sufficient: you should treat the generated <command>.deb</command> like another custom package. Please see <xref linkend="custom-packages"/> for more information. You should pay particular attention to <xref linkend="custom-packages-apt"/>.</para>
</listitem>
</orderedlist>
diff --git a/xml/chapters/live-environment.xml b/xml/chapters/live-environment.xml
index 6af5372..f09d1a5 100644
--- a/xml/chapters/live-environment.xml
+++ b/xml/chapters/live-environment.xml
@@ -21,7 +21,7 @@
<para>Username FIXME.</para>
<para>One important consideration is that the live user is created by &live-initramfs; during bootup, it is not created by &live-helper; when building the image.</para>
- <para>You can specify additional groups that the live user will belong to by preseeding the <computeroutput>passwd/user-default-groups</computeroutput> debconf value. For example, to add the live user to the <computeroutput>fuse</computeroutput> group, add the following to a file in the <filename class="directory">config/chroot_local-preseed</filename> directory:</para>
+ <para>You can specify additional groups that the live user will belong to by preseeding the <command>passwd/user-default-groups</command> debconf value. For example, to add the live user to the <command>fuse</command> group, add the following to a file in the <filename class="directory">config/chroot_local-preseed</filename> directory:</para>
<screen>
debconf passwd/user-default-groups string audio cdrom dialout floppy video plugdev netdev powerdev fuse
@@ -33,11 +33,11 @@
<section id="language">
<title>Language</title>
-<para>When the live system boots there are three process which concerns language: the locale generation, setting the keyboard layout for the console and setting the keyboard layout for X. To define the locale that should be generated, use the <computeroutput>locale</computeroutput> parameter to the <computeroutput>--bootappend-live</computeroutput> option of <filename>lh_config</filename>, e.g.:
+<para>When the live system boots there are three process which concerns language: the locale generation, setting the keyboard layout for the console and setting the keyboard layout for X. To define the locale that should be generated, use the <command>locale</command> parameter to the <command>--bootappend-live</command> option of <filename>lh_config</filename>, e.g.:
<screen>lh_config --bootappend-live "locale=sv_SE.utf8"</screen>
-Both the console and X keyboard configuration depends on the <computeroutput>keyb</computeroutput> parameter of the <computeroutput>--bootappend-live</computeroutput>option. Valid options for X keyboard layouts can be found in <filename>/etc/X11/xkb/base.xml</filename>. To find the value (the two characters) corresponding to a language try searching for the english name of the nation where the language is spoken, e.g:
+Both the console and X keyboard configuration depends on the <command>keyb</command> parameter of the <command>--bootappend-live</command>option. Valid options for X keyboard layouts can be found in <filename>/etc/X11/xkb/base.xml</filename>. To find the value (the two characters) corresponding to a language try searching for the english name of the nation where the language is spoken, e.g:
<screen>$ grep -i sweden -C3 /etc/X11/xkb/base.xml | grep name
<name>se<name>
@@ -65,7 +65,7 @@ To make the console keyboard use a swedish layout use
<para>A Debian Live system is a generalization of this paradigm and thus supports more media, and not only cds; but stills, in its default behaviour, it should be considered read only and all the runtime evolutions of the system are lost with a shutdown.</para>
<para>Persistence is a common name for different kinds of solutions for saving across reboots some or all of this runtime evolution of the system; to undestand how it could work it could be handy to know that even if the system is booted and runt from a read only media, modification to the files and directories are wrote on a writable media , tipically a ram disk (tmpfs) and ram disk's data do not survive reboots.</para>
-<para>The data stored on this ramdisk should be saved in a writable persistent media like on an Hard Disk, a USB key, a network "share" or even a session of a multisession (re)writable CD/DVD. All this cited media are supported in Debian Live in different ways, all but latest one requires a special boot parameter to be specified at boot: <computeroutput>persistent</computeroutput>.</para>
+<para>The data stored on this ramdisk should be saved in a writable persistent media like on an Hard Disk, a USB key, a network "share" or even a session of a multisession (re)writable CD/DVD. All this cited media are supported in Debian Live in different ways, all but latest one requires a special boot parameter to be specified at boot: <command>persistent</command>.</para>
<section><title>Full persistence</title>
<para>With "full persistence" it is meant that instead of using a tmpfs for storing modifications to the read-only media (with the copy-on-write, COW, system) a writable partition is used. In order to use this feature a partition with a clean writable supported filesystem on it labeled "live-rw" must be attached on the system at bootime and the system must be started with "persistent" boot parameter; this partition could be an ext2 partition on the hard disk or on a usb key created with, e.g.:</para>
@@ -81,16 +81,16 @@ $ dd if=/dev/zero of=live-rw bs=1024k count=1 seek=1k # for a 1G image file
# mkfs.ext2 -F live-rw
</screen>
-<para>Then copy the <computeroutput>live-rw</computeroutput> file in a writable partition and reboot with "persistent" boot parameter.</para>
+<para>Then copy the <command>live-rw</command> file in a writable partition and reboot with "persistent" boot parameter.</para>
</section>
<section><title>Home automounting</title>
-<para>If during the boot a partition (filesystem) image file or a partition labeled <computeroutput>home-rw</computeroutput> will be discovered, this filesystem will be directly mounted as <computeroutput>/home</computeroutput>, thus permitting persistence of files that belong to the e.g. default user. It can be combined with full persistence.</para>
+<para>If during the boot a partition (filesystem) image file or a partition labeled <command>home-rw</command> will be discovered, this filesystem will be directly mounted as <command>/home</command>, thus permitting persistence of files that belong to the e.g. default user. It can be combined with full persistence.</para>
</section>
<section><title>Snapshots</title>
-<para>Snapshots are collection of files and directories which are not mounted while running but which are copied from a persistent device to the system (tmpfs) at boot and which are resynced at reboot/shutdown of the system. The content of a snapshot could reside on a partition or an image file (like the above mentioned types) labeled <computeroutput>live-sn</computeroutput>, but it defaults as a simple cpio archive named <computeroutput>live-sn.cpio.gz</computeroutput>. As above at boot time, the block devices connected to the system are traversed to see it a suche named partition or file could be found. A power interruption during runtime could mean data lost hence a tool invoked <computeroutput>live-snapshot --refresh</computeroutput> could be called to sync important changes. This type of persistence since no not write continuosly to the persistent media is the most flash-based device friendly and the fastest of all the persistence systems.</para>
-<para> A /home version of snapshot exists too and its label is <computeroutput>home-sn.*</computeroutput>; it works the same as the main snapshot but it is only applied to /home.</para>
+<para>Snapshots are collection of files and directories which are not mounted while running but which are copied from a persistent device to the system (tmpfs) at boot and which are resynced at reboot/shutdown of the system. The content of a snapshot could reside on a partition or an image file (like the above mentioned types) labeled <command>live-sn</command>, but it defaults as a simple cpio archive named <command>live-sn.cpio.gz</command>. As above at boot time, the block devices connected to the system are traversed to see it a suche named partition or file could be found. A power interruption during runtime could mean data lost hence a tool invoked <command>live-snapshot --refresh</command> could be called to sync important changes. This type of persistence since no not write continuosly to the persistent media is the most flash-based device friendly and the fastest of all the persistence systems.</para>
+<para> A /home version of snapshot exists too and its label is <command>home-sn.*</command>; it works the same as the main snapshot but it is only applied to /home.</para>
<para> All kind of snapshots cannot currently handle file deleting while full persistence and obviously home automounting could.</para>
</section>
diff --git a/xml/chapters/overview.xml b/xml/chapters/overview.xml
index 769b53f..3422972 100644
--- a/xml/chapters/overview.xml
+++ b/xml/chapters/overview.xml
@@ -14,29 +14,29 @@
<para>The idea behind live-helper is a framework that uses a configuration directory to completely automate and customize all aspects of building a Live image.</para>
-<para>Many concepts are similar with the <computeroutput>debhelper</computeroutput> Debian package tools written by Joey Hess:</para>
+<para>Many concepts are similar with the <command>debhelper</command> Debian package tools written by Joey Hess:</para>
<orderedlist>
<listitem>
<para>The scripts have a central location for configuring their operation.</para>
-<para>In <computeroutput>debhelper</computeroutput>, this is the <filename class="directory">debian</filename> subdirectory of a package tree. For example, <computeroutput>dh_install</computeroutput> will look for file called <filename>debian/<packagename>.install</filename> to determine which files should exist in a particular binary package. In much the same way, &live-helper; stores its configuration entirely under a <filename class="directory">config/</filename> subdirectory.</para>
+<para>In <command>debhelper</command>, this is the <filename class="directory">debian</filename> subdirectory of a package tree. For example, <command>dh_install</command> will look for file called <filename>debian/<packagename>.install</filename> to determine which files should exist in a particular binary package. In much the same way, &live-helper; stores its configuration entirely under a <filename class="directory">config/</filename> subdirectory.</para>
</listitem>
<listitem><para>The scripts are independent - that is to say, it is always safe to run each command.</para></listitem>
</orderedlist>
-<para>Unlike <computeroutput>debhelper</computeroutput>, &live-helper; contains a tool to generate a skeleton configuration directory, <filename>lh_config</filename>. This could be considered to be similar to tools such as <computeroutput>dh-make</computeroutput>. For more information about <filename>lh_config</filename>, please see <xref linkend="lh_config"/>.</para>
+<para>Unlike <command>debhelper</command>, &live-helper; contains a tool to generate a skeleton configuration directory, <filename>lh_config</filename>. This could be considered to be similar to tools such as <command>dh-make</command>. For more information about <filename>lh_config</filename>, please see <xref linkend="lh_config"/>.</para>
-<para>Besides the common <filename>config/common</filename>, which is used by all &live-helper; commands, some additional files can be used to configure the behavior of specific helpers. These files are typically named <computeroutput>config/foo</computeroutput> or <computeroutput>config/stage</computeroutput> (where "stage", of course, is replaced with the name of the stage that they belong to, and "helper" with the name of the helper).</para>
+<para>Besides the common <filename>config/common</filename>, which is used by all &live-helper; commands, some additional files can be used to configure the behavior of specific helpers. These files are typically named <command>config/foo</command> or <command>config/stage</command> (where "stage", of course, is replaced with the name of the stage that they belong to, and "helper" with the name of the helper).</para>
-<para>For example, <computeroutput>lh_bootstrap_debootstrap</computeroutput> uses files named <filename>config/bootstrap</filename> and <filename>config/bootstrap_debootstrap</filename> to read the options it will use. Generally, these files contain variables with values assigned, one variable per line. Some programs in &live-helper; use pairs of values or slightly more complicated variable assignments.</para>
+<para>For example, <command>lh_bootstrap_debootstrap</command> uses files named <filename>config/bootstrap</filename> and <filename>config/bootstrap_debootstrap</filename> to read the options it will use. Generally, these files contain variables with values assigned, one variable per line. Some programs in &live-helper; use pairs of values or slightly more complicated variable assignments.</para>
<para>&live-helper; respects 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 is thus unset), &live-helper; will automatically set it to a default value.</para>
<para>All config files are shell scripts which are sourced by a live-helper program. That means they have to follow the normal shell syntax. You can also put comments in these files; lines beginning with "#" are ignored.</para>
-<para>In some rare cases, you may want to have different versions of these files for different architectures or distributions. If files named <computeroutput>config/stage.arch</computeroutput> or <computeroutput>config/stage_helper.arch</computeroutput>, and <computeroutput>config/stage.dist</computeroutput> or <computeroutput>config/stage_helper.dist</computeroutput> exist (where "arch" is the same as the output of <computeroutput>dpkg --print-architecture</computeroutput> and "dist" is the same as the codename of the target distribution), then they will be used in preference to the other, more general files.</para>
+<para>In some rare cases, you may want to have different versions of these files for different architectures or distributions. If files named <command>config/stage.arch</command> or <command>config/stage_helper.arch</command>, and <command>config/stage.dist</command> or <command>config/stage_helper.dist</command> exist (where "arch" is the same as the output of <command>dpkg --print-architecture</command> and "dist" is the same as the codename of the target distribution), then they will be used in preference to the other, more general files.</para>
<para>Please see <xref linkend="installation"/> for information on how to install &live-helper;.
@@ -58,9 +58,9 @@
<section id="lh_config">
<title>The <filename>lh_config</filename> helper</title>
-<para>As discussed in <xref linkend="live-helper"/>, the scripts that make up &live-helper; source their configuration from a single directory named <computeroutput>config/</computeroutput>. As constructing this directory by hand would be time-consuming and error-prone, the <filename>lh_config</filename> helper can be used to create skeleton configuration folders.</para>
+<para>As discussed in <xref linkend="live-helper"/>, the scripts that make up &live-helper; source their configuration from a single directory named <command>config/</command>. As constructing this directory by hand would be time-consuming and error-prone, the <filename>lh_config</filename> helper can be used to create skeleton configuration folders.</para>
-<para>Issuing <filename>lh_config</filename> without any arguments creates a <computeroutput>config</computeroutput> subdirectory which it populates with some default settings:</para>
+<para>Issuing <filename>lh_config</filename> without any arguments creates a <command>config</command> subdirectory which it populates with some default settings:</para>
<screen>
$ lh_config
$ ls -l
@@ -100,13 +100,13 @@ drwxr-xr-x 2 user group 4.1k 2008-05-09 21:37 templates
$ lh_config -p gnome
</screen>
-<para>will build a <filename class="directory">config/</filename> directory configured to include the '<computeroutput>gnome</computeroutput>' package list. It is possible to specify many options:</para>
+<para>will build a <filename class="directory">config/</filename> directory configured to include the '<command>gnome</command>' package list. It is possible to specify many options:</para>
<screen>
$ lh_config --apt aptitude --binary-images net --hostname live-machine --username live-user ...
</screen>
-<para>A full list of options is available FIXME. Most options have a parallel with an "<computeroutput>LH_</computeroutput>" prefixed variable.</para>
+<para>A full list of options is available FIXME. Most options have a parallel with an "<command>LH_</command>" prefixed variable.</para>
</section>
diff --git a/xml/chapters/reporting-bugs.xml b/xml/chapters/reporting-bugs.xml
index 2480607..e703a5f 100644
--- a/xml/chapters/reporting-bugs.xml
+++ b/xml/chapters/reporting-bugs.xml
@@ -81,9 +81,9 @@ encountered.</para>
<varlistentry><term>At build time whilst bootstrapping</term>
<listitem><para>
-<para>&live-helper; first bootstraps a basic Debian system with <computeroutput>debootstrap</computeroutput> or <computeroutput>cdebootstrap</computeroutput>. Depending on the bootstrapping tool used and the Debian distribution it is bootstrapping, it may fail. If a bug appears here, check if the error is related to a specific Debian package (most likely), or if it is related to cdebootstrap itself.</para>
+<para>&live-helper; first bootstraps a basic Debian system with <command>debootstrap</command> or <command>cdebootstrap</command>. Depending on the bootstrapping tool used and the Debian distribution it is bootstrapping, it may fail. If a bug appears here, check if the error is related to a specific Debian package (most likely), or if it is related to cdebootstrap itself.</para>
-<para>In both cases, this is not a bug in Debian Live, but rather in Debian itself which we can not fix this directly. Please report such a bug against <computeroutput>debootstrap</computeroutput>, <computeroutput>cdebootstrap</computeroutput> or the failing package.</para>
+<para>In both cases, this is not a bug in Debian Live, but rather in Debian itself which we can not fix this directly. Please report such a bug against <command>debootstrap</command>, <command>cdebootstrap</command> or the failing package.</para>
</para></listitem>
</varlistentry>
@@ -91,7 +91,7 @@ encountered.</para>
<listitem><para>&live-helper; installs additional packages from the Debian archive and depending on the Debian distribution used and the daily archive state, it can fail. If a bug appears here, check if the error is also reproducible on a normal system.</para>
-<para>If this is the case, this is not a bug in Debian Live, but rather in Debian - please report it against the failing package. Running <filename>debootstrap</filename> seperately from the Live system build or running <filename>lh_bootstrap</filename> with <computeroutput>--debug</computeroutput> will give you more information.</para>
+<para>If this is the case, this is not a bug in Debian Live, but rather in Debian - please report it against the failing package. Running <filename>debootstrap</filename> seperately from the Live system build or running <filename>lh_bootstrap</filename> with <command>--debug</command> will give you more information.</para>
<para>Also, if you are using a local mirror and/or any of sort of proxy and you are experiencing a problem, please always reproduce it first by bootstrapping from an official mirror.</para>
@@ -130,7 +130,7 @@ encountered.</para>
<section id="where">
<title>Where to report bugs</title>
-<para>The Debian Live project keeps track of all bugs in the Debian Bug Tracking System (BTS). For information on how to use the system, please see <ulink url="http://bugs.debian.org">http://bugs.debian.org</ulink>. You can also submit the bugs by using the <computeroutput>reportbug</computeroutput> command from the package with the same name.</para>
+<para>The Debian Live project keeps track of all bugs in the Debian Bug Tracking System (BTS). For information on how to use the system, please see <ulink url="http://bugs.debian.org">http://bugs.debian.org</ulink>. You can also submit the bugs by using the <command>reportbug</command> command from the package with the same name.</para>
<para>In general, you should report build time errors against the <ulink url="http://bugs.debian.org/cgi-bin/pkgreport.cgi?src=live-helper">live-helper</ulink> package and run time errors against <ulink url="http://bugs.debian.org/cgi-bin/pkgreport.cgi?src=live-helper">live-initramfs</ulink>. If you are unsure of which package is appropriate or need more help before submitting a bug report, please send a message to the mailing list and we will help you to figure it out.</para>
--
Debian Live manual
More information about the debian-live-changes
mailing list