| 1 | <sect1 id="intro-welcome-conventions">
|
|---|
| 2 | <?dbhtml filename="conventions.html"?>
|
|---|
| 3 | <title>Conventions used in this book</title>
|
|---|
| 4 |
|
|---|
| 5 | <para>To make things easy to follow, there are a number of conventions used
|
|---|
| 6 | throughout the book. Following are some examples:</para>
|
|---|
| 7 |
|
|---|
| 8 | <screen><command>./configure --prefix=/usr</command></screen>
|
|---|
| 9 |
|
|---|
| 10 | <blockquote><para>This form of text is designed to be typed exactly
|
|---|
| 11 | as seen unless otherwise noted in the surrounding text. It is also used
|
|---|
| 12 | in the explanation sections to identify which of the commands is being
|
|---|
| 13 | referred to.</para></blockquote>
|
|---|
| 14 |
|
|---|
| 15 | <para><filename>install-info: unknown option
|
|---|
| 16 | `--dir-file=/mnt/lfs/usr/info/dir'</filename></para>
|
|---|
| 17 |
|
|---|
| 18 | <blockquote><para>This form of text (fixed width text) is showing screen
|
|---|
| 19 | output, probably as the result of commands issued and is also used to
|
|---|
| 20 | show filenames such as <filename>/etc/lilo.conf</filename></para></blockquote>
|
|---|
| 21 |
|
|---|
| 22 | <para><emphasis>Emphasis</emphasis></para>
|
|---|
| 23 |
|
|---|
| 24 | <blockquote><para>This form of text is used for several purposes in the
|
|---|
| 25 | book but mainly to emphasize important points or to give examples as to
|
|---|
| 26 | what to type.</para></blockquote>
|
|---|
| 27 |
|
|---|
| 28 | <para><ulink url="http://www.linuxfromscratch.org/">http://www.linuxfromscratch.org/</ulink></para>
|
|---|
| 29 |
|
|---|
| 30 | <blockquote><para>This form of text is used for hypertext links, both within
|
|---|
| 31 | the book and to external pages such as HowTo's, download locations,
|
|---|
| 32 | websites, etc.</para></blockquote>
|
|---|
| 33 |
|
|---|
| 34 | <screen><userinput><command>cat > $LFS/etc/group << "EOF"</command>
|
|---|
| 35 | root:x:0:
|
|---|
| 36 | bin:x:1:
|
|---|
| 37 | ......
|
|---|
| 38 | <command>EOF</command></userinput></screen>
|
|---|
| 39 |
|
|---|
| 40 | <blockquote><para>This type of section is used mainly when creating
|
|---|
| 41 | configuration files. The first command (in bold) tells the system to create
|
|---|
| 42 | the file <filename>$LFS/etc/group</filename> from whatever is typed on the
|
|---|
| 43 | following lines until the sequence <acronym>EOF</acronym> is encountered.
|
|---|
| 44 | Therefore, this whole section is generally typed as seen.</para></blockquote>
|
|---|
| 45 |
|
|---|
| 46 | <para><replaceable>[REPLACED TEXT]</replaceable></para>
|
|---|
| 47 |
|
|---|
| 48 | <blockquote><para>This form of text is used to encapsulate text that is
|
|---|
| 49 | not to be typed as seen or copy and pasted.</para></blockquote>
|
|---|
| 50 |
|
|---|
| 51 | </sect1>
|
|---|
