source: template/template.xml@ 161767fb

10.0 10.1 11.0 7.10 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus nosym perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 161767fb was 161767fb, checked in by Pierre Labastie <pieere@…>, 7 years ago

Actualise template for "Kernel Configuration" style + minor changes
according to what has been discussed on the list(s) in the last months
(ordering of deps)

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

  • Property mode set to 100644
File size: 11.7 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 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
100 a sentence. If there are more than two, they must be separated by commas
101 with the last member having "and" in front of it. The use of a serial
102 comma is preferred (a comma after the next to last member before the
103 "and"). BLFS_DEPENDENCY should be an "id" attribute defined somewhere
104 in the book (usually in a <sect1>). -->
105 </para>
106
107 <!-- As required -->
108 <bridgehead renderas="sect4">Recommended</bridgehead>
109 <para role="recommended">
110 <xref linkend="BLFS_DEPENDENCY"/> <!-- notice no period as this is not
111 a sentence. See above for the use of "and" and commas. Normally, neither
112 required nor recommended dependencies should be <ulink>. -->
113 </para>
114
115 <!-- As required -->
116 <bridgehead renderas="sect4">Optional</bridgehead>
117 <para role="optional">
118 <xref linkend="BLFS_DEPENDENCY"/> and
119 <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>
120 <!-- notice no period as this is not a sentence. See above for the use
121 of commas and "and". The order should <xref> before <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 ---&gt;
141 Subsection ---&gt;
142 [*] Required parameter [CONFIG_REQU_PAR]
143 &lt;*&gt; Required parameter (not as module) [CONFIG_REQU_PAR_NMOD]
144 &lt;*/M&gt; Required parameter (could be a module) [CONFIG_REQU_PAR_MOD]
145 &lt;*/M/ &gt; Optional parameter [CONFIG_OPT_PAR]
146 [ ] Incompatible parameter [CONFIG_INCOMP_PAR]
147 &lt; &gt; Incompatible parameter (even as module) [CONFIG_INCOMP_PAR_MOD]</literal></screen>
148
149 <para>
150 Select the appropriate sub-options that appear when the above options are
151 selected. As much as possible, the layout should be the same as in
152 kernel menus.
153 </para>
154
155 <indexterm zone="TEMPLATE TEMPLATE-kernel">
156 <primary sortas="d-TEMPLATE">TEMPLATE</primary>
157 </indexterm>
158 </sect2>
159
160 <!--Required section-->
161 <sect2 role="installation">
162 <title>Installation of TEMPLATE</title>
163
164 <para>
165 Install <application>TEMPLATE</application> by running the following
166 commands:
167 </para>
168
169<!-- Spaces are significant in <screen> sections -->
170<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
171make</userinput></screen>
172
173 <!-- Optional section. Use one of the two mentions below about a test
174 suite, delete the line that is not applicable. Of course, if the
175 test suite uses syntax other than 'make check', revise the
176 line to reflect the actual syntax to run the test suite -->
177
178 <para>
179 This package does not come with a test suite.
180 </para>
181
182 <para>
183 To test the results, issue: <command>make check</command>.
184 </para>
185
186 <para>
187 Now, as the <systemitem class="username">root</systemitem> user:
188 </para>
189
190<screen role="root"><userinput>make install</userinput></screen>
191 </sect2>
192
193 <!--Optional section-->
194 <sect2 role="commands">
195 <title>Command Explanations</title>
196
197 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
198 href="../../xincludes/static-libraries.xml"/>
199
200 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
201 href="../../xincludes/gtk-doc-rebuild.xml"/>
202
203 <para>
204 <command>COMMAND</command>: This command does something.
205 </para>
206
207 <para>
208 <parameter>--PARAMETER</parameter>: This parameter does something
209 mandatory for BLFS purposes. It will be in the instructions above. It is
210 not optional and is why it is listed as a parameter and not an option.
211 </para>
212
213 <para>
214 <option>--OPTION</option>: This option does something optionally per the
215 user's desires. It is not listed in the instructions above, but instead,
216 is listed here because many (some) readers may want to include it.
217 </para>
218 </sect2>
219
220 <sect2 role="using">
221 <title>Using TEMPLATE</title>
222
223 <para>
224 Stuff about how to use TEMPLATE to do something. This section is rarely
225 used.
226 </para>
227 </sect2>
228
229 <!--Optional section-->
230 <sect2 role="configuration">
231 <title>Configuring TEMPLATE</title>
232
233 <sect3 id="TEMPLATE-config">
234 <title>Config Files</title>
235 <para>
236 <filename>~/.Configfilename1</filename> and
237 <filename>/etc/path/Configfilename2</filename> <!-- notice no period as this is not a sentence-->
238 </para>
239
240 <indexterm zone="TEMPLATE TEMPLATE-config">
241 <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
242 </indexterm>
243
244 <indexterm zone="TEMPLATE TEMPLATE-config">
245 <primary
246 sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
247 </indexterm>
248 </sect3>
249
250 <sect3><title>Configuration Information</title>
251
252 <para>
253 Blah blah blah about config.
254 </para>
255
256<screen><userinput>USER CONFIG COMMANDS</userinput></screen>
257
258<screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
259
260 <!-- File creation. Add the appropriate <indexterm> block if needed.-->
261 <para>
262 Create the file .... for ...
263 </para>
264
265<screen role="root"><userinput>cat &gt;&gt; /PATH/FILENAME &lt;&lt; "EOF"
266<literal># Begin FILENAME
267
268TEXT
269
270# End FILENAME</literal>
271EOF</userinput></screen>
272 </sect3>
273
274 <sect3 id="TEMPLATE-init">
275 <title>Boot Script</title>
276
277 <para>
278 To automatically start the <command>TEMPLATE</command> daemon when the
279 system is rebooted, install the
280 <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
281 <xref linkend="bootscripts"/> package as the
282 <systemitem class="username">root</systemitem> user:
283 </para>
284
285 <indexterm zone="TEMPLATE TEMPLATE-init">
286 <primary sortas="f-TEMPLATE">TEMPLATE</primary>
287 </indexterm>
288
289<screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
290 </sect3>
291 </sect2>
292
293 <!--Required section-->
294 <sect2 role="content">
295 <title>Contents</title>
296
297 <segmentedlist>
298 <segtitle>Installed Program(s)</segtitle>
299 <segtitle>Installed Librar(y,ies)</segtitle>
300 <segtitle>Installed Director(y,ies)</segtitle>
301
302 <!-- If there were no programs, libraries, or directories created, then
303 we would list the section as "None". However, a decision must have
304 been made to change the "None" to just removing the whole section
305 because I've noticed that many packages have had the "None"
306 removed and the section completely removed as well. The reasoning
307 was that by putting "None", it appears as we know there are none.
308 Without anything it appears as we are not sure. -->
309
310 <seglistitem>
311 <seg>
312 PROGRAM1, PROGRAM2 and PROGRAM3.
313 </seg>
314 <seg>
315 libLIBRARY1.so, libLIBRARY2.so and libLIBRARY3.so.
316 </seg>
317 <seg>
318 /etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
319 /usr/share/TEMPLATE-&TEMPLATE-version;,
320 /usr/share/doc/TEMPLATE-&TEMPLATE-version; and
321 /var/lib/TEMPLATE.
322 </seg>
323 </seglistitem>
324 </segmentedlist>
325
326 <variablelist>
327 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
328 <?dbfo list-presentation="list"?>
329 <?dbhtml list-presentation="table"?>
330
331 <!-- If the program or library name conflicts (is the same) as the
332 package name, add -prog or -lib to the varlistentry entity id
333 and the 2nd entry of the indexterm zone entity -->
334
335 <varlistentry id="PROGRAM1">
336 <term><command>PROGRAM1</command></term>
337 <listitem>
338 <para>
339 does this ..... (end the sentence with a period).
340 </para>
341 <indexterm zone="TEMPLATE PROGRAM1">
342 <primary sortas="b-PROGRAM1">PROGRAM1</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="PROGRAM2">
348 <term><command>PROGRAM2</command></term>
349 <listitem>
350 <para>
351 does this ..... (end the sentence with a period).
352 </para>
353 <indexterm zone="TEMPLATE PROGRAM2">
354 <primary sortas="b-PROGRAM2">PROGRAM2</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="libLIBRARY1">
360 <term><filename class="libraryfile">libLIBRARY1.so</filename></term>
361 <listitem>
362 <para>
363 contains functions that ..... (end the sentence with a period).
364 </para>
365 <indexterm zone="TEMPLATE libLIBRARY1">
366 <primary sortas="c-libLIBRARY1">libLIBRARY1.so</primary>
367 </indexterm>
368 </listitem>
369 </varlistentry>
370 </variablelist>
371 </sect2>
372</sect1>
Note: See TracBrowser for help on using the repository browser.