[4122007] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[4122007] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 | ]>
|
---|
| 7 |
|
---|
[4afc2603] | 8 | <sect1 id="conventions">
|
---|
[2d817d3] | 9 | <?dbhtml filename="conventions.html"?>
|
---|
[f45b1953] | 10 |
|
---|
[2d817d3] | 11 | <sect1info>
|
---|
| 12 | <othername>$LastChangedBy$</othername>
|
---|
| 13 | <date>$Date$</date>
|
---|
| 14 | </sect1info>
|
---|
[f45b1953] | 15 |
|
---|
[8149a43] | 16 | <title>Conventions Used in this Book</title>
|
---|
[f45b1953] | 17 |
|
---|
[89e6d61] | 18 | <sect2>
|
---|
| 19 | <title>Typographical Conventions</title>
|
---|
[2d817d3] | 20 | <para>To make things easy to follow, there are a number of conventions used
|
---|
| 21 | throughout the book. Following are some examples:</para>
|
---|
[f45b1953] | 22 |
|
---|
[2d817d3] | 23 | <screen><userinput>./configure --prefix=/usr</userinput></screen>
|
---|
[f45b1953] | 24 |
|
---|
[2d817d3] | 25 | <blockquote>
|
---|
[8aefeb67] | 26 | <para>This form of text is designed to be typed exactly as seen unless
|
---|
| 27 | otherwise noted in the surrounding text. It is also used to identify
|
---|
| 28 | references to specific commands.</para>
|
---|
[2d817d3] | 29 | </blockquote>
|
---|
[f45b1953] | 30 |
|
---|
[a71ee9cb] | 31 | <screen><computeroutput>install-info: unknown option
|
---|
[2d817d3] | 32 | `--dir-file=/mnt/lfs/usr/info/dir'</computeroutput></screen>
|
---|
[f45b1953] | 33 |
|
---|
[2d817d3] | 34 | <blockquote>
|
---|
[a71ee9cb] | 35 | <para>This form of text (fixed width text) is showing screen
|
---|
[4afc2603] | 36 | output, probably a result from issuing a command. It is also used to
|
---|
[2d817d3] | 37 | show filenames such as <filename>/boot/grub/grub.conf</filename></para>
|
---|
| 38 | </blockquote>
|
---|
[f45b1953] | 39 |
|
---|
[2d817d3] | 40 | <para><emphasis>Emphasis</emphasis></para>
|
---|
[f45b1953] | 41 |
|
---|
[2d817d3] | 42 | <blockquote>
|
---|
[a71ee9cb] | 43 | <para>This form of text is used for several purposes in the
|
---|
| 44 | book but mainly to emphasize important points or to give examples as to
|
---|
[2d817d3] | 45 | what to type.</para>
|
---|
| 46 | </blockquote>
|
---|
[f45b1953] | 47 |
|
---|
[4e88613] | 48 | <para><ulink url="http://www.&lfs-domainname;/"/></para>
|
---|
[f45b1953] | 49 |
|
---|
[2d817d3] | 50 | <blockquote>
|
---|
[6d3d9b3] | 51 | <para>This form of text is used for hypertext links external to
|
---|
[4afc2603] | 52 | the book such as HowTos, download locations, websites, etc.</para>
|
---|
[6d3d9b3] | 53 | </blockquote>
|
---|
| 54 |
|
---|
[b5eb704] | 55 | <para><xref linkend="seamonkey"/></para>
|
---|
[bccbdaea] | 56 |
|
---|
[6d3d9b3] | 57 | <blockquote>
|
---|
| 58 | <para>This form of text is used for links internal to
|
---|
| 59 | the book such as another section describing a different package.</para>
|
---|
[2d817d3] | 60 | </blockquote>
|
---|
[f45b1953] | 61 |
|
---|
[2d817d3] | 62 | <screen><userinput>cat > $LFS/etc/group << "EOF"
|
---|
| 63 | <literal>root:x:0:
|
---|
| 64 | bin:x:1:
|
---|
| 65 | ......</literal>
|
---|
| 66 | EOF</userinput></screen>
|
---|
[aa15d3e] | 67 |
|
---|
[2d817d3] | 68 | <blockquote>
|
---|
[8aefeb67] | 69 | <para>This type of section is used mainly when creating configuration
|
---|
| 70 | files. The first command (in bold) tells the system to create
|
---|
[a71ee9cb] | 71 | the file <filename>$LFS/etc/group</filename> from whatever is typed on the
|
---|
| 72 | following lines until the sequence EOF is encountered.
|
---|
[2d817d3] | 73 | Therefore, this whole section is generally typed as seen.</para>
|
---|
| 74 | </blockquote>
|
---|
| 75 |
|
---|
[57b11363] | 76 | <para><replaceable><REPLACED TEXT></replaceable></para>
|
---|
[2d817d3] | 77 |
|
---|
| 78 | <blockquote>
|
---|
| 79 | <para>This form of text is used to encapsulate text that should be
|
---|
[8aefeb67] | 80 | modified and is not to be typed as seen, or copy and pasted. Note that
|
---|
| 81 | the square brackets are not part of the text, but should be substituted
|
---|
| 82 | for as well.</para>
|
---|
| 83 | </blockquote>
|
---|
| 84 |
|
---|
| 85 | <para><systemitem class='username'>root</systemitem></para>
|
---|
| 86 |
|
---|
| 87 | <blockquote>
|
---|
[4afc2603] | 88 | <para>This form of text is used to show a specific system user or group
|
---|
| 89 | reference in the instructions.</para>
|
---|
[2d817d3] | 90 | </blockquote>
|
---|
[f45b1953] | 91 |
|
---|
[89e6d61] | 92 | </sect2>
|
---|
| 93 |
|
---|
| 94 | <sect2>
|
---|
| 95 | <title>Conventions Used for Package Dependencies</title>
|
---|
| 96 |
|
---|
| 97 | <para>When packages are created, the authors depend on prior work. In
|
---|
| 98 | order to build a package in BLFS, these dependencies must be built prior to
|
---|
| 99 | the desired package. For each package, any prerequsite packages are listed
|
---|
| 100 | in one or more separate sections: Required, Recommended, and Optional.</para>
|
---|
| 101 |
|
---|
| 102 | <bridgehead renderas="sect3">Required Dependencies</bridgehead>
|
---|
| 103 |
|
---|
| 104 | <para>These dependencies are the minimum prerequsite packages required to
|
---|
| 105 | build the package. Omitted from the list are packages in LFS and required
|
---|
| 106 | dependencies of other required packages.</para>
|
---|
| 107 |
|
---|
| 108 | <bridgehead renderas="sect3">Recommended Dependencies</bridgehead>
|
---|
| 109 |
|
---|
| 110 | <para>These dependencies are those that the BLFS editors have determined
|
---|
[a772d7e1] | 111 | are important to give the package reasonable capabilities. Package
|
---|
[89e6d61] | 112 | installation instructions assume thay are installed. If a recommended
|
---|
| 113 | package is not desired, the instructions may need to be modified to
|
---|
[a772d7e1] | 114 | accommodate the missing package.</para>
|
---|
[89e6d61] | 115 |
|
---|
| 116 | <bridgehead renderas="sect3">Optional Dependencies</bridgehead>
|
---|
| 117 |
|
---|
| 118 | <para>These dependencies are those that the package may use. Integration
|
---|
| 119 | of optional dependencies may be automatic by the package or may need
|
---|
| 120 | additional instructions not presented by BLFS. Optional packages may be
|
---|
| 121 | listed without corresponding BLFS instructions. In this case it is up to
|
---|
| 122 | the user to determine appropriate installation instructions. </para>
|
---|
| 123 |
|
---|
| 124 | </sect2>
|
---|
| 125 |
|
---|
[bfa21f3] | 126 | <sect2>
|
---|
[340080b] | 127 | <title>Conventions Used for Kernel Configuration Options</title>
|
---|
| 128 |
|
---|
| 129 | <para>Some packages have specific needs regarding the kernel configuration.
|
---|
| 130 | The general layout is the following:</para>
|
---|
| 131 |
|
---|
| 132 | <screen><literal>Master section --->
|
---|
| 133 | Subsection --->
|
---|
| 134 | [*] Required parameter [CONFIG_REQU_PAR]
|
---|
| 135 | <*> Required parameter (not as module) [CONFIG_REQU_PAR_NMOD]
|
---|
| 136 | <*/M> Required parameter (could be a module) [CONFIG_REQU_PAR_MOD]
|
---|
| 137 | <*/M/ > Optional parameter [CONFIG_OPT_PAR]
|
---|
| 138 | [ ] Incompatible parameter [CONFIG_INCOMP_PAR]
|
---|
| 139 | < > Incompatible parameter (even as module) [CONFIG_INCOMP_PAR_MOD]</literal></screen>
|
---|
| 140 |
|
---|
| 141 | <para>[CONFIG_...] on the right gives the name of the option, so you can
|
---|
| 142 | easily check whether it is set in your <filename>config</filename> file.
|
---|
| 143 | The meaning of the various entries is:
|
---|
| 144 |
|
---|
| 145 | <blockquote>
|
---|
| 146 | <informaltable frame='none'><tgroup cols="2">
|
---|
| 147 | <colspec align="left"/><colspec align="left"/><tbody>
|
---|
| 148 | <row>
|
---|
| 149 | <entry><emphasis role="bold">Master section</emphasis></entry>
|
---|
| 150 | <entry>top level menu item</entry>
|
---|
| 151 | </row>
|
---|
| 152 | <row>
|
---|
| 153 | <entry><emphasis role="bold">Subsection</emphasis></entry>
|
---|
| 154 | <entry>submenu item</entry>
|
---|
| 155 | </row>
|
---|
| 156 | <row>
|
---|
| 157 | <entry>
|
---|
| 158 | <emphasis role="bold">Required parameter</emphasis></entry>
|
---|
| 159 | <entry>
|
---|
| 160 | the option could be either built-in or not selected: it must be
|
---|
| 161 | selected
|
---|
| 162 | </entry>
|
---|
| 163 | </row>
|
---|
| 164 | <row>
|
---|
| 165 | <entry>
|
---|
| 166 | <emphasis role="bold">Required parameter (not as
|
---|
| 167 | module)</emphasis>
|
---|
| 168 | </entry>
|
---|
| 169 | <entry>
|
---|
| 170 | the option could be either built-in, module, or not selected:
|
---|
| 171 | it must be selected as built-in
|
---|
| 172 | </entry>
|
---|
| 173 | </row>
|
---|
| 174 | <row>
|
---|
| 175 | <entry>
|
---|
| 176 | <emphasis role="bold">Required parameter (could be
|
---|
| 177 | a module)</emphasis>
|
---|
| 178 | </entry>
|
---|
| 179 | <entry>
|
---|
| 180 | the option could be either built-in, module, or not selected:
|
---|
| 181 | it must be selected, either as built-in or module
|
---|
| 182 | </entry>
|
---|
| 183 | </row>
|
---|
| 184 | <row>
|
---|
| 185 | <entry>
|
---|
| 186 | <emphasis role="bold">Optional parameter</emphasis>
|
---|
| 187 | </entry>
|
---|
| 188 | <entry>
|
---|
| 189 | rarely used: the option could be either built-in, module, or not
|
---|
| 190 | selected: it may be selected at will
|
---|
| 191 | </entry>
|
---|
| 192 | </row>
|
---|
| 193 | <row>
|
---|
| 194 | <entry>
|
---|
| 195 | <emphasis role="bold">Incompatible parameter</emphasis>
|
---|
| 196 | </entry>
|
---|
| 197 | <entry>
|
---|
| 198 | the option could be either built-in or not selected: it must
|
---|
| 199 | <emphasis>not</emphasis> be selected
|
---|
| 200 | </entry>
|
---|
| 201 | </row>
|
---|
| 202 | <row>
|
---|
| 203 | <entry>
|
---|
| 204 | <emphasis role="bold">Incompatible parameter (even as module)</emphasis>
|
---|
| 205 | </entry>
|
---|
| 206 | <entry>
|
---|
| 207 | the option could be either built-in, module, or not selected:
|
---|
| 208 | it must <emphasis>not</emphasis> be selected
|
---|
| 209 | </entry>
|
---|
| 210 | </row>
|
---|
| 211 | </tbody></tgroup></informaltable>
|
---|
| 212 | </blockquote>
|
---|
| 213 | </para>
|
---|
| 214 |
|
---|
| 215 | <para>Note that, depending on other selections, the angle brackets
|
---|
| 216 | (<>) may appear as braces ({}), if the option cannot be unselected,
|
---|
| 217 | or even dashes (-*- or -M-), when the choice is imposed.
|
---|
| 218 | The help text about the option specifies the other selections on which this
|
---|
| 219 | option relies, and how those other selections are set.</para>
|
---|
| 220 |
|
---|
| 221 | </sect2>
|
---|
| 222 |
|
---|
| 223 | <sect2>
|
---|
[bfa21f3] | 224 | <title>SBU values in BLFS</title>
|
---|
| 225 |
|
---|
| 226 | <para>As in LFS, each package in BLFS has a build time listed in Standard
|
---|
| 227 | Build Units (SBUs). These times are relative to the time it took to build
|
---|
| 228 | binutils in LFS and are intended to provide some insight into how long it
|
---|
| 229 | will take to build a package. Most times listed are for a single processor
|
---|
| 230 | or core to build the package. In some cases, large, long running builds
|
---|
| 231 | tested on multi-core systems have SBU times listed with comments such
|
---|
| 232 | as '(parallelism=4)'. These values indicate testing was done using
|
---|
| 233 | multiple cores. Note that while this speeds up the build on systems with
|
---|
| 234 | the appropriate hardware, the speedup is not linear and to some extent
|
---|
| 235 | depends on the individual package and specific hardware used. </para>
|
---|
| 236 |
|
---|
[d5e120a] | 237 | <para>Some packages do not support parallel builds and using -j1 for the
|
---|
| 238 | make command is required. Packages that are known to have such limits are
|
---|
| 239 | marked as such in the text.</para>
|
---|
| 240 |
|
---|
[bfa21f3] | 241 | </sect2>
|
---|
| 242 |
|
---|
[aa15d3e] | 243 | </sect1>
|
---|