source: template/template.xml@ 66b546a

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 ken/refactor-virt krejzi/svn lazarus 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 66b546a was 66b546a, checked in by Andrew Benton <andy@…>, 10 years ago

python module tweaks

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@9802 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 <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 &amp;&amp;
165make</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 <para>
192 <option>--disable-static</option>: This prevents the installation of
193 static versions of the libraries.
194 </para>
195
196 <para>
197 <command>COMMAND</command>: This command does something.
198 </para>
199
200 <para>
201 <parameter>--SWITCH=PARAMETER</parameter>: This parameter does something
202 mandatory for BLFS purposes.
203 </para>
204
205 <para>
206 <option>--OPTION</option>: This option does something optionally per the
207 user's desires.
208 </para>
209 </sect2>
210
211 <!--Optional section-->
212 <sect2 role="configuration">
213 <title>Configuring TEMPLATE</title>
214
215 <sect3 id="TEMPLATE-config">
216 <title>Config Files</title>
217 <para>
218 <filename>~/.Configfilename1</filename> and
219 <filename>/etc/path/Configfilename2</filename>.
220 </para>
221
222 <indexterm zone="TEMPLATE TEMPLATE-config">
223 <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
224 </indexterm>
225
226 <indexterm zone="TEMPLATE TEMPLATE-config">
227 <primary
228 sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
229 </indexterm>
230 </sect3>
231
232 <sect3><title>Configuration Information</title>
233
234 <para>
235 Blah blah blah about config.
236 </para>
237
238<screen><userinput>USER CONFIG COMMANDS</userinput></screen>
239
240<screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
241
242 <!-- File creation. Add the appropriate <indexterm> block if needed.-->
243 <para>
244 Create the file .... for ...
245 </para>
246
247<screen role="root"><userinput>cat &gt;&gt; /PATH/FILENAME &lt;&lt; "EOF"
248<literal># Begin FILENAME
249
250TEXT
251
252# End FILENAME</literal>
253EOF</userinput></screen>
254 </sect3>
255
256 <sect3 id="TEMPLATE-init">
257 <title>Boot Script</title>
258
259 <para>
260 To automatically start the <command>TEMPLATE</command> daemon when the
261 system is rebooted, install the
262 <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
263 <xref linkend="bootscripts"/> package.
264 </para>
265
266 <indexterm zone="TEMPLATE TEMPLATE-init">
267 <primary sortas="f-TEMPLATE">TEMPLATE</primary>
268 </indexterm>
269
270<screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
271 </sect3>
272 </sect2>
273
274 <!--Required section-->
275 <sect2 role="content">
276 <title>Contents</title>
277
278 <segmentedlist>
279 <segtitle>Installed Program(s)</segtitle>
280 <segtitle>Installed Librar(y,ies)</segtitle>
281 <segtitle>Installed Director(y,ies)</segtitle>
282
283 <seglistitem>
284 <seg>
285 PROGRAM1, PROGRAM2 and PROGRAM3.
286 </seg>
287 <seg>
288 libLIBRARY1.so, libLIBRARY2.so and libLIBRARY3.so.
289 </seg>
290 <seg>
291 /etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
292 /usr/share/TEMPLATE-&TEMPLATE-version;,
293 /usr/share/doc/TEMPLATE-&TEMPLATE-version; and
294 /var/lib/TEMPLATE.
295 </seg>
296 </seglistitem>
297 </segmentedlist>
298
299 <variablelist>
300 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
301 <?dbfo list-presentation="list"?>
302 <?dbhtml list-presentation="table"?>
303
304 <!-- If the program or library name conflicts (is the same) as the
305 package name, add -prog or -lib to the varlistentry entity id
306 and the 2nd entry of the indexterm zone entity -->
307
308 <varlistentry id="PROGRAM1">
309 <term><command>PROGRAM1</command></term>
310 <listitem>
311 <para>
312 does this .....
313 </para>
314 <indexterm zone="TEMPLATE PROGRAM1">
315 <primary sortas="b-PROGRAM1">PROGRAM1</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 <varlistentry id="PROGRAM2">
321 <term><command>PROGRAM2</command></term>
322 <listitem>
323 <para>
324 does this .....
325 </para>
326 <indexterm zone="TEMPLATE PROGRAM2">
327 <primary sortas="b-PROGRAM2">PROGRAM2</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="libLIBRARY1">
333 <term><filename class="libraryfile">libLIBRARY1.so</filename></term>
334 <listitem>
335 <para>
336 contains functions that .....
337 </para>
338 <indexterm zone="TEMPLATE libLIBRARY1">
339 <primary sortas="c-libLIBRARY1">libLIBRARY1.so</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343 </variablelist>
344 </sect2>
345</sect1>
Note: See TracBrowser for help on using the repository browser.