source: template/template.xml@ 1ae4746

10.0 10.1 11.0 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 1ae4746 was 1ae4746, checked in by Pierre Labastie <pieere@…>, 5 years ago

Fix non standard SBUs and update template so that new users use
the same rules

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

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