[d3edf27] | 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" [
|
---|
[d3edf27] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[e248af7] | 7 | <!-- Place this in the packages.ent file
|
---|
[43fd8be] | 8 | <!ENTITY TEMPLATE-version "">
|
---|
[d3edf27] | 9 | -->
|
---|
| 10 |
|
---|
[43fd8be] | 11 | <!ENTITY TEMPLATE-download-http "http://">
|
---|
| 12 | <!ENTITY TEMPLATE-download-ftp "ftp://">
|
---|
| 13 | <!ENTITY TEMPLATE-md5sum "MD5 sum">
|
---|
| 14 | <!ENTITY TEMPLATE-size "?? MB">
|
---|
| 15 | <!ENTITY TEMPLATE-buildsize "?? MB">
|
---|
| 16 | <!ENTITY TEMPLATE-time "?? SBU">
|
---|
[1ae4746] | 17 | <!-- SBU should be rounded to integer if greater than 10, to one
|
---|
| 18 | decimal if below 10, and should be "less than 0.1 SBU" if
|
---|
| 19 | below 0.1. If the SBU without parallelisation is too long,
|
---|
| 20 | it is acceptable to give the value "with parallelism=N", where
|
---|
| 21 | N is the number of threads used. Note that some build system
|
---|
| 22 | automatically fix N equal to the number of available CPU cores
|
---|
| 23 | on the machine. -->
|
---|
[d3edf27] | 24 | ]>
|
---|
| 25 |
|
---|
[4705fa4] | 26 | <!-- Try to keep the indentation used in this file-->
|
---|
[1ae02579] | 27 | <sect1 id="TEMPLATE" xreflabel="TEMPLATE-&TEMPLATE-version;">
|
---|
[4705fa4] | 28 | <?dbhtml filename="TEMPLATE.html"?>
|
---|
[46daaa1] | 29 |
|
---|
[4705fa4] | 30 | <sect1info>
|
---|
| 31 | <othername>$LastChangedBy$</othername>
|
---|
| 32 | <date>$Date$</date>
|
---|
| 33 | </sect1info>
|
---|
[46daaa1] | 34 |
|
---|
[17bcb81] | 35 | <!-- No other tags inside any title.
|
---|
| 36 | Use Title Case in All Titles -->
|
---|
[4705fa4] | 37 | <title>TEMPLATE-&TEMPLATE-version;</title>
|
---|
[46daaa1] | 38 |
|
---|
[4705fa4] | 39 | <indexterm zone="TEMPLATE">
|
---|
| 40 | <primary sortas="a-TEMPLATE">TEMPLATE</primary>
|
---|
| 41 | </indexterm>
|
---|
[46daaa1] | 42 |
|
---|
[4705fa4] | 43 | <!--Required section-->
|
---|
| 44 | <sect2 role="package">
|
---|
| 45 | <title>Introduction to TEMPLATE</title>
|
---|
[46daaa1] | 46 |
|
---|
[14aeac4] | 47 | <para>
|
---|
| 48 | The <application>TEMPLATE</application> package contains...
|
---|
| 49 | This is useful for...
|
---|
| 50 | </para>
|
---|
[46daaa1] | 51 |
|
---|
[a4a52f4] | 52 | <!-- if it builds but hasn't been tested: -->
|
---|
[4c77a949] | 53 | &lfs71_built;
|
---|
[a4a52f4] | 54 | <!-- if it works: -->
|
---|
[4c77a949] | 55 | &lfs71_checked;
|
---|
[a4a52f4] | 56 |
|
---|
[4705fa4] | 57 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 58 | <itemizedlist spacing="compact">
|
---|
| 59 | <listitem>
|
---|
[14aeac4] | 60 | <para>
|
---|
| 61 | Download (HTTP): <ulink url="&TEMPLATE-download-http;"/>
|
---|
| 62 | </para>
|
---|
[4705fa4] | 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
[14aeac4] | 65 | <para>
|
---|
| 66 | Download (FTP): <ulink url="&TEMPLATE-download-ftp;"/>
|
---|
| 67 | </para>
|
---|
[4705fa4] | 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
[14aeac4] | 70 | <para>
|
---|
| 71 | Download MD5 sum: &TEMPLATE-md5sum;
|
---|
| 72 | </para>
|
---|
[4705fa4] | 73 | </listitem>
|
---|
| 74 | <listitem>
|
---|
[14aeac4] | 75 | <para>
|
---|
| 76 | Download size: &TEMPLATE-size;
|
---|
| 77 | </para>
|
---|
[4705fa4] | 78 | </listitem>
|
---|
| 79 | <listitem>
|
---|
[14aeac4] | 80 | <para>
|
---|
| 81 | Estimated disk space required: &TEMPLATE-buildsize;
|
---|
| 82 | </para>
|
---|
[4705fa4] | 83 | </listitem>
|
---|
| 84 | <listitem>
|
---|
[14aeac4] | 85 | <para>
|
---|
| 86 | Estimated build time: &TEMPLATE-time;
|
---|
| 87 | </para>
|
---|
[f2c510ee] | 88 | </listitem>
|
---|
[4705fa4] | 89 | </itemizedlist>
|
---|
[46daaa1] | 90 |
|
---|
[4705fa4] | 91 | <!-- As required -->
|
---|
| 92 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 93 | <itemizedlist spacing="compact">
|
---|
| 94 | <listitem>
|
---|
[14aeac4] | 95 | <para>
|
---|
| 96 | Required patch:
|
---|
| 97 | <ulink url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/>
|
---|
| 98 | </para>
|
---|
[4705fa4] | 99 | </listitem>
|
---|
| 100 | </itemizedlist>
|
---|
[46daaa1] | 101 |
|
---|
[4705fa4] | 102 | <bridgehead renderas="sect3">TEMPLATE Dependencies</bridgehead>
|
---|
[46daaa1] | 103 |
|
---|
[4705fa4] | 104 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[14aeac4] | 105 | <para role="required">
|
---|
[161767fb] | 106 | <xref linkend="BLFS_DEPENDENCY"/> <!-- notice no period as this is not
|
---|
| 107 | a sentence. If there are more than two, they must be separated by commas
|
---|
| 108 | with the last member having "and" in front of it. The use of a serial
|
---|
| 109 | comma is preferred (a comma after the next to last member before the
|
---|
| 110 | "and"). BLFS_DEPENDENCY should be an "id" attribute defined somewhere
|
---|
| 111 | in the book (usually in a <sect1>). -->
|
---|
[14aeac4] | 112 | </para>
|
---|
[46daaa1] | 113 |
|
---|
[4705fa4] | 114 | <!-- As required -->
|
---|
| 115 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[14aeac4] | 116 | <para role="recommended">
|
---|
[161767fb] | 117 | <xref linkend="BLFS_DEPENDENCY"/> <!-- notice no period as this is not
|
---|
| 118 | a sentence. See above for the use of "and" and commas. Normally, neither
|
---|
| 119 | required nor recommended dependencies should be <ulink>. -->
|
---|
[14aeac4] | 120 | </para>
|
---|
[46daaa1] | 121 |
|
---|
[4705fa4] | 122 | <!-- As required -->
|
---|
| 123 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[14aeac4] | 124 | <para role="optional">
|
---|
[161767fb] | 125 | <xref linkend="BLFS_DEPENDENCY"/> and
|
---|
[8bf11809] | 126 | <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>
|
---|
[161767fb] | 127 | <!-- notice no period as this is not a sentence. See above for the use
|
---|
| 128 | of commas and "and". The order should <xref> before <ulink>.-->
|
---|
[14aeac4] | 129 | </para>
|
---|
[46daaa1] | 130 |
|
---|
[14aeac4] | 131 | <para condition="html" role="usernotes">
|
---|
| 132 | User Notes: <ulink url="&blfs-wiki;/TEMPLATE"/>
|
---|
| 133 | </para>
|
---|
[4705fa4] | 134 | </sect2>
|
---|
[46daaa1] | 135 |
|
---|
[d615263] | 136 | <!-- Optional section for packages that need a specific kernel
|
---|
| 137 | configuration-->
|
---|
[64fecc4] | 138 | <sect2 role="kernel" id="TEMPLATE-kernel">
|
---|
[4705fa4] | 139 | <title>Kernel Configuration</title>
|
---|
[46daaa1] | 140 |
|
---|
[14aeac4] | 141 | <para>
|
---|
| 142 | Enable the following options in the kernel configuration and recompile the
|
---|
| 143 | kernel if necessary:
|
---|
| 144 | </para>
|
---|
[46daaa1] | 145 |
|
---|
| 146 | <!-- Spaces are significant in <screen> sections -->
|
---|
[ca40dcac] | 147 | <screen><literal>Master section --->
|
---|
| 148 | Subsection --->
|
---|
[161767fb] | 149 | [*] Required parameter [CONFIG_REQU_PAR]
|
---|
| 150 | <*> Required parameter (not as module) [CONFIG_REQU_PAR_NMOD]
|
---|
| 151 | <*/M> Required parameter (could be a module) [CONFIG_REQU_PAR_MOD]
|
---|
| 152 | <*/M/ > Optional parameter [CONFIG_OPT_PAR]
|
---|
| 153 | [ ] Incompatible parameter [CONFIG_INCOMP_PAR]
|
---|
| 154 | < > Incompatible parameter (even as module) [CONFIG_INCOMP_PAR_MOD]</literal></screen>
|
---|
[46daaa1] | 155 |
|
---|
[14aeac4] | 156 | <para>
|
---|
| 157 | Select the appropriate sub-options that appear when the above options are
|
---|
[8d99b03f] | 158 | selected. As much as possible, the layout should be the same as in
|
---|
[ca40dcac] | 159 | kernel menus.
|
---|
[14aeac4] | 160 | </para>
|
---|
[46daaa1] | 161 |
|
---|
[4705fa4] | 162 | <indexterm zone="TEMPLATE TEMPLATE-kernel">
|
---|
| 163 | <primary sortas="d-TEMPLATE">TEMPLATE</primary>
|
---|
| 164 | </indexterm>
|
---|
| 165 | </sect2>
|
---|
[46daaa1] | 166 |
|
---|
[4705fa4] | 167 | <!--Required section-->
|
---|
| 168 | <sect2 role="installation">
|
---|
| 169 | <title>Installation of TEMPLATE</title>
|
---|
[46daaa1] | 170 |
|
---|
[14aeac4] | 171 | <para>
|
---|
| 172 | Install <application>TEMPLATE</application> by running the following
|
---|
| 173 | commands:
|
---|
| 174 | </para>
|
---|
[46daaa1] | 175 |
|
---|
| 176 | <!-- Spaces are significant in <screen> sections -->
|
---|
[14aeac4] | 177 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[eaf6a1cd] | 178 | make</userinput></screen>
|
---|
[46daaa1] | 179 |
|
---|
[d615263] | 180 | <!-- Optional section. Use one of the two mentions below about a test
|
---|
| 181 | suite, delete the line that is not applicable. Of course, if the
|
---|
[8e46700] | 182 | test suite uses syntax other than 'make check', revise the
|
---|
| 183 | line to reflect the actual syntax to run the test suite -->
|
---|
| 184 |
|
---|
[14aeac4] | 185 | <para>
|
---|
| 186 | This package does not come with a test suite.
|
---|
| 187 | </para>
|
---|
[46daaa1] | 188 |
|
---|
[14aeac4] | 189 | <para>
|
---|
| 190 | To test the results, issue: <command>make check</command>.
|
---|
| 191 | </para>
|
---|
| 192 |
|
---|
| 193 | <para>
|
---|
| 194 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 195 | </para>
|
---|
[46daaa1] | 196 |
|
---|
[eaf6a1cd] | 197 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[4705fa4] | 198 | </sect2>
|
---|
[46daaa1] | 199 |
|
---|
[4705fa4] | 200 | <!--Optional section-->
|
---|
| 201 | <sect2 role="commands">
|
---|
| 202 | <title>Command Explanations</title>
|
---|
[46daaa1] | 203 |
|
---|
[a26f3f8f] | 204 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[692b244c] | 205 | href="../../xincludes/static-libraries.xml"/>
|
---|
[14aeac4] | 206 |
|
---|
[17bcb81] | 207 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 208 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 209 |
|
---|
[14aeac4] | 210 | <para>
|
---|
| 211 | <command>COMMAND</command>: This command does something.
|
---|
| 212 | </para>
|
---|
[46daaa1] | 213 |
|
---|
[14aeac4] | 214 | <para>
|
---|
[8bf11809] | 215 | <parameter>--PARAMETER</parameter>: This parameter does something
|
---|
| 216 | mandatory for BLFS purposes. It will be in the instructions above. It is
|
---|
| 217 | not optional and is why it is listed as a parameter and not an option.
|
---|
[14aeac4] | 218 | </para>
|
---|
[46daaa1] | 219 |
|
---|
[14aeac4] | 220 | <para>
|
---|
| 221 | <option>--OPTION</option>: This option does something optionally per the
|
---|
[8bf11809] | 222 | user's desires. It is not listed in the instructions above, but instead,
|
---|
| 223 | is listed here because many (some) readers may want to include it.
|
---|
[14aeac4] | 224 | </para>
|
---|
[4705fa4] | 225 | </sect2>
|
---|
[46daaa1] | 226 |
|
---|
[5603a81] | 227 | <sect2 role="using">
|
---|
| 228 | <title>Using TEMPLATE</title>
|
---|
| 229 |
|
---|
| 230 | <para>
|
---|
[8bf11809] | 231 | Stuff about how to use TEMPLATE to do something. This section is rarely
|
---|
| 232 | used.
|
---|
[5603a81] | 233 | </para>
|
---|
| 234 | </sect2>
|
---|
| 235 |
|
---|
[4705fa4] | 236 | <!--Optional section-->
|
---|
| 237 | <sect2 role="configuration">
|
---|
| 238 | <title>Configuring TEMPLATE</title>
|
---|
[46daaa1] | 239 |
|
---|
[4705fa4] | 240 | <sect3 id="TEMPLATE-config">
|
---|
| 241 | <title>Config Files</title>
|
---|
[14aeac4] | 242 | <para>
|
---|
| 243 | <filename>~/.Configfilename1</filename> and
|
---|
[8bf11809] | 244 | <filename>/etc/path/Configfilename2</filename> <!-- notice no period as this is not a sentence-->
|
---|
[14aeac4] | 245 | </para>
|
---|
[46daaa1] | 246 |
|
---|
[4705fa4] | 247 | <indexterm zone="TEMPLATE TEMPLATE-config">
|
---|
| 248 | <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
|
---|
| 249 | </indexterm>
|
---|
[46daaa1] | 250 |
|
---|
[4705fa4] | 251 | <indexterm zone="TEMPLATE TEMPLATE-config">
|
---|
[d615263] | 252 | <primary
|
---|
| 253 | sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
|
---|
[4705fa4] | 254 | </indexterm>
|
---|
| 255 | </sect3>
|
---|
[46daaa1] | 256 |
|
---|
[4705fa4] | 257 | <sect3><title>Configuration Information</title>
|
---|
[46daaa1] | 258 |
|
---|
[14aeac4] | 259 | <para>
|
---|
| 260 | Blah blah blah about config.
|
---|
| 261 | </para>
|
---|
[46daaa1] | 262 |
|
---|
[eaf6a1cd] | 263 | <screen><userinput>USER CONFIG COMMANDS</userinput></screen>
|
---|
[46daaa1] | 264 |
|
---|
[eaf6a1cd] | 265 | <screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
|
---|
[46daaa1] | 266 |
|
---|
[b8dba81] | 267 | <!-- File creation. Add the appropriate <indexterm> block if needed.-->
|
---|
[14aeac4] | 268 | <para>
|
---|
| 269 | Create the file .... for ...
|
---|
| 270 | </para>
|
---|
[46daaa1] | 271 |
|
---|
[eaf6a1cd] | 272 | <screen role="root"><userinput>cat >> /PATH/FILENAME << "EOF"
|
---|
| 273 | <literal># Begin FILENAME
|
---|
[46daaa1] | 274 |
|
---|
[eaf6a1cd] | 275 | TEXT
|
---|
[46daaa1] | 276 |
|
---|
[eaf6a1cd] | 277 | # End FILENAME</literal>
|
---|
| 278 | EOF</userinput></screen>
|
---|
[4705fa4] | 279 | </sect3>
|
---|
[46daaa1] | 280 |
|
---|
[4705fa4] | 281 | <sect3 id="TEMPLATE-init">
|
---|
| 282 | <title>Boot Script</title>
|
---|
[46daaa1] | 283 |
|
---|
[14aeac4] | 284 | <para>
|
---|
| 285 | To automatically start the <command>TEMPLATE</command> daemon when the
|
---|
| 286 | system is rebooted, install the
|
---|
| 287 | <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
|
---|
[3c7bd00] | 288 | <xref linkend="bootscripts" revision="sysv"/>
|
---|
| 289 | <xref linkend="systemd-units" revision="systemd"/> package as the
|
---|
[8bf11809] | 290 | <systemitem class="username">root</systemitem> user:
|
---|
[14aeac4] | 291 | </para>
|
---|
[46daaa1] | 292 |
|
---|
| 293 | <indexterm zone="TEMPLATE TEMPLATE-init">
|
---|
[4705fa4] | 294 | <primary sortas="f-TEMPLATE">TEMPLATE</primary>
|
---|
[46daaa1] | 295 | </indexterm>
|
---|
| 296 |
|
---|
[eaf6a1cd] | 297 | <screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
|
---|
[4705fa4] | 298 | </sect3>
|
---|
| 299 | </sect2>
|
---|
[46daaa1] | 300 |
|
---|
| 301 | <!--Required section-->
|
---|
[4705fa4] | 302 | <sect2 role="content">
|
---|
| 303 | <title>Contents</title>
|
---|
[46daaa1] | 304 |
|
---|
[4705fa4] | 305 | <segmentedlist>
|
---|
| 306 | <segtitle>Installed Program(s)</segtitle>
|
---|
| 307 | <segtitle>Installed Librar(y,ies)</segtitle>
|
---|
| 308 | <segtitle>Installed Director(y,ies)</segtitle>
|
---|
[46daaa1] | 309 |
|
---|
[8bf11809] | 310 | <!-- If there were no programs, libraries, or directories created, then
|
---|
| 311 | we would list the section as "None". However, a decision must have
|
---|
| 312 | been made to change the "None" to just removing the whole section
|
---|
| 313 | because I've noticed that many packages have had the "None"
|
---|
| 314 | removed and the section completely removed as well. The reasoning
|
---|
| 315 | was that by putting "None", it appears as we know there are none.
|
---|
| 316 | Without anything it appears as we are not sure. -->
|
---|
[0d7900a] | 317 |
|
---|
[4705fa4] | 318 | <seglistitem>
|
---|
[14aeac4] | 319 | <seg>
|
---|
| 320 | PROGRAM1, PROGRAM2 and PROGRAM3.
|
---|
| 321 | </seg>
|
---|
| 322 | <seg>
|
---|
| 323 | libLIBRARY1.so, libLIBRARY2.so and libLIBRARY3.so.
|
---|
| 324 | </seg>
|
---|
| 325 | <seg>
|
---|
| 326 | /etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
|
---|
| 327 | /usr/share/TEMPLATE-&TEMPLATE-version;,
|
---|
| 328 | /usr/share/doc/TEMPLATE-&TEMPLATE-version; and
|
---|
| 329 | /var/lib/TEMPLATE.
|
---|
| 330 | </seg>
|
---|
[4705fa4] | 331 | </seglistitem>
|
---|
| 332 | </segmentedlist>
|
---|
[46daaa1] | 333 |
|
---|
[4705fa4] | 334 | <variablelist>
|
---|
| 335 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 336 | <?dbfo list-presentation="list"?>
|
---|
| 337 | <?dbhtml list-presentation="table"?>
|
---|
[46daaa1] | 338 |
|
---|
[fb3dd289] | 339 | <!-- If the program or library name conflicts (is the same) as the
|
---|
| 340 | package name, add -prog or -lib to the varlistentry entity id
|
---|
[4705fa4] | 341 | and the 2nd entry of the indexterm zone entity -->
|
---|
[46daaa1] | 342 |
|
---|
[4705fa4] | 343 | <varlistentry id="PROGRAM1">
|
---|
| 344 | <term><command>PROGRAM1</command></term>
|
---|
| 345 | <listitem>
|
---|
[14aeac4] | 346 | <para>
|
---|
[8bf11809] | 347 | does this ..... (end the sentence with a period).
|
---|
[14aeac4] | 348 | </para>
|
---|
[4705fa4] | 349 | <indexterm zone="TEMPLATE PROGRAM1">
|
---|
| 350 | <primary sortas="b-PROGRAM1">PROGRAM1</primary>
|
---|
| 351 | </indexterm>
|
---|
| 352 | </listitem>
|
---|
| 353 | </varlistentry>
|
---|
[46daaa1] | 354 |
|
---|
[4705fa4] | 355 | <varlistentry id="PROGRAM2">
|
---|
| 356 | <term><command>PROGRAM2</command></term>
|
---|
| 357 | <listitem>
|
---|
[14aeac4] | 358 | <para>
|
---|
[8bf11809] | 359 | does this ..... (end the sentence with a period).
|
---|
[14aeac4] | 360 | </para>
|
---|
[4705fa4] | 361 | <indexterm zone="TEMPLATE PROGRAM2">
|
---|
| 362 | <primary sortas="b-PROGRAM2">PROGRAM2</primary>
|
---|
| 363 | </indexterm>
|
---|
| 364 | </listitem>
|
---|
| 365 | </varlistentry>
|
---|
[46daaa1] | 366 |
|
---|
[4705fa4] | 367 | <varlistentry id="libLIBRARY1">
|
---|
[14aeac4] | 368 | <term><filename class="libraryfile">libLIBRARY1.so</filename></term>
|
---|
[4705fa4] | 369 | <listitem>
|
---|
[14aeac4] | 370 | <para>
|
---|
[8bf11809] | 371 | contains functions that ..... (end the sentence with a period).
|
---|
[14aeac4] | 372 | </para>
|
---|
[4705fa4] | 373 | <indexterm zone="TEMPLATE libLIBRARY1">
|
---|
[14aeac4] | 374 | <primary sortas="c-libLIBRARY1">libLIBRARY1.so</primary>
|
---|
[4705fa4] | 375 | </indexterm>
|
---|
| 376 | </listitem>
|
---|
| 377 | </varlistentry>
|
---|
| 378 | </variablelist>
|
---|
| 379 | </sect2>
|
---|
[46daaa1] | 380 | </sect1>
|
---|