source: template/template.xml@ a5ae8bf

10.0 10.1 11.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since a5ae8bf was a5ae8bf, checked in by Bruce Dubbs <bdubbs@…>, 4 years ago

Update md5sum

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

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