From 797e544a4d50bd71fd4b9340bcc881485586cfcc Mon Sep 17 00:00:00 2001
From: Gerard Beekmans <gerard@linuxfromscratch.org>
Date: Fri, 29 Jun 2001 13:59:37 +0000
Subject: Initial commit

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@728 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
---
 chapter01/conventions.xml | 66 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 chapter01/conventions.xml

(limited to 'chapter01/conventions.xml')

diff --git a/chapter01/conventions.xml b/chapter01/conventions.xml
new file mode 100644
index 000000000..e4a1e2404
--- /dev/null
+++ b/chapter01/conventions.xml
@@ -0,0 +1,66 @@
+<sect1 id="ch01-conventions">
+<title>Conventions used in this book</title>
+
+<para>
+To make things easy to follow, there are a number of conventions used
+throughout the book.  Following are some examples:
+</para>
+
+<para>
+<userinput>./configure --prefix=/usr</userinput>
+</para>
+
+<blockquote><para>
+This form of text is designed to be typed exactly as seen unless otherwise
+noted in the surrounding text.  It is also used in the explanation sections to
+identify which of the commands is being referred to.
+</para></blockquote>
+
+<para>
+<filename>
+install-info: unknown option `--dir-file=/mnt/lfs/usr/info/dir'
+</filename>
+</para>
+
+<blockquote><para>
+This form of text (fixed width text) is showing screen output, probably as the
+result of commands issued and is also used to show filenames such as
+<filename>/etc/lilo.conf</filename>
+</para></blockquote>
+
+<para>
+<emphasis>Emphasis</emphasis>
+</para>
+
+<blockquote><para>
+This form of text is used for several purposes in the book but mainly to
+emphasise important points or to give examples as to what to type.
+</para></blockquote>
+
+<para>
+<ulink url="http://www.linuxfromscratch.org/">
+http://www.linuxfromscratch.org/</ulink>
+</para>
+
+<blockquote><para>
+This form of text is used for hyperlinks, both within the book and to external
+pages such as HowTo's,download locations and websites etc. 
+</para></blockquote>
+
+<literallayout>
+<userinput>cat &gt; $LFS/etc/group &lt;&lt; "EOF"</userinput>
+	root:x:0:
+	bin:x:1:
+	......
+<userinput>EOF</userinput>
+</literallayout>
+
+<blockquote><para>
+This type of section is used mainly when creating configuration files.  The
+first command (in bold) tells the system to create the file $LFS/etc/group from
+whatever is typed on the following lines until the sequence EOF is encountered.
+Therefore, this whole section is generally typed as seen.
+</para></blockquote>
+
+</sect1>
+
-- 
cgit v1.2.3-54-g00ecf