source: template/template.xml@ ca40dca

10.0 10.1 11.0 7.10 7.7 7.8 7.9 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 ca40dca was ca40dca, checked in by Pierre Labastie <pieere@…>, 7 years ago

Modify Kernel Configuration instructions for Xorg drivers, to use the same
format as in the LFS Kernel page

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

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