source: template/template.xml@ 8d52d869

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 8d52d869 was 3ca8be3, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

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