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