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