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