source: template/template.xml@ 6732c094

10.0 10.1 11.0 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 6732c094 was 6732c094, checked in by Randy McMurchy <randy@…>, 14 years ago

Updated all the XML files (and the one stylesheet) to use the 4.5 version of DocBook XML DTD

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

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