[SCM] Debian Live manual branch, master, updated. 358134c215b0038d19b6f4f1dbba2be340d7faf7

Chris Lamb chris at chris-lamb.co.uk
Thu Aug 7 14:02:17 UTC 2008


The following commit has been merged in the master branch:
commit 358134c215b0038d19b6f4f1dbba2be340d7faf7
Author: Frederic Daniel Luc Lehobey <Frederic at Lehobey.net>
Date:   Thu Aug 7 04:33:47 2008 +0200

    * Correction of typos * According to meta.xml, the character user for root is '#' (and not '%') and '$' for user commands. Fixed several mismatches.

diff --git a/chapters/about.xml b/chapters/about.xml
index d52965f..3ce9426 100644
--- a/chapters/about.xml
+++ b/chapters/about.xml
@@ -58,7 +58,7 @@
 </para>
 
 <para>
- Exception: temporarly, our own packages like live-helper or live-initramfs may be used from our own repository for development reasons (e.g. to create development snapshots). They will be synced into Debian on a regular basis.
+ Exception: temporarily, our own packages like live-helper or live-initramfs may be used from our own repository for development reasons (e.g. to create development snapshots). They will be synced into Debian on a regular basis.
 </para>
 </section>
 
@@ -82,13 +82,13 @@
 </section>
 
 <section>
-<title>No live system to hardisk installer</title>
+<title>No live system to hard disk installer</title>
 <para>
  [ this is no longer valid after etch release, we will work on an installer for lenny ]
 </para>
 
 <para>
- For the moment we will not ship a installer to copy the live system to a partition on the hardisk. Although we keep the changes in the live system as drastically minimal as possible compared to a regular Debian installation, the live system does differ in a few essential points (see exceptions, guideline 2).
+ For the moment we will not ship an installer to copy the live system to a partition on the hard disk. Although we keep the changes in the live system as drastically minimal as possible compared to a regular Debian installation, the live system does differ in a few essential points (see exceptions, guideline 2).
 </para>
 
 <para>
diff --git a/chapters/basics.xml b/chapters/basics.xml
index ca60fb0..27fbf0a 100644
--- a/chapters/basics.xml
+++ b/chapters/basics.xml
@@ -112,7 +112,7 @@ $ qemu -hda binary.img
 </section>
 
 <section>
-<title>Building an netboot image</title>
+<title>Building a netboot image</title>
 
 <para>
  First, we configure our Live system:
diff --git a/chapters/common-tasks.xml b/chapters/common-tasks.xml
index 428ab6f..29aaf3e 100644
--- a/chapters/common-tasks.xml
+++ b/chapters/common-tasks.xml
@@ -9,7 +9,7 @@
 <section id="debian-installer">
 <title>The Debian Installer</title>
  <para>
-  Although Debian Live is mostly concerned with avoiding permanent nstallation, integrating some form of installer to your image is possible. There are number of different "types" of installation, varying in what and how the install the image.
+  Although Debian Live is mostly concerned with avoiding permanent installation, integrating some form of installer to your image is possible. There are number of different "types" of installation, varying in what and how to install the image.
  </para>
  <note>
   <title>
diff --git a/chapters/customisation-binary.xml b/chapters/customisation-binary.xml
index 40876df..c7474b9 100644
--- a/chapters/customisation-binary.xml
+++ b/chapters/customisation-binary.xml
@@ -6,7 +6,7 @@
 <chapter id="binary">
 <title>Customising the binary image</title>
 
-<para>This chapter discusses FIXME></para>
+<para>This chapter discusses FIXME</para>
 
 <section id="iso-metadata">
  <title>ISO metadata</title>
@@ -27,7 +27,7 @@
   <term><computeroutput>LH_ISO_PREPARER</computeroutput> / <computeroutput>--iso-preparer <replaceable>NAME</replaceable></computeroutput></term>
   <listitem>
    <para>
