source: template/template.xml@ 4daebcb1

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 ken/refactor-virt 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 4daebcb1 was bfb7882, checked in by Tushar Teredesai <tushar@…>, 16 years ago

More typo fixes

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

  • Property mode set to 100644
File size: 8.9 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 necessary:</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 <!-- Use one of the two mentions below about a test suite,
132 delete the line that is not applicable. Of course, if the
133 test suite uses syntax other than 'make check', revise the
134 line to reflect the actual syntax to run the test suite -->
135
136 <para>This package does not come with a test suite.</para>
137 <para>To test the results, issue: <command>make check</command>.</para>
138
139 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
140
141<screen role="root"><userinput>make install</userinput></screen>
142
143 </sect2>
144
145 <!--Optional section-->
146 <sect2 role="commands">
147 <title>Command Explanations</title>
148
149 <para><command>COMMAND</command>: This command does something.</para>
150
151 <para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
152 something mandatory for BLFS purposes.</para>
153
154 <para><option>--OPTION</option>: This option does something optionally
155 per the user's desires.</para>
156
157 </sect2>
158
159 <!--Optional section-->
160 <sect2 role="configuration">
161 <title>Configuring TEMPLATE</title>
162
163 <sect3 id="TEMPLATE-config">
164 <title>Config Files</title>
165 <para><filename>~/.Configfilename1</filename> and
166 <filename>/etc/path/Configfilename2</filename></para>
167
168 <indexterm zone="TEMPLATE TEMPLATE-config">
169 <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
170 </indexterm>
171
172 <indexterm zone="TEMPLATE TEMPLATE-config">
173 <primary sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
174 </indexterm>
175 </sect3>
176
177 <sect3><title>Configuration Information</title>
178
179 <para>Blah blah blah about config.</para>
180
181<screen><userinput>USER CONFIG COMMANDS</userinput></screen>
182
183<screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
184
185 <!-- File creation. Add the appropiate <indexterm> block if needed.-->
186 <para>Create the file .... for ...</para>
187
188<screen role="root"><userinput>cat &gt;&gt; /PATH/FILENAME &lt;&lt; "EOF"
189<literal># Begin FILENAME
190
191TEXT
192
193# End FILENAME</literal>
194EOF</userinput></screen>
195
196 </sect3>
197
198 <sect3 id="TEMPLATE-init">
199 <title>Boot Script</title>
200
201 <para>To automatically start the <command>TEMPLATE</command> daemon
202 when the system is rebooted, install the
203 <filename>/etc/rc.d/init.d/TEMPLATE</filename>
204 bootscript from the
205 <xref linkend="intro-important-bootscripts"/> package.</para>
206
207 <indexterm zone="TEMPLATE TEMPLATE-init">
208 <primary sortas="f-TEMPLATE">TEMPLATE</primary>
209 </indexterm>
210
211<screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
212
213 </sect3>
214
215 </sect2>
216
217 <!--Required section-->
218 <sect2 role="content">
219 <title>Contents</title>
220
221 <segmentedlist>
222 <segtitle>Installed Program(s)</segtitle>
223 <segtitle>Installed Librar(y,ies)</segtitle>
224 <segtitle>Installed Director(y,ies)</segtitle>
225
226 <seglistitem>
227 <seg>PROGRAM1, PROGRAM2, and PROGRAM3</seg>
228 <seg>libLIBRARY1, libLIBRARY2, and libLIBRARY3</seg>
229 <seg>/etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
230 /usr/share/TEMPLATE-&TEMPLATE-version;,
231 /usr/share/doc/TEMPLATE-&TEMPLATE-version;, and
232 /var/lib/TEMPLATE</seg>
233 </seglistitem>
234 </segmentedlist>
235
236 <variablelist>
237 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
238 <?dbfo list-presentation="list"?>
239 <?dbhtml list-presentation="table"?>
240
241 <!-- If the program or library name conflicts (is the same) as the
242 package name, add -prog or -lib to the varlistentry entity id
243 and the 2nd entry of the indexterm zone entity -->
244
245 <varlistentry id="PROGRAM1">
246 <term><command>PROGRAM1</command></term>
247 <listitem>
248 <para>does this .....</para>
249 <indexterm zone="TEMPLATE PROGRAM1">
250 <primary sortas="b-PROGRAM1">PROGRAM1</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="PROGRAM2">
256 <term><command>PROGRAM2</command></term>
257 <listitem>
258 <para>does this .....</para>
259 <indexterm zone="TEMPLATE PROGRAM2">
260 <primary sortas="b-PROGRAM2">PROGRAM2</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="libLIBRARY1">
266 <term><filename class='libraryfile'>libLIBRARY1.[so,a]</filename></term>
267 <listitem>
268 <para>contains functions that .....</para>
269 <indexterm zone="TEMPLATE libLIBRARY1">
270 <primary sortas="c-libLIBRARY1">libLIBRARY1.[so,a]</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 </variablelist>
276
277 </sect2>
278
279</sect1>
Note: See TracBrowser for help on using the repository browser.