1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 | ]>
|
---|
7 |
|
---|
8 | <sect1 id="conventions">
|
---|
9 | <?dbhtml filename="conventions.html"?>
|
---|
10 |
|
---|
11 | <sect1info>
|
---|
12 | <othername>$LastChangedBy$</othername>
|
---|
13 | <date>$Date$</date>
|
---|
14 | </sect1info>
|
---|
15 |
|
---|
16 | <title>Conventions Used in this Book</title>
|
---|
17 |
|
---|
18 | <para>To make things easy to follow, there are a number of conventions used
|
---|
19 | throughout the book. Following are some examples:</para>
|
---|
20 |
|
---|
21 | <screen><userinput>./configure --prefix=/usr</userinput></screen>
|
---|
22 |
|
---|
23 | <blockquote>
|
---|
24 | <para>This form of text is designed to be typed exactly as seen unless
|
---|
25 | otherwise noted in the surrounding text. It is also used to identify
|
---|
26 | references to specific commands.</para>
|
---|
27 | </blockquote>
|
---|
28 |
|
---|
29 | <screen><computeroutput>install-info: unknown option
|
---|
30 | `--dir-file=/mnt/lfs/usr/info/dir'</computeroutput></screen>
|
---|
31 |
|
---|
32 | <blockquote>
|
---|
33 | <para>This form of text (fixed width text) is showing screen
|
---|
34 | output, probably a result from issuing a command. It is also used to
|
---|
35 | show filenames such as <filename>/boot/grub/grub.conf</filename></para>
|
---|
36 | </blockquote>
|
---|
37 |
|
---|
38 | <para><emphasis>Emphasis</emphasis></para>
|
---|
39 |
|
---|
40 | <blockquote>
|
---|
41 | <para>This form of text is used for several purposes in the
|
---|
42 | book but mainly to emphasize important points or to give examples as to
|
---|
43 | what to type.</para>
|
---|
44 | </blockquote>
|
---|
45 |
|
---|
46 | <para><ulink url="http://www.&lfs-domainname;/"/></para>
|
---|
47 |
|
---|
48 | <blockquote>
|
---|
49 | <para>This form of text is used for hypertext links external to
|
---|
50 | the book such as HowTos, download locations, websites, etc.</para>
|
---|
51 | </blockquote>
|
---|
52 |
|
---|
53 | <para><xref linkend="seamonkey"/></para>
|
---|
54 |
|
---|
55 | <blockquote>
|
---|
56 | <para>This form of text is used for links internal to
|
---|
57 | the book such as another section describing a different package.</para>
|
---|
58 | </blockquote>
|
---|
59 |
|
---|
60 | <screen><userinput>cat > $LFS/etc/group << "EOF"
|
---|
61 | <literal>root:x:0:
|
---|
62 | bin:x:1:
|
---|
63 | ......</literal>
|
---|
64 | EOF</userinput></screen>
|
---|
65 |
|
---|
66 | <blockquote>
|
---|
67 | <para>This type of section is used mainly when creating configuration
|
---|
68 | files. The first command (in bold) tells the system to create
|
---|
69 | the file <filename>$LFS/etc/group</filename> from whatever is typed on the
|
---|
70 | following lines until the sequence EOF is encountered.
|
---|
71 | Therefore, this whole section is generally typed as seen.</para>
|
---|
72 | </blockquote>
|
---|
73 |
|
---|
74 | <para><replaceable><REPLACED TEXT></replaceable></para>
|
---|
75 |
|
---|
76 | <blockquote>
|
---|
77 | <para>This form of text is used to encapsulate text that should be
|
---|
78 | modified and is not to be typed as seen, or copy and pasted. Note that
|
---|
79 | the square brackets are not part of the text, but should be substituted
|
---|
80 | for as well.</para>
|
---|
81 | </blockquote>
|
---|
82 |
|
---|
83 | <para><systemitem class='username'>root</systemitem></para>
|
---|
84 |
|
---|
85 | <blockquote>
|
---|
86 | <para>This form of text is used to show a specific system user or group
|
---|
87 | reference in the instructions.</para>
|
---|
88 | </blockquote>
|
---|
89 |
|
---|
90 | </sect1>
|
---|