-    This should describe the preparer of the image, usually with some contect 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.
+    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.
    </para>
   </listitem>
  </varlistentry>
diff --git a/chapters/customisation-bootup.xml b/chapters/customisation-bootup.xml
index 73fa5ed..9e30a1f 100644
--- a/chapters/customisation-bootup.xml
+++ b/chapters/customisation-bootup.xml
@@ -29,7 +29,7 @@
 
 <section id="syslinux">
 <title>Syslinux</title>
- <para>In the default configuration, Syslinux will pause indefinitely at its splash screen. To adjust ths, 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 <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>
 
 <section>
diff --git a/chapters/customisation-contents.xml b/chapters/customisation-contents.xml
index ce933df..8902295 100644
--- a/chapters/customisation-contents.xml
+++ b/chapters/customisation-contents.xml
@@ -61,8 +61,8 @@
  </para>
 
  <screen>
-  % mkdir -p config/lh_chroot_local-includes/var/www
-  % cp /path/to/my/index.html config/lh_chroot_local-includes/var/www
+  $ mkdir -p config/lh_chroot_local-includes/var/www
+  $ cp /path/to/my/index.html config/lh_chroot_local-includes/var/www
  </screen>
 
  <para>
diff --git a/chapters/customisation-packages.xml b/chapters/customisation-packages.xml
index 61b9bce..af0efa5 100644
--- a/chapters/customisation-packages.xml
+++ b/chapters/customisation-packages.xml
@@ -84,7 +84,7 @@ LH_PACKAGES="package1 package2 package3 ... "
 </para>
 
 <screen>
-% lh_config --packages "package1 package2 package3"
+$ lh_config --packages "package1 package2 package3"
 </screen>
 
 <para>The behaviour of &live-helper; when specifying a package that does not exist is determined by your choice of APT utility. See <xref linkend="package-installation"/> for more details.</para>
diff --git a/chapters/installation.xml b/chapters/installation.xml
index 89fd0e1..8e41190 100644
--- a/chapters/installation.xml
+++ b/chapters/installation.xml
@@ -48,7 +48,7 @@
 </para>
 
 <screen>
- % apt-get install live-helper
+ # apt-get install live-helper
 </screen>
 
 <para>
@@ -56,7 +56,7 @@
 </para>
 
 <screen>
- % aptitude install live-helper
+ # aptitude install live-helper
 </screen>
 
 </section>
@@ -69,7 +69,7 @@
 </para>
 
 <screen>
- % git clone git://git.debian.net/git/live-helper.git
+ $ git clone git://git.debian.net/git/live-helper.git
 </screen>
 
 <para>
@@ -77,16 +77,16 @@
 </para>
 
 <screen>
- % cd live-helper
- % dpkg-buildpackage -uc -us -rfakeroot
- % cd ..
- $ dpkg -i live-helper*.deb
+ $ cd live-helper
+ $ dpkg-buildpackage -uc -us -rfakeroot
+ $ cd ..
+ # dpkg -i live-helper*.deb
 </screen>
 
  <para>Since &live-helper; version 1.0~a38-1, you can use local version of &live-helper; without installation:</para>
 
 <screen>
- % live-helper/helpers/lh_local
+ # live-helper/helpers/lh_local
 </screen>
 
 <para>
@@ -96,7 +96,7 @@
  <para>You can also install &live-helper; directly to your system by executing:</para>
 
 <screen>
- $ make install
+ # make install
 </screen>
 </section>
 
@@ -145,17 +145,22 @@ apt-get install -t etch-backports cdebootstrap
 
 <para>It is not recommended that you use &live-helper; from backports.org as it is likely to be out of date.
 
