source: template/template.xml@ 4ff86b9

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 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 4ff86b9 was 4ff86b9, checked in by Randy McMurchy <randy@…>, 16 years ago

Removed spaces from blank lines and excess spaces from the end of XML data

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

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