source: template/template.xml@ 14aeac4

10.0 10.1 11.0 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 krejzi/svn nosym perl-modules qt5new systemd-11177 systemd-13485 trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 14aeac4 was 14aeac4, checked in by Andrew Benton <andy@…>, 10 years ago

Added --disable-static to the template

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@9671 af4574ff-66df-0310-9fd7-8a98e5e911e0

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