source: template/template.xml@ f3e3b83

10.0 10.1 11.0 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since f3e3b83 was f3e3b83, checked in by Douglas R. Reno <renodr@…>, 3 years ago

Revert typo fix.

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

  • Property mode set to 100644
File size: 13.3 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 <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 follow. -->
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 section. Use one of the two mentions below about a test
202 suite, delete the line that is not applicable. Of course, if the
203 test suite uses syntax other than 'make check', revise the
204 line to reflect the actual syntax to run the test suite -->
205
206 <para>
207 This package does not come with a test suite.
208 </para>
209
210 <para>
211 To test the results, issue: <command>make check</command>.
212 </para>
213
214 <para>
215 Now, as the <systemitem class="username">root</systemitem> user:
216 </para>
217
218<screen role="root"><userinput>make install</userinput></screen>
219 </sect2>
220
221 <!--Optional section-->
222 <sect2 role="commands">
223 <title>Command Explanations</title>
224
225 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
226 href="../../xincludes/static-libraries.xml"/>
227
228 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
229 href="../../xincludes/gtk-doc-rebuild.xml"/>
230
231 <para>
232 <command>COMMAND</command>: This command does something.
233 </para>
234
235 <para>
236 <parameter>--PARAMETER</parameter>: This parameter does something
237 mandatory for BLFS purposes. It will be in the instructions above. It is
238 not optional and is why it is listed as a parameter and not an option.
239 </para>
240
241 <para>
242 <option>--OPTION</option>: This option does something optionally per the
243 user's desires. It is not listed in the instructions above, but instead,
244 is listed here because many (some) readers may want to include it.
245 </para>
246 </sect2>
247
248 <sect2 role="using">
249 <title>Using TEMPLATE</title>
250
251 <para>
252 Stuff about how to use TEMPLATE to do something. This section is rarely
253 used.
254 </para>
255 </sect2>
256
257 <!--Optional section-->
258 <sect2 role="configuration">
259 <title>Configuring TEMPLATE</title>
260
261 <sect3 id="TEMPLATE-config">
262 <title>Config Files</title>
263 <para>
264 <filename>~/.Configfilename1</filename> and
265 <filename>/etc/path/Configfilename2</filename> <!-- notice no period as this is not a sentence-->
266 </para>
267
268 <indexterm zone="TEMPLATE TEMPLATE-config">
269 <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
270 </indexterm>
271
272 <indexterm zone="TEMPLATE TEMPLATE-config">
273 <primary
274 sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
275 </indexterm>
276 </sect3>
277
278 <sect3><title>Configuration Information</title>
279
280 <para>
281 Blah blah blah about config.
282 </para>
283
284<screen><userinput>USER CONFIG COMMANDS</userinput></screen>
285
286<screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
287
288 <!-- File creation. Add the appropriate <indexterm> block if needed.-->
289 <para>
290 Create the file .... for ...
291 </para>
292
293<screen role="root"><userinput>cat &gt;&gt; /PATH/FILENAME &lt;&lt; "EOF"
294<literal># Begin FILENAME
295
296TEXT
297
298# End FILENAME</literal>
299EOF</userinput></screen>
300 </sect3>
301
302 <sect3 id="TEMPLATE-init">
303 <title>Boot Script</title>
304
305 <para>
306 To automatically start the <command>TEMPLATE</command> daemon when the
307 system is rebooted, install the
308 <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
309 <xref linkend="bootscripts" revision="sysv"/>
310 <xref linkend="systemd-units" revision="systemd"/> package as the
311 <systemitem class="username">root</systemitem> user:
312 </para>
313
314 <indexterm zone="TEMPLATE TEMPLATE-init">
315 <primary sortas="f-TEMPLATE">TEMPLATE</primary>
316 </indexterm>
317
318<screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
319 </sect3>
320 </sect2>
321
322 <!--Required section-->
323 <sect2 role="content">
324 <title>Contents</title>
325
326 <segmentedlist>
327 <segtitle>Installed Program(s)</segtitle>
328 <segtitle>Installed Librar(y,ies)</segtitle>
329 <segtitle>Installed Director(y,ies)</segtitle>
330
331 <!-- If there were no programs, libraries, or directories created, then
332 we would list the section as "None". However, a decision must have
333 been made to change the "None" to just removing the whole section
334 because I've noticed that many packages have had the "None"
335 removed and the section completely removed as well. The reasoning
336 was that by putting "None", it appears as we know there are none.
337 Without anything it appears as we are not sure. -->
338
339 <seglistitem>
340 <seg>
341 PROGRAM1, PROGRAM2 and PROGRAM3.
342 </seg>
343 <seg>
344 libLIBRARY1.so, libLIBRARY2.so and libLIBRARY3.so.
345 </seg>
346 <seg>
347 /etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
348 /usr/share/TEMPLATE-&TEMPLATE-version;,
349 /usr/share/doc/TEMPLATE-&TEMPLATE-version; and
350 /var/lib/TEMPLATE.
351 </seg>
352 </seglistitem>
353 </segmentedlist>
354
355 <variablelist>
356 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
357 <?dbfo list-presentation="list"?>
358 <?dbhtml list-presentation="table"?>
359
360 <!-- If the program or library name conflicts (is the same) as the
361 package name, add -prog or -lib to the varlistentry entity id
362 and the 2nd entry of the indexterm zone entity -->
363
364 <varlistentry id="PROGRAM1">
365 <term><command>PROGRAM1</command></term>
366 <listitem>
367 <para>
368 does this ..... (end the sentence with a period).
369 </para>
370 <indexterm zone="TEMPLATE PROGRAM1">
371 <primary sortas="b-PROGRAM1">PROGRAM1</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="PROGRAM2">
377 <term><command>PROGRAM2</command></term>
378 <listitem>
379 <para>
380 does this ..... (end the sentence with a period).
381 </para>
382 <indexterm zone="TEMPLATE PROGRAM2">
383 <primary sortas="b-PROGRAM2">PROGRAM2</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="libLIBRARY1">
389 <term><filename class="libraryfile">libLIBRARY1.so</filename></term>
390 <listitem>
391 <para>
392 contains functions that ..... (end the sentence with a period).
393 </para>
394 <indexterm zone="TEMPLATE libLIBRARY1">
395 <primary sortas="c-libLIBRARY1">libLIBRARY1.so</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399 </variablelist>
400 </sect2>
401</sect1>
Note: See TracBrowser for help on using the repository browser.