[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 |
|
---|
[4705fa4] | 28 | <!-- No other tags inside any title-->
|
---|
[fb3dd289] | 29 | <!-- Use Title Case in All Titles
|
---|
[4705fa4] | 30 | The "The Chicago Manual of Style":
|
---|
[fb3dd289] | 31 | "-Always capitalize the first and the last word.
|
---|
[4705fa4] | 32 | -Capitalize all nouns, pronouns, adjectives, verbs, adverbs, and
|
---|
| 33 | subordinate conjunctions ("as", "because", "although").
|
---|
| 34 | -Lowercase all articles, coordinate conjunctions ("and", "or", "nor"),
|
---|
| 35 | and prepositions regardless of length, when they are other than the
|
---|
| 36 | first or last word.
|
---|
| 37 | -Lowercase the "to" in an infinitive."-->
|
---|
| 38 | <title>TEMPLATE-&TEMPLATE-version;</title>
|
---|
[46daaa1] | 39 |
|
---|
[4705fa4] | 40 | <indexterm zone="TEMPLATE">
|
---|
| 41 | <primary sortas="a-TEMPLATE">TEMPLATE</primary>
|
---|
| 42 | </indexterm>
|
---|
[46daaa1] | 43 |
|
---|
[4705fa4] | 44 | <!--Required section-->
|
---|
| 45 | <sect2 role="package">
|
---|
| 46 | <title>Introduction to TEMPLATE</title>
|
---|
[46daaa1] | 47 |
|
---|
[fb3dd289] | 48 | <para>The <application>TEMPLATE</application> package contains...
|
---|
[4705fa4] | 49 | This is useful for...</para>
|
---|
[46daaa1] | 50 |
|
---|
[4705fa4] | 51 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 52 | <itemizedlist spacing="compact">
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>Download (HTTP): <ulink url="&TEMPLATE-download-http;"/></para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>Download (FTP): <ulink url="&TEMPLATE-download-ftp;"/></para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>Download MD5 sum: &TEMPLATE-md5sum;</para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>Download size: &TEMPLATE-size;</para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>Estimated disk space required: &TEMPLATE-buildsize;</para>
|
---|
| 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
[f2c510ee] | 69 | <para>Estimated build time: &TEMPLATE-time;</para>
|
---|
| 70 | </listitem>
|
---|
[4705fa4] | 71 | </itemizedlist>
|
---|
[46daaa1] | 72 |
|
---|
[4705fa4] | 73 | <!-- As required -->
|
---|
| 74 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 75 | <itemizedlist spacing="compact">
|
---|
| 76 | <listitem>
|
---|
[fb3dd289] | 77 | <para>Required patch: <ulink
|
---|
[9d798aee] | 78 | url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
|
---|
[4705fa4] | 79 | </listitem>
|
---|
| 80 | </itemizedlist>
|
---|
[46daaa1] | 81 |
|
---|
[4705fa4] | 82 | <bridgehead renderas="sect3">TEMPLATE Dependencies</bridgehead>
|
---|
[46daaa1] | 83 |
|
---|
[4705fa4] | 84 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[aa82253] | 85 | <para role="required"><xref linkend="BLFS DEPENDENCY"/></para>
|
---|
[46daaa1] | 86 |
|
---|
[4705fa4] | 87 | <!-- As required -->
|
---|
| 88 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[aa82253] | 89 | <para role="recommended"><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>,
|
---|
[9d798aee] | 90 | <xref linkend="BLFS DEPENDENCY"/></para>
|
---|
[46daaa1] | 91 |
|
---|
[4705fa4] | 92 | <!-- As required -->
|
---|
| 93 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[aa82253] | 94 | <para role="optional"><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para>
|
---|
[46daaa1] | 95 |
|
---|
[57b11363] | 96 | <para condition="html" role="usernotes">User Notes:
|
---|
[10ce9fe] | 97 | <ulink url="&blfs-wiki;/TEMPLATE"/></para>
|
---|
[57b11363] | 98 |
|
---|
[4705fa4] | 99 | </sect2>
|
---|
[46daaa1] | 100 |
|
---|
[4705fa4] | 101 | <!-- Optional section for packages that need a specific kernel configuration-->
|
---|
| 102 | <sect2 role="kernel" id='TEMPLATE-kernel'>
|
---|
| 103 | <title>Kernel Configuration</title>
|
---|
[46daaa1] | 104 |
|
---|
[4705fa4] | 105 | <para>Enable the following options in the kernel configuration
|
---|
[bfb7882] | 106 | and recompile the kernel if necessary:</para>
|
---|
[46daaa1] | 107 |
|
---|
| 108 | <!-- Spaces are significant in <screen> sections -->
|
---|
[4705fa4] | 109 | <screen><literal>Master section:
|
---|
| 110 | Subsection:
|
---|
| 111 | Required Option: M or Y
|
---|
| 112 | Incompatible option: N</literal></screen>
|
---|
[46daaa1] | 113 |
|
---|
[4705fa4] | 114 | <para>Select the appropriate sub-options that appear when the above options
|
---|
| 115 | are selected.</para>
|
---|
[46daaa1] | 116 |
|
---|
[4705fa4] | 117 | <indexterm zone="TEMPLATE TEMPLATE-kernel">
|
---|
| 118 | <primary sortas="d-TEMPLATE">TEMPLATE</primary>
|
---|
| 119 | </indexterm>
|
---|
[46daaa1] | 120 |
|
---|
[4705fa4] | 121 | </sect2>
|
---|
[46daaa1] | 122 |
|
---|
[4705fa4] | 123 | <!--Required section-->
|
---|
| 124 | <sect2 role="installation">
|
---|
| 125 | <title>Installation of TEMPLATE</title>
|
---|
[46daaa1] | 126 |
|
---|
[fb3dd289] | 127 | <para>Install <application>TEMPLATE</application> by running the following
|
---|
[4705fa4] | 128 | commands:</para>
|
---|
[46daaa1] | 129 |
|
---|
| 130 | <!-- Spaces are significant in <screen> sections -->
|
---|
[eaf6a1cd] | 131 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 132 | make</userinput></screen>
|
---|
[46daaa1] | 133 |
|
---|
[8e46700] | 134 | <!-- Use one of the two mentions below about a test suite,
|
---|
| 135 | delete the line that is not applicable. Of course, if the
|
---|
| 136 | test suite uses syntax other than 'make check', revise the
|
---|
| 137 | line to reflect the actual syntax to run the test suite -->
|
---|
| 138 |
|
---|
| 139 | <para>This package does not come with a test suite.</para>
|
---|
[4705fa4] | 140 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
[46daaa1] | 141 |
|
---|
[4705fa4] | 142 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[46daaa1] | 143 |
|
---|
[eaf6a1cd] | 144 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[46daaa1] | 145 |
|
---|
[4705fa4] | 146 | </sect2>
|
---|
[46daaa1] | 147 |
|
---|
[4705fa4] | 148 | <!--Optional section-->
|
---|
| 149 | <sect2 role="commands">
|
---|
| 150 | <title>Command Explanations</title>
|
---|
[46daaa1] | 151 |
|
---|
[4705fa4] | 152 | <para><command>COMMAND</command>: This command does something.</para>
|
---|
[46daaa1] | 153 |
|
---|
[fb3dd289] | 154 | <para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
|
---|
[4705fa4] | 155 | something mandatory for BLFS purposes.</para>
|
---|
[46daaa1] | 156 |
|
---|
[4705fa4] | 157 | <para><option>--OPTION</option>: This option does something optionally
|
---|
| 158 | per the user's desires.</para>
|
---|
[46daaa1] | 159 |
|
---|
[4705fa4] | 160 | </sect2>
|
---|
[46daaa1] | 161 |
|
---|
[4705fa4] | 162 | <!--Optional section-->
|
---|
| 163 | <sect2 role="configuration">
|
---|
| 164 | <title>Configuring TEMPLATE</title>
|
---|
[46daaa1] | 165 |
|
---|
[4705fa4] | 166 | <sect3 id="TEMPLATE-config">
|
---|
| 167 | <title>Config Files</title>
|
---|
[fb3dd289] | 168 | <para><filename>~/.Configfilename1</filename> and
|
---|
[4705fa4] | 169 | <filename>/etc/path/Configfilename2</filename></para>
|
---|
[46daaa1] | 170 |
|
---|
[4705fa4] | 171 | <indexterm zone="TEMPLATE TEMPLATE-config">
|
---|
| 172 | <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
|
---|
| 173 | </indexterm>
|
---|
[46daaa1] | 174 |
|
---|
[4705fa4] | 175 | <indexterm zone="TEMPLATE TEMPLATE-config">
|
---|
| 176 | <primary sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
|
---|
| 177 | </indexterm>
|
---|
| 178 | </sect3>
|
---|
[46daaa1] | 179 |
|
---|
[4705fa4] | 180 | <sect3><title>Configuration Information</title>
|
---|
[46daaa1] | 181 |
|
---|
[4705fa4] | 182 | <para>Blah blah blah about config.</para>
|
---|
[46daaa1] | 183 |
|
---|
[eaf6a1cd] | 184 | <screen><userinput>USER CONFIG COMMANDS</userinput></screen>
|
---|
[46daaa1] | 185 |
|
---|
[eaf6a1cd] | 186 | <screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
|
---|
[46daaa1] | 187 |
|
---|
[b8dba81] | 188 | <!-- File creation. Add the appropriate <indexterm> block if needed.-->
|
---|
[4705fa4] | 189 | <para>Create the file .... for ...</para>
|
---|
[46daaa1] | 190 |
|
---|
[eaf6a1cd] | 191 | <screen role="root"><userinput>cat >> /PATH/FILENAME << "EOF"
|
---|
| 192 | <literal># Begin FILENAME
|
---|
[46daaa1] | 193 |
|
---|
[eaf6a1cd] | 194 | TEXT
|
---|
[46daaa1] | 195 |
|
---|
[eaf6a1cd] | 196 | # End FILENAME</literal>
|
---|
| 197 | EOF</userinput></screen>
|
---|
[46daaa1] | 198 |
|
---|
[4705fa4] | 199 | </sect3>
|
---|
[46daaa1] | 200 |
|
---|
[4705fa4] | 201 | <sect3 id="TEMPLATE-init">
|
---|
| 202 | <title>Boot Script</title>
|
---|
[46daaa1] | 203 |
|
---|
[fb3dd289] | 204 | <para>To automatically start the <command>TEMPLATE</command> daemon
|
---|
| 205 | when the system is rebooted, install the
|
---|
[4ff86b9] | 206 | <filename>/etc/rc.d/init.d/TEMPLATE</filename>
|
---|
[fb3dd289] | 207 | bootscript from the
|
---|
[5254d12] | 208 | <xref linkend="bootscripts"/> package.</para>
|
---|
[46daaa1] | 209 |
|
---|
| 210 | <indexterm zone="TEMPLATE TEMPLATE-init">
|
---|
[4705fa4] | 211 | <primary sortas="f-TEMPLATE">TEMPLATE</primary>
|
---|
[46daaa1] | 212 | </indexterm>
|
---|
| 213 |
|
---|
[eaf6a1cd] | 214 | <screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
|
---|
[46daaa1] | 215 |
|
---|
[4705fa4] | 216 | </sect3>
|
---|
[46daaa1] | 217 |
|
---|
[4705fa4] | 218 | </sect2>
|
---|
[46daaa1] | 219 |
|
---|
| 220 | <!--Required section-->
|
---|
[4705fa4] | 221 | <sect2 role="content">
|
---|
| 222 | <title>Contents</title>
|
---|
[46daaa1] | 223 |
|
---|
[4705fa4] | 224 | <segmentedlist>
|
---|
| 225 | <segtitle>Installed Program(s)</segtitle>
|
---|
| 226 | <segtitle>Installed Librar(y,ies)</segtitle>
|
---|
| 227 | <segtitle>Installed Director(y,ies)</segtitle>
|
---|
[46daaa1] | 228 |
|
---|
[4705fa4] | 229 | <seglistitem>
|
---|
| 230 | <seg>PROGRAM1, PROGRAM2, and PROGRAM3</seg>
|
---|
| 231 | <seg>libLIBRARY1, libLIBRARY2, and libLIBRARY3</seg>
|
---|
[fb3dd289] | 232 | <seg>/etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
|
---|
| 233 | /usr/share/TEMPLATE-&TEMPLATE-version;,
|
---|
| 234 | /usr/share/doc/TEMPLATE-&TEMPLATE-version;, and
|
---|
[4705fa4] | 235 | /var/lib/TEMPLATE</seg>
|
---|
| 236 | </seglistitem>
|
---|
| 237 | </segmentedlist>
|
---|
[46daaa1] | 238 |
|
---|
[4705fa4] | 239 | <variablelist>
|
---|
| 240 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 241 | <?dbfo list-presentation="list"?>
|
---|
| 242 | <?dbhtml list-presentation="table"?>
|
---|
[46daaa1] | 243 |
|
---|
[fb3dd289] | 244 | <!-- If the program or library name conflicts (is the same) as the
|
---|
| 245 | package name, add -prog or -lib to the varlistentry entity id
|
---|
[4705fa4] | 246 | and the 2nd entry of the indexterm zone entity -->
|
---|
[46daaa1] | 247 |
|
---|
[4705fa4] | 248 | <varlistentry id="PROGRAM1">
|
---|
| 249 | <term><command>PROGRAM1</command></term>
|
---|
| 250 | <listitem>
|
---|
| 251 | <para>does this .....</para>
|
---|
| 252 | <indexterm zone="TEMPLATE PROGRAM1">
|
---|
| 253 | <primary sortas="b-PROGRAM1">PROGRAM1</primary>
|
---|
| 254 | </indexterm>
|
---|
| 255 | </listitem>
|
---|
| 256 | </varlistentry>
|
---|
[46daaa1] | 257 |
|
---|
[4705fa4] | 258 | <varlistentry id="PROGRAM2">
|
---|
| 259 | <term><command>PROGRAM2</command></term>
|
---|
| 260 | <listitem>
|
---|
| 261 | <para>does this .....</para>
|
---|
| 262 | <indexterm zone="TEMPLATE PROGRAM2">
|
---|
| 263 | <primary sortas="b-PROGRAM2">PROGRAM2</primary>
|
---|
| 264 | </indexterm>
|
---|
| 265 | </listitem>
|
---|
| 266 | </varlistentry>
|
---|
[46daaa1] | 267 |
|
---|
[4705fa4] | 268 | <varlistentry id="libLIBRARY1">
|
---|
[57b11363] | 269 | <term><filename class='libraryfile'>libLIBRARY1.{so,a}</filename></term>
|
---|
[4705fa4] | 270 | <listitem>
|
---|
| 271 | <para>contains functions that .....</para>
|
---|
| 272 | <indexterm zone="TEMPLATE libLIBRARY1">
|
---|
[57b11363] | 273 | <primary sortas="c-libLIBRARY1">libLIBRARY1.{so,a}</primary>
|
---|
[4705fa4] | 274 | </indexterm>
|
---|
| 275 | </listitem>
|
---|
| 276 | </varlistentry>
|
---|
[46daaa1] | 277 |
|
---|
[4705fa4] | 278 | </variablelist>
|
---|
[46daaa1] | 279 |
|
---|
[4705fa4] | 280 | </sect2>
|
---|
[f45b1953] | 281 |
|
---|
[46daaa1] | 282 | </sect1>
|
---|