-The live-helper package from Lenny or Sid can be installed on Etch (without upgrading other packages, such as libc6; it's just shell scripts).
+The live-helper package from Lenny or Sid can be installed on Etch (without upgrading other packages, such as libc6; it's just shell scripts).</para>
 
-1. install cdebootstrap from backports.org (as indicated above)
-
-apt-get install -t etch-backports cdebootstrap
+<orderedlist>
+<listitem><para>install cdebootstrap from backports.org (as indicated above)</para>
 
-2. install live-helper from testing or unstable
+<screen>
+# apt-get install -t etch-backports cdebootstrap
+</screen></listitem>
 
-apt-get install -t unstable live-helper
+<listitem><para>install live-helper from testing or unstable</para>
 
-Of course you need the testing or unstable sources in /etc/apt/sources.list for this.</para>
+<screen>
+# apt-get install -t unstable live-helper
+</screen></listitem>
+</orderedlist>
+<para>Of course you need the testing or unstable sources in /etc/apt/sources.list for this.</para>
 
 </section>
 </section>
diff --git a/chapters/meta.xml b/chapters/meta.xml
index 8a31ef2..92562e7 100644
--- a/chapters/meta.xml
+++ b/chapters/meta.xml
@@ -7,9 +7,9 @@
 <title>About this manual</title>
 
 <para>
-The main goal of this manul 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>
+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 the rootuser 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 <computeroutput>$</computeroutput> or <computeroutput>#</computeroutput> respectively. This symbol is not a part of the command.</para>
 
 <section id="terms">
 <title>Terms</title>
@@ -99,7 +99,7 @@ The main goal of this manul is to serve as a single access point to all document
 <para>The sources for this manual are maintained using the Git version control system. You can checkout the latest copy by executing:</para>
 
 <screen>
-% git clone git://git.debian.org/git/debian-live/live-manual.git
+$ git clone git://git.debian.org/git/debian-live/live-manual.git
 </screen>
 
 </section>
diff --git a/chapters/overview.xml b/chapters/overview.xml
index a182f5b..70809be 100644
--- a/chapters/overview.xml
+++ b/chapters/overview.xml
@@ -22,7 +22,7 @@
 <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/&lt;packagename&gt;.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 indepodent - that is to say, it is always safe to run each command.</para></listitem>
+<listitem><para>The scripts are independent - that is to say, it is always safe to run each command.</para></listitem>
 
 </orderedlist>
 
@@ -62,11 +62,11 @@
 
 <para>Issuing <filename>lh_config</filename> without any arguments creates a <computeroutput>config</computeroutput> subdirectory which it populates with some default settings:</para>
 <screen>
-% lh_config
-% ls -l
+$ lh_config
+$ ls -l
 total 4.1k
 drwxr-xr-x 19 user group 4.1k 2008-05-09 21:37 config
-% ls -l config/
+$ ls -l config/
 total 91k
 -rw-r--r-- 1 user group 4.0k 2008-05-09 21:37 binary
 drwxr-xr-x 2 user group 4.1k 2008-05-09 21:37 binary_debian-installer
@@ -97,13 +97,13 @@ drwxr-xr-x 2 user group 4.1k 2008-05-09 21:37 templates
 <para>You can ask <filename>lh_config</filename> to generate <filename class="directory">config/</filename> directory "preseeded" with various options. This might be suitable if you do not require the default settings but do not need to change a large number of options. For example:</para>
 
 <screen>
-% lh_config -p gnome
+$ 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>
 
 <screen>
-% lh_config --apt aptitude --binary-images net --hostname live-machine --username live-user ...
+$ 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>
diff --git a/chapters/reporting-bugs.xml b/chapters/reporting-bugs.xml
index 0801015..1181af9 100644
--- a/chapters/reporting-bugs.xml
+++ b/chapters/reporting-bugs.xml
@@ -59,7 +59,7 @@ information:</para>
 </para>
 
 <screen>
- % lh_build 2>&amp;1 | tee buildlog.txt
+ # lh_build 2>&amp;1 | tee buildlog.txt
 </screen>
 
 <para>Additionally, to rule out other errors, it is always a good idea to tar up

-- 
Debian Live manual



More information about the debian-live-changes mailing list