[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 |
|
---|
| 7 | <!-- Place this in the general.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">
|
---|
| 99 | <xref linkend="BLFS DEPENDENCY"/>
|
---|
| 100 | </para>
|
---|
[46daaa1] | 101 |
|
---|
[4705fa4] | 102 | <!-- As required -->
|
---|
| 103 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[14aeac4] | 104 | <para role="recommended">
|
---|
| 105 | <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink> and
|
---|
| 106 | <xref linkend="BLFS DEPENDENCY"/>.
|
---|
| 107 | </para>
|
---|
[46daaa1] | 108 |
|
---|
[4705fa4] | 109 | <!-- As required -->
|
---|
| 110 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[14aeac4] | 111 | <para role="optional">
|
---|
| 112 | <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>.
|
---|
| 113 | </para>
|
---|
[46daaa1] | 114 |
|
---|
[14aeac4] | 115 | <para condition="html" role="usernotes">
|
---|
| 116 | User Notes: <ulink url="&blfs-wiki;/TEMPLATE"/>
|
---|
| 117 | </para>
|
---|
[4705fa4] | 118 | </sect2>
|
---|
[46daaa1] | 119 |
|
---|
[d615263] | 120 | <!-- Optional section for packages that need a specific kernel
|
---|
| 121 | configuration-->
|
---|
[64fecc4] | 122 | <sect2 role="kernel" id="TEMPLATE-kernel">
|
---|
[4705fa4] | 123 | <title>Kernel Configuration</title>
|
---|
[46daaa1] | 124 |
|
---|
[14aeac4] | 125 | <para>
|
---|
| 126 | Enable the following options in the kernel configuration and recompile the
|
---|
| 127 | kernel if necessary:
|
---|
| 128 | </para>
|
---|
[46daaa1] | 129 |
|
---|
| 130 | <!-- Spaces are significant in <screen> sections -->
|
---|
[4705fa4] | 131 | <screen><literal>Master section:
|
---|
| 132 | Subsection:
|
---|
| 133 | Required Option: M or Y
|
---|
| 134 | Incompatible option: N</literal></screen>
|
---|
[46daaa1] | 135 |
|
---|
[14aeac4] | 136 | <para>
|
---|
| 137 | Select the appropriate sub-options that appear when the above options are
|
---|
| 138 | selected.
|
---|
| 139 | </para>
|
---|
[46daaa1] | 140 |
|
---|
[4705fa4] | 141 | <indexterm zone="TEMPLATE TEMPLATE-kernel">
|
---|
| 142 | <primary sortas="d-TEMPLATE">TEMPLATE</primary>
|
---|
| 143 | </indexterm>
|
---|
| 144 | </sect2>
|
---|
[46daaa1] | 145 |
|
---|
[4705fa4] | 146 | <!--Required section-->
|
---|
| 147 | <sect2 role="installation">
|
---|
| 148 | <title>Installation of TEMPLATE</title>
|
---|
[46daaa1] | 149 |
|
---|
[14aeac4] | 150 | <para>
|
---|
| 151 | Install <application>TEMPLATE</application> by running the following
|
---|
| 152 | commands:
|
---|
| 153 | </para>
|
---|
[46daaa1] | 154 |
|
---|
| 155 | <!-- Spaces are significant in <screen> sections -->
|
---|
[14aeac4] | 156 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[eaf6a1cd] | 157 | make</userinput></screen>
|
---|
[46daaa1] | 158 |
|
---|
[d615263] | 159 | <!-- Optional section. Use one of the two mentions below about a test
|
---|
| 160 | suite, delete the line that is not applicable. Of course, if the
|
---|
[8e46700] | 161 | test suite uses syntax other than 'make check', revise the
|
---|
| 162 | line to reflect the actual syntax to run the test suite -->
|
---|
| 163 |
|
---|
[14aeac4] | 164 | <para>
|
---|
| 165 | This package does not come with a test suite.
|
---|
| 166 | </para>
|
---|
[46daaa1] | 167 |
|
---|
[14aeac4] | 168 | <para>
|
---|
| 169 | To test the results, issue: <command>make check</command>.
|
---|
| 170 | </para>
|
---|
| 171 |
|
---|
| 172 | <para>
|
---|
| 173 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 174 | </para>
|
---|
[46daaa1] | 175 |
|
---|
[eaf6a1cd] | 176 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[4705fa4] | 177 | </sect2>
|
---|
[46daaa1] | 178 |
|
---|
[4705fa4] | 179 | <!--Optional section-->
|
---|
| 180 | <sect2 role="commands">
|
---|
| 181 | <title>Command Explanations</title>
|
---|
[46daaa1] | 182 |
|
---|
[a26f3f8f] | 183 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[692b244c] | 184 | href="../../xincludes/static-libraries.xml"/>
|
---|
[14aeac4] | 185 |
|
---|
[17bcb81] | 186 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 187 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 188 |
|
---|
[14aeac4] | 189 | <para>
|
---|
| 190 | <command>COMMAND</command>: This command does something.
|
---|
| 191 | </para>
|
---|
[46daaa1] | 192 |
|
---|
[14aeac4] | 193 | <para>
|
---|
| 194 | <parameter>--SWITCH=PARAMETER</parameter>: This parameter does something
|
---|
| 195 | mandatory for BLFS purposes.
|
---|
| 196 | </para>
|
---|
[46daaa1] | 197 |
|
---|
[14aeac4] | 198 | <para>
|
---|
| 199 | <option>--OPTION</option>: This option does something optionally per the
|
---|
| 200 | user's desires.
|
---|
| 201 | </para>
|
---|
[4705fa4] | 202 | </sect2>
|
---|
[46daaa1] | 203 |
|
---|
[5603a81] | 204 | <sect2 role="using">
|
---|
| 205 | <title>Using TEMPLATE</title>
|
---|
| 206 |
|
---|
| 207 | <para>
|
---|
| 208 | Stuff about how to use TEMPLATE to do something.
|
---|
| 209 | </para>
|
---|
| 210 | </sect2>
|
---|
| 211 |
|
---|
[4705fa4] | 212 | <!--Optional section-->
|
---|
| 213 | <sect2 role="configuration">
|
---|
| 214 | <title>Configuring TEMPLATE</title>
|
---|
[46daaa1] | 215 |
|
---|
[4705fa4] | 216 | <sect3 id="TEMPLATE-config">
|
---|
| 217 | <title>Config Files</title>
|
---|
[14aeac4] | 218 | <para>
|
---|
| 219 | <filename>~/.Configfilename1</filename> and
|
---|
| 220 | <filename>/etc/path/Configfilename2</filename>.
|
---|
| 221 | </para>
|
---|
[46daaa1] | 222 |
|
---|
[4705fa4] | 223 | <indexterm zone="TEMPLATE TEMPLATE-config">
|
---|
| 224 | <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
|
---|
| 225 | </indexterm>
|
---|
[46daaa1] | 226 |
|
---|
[4705fa4] | 227 | <indexterm zone="TEMPLATE TEMPLATE-config">
|
---|
[d615263] | 228 | <primary
|
---|
| 229 | sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
|
---|
[4705fa4] | 230 | </indexterm>
|
---|
| 231 | </sect3>
|
---|
[46daaa1] | 232 |
|
---|
[4705fa4] | 233 | <sect3><title>Configuration Information</title>
|
---|
[46daaa1] | 234 |
|
---|
[14aeac4] | 235 | <para>
|
---|
| 236 | Blah blah blah about config.
|
---|
| 237 | </para>
|
---|
[46daaa1] | 238 |
|
---|
[eaf6a1cd] | 239 | <screen><userinput>USER CONFIG COMMANDS</userinput></screen>
|
---|
[46daaa1] | 240 |
|
---|
[eaf6a1cd] | 241 | <screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
|
---|
[46daaa1] | 242 |
|
---|
[b8dba81] | 243 | <!-- File creation. Add the appropriate <indexterm> block if needed.-->
|
---|
[14aeac4] | 244 | <para>
|
---|
| 245 | Create the file .... for ...
|
---|
| 246 | </para>
|
---|
[46daaa1] | 247 |
|
---|
[eaf6a1cd] | 248 | <screen role="root"><userinput>cat >> /PATH/FILENAME << "EOF"
|
---|
| 249 | <literal># Begin FILENAME
|
---|
[46daaa1] | 250 |
|
---|
[eaf6a1cd] | 251 | TEXT
|
---|
[46daaa1] | 252 |
|
---|
[eaf6a1cd] | 253 | # End FILENAME</literal>
|
---|
| 254 | EOF</userinput></screen>
|
---|
[4705fa4] | 255 | </sect3>
|
---|
[46daaa1] | 256 |
|
---|
[4705fa4] | 257 | <sect3 id="TEMPLATE-init">
|
---|
| 258 | <title>Boot Script</title>
|
---|
[46daaa1] | 259 |
|
---|
[14aeac4] | 260 | <para>
|
---|
| 261 | To automatically start the <command>TEMPLATE</command> daemon when the
|
---|
| 262 | system is rebooted, install the
|
---|
| 263 | <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
|
---|
| 264 | <xref linkend="bootscripts"/> package.
|
---|
| 265 | </para>
|
---|
[46daaa1] | 266 |
|
---|
| 267 | <indexterm zone="TEMPLATE TEMPLATE-init">
|
---|
[4705fa4] | 268 | <primary sortas="f-TEMPLATE">TEMPLATE</primary>
|
---|
[46daaa1] | 269 | </indexterm>
|
---|
| 270 |
|
---|
[eaf6a1cd] | 271 | <screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
|
---|
[4705fa4] | 272 | </sect3>
|
---|
| 273 | </sect2>
|
---|
[46daaa1] | 274 |
|
---|
| 275 | <!--Required section-->
|
---|
[4705fa4] | 276 | <sect2 role="content">
|
---|
| 277 | <title>Contents</title>
|
---|
[46daaa1] | 278 |
|
---|
[4705fa4] | 279 | <segmentedlist>
|
---|
| 280 | <segtitle>Installed Program(s)</segtitle>
|
---|
| 281 | <segtitle>Installed Librar(y,ies)</segtitle>
|
---|
| 282 | <segtitle>Installed Director(y,ies)</segtitle>
|
---|
[46daaa1] | 283 |
|
---|
[4705fa4] | 284 | <seglistitem>
|
---|
[14aeac4] | 285 | <seg>
|
---|
| 286 | PROGRAM1, PROGRAM2 and PROGRAM3.
|
---|
| 287 | </seg>
|
---|
| 288 | <seg>
|
---|
| 289 | libLIBRARY1.so, libLIBRARY2.so and libLIBRARY3.so.
|
---|
| 290 | </seg>
|
---|
| 291 | <seg>
|
---|
| 292 | /etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
|
---|
| 293 | /usr/share/TEMPLATE-&TEMPLATE-version;,
|
---|
| 294 | /usr/share/doc/TEMPLATE-&TEMPLATE-version; and
|
---|
| 295 | /var/lib/TEMPLATE.
|
---|
| 296 | </seg>
|
---|
[4705fa4] | 297 | </seglistitem>
|
---|
| 298 | </segmentedlist>
|
---|
[46daaa1] | 299 |
|
---|
[4705fa4] | 300 | <variablelist>
|
---|
| 301 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 302 | <?dbfo list-presentation="list"?>
|
---|
| 303 | <?dbhtml list-presentation="table"?>
|
---|
[46daaa1] | 304 |
|
---|
[fb3dd289] | 305 | <!-- If the program or library name conflicts (is the same) as the
|
---|
| 306 | package name, add -prog or -lib to the varlistentry entity id
|
---|
[4705fa4] | 307 | and the 2nd entry of the indexterm zone entity -->
|
---|
[46daaa1] | 308 |
|
---|
[4705fa4] | 309 | <varlistentry id="PROGRAM1">
|
---|
| 310 | <term><command>PROGRAM1</command></term>
|
---|
| 311 | <listitem>
|
---|
[14aeac4] | 312 | <para>
|
---|
| 313 | does this .....
|
---|
| 314 | </para>
|
---|
[4705fa4] | 315 | <indexterm zone="TEMPLATE PROGRAM1">
|
---|
| 316 | <primary sortas="b-PROGRAM1">PROGRAM1</primary>
|
---|
| 317 | </indexterm>
|
---|
| 318 | </listitem>
|
---|
| 319 | </varlistentry>
|
---|
[46daaa1] | 320 |
|
---|
[4705fa4] | 321 | <varlistentry id="PROGRAM2">
|
---|
| 322 | <term><command>PROGRAM2</command></term>
|
---|
| 323 | <listitem>
|
---|
[14aeac4] | 324 | <para>
|
---|
| 325 | does this .....
|
---|
| 326 | </para>
|
---|
[4705fa4] | 327 | <indexterm zone="TEMPLATE PROGRAM2">
|
---|
| 328 | <primary sortas="b-PROGRAM2">PROGRAM2</primary>
|
---|
| 329 | </indexterm>
|
---|
| 330 | </listitem>
|
---|
| 331 | </varlistentry>
|
---|
[46daaa1] | 332 |
|
---|
[4705fa4] | 333 | <varlistentry id="libLIBRARY1">
|
---|
[14aeac4] | 334 | <term><filename class="libraryfile">libLIBRARY1.so</filename></term>
|
---|
[4705fa4] | 335 | <listitem>
|
---|
[14aeac4] | 336 | <para>
|
---|
| 337 | contains functions that .....
|
---|
| 338 | </para>
|
---|
[4705fa4] | 339 | <indexterm zone="TEMPLATE libLIBRARY1">
|
---|
[14aeac4] | 340 | <primary sortas="c-libLIBRARY1">libLIBRARY1.so</primary>
|
---|
[4705fa4] | 341 | </indexterm>
|
---|
| 342 | </listitem>
|
---|
| 343 | </varlistentry>
|
---|
| 344 | </variablelist>
|
---|
| 345 | </sect2>
|
---|
[46daaa1] | 346 | </sect1>
|
---|