source: template/template.xml@ bfd20b5

10.1 11.0 lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since bfd20b5 was bfd20b5, checked in by Douglas R. Reno <renodr@…>, 12 months ago

Template: update to lfs10 for the tags
Brotli: Adapt sed to be more consistent with others in the book

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

  • Property mode set to 100644
File size: 15.1 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<!-- SBU should be rounded to integer if greater than 10, to one
18 decimal if below 10, and should be "less than 0.1 SBU" if
19 below 0.1. If the SBU without parallelisation is too long,
20 it is acceptable to give the value "with parallelism=N", where
21 N is the number of threads used. Note that some build system
22 automatically fix N equal to the number of available CPU cores
23 on the machine. -->
24]>
25
26<!-- Try to keep the indentation used in this file-->
27<sect1 id="TEMPLATE" xreflabel="TEMPLATE-&TEMPLATE-version;">
28 <?dbhtml filename="TEMPLATE.html"?>
29
30 <sect1info>
31 <!-- this part gets updated when you commit, IFF you set the properties:
32 first, svn add path/to/thisfile.xml and then
33 svn propset svn:mime-type text/plain path/to/thisfile.xml and
34 svn propset svn:keywords "Date LastChangedBy" path/to/thisfile.xml -->
35 <othername>$LastChangedBy$</othername>
36 <date>$Date$</date>
37 </sect1info>
38
39 <!-- No other tags inside any title.
40 Use Title Case in All Titles -->
41 <title>TEMPLATE-&TEMPLATE-version;</title>
42
43 <indexterm zone="TEMPLATE">
44 <primary sortas="a-TEMPLATE">TEMPLATE</primary>
45 </indexterm>
46
47 <!--Required section-->
48 <sect2 role="package">
49 <title>Introduction to TEMPLATE</title>
50
51 <para>
52 The <application>TEMPLATE</application> package contains...
53 This is useful for...
54 </para>
55
56 <!-- if it builds but hasn't been tested: -->
57 &lfs1?_built;
58 <!-- if it works: -->
59 &lfs1?_checked;
60
61 <bridgehead renderas="sect3">Package Information</bridgehead>
62 <itemizedlist spacing="compact">
63 <listitem>
64 <para>
65 Download (HTTP): <ulink url="&TEMPLATE-download-http;"/>
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Download (FTP): <ulink url="&TEMPLATE-download-ftp;"/>
71 </para>
72 </listitem>
73 <listitem>
74 <para>
75 Download MD5 sum: &TEMPLATE-md5sum;
76 </para>
77 </listitem>
78 <listitem>
79 <para>
80 Download size: &TEMPLATE-size;
81 </para>
82 </listitem>
83 <listitem>
84 <para>
85 Estimated disk space required: &TEMPLATE-buildsize;
86 </para>
87 </listitem>
88 <listitem>
89 <para>
90 Estimated build time: &TEMPLATE-time;
91 </para>
92 </listitem>
93 </itemizedlist>
94
95 <!-- As required -->
96 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
97 <itemizedlist spacing="compact">
98 <listitem>
99 <para>
100 Required patch:
101 <ulink url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/>
102 </para>
103 </listitem>
104 </itemizedlist>
105
106 <bridgehead renderas="sect3">TEMPLATE Dependencies</bridgehead>
107
108 <bridgehead renderas="sect4">Required</bridgehead>
109 <para role="required">
110 <xref linkend="BLFS_DEPENDENCY"/> <!-- notice no period as this is not
111 a sentence. If there are more than two, they must be separated by commas
112 with the last member having "and" in front of it. The use of a serial
113 comma is preferred (a comma after the next to last member before the
114 "and"). BLFS_DEPENDENCY should be an "id" attribute defined somewhere
115 in the book (usually in a <sect1>). -->
116 <xref role="runtime" linkend="RUNTIME_DEPENDENCY"/> (runtime)
117 <!-- Specifying that a dependency is a runtime one, may avoid circular
118 dependencies. Add role="runtime" to help jhalfs -->
119 </para>
120
121 <!-- It may be nice to have a separate section for runtime dependencies.
122 Do it as follows. -->
123 <bridgehead renderas="sect4">Required at runtime</bridgehead>
124 <para role="required">
125 <xref role="runtime" linkend="RUNTIME_DEPENDENCY"/>
126 </para>
127
128 <!-- As required -->
129 <bridgehead renderas="sect4">Recommended</bridgehead>
130 <para role="recommended">
131 <xref linkend="BLFS_DEPENDENCY"/> <!-- notice no period as this is not
132 a sentence. See above for the use of "and" and commas. Normally, neither
133 required nor recommended dependencies should be <ulink>. -->
134 <xref linkend="ANOTHER_RECOMMENDED_DEP"/> (required if building
135 <xref role="nodep" linkend="SOME_FANCY_PACKAGE"/>) <!-- You may need
136 to refer to another package, which is not a dependency. Use the role
137 attibute with value "nodep". -->
138 <!-- See above for runtime dependencies -->
139 </para>
140
141 <!-- As required -->
142 <bridgehead renderas="sect4">Optional</bridgehead>
143 <para role="optional">
144 <xref linkend="BLFS_DEPENDENCY"/> and
145 <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>
146 <!-- notice no period as this is not a sentence. See above for the use
147 of commas and "and". The order should <xref> before <ulink>.-->
148 <!-- See above how to refer to another package, which is not a
149 dependency. -->
150 </para>
151
152 <para condition="html" role="usernotes">
153 User Notes: <ulink url="&blfs-wiki;/TEMPLATE"/>
154 </para>
155 </sect2>
156
157 <!-- Optional section for packages that need a specific kernel
158 configuration-->
159 <sect2 role="kernel" id="TEMPLATE-kernel">
160 <title>Kernel Configuration</title>
161
162 <para>
163 Enable the following options in the kernel configuration and recompile the
164 kernel if necessary:
165 </para>
166
167<!-- Spaces are significant in <screen> sections -->
168<screen><literal>Master section ---&gt;
169 Subsection ---&gt;
170 [*] Required parameter [CONFIG_REQU_PAR]
171 &lt;*&gt; Required parameter (not as module) [CONFIG_REQU_PAR_NMOD]
172 &lt;*/M&gt; Required parameter (could be a module) [CONFIG_REQU_PAR_MOD]
173 &lt;*/M/ &gt; Optional parameter [CONFIG_OPT_PAR]
174 [ ] Incompatible parameter [CONFIG_INCOMP_PAR]
175 &lt; &gt; Incompatible parameter (even as module) [CONFIG_INCOMP_PAR_MOD]</literal></screen>
176
177 <para>
178 Select the appropriate sub-options that appear when the above options are
179 selected. As much as possible, the layout should be the same as in
180 kernel menus.
181 </para>
182
183 <indexterm zone="TEMPLATE TEMPLATE-kernel">
184 <primary sortas="d-TEMPLATE">TEMPLATE</primary>
185 </indexterm>
186 </sect2>
187
188 <!--Required section-->
189 <sect2 role="installation">
190 <title>Installation of TEMPLATE</title>
191
192 <para>
193 Install <application>TEMPLATE</application> by running the following
194 commands:
195 </para>
196
197<!-- Spaces are significant in <screen> sections -->
198<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
199make</userinput></screen>
200
201 <!-- Optional paragraph. Add it when some instructions for building
202 documentation need optional or external packages. The remap="doc"
203 attribute signals those kind of instructions. Note: instructions
204 for generating documentation that can be built with
205 recommended/required/LFS book packages may be included in the
206 same block as configure and make. -->
207
208 <para>
209 If you have installed <xref linkend="optional-dep"/>, you can build
210 the documentation (or additional formats of the documentation) by issuing: </para>
211
212<screen remap="doc"><userinput>make -C doc pdf</userinput></screen>
213
214 <!-- adjust the instructions as needed. -->
215
216
217 <!-- Optional paragraph. Use one of the two mentions below about a test
218 suite, delete the line that is not applicable. Of course, if the
219 test suite uses syntax other than 'make check', revise the
220 line to reflect the actual syntax to run the test suite -->
221
222 <para>
223 This package does not come with a test suite.
224 </para>
225
226 <para>
227 To test the results, issue: <command>make check</command>.
228 </para>
229
230 <!-- Sometimes, more complex instructions are needed for running tests, or
231 they need to be run as root. They can then be put inside screen
232 tags using the remap="test" attribute as in the following example: -->
233
234 <para>
235 If you want to run the tests, first create some needed files:
236 </para>
237
238<screen remap="test"><userinput>make prepare-tests</userinput></screen>
239
240 <para>
241 Then run the tests as the <systemitem class="username">root</systemitem>
242 user:
243 </para>
244
245<screen role="root" remap="test"><userinput>make tests</userinput></screen>
246
247 <para>
248 Now, as the <systemitem class="username">root</systemitem> user:
249 </para>
250
251<screen role="root"><userinput>make install</userinput></screen>
252 </sect2>
253
254 <!-- Optional paragraph for documentation that has been generated using
255 optional/external packages: -->
256
257 <para>
258 If you have built the optional documentation, install it as the
259 <systemitem class="username">root</systemitem> user:
260 </para>
261
262<screen role="root"
263 remap="doc"><userinput>install -vdm 755 /usr/share/doc/template-&template-version; &amp;&amp;
264mv doc/* /usr/share/doc/template-&template-version;</userinput></screen>
265
266 <!--Optional section-->
267 <sect2 role="commands">
268 <title>Command Explanations</title>
269
270 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
271 href="../../xincludes/static-libraries.xml"/>
272
273 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
274 href="../../xincludes/gtk-doc-rebuild.xml"/>
275
276 <para>
277 <command>COMMAND</command>: This command does something.
278 </para>
279
280 <para>
281 <parameter>--PARAMETER</parameter>: This parameter does something
282 mandatory for BLFS purposes. It will be in the instructions above. It is
283 not optional and is why it is listed as a parameter and not an option.
284 </para>
285
286 <para>
287 <option>--OPTION</option>: This option does something optionally per the
288 user's desires. It is not listed in the instructions above, but instead,
289 is listed here because many (some) readers may want to include it.
290 </para>
291 </sect2>
292
293 <sect2 role="using">
294 <title>Using TEMPLATE</title>
295
296 <para>
297 Stuff about how to use TEMPLATE to do something. This section is rarely
298 used.
299 </para>
300 </sect2>
301
302 <!--Optional section-->
303 <sect2 role="configuration">
304 <title>Configuring TEMPLATE</title>
305
306 <sect3 id="TEMPLATE-config">
307 <title>Config Files</title>
308 <para>
309 <filename>~/.Configfilename1</filename> and
310 <filename>/etc/path/Configfilename2</filename> <!-- notice no period as this is not a sentence-->
311 </para>
312
313 <indexterm zone="TEMPLATE TEMPLATE-config">
314 <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
315 </indexterm>
316
317 <indexterm zone="TEMPLATE TEMPLATE-config">
318 <primary
319 sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
320 </indexterm>
321 </sect3>
322
323 <sect3><title>Configuration Information</title>
324
325 <para>
326 Blah blah blah about config.
327 </para>
328
329<screen><userinput>USER CONFIG COMMANDS</userinput></screen>
330
331<screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
332
333 <!-- File creation. Add the appropriate <indexterm> block if needed.-->
334 <para>
335 Create the file .... for ...
336 </para>
337
338<screen role="root"><userinput>cat &gt;&gt; /PATH/FILENAME &lt;&lt; "EOF"
339<literal># Begin FILENAME
340
341TEXT
342
343# End FILENAME</literal>
344EOF</userinput></screen>
345 </sect3>
346
347 <sect3 id="TEMPLATE-init">
348 <title>Boot Script</title>
349
350 <para>
351 To automatically start the <command>TEMPLATE</command> daemon when the
352 system is rebooted, install the
353 <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
354 <xref linkend="bootscripts" revision="sysv"/>
355 <xref linkend="systemd-units" revision="systemd"/> package as the
356 <systemitem class="username">root</systemitem> user:
357 </para>
358
359 <indexterm zone="TEMPLATE TEMPLATE-init">
360 <primary sortas="f-TEMPLATE">TEMPLATE</primary>
361 </indexterm>
362
363<screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
364 </sect3>
365 </sect2>
366
367 <!--Required section-->
368 <sect2 role="content">
369 <title>Contents</title>
370
371 <segmentedlist>
372 <segtitle>Installed Program(s)</segtitle>
373 <segtitle>Installed Librar(y,ies)</segtitle>
374 <segtitle>Installed Director(y,ies)</segtitle>
375
376 <!-- If there were no programs, libraries, or directories created, then
377 we would list the section as "None". However, a decision must have
378 been made to change the "None" to just removing the whole section
379 because I've noticed that many packages have had the "None"
380 removed and the section completely removed as well. The reasoning
381 was that by putting "None", it appears as we know there are none.
382 Without anything it appears as we are not sure. -->
383
384 <seglistitem>
385 <seg>
386 PROGRAM1, PROGRAM2 and PROGRAM3.
387 </seg>
388 <seg>
389 libLIBRARY1.so, libLIBRARY2.so and libLIBRARY3.so.
390 </seg>
391 <seg>
392 /etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
393 /usr/share/TEMPLATE-&TEMPLATE-version;,
394 /usr/share/doc/TEMPLATE-&TEMPLATE-version; and
395 /var/lib/TEMPLATE.
396 </seg>
397 </seglistitem>
398 </segmentedlist>
399
400 <variablelist>
401 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
402 <?dbfo list-presentation="list"?>
403 <?dbhtml list-presentation="table"?>
404
405 <!-- If the program or library name conflicts (is the same) as the
406 package name, add -prog or -lib to the varlistentry entity id
407 and the 2nd entry of the indexterm zone entity -->
408
409 <varlistentry id="PROGRAM1">
410 <term><command>PROGRAM1</command></term>
411 <listitem>
412 <para>
413 does this ..... (end the sentence with a period).
414 </para>
415 <indexterm zone="TEMPLATE PROGRAM1">
416 <primary sortas="b-PROGRAM1">PROGRAM1</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="PROGRAM2">
422 <term><command>PROGRAM2</command></term>
423 <listitem>
424 <para>
425 does this ..... (end the sentence with a period).
426 </para>
427 <indexterm zone="TEMPLATE PROGRAM2">
428 <primary sortas="b-PROGRAM2">PROGRAM2</primary>
429 </indexterm>
430 </listitem>
431 </varlistentry>
432
433 <varlistentry id="libLIBRARY1">
434 <term><filename class="libraryfile">libLIBRARY1.so</filename></term>
435 <listitem>
436 <para>
437 contains functions that ..... (end the sentence with a period).
438 </para>
439 <indexterm zone="TEMPLATE libLIBRARY1">
440 <primary sortas="c-libLIBRARY1">libLIBRARY1.so</primary>
441 </indexterm>
442 </listitem>
443 </varlistentry>
444 </variablelist>
445 </sect2>
446</sect1>
Note: See TracBrowser for help on using the repository browser.