source: template/template.xml@ 9d798aee

10.0 10.1 11.0 6.1 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 lazarus 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 9d798aee was 9d798aee, checked in by Manuel Canales Esparcia <manuel@…>, 16 years ago

Fixed template.xml for validation and small bogus indentation.

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

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