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 &&
|
---|
129 | make</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 >> /PATH/FILENAME << "EOF"
|
---|
183 | <literal># Begin FILENAME
|
---|
184 |
|
---|
185 | TEXT
|
---|
186 |
|
---|
187 | # End FILENAME</literal>
|
---|
188 | EOF</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 <filename>/etc/rc.d/init.d/TEMPLATE</filename>
|
---|
197 | bootscript from the <xref linkend="intro-important-bootscripts"/> package.</para>
|
---|
198 |
|
---|
199 | <indexterm zone="TEMPLATE TEMPLATE-init">
|
---|
200 | <primary sortas="f-TEMPLATE">TEMPLATE</primary>
|
---|
201 | </indexterm>
|
---|
202 |
|
---|
203 | <screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
|
---|
204 |
|
---|
205 | </sect3>
|
---|
206 |
|
---|
207 | </sect2>
|
---|
208 |
|
---|
209 | <!--Required section-->
|
---|
210 | <sect2 role="content">
|
---|
211 | <title>Contents</title>
|
---|
212 |
|
---|
213 | <segmentedlist>
|
---|
214 | <segtitle>Installed Program(s)</segtitle>
|
---|
215 | <segtitle>Installed Librar(y,ies)</segtitle>
|
---|
216 | <segtitle>Installed Director(y,ies)</segtitle>
|
---|
217 |
|
---|
218 | <seglistitem>
|
---|
219 | <seg>PROGRAM1, PROGRAM2, and PROGRAM3</seg>
|
---|
220 | <seg>libLIBRARY1, libLIBRARY2, and libLIBRARY3</seg>
|
---|
221 | <seg>/etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
|
---|
222 | /usr/share/TEMPLATE-&TEMPLATE-version;,
|
---|
223 | /usr/share/doc/TEMPLATE-&TEMPLATE-version;, and
|
---|
224 | /var/lib/TEMPLATE</seg>
|
---|
225 | </seglistitem>
|
---|
226 | </segmentedlist>
|
---|
227 |
|
---|
228 | <variablelist>
|
---|
229 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
230 | <?dbfo list-presentation="list"?>
|
---|
231 | <?dbhtml list-presentation="table"?>
|
---|
232 |
|
---|
233 | <!-- If the program or library name conflicts (is the same) as the
|
---|
234 | package name, add -prog or -lib to the varlistentry entity id
|
---|
235 | and the 2nd entry of the indexterm zone entity -->
|
---|
236 |
|
---|
237 | <varlistentry id="PROGRAM1">
|
---|
238 | <term><command>PROGRAM1</command></term>
|
---|
239 | <listitem>
|
---|
240 | <para>does this .....</para>
|
---|
241 | <indexterm zone="TEMPLATE PROGRAM1">
|
---|
242 | <primary sortas="b-PROGRAM1">PROGRAM1</primary>
|
---|
243 | </indexterm>
|
---|
244 | </listitem>
|
---|
245 | </varlistentry>
|
---|
246 |
|
---|
247 | <varlistentry id="PROGRAM2">
|
---|
248 | <term><command>PROGRAM2</command></term>
|
---|
249 | <listitem>
|
---|
250 | <para>does this .....</para>
|
---|
251 | <indexterm zone="TEMPLATE PROGRAM2">
|
---|
252 | <primary sortas="b-PROGRAM2">PROGRAM2</primary>
|
---|
253 | </indexterm>
|
---|
254 | </listitem>
|
---|
255 | </varlistentry>
|
---|
256 |
|
---|
257 | <varlistentry id="libLIBRARY1">
|
---|
258 | <term><filename class='libraryfile'>libLIBRARY1.[so,a]</filename></term>
|
---|
259 | <listitem>
|
---|
260 | <para>contains functions that .....</para>
|
---|
261 | <indexterm zone="TEMPLATE libLIBRARY1">
|
---|
262 | <primary sortas="c-libLIBRARY1">libLIBRARY1.[so,a]</primary>
|
---|
263 | </indexterm>
|
---|
264 | </listitem>
|
---|
265 | </varlistentry>
|
---|
266 |
|
---|
267 | </variablelist>
|
---|
268 |
|
---|
269 | </sect2>
|
---|
270 |
|
---|
271 | </sect1>
|
---|
272 |
|
---|