source: template/template.xml@ 10ce9fe

10.0 10.1 11.0 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 krejzi/svn nosym perl-modules qt5new systemd-11177 systemd-13485 trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 10ce9fe was 10ce9fe, checked in by Randy McMurchy <randy@…>, 15 years ago

Fixed the Template file after the sed insert

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

  • Property mode set to 100644
File size: 9.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!-- Place this in the general.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 <keywordset>
27 <!-- The actual package name but without .bz2 or .gz extension -->
28 <keyword role="package">TEMPLATE-&TEMPLATE-version;.tar</keyword>
29 <!-- The subdir under BLFS/conglomeration/ in where the package
30 is stored on the FTP mirrors -->
31 <keyword role="ftpdir">TEMPLATE</keyword>
32 </keywordset>
33 </sect1info>
34
35 <!-- No other tags inside any title-->
36 <!-- Use Title Case in All Titles
37 The "The Chicago Manual of Style":
38 "-Always capitalize the first and the last word.
39 -Capitalize all nouns, pronouns, adjectives, verbs, adverbs, and
40 subordinate conjunctions ("as", "because", "although").
41 -Lowercase all articles, coordinate conjunctions ("and", "or", "nor"),
42 and prepositions regardless of length, when they are other than the
43 first or last word.
44 -Lowercase the "to" in an infinitive."-->
45 <title>TEMPLATE-&TEMPLATE-version;</title>
46
47 <indexterm zone="TEMPLATE">
48 <primary sortas="a-TEMPLATE">TEMPLATE</primary>
49 </indexterm>
50
51 <!--Required section-->
52 <sect2 role="package">
53 <title>Introduction to TEMPLATE</title>
54
55 <para>The <application>TEMPLATE</application> package contains...
56 This is useful for...</para>
57
58 <bridgehead renderas="sect3">Package Information</bridgehead>
59 <itemizedlist spacing="compact">
60 <listitem>
61 <para>Download (HTTP): <ulink url="&TEMPLATE-download-http;"/></para>
62 </listitem>
63 <listitem>
64 <para>Download (FTP): <ulink url="&TEMPLATE-download-ftp;"/></para>
65 </listitem>
66 <listitem>
67 <para>Download MD5 sum: &TEMPLATE-md5sum;</para>
68 </listitem>
69 <listitem>
70 <para>Download size: &TEMPLATE-size;</para>
71 </listitem>
72 <listitem>
73 <para>Estimated disk space required: &TEMPLATE-buildsize;</para>
74 </listitem>
75 <listitem>
76 <para>Estimated build time: &TEMPLATE-time;</para>
77 </listitem>
78 </itemizedlist>
79
80 <!-- As required -->
81 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
82 <itemizedlist spacing="compact">
83 <listitem>
84 <para>Required patch: <ulink
85 url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
86 </listitem>
87 </itemizedlist>
88
89 <bridgehead renderas="sect3">TEMPLATE Dependencies</bridgehead>
90
91 <bridgehead renderas="sect4">Required</bridgehead>
92 <para role="required"><xref linkend="BLFS DEPENDENCY"/></para>
93
94 <!-- As required -->
95 <bridgehead renderas="sect4">Recommended</bridgehead>
96 <para role="recommended"><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>,
97 <xref linkend="BLFS DEPENDENCY"/></para>
98
99 <!-- As required -->
100 <bridgehead renderas="sect4">Optional</bridgehead>
101 <para role="optional"><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para>
102
103 <para condition="html" role="usernotes">User Notes:
104 <ulink url="&blfs-wiki;/TEMPLATE"/></para>
105
106 </sect2>
107
108 <!-- Optional section for packages that need a specific kernel configuration-->
109 <sect2 role="kernel" id='TEMPLATE-kernel'>
110 <title>Kernel Configuration</title>
111
112 <para>Enable the following options in the kernel configuration
113 and recompile the kernel if necessary:</para>
114
115<!-- Spaces are significant in <screen> sections -->
116<screen><literal>Master section:
117 Subsection:
118 Required Option: M or Y
119 Incompatible option: N</literal></screen>
120
121 <para>Select the appropriate sub-options that appear when the above options
122 are selected.</para>
123
124 <indexterm zone="TEMPLATE TEMPLATE-kernel">
125 <primary sortas="d-TEMPLATE">TEMPLATE</primary>
126 </indexterm>
127
128 </sect2>
129
130 <!--Required section-->
131 <sect2 role="installation">
132 <title>Installation of TEMPLATE</title>
133
134 <para>Install <application>TEMPLATE</application> by running the following
135 commands:</para>
136
137<!-- Spaces are significant in <screen> sections -->
138<screen><userinput>./configure --prefix=/usr &amp;&amp;
139make</userinput></screen>
140
141 <!-- Use one of the two mentions below about a test suite,
142 delete the line that is not applicable. Of course, if the
143 test suite uses syntax other than 'make check', revise the
144 line to reflect the actual syntax to run the test suite -->
145
146 <para>This package does not come with a test suite.</para>
147 <para>To test the results, issue: <command>make check</command>.</para>
148
149 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
150
151<screen role="root"><userinput>make install</userinput></screen>
152
153 </sect2>
154
155 <!--Optional section-->
156 <sect2 role="commands">
157 <title>Command Explanations</title>
158
159 <para><command>COMMAND</command>: This command does something.</para>
160
161 <para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
162 something mandatory for BLFS purposes.</para>
163
164 <para><option>--OPTION</option>: This option does something optionally
165 per the user's desires.</para>
166
167 </sect2>
168
169 <!--Optional section-->
170 <sect2 role="configuration">
171 <title>Configuring TEMPLATE</title>
172
173 <sect3 id="TEMPLATE-config">
174 <title>Config Files</title>
175 <para><filename>~/.Configfilename1</filename> and
176 <filename>/etc/path/Configfilename2</filename></para>
177
178 <indexterm zone="TEMPLATE TEMPLATE-config">
179 <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
180 </indexterm>
181
182 <indexterm zone="TEMPLATE TEMPLATE-config">
183 <primary sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
184 </indexterm>
185 </sect3>
186
187 <sect3><title>Configuration Information</title>
188
189 <para>Blah blah blah about config.</para>
190
191<screen><userinput>USER CONFIG COMMANDS</userinput></screen>
192
193<screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
194
195 <!-- File creation. Add the appropiate <indexterm> block if needed.-->
196 <para>Create the file .... for ...</para>
197
198<screen role="root"><userinput>cat &gt;&gt; /PATH/FILENAME &lt;&lt; "EOF"
199<literal># Begin FILENAME
200
201TEXT
202
203# End FILENAME</literal>
204EOF</userinput></screen>
205
206 </sect3>
207
208 <sect3 id="TEMPLATE-init">
209 <title>Boot Script</title>
210
211 <para>To automatically start the <command>TEMPLATE</command> daemon
212 when the system is rebooted, install the
213 <filename>/etc/rc.d/init.d/TEMPLATE</filename>
214 bootscript from the
215 <xref linkend="bootscripts"/> package.</para>
216
217 <indexterm zone="TEMPLATE TEMPLATE-init">
218 <primary sortas="f-TEMPLATE">TEMPLATE</primary>
219 </indexterm>
220
221<screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
222
223 </sect3>
224
225 </sect2>
226
227 <!--Required section-->
228 <sect2 role="content">
229 <title>Contents</title>
230
231 <segmentedlist>
232 <segtitle>Installed Program(s)</segtitle>
233 <segtitle>Installed Librar(y,ies)</segtitle>
234 <segtitle>Installed Director(y,ies)</segtitle>
235
236 <seglistitem>
237 <seg>PROGRAM1, PROGRAM2, and PROGRAM3</seg>
238 <seg>libLIBRARY1, libLIBRARY2, and libLIBRARY3</seg>
239 <seg>/etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
240 /usr/share/TEMPLATE-&TEMPLATE-version;,
241 /usr/share/doc/TEMPLATE-&TEMPLATE-version;, and
242 /var/lib/TEMPLATE</seg>
243 </seglistitem>
244 </segmentedlist>
245
246 <variablelist>
247 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
248 <?dbfo list-presentation="list"?>
249 <?dbhtml list-presentation="table"?>
250
251 <!-- If the program or library name conflicts (is the same) as the
252 package name, add -prog or -lib to the varlistentry entity id
253 and the 2nd entry of the indexterm zone entity -->
254
255 <varlistentry id="PROGRAM1">
256 <term><command>PROGRAM1</command></term>
257 <listitem>
258 <para>does this .....</para>
259 <indexterm zone="TEMPLATE PROGRAM1">
260 <primary sortas="b-PROGRAM1">PROGRAM1</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="PROGRAM2">
266 <term><command>PROGRAM2</command></term>
267 <listitem>
268 <para>does this .....</para>
269 <indexterm zone="TEMPLATE PROGRAM2">
270 <primary sortas="b-PROGRAM2">PROGRAM2</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="libLIBRARY1">
276 <term><filename class='libraryfile'>libLIBRARY1.{so,a}</filename></term>
277 <listitem>
278 <para>contains functions that .....</para>
279 <indexterm zone="TEMPLATE libLIBRARY1">
280 <primary sortas="c-libLIBRARY1">libLIBRARY1.{so,a}</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 </variablelist>
286
287 </sect2>
288
289</sect1>
Note: See TracBrowser for help on using the repository browser.