source: template/template.xml@ 45ab6c7

11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 22 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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