source: template/template.xml@ 5603a81

10.0 10.1 11.0 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 5603a81 was 5603a81, checked in by Andrew Benton <andy@…>, 9 years ago

Added some checked tags

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

  • Property mode set to 100644
File size: 9.6 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 <title>TEMPLATE-&TEMPLATE-version;</title>
31
32 <indexterm zone="TEMPLATE">
33 <primary sortas="a-TEMPLATE">TEMPLATE</primary>
34 </indexterm>
35
36 <!--Required section-->
37 <sect2 role="package">
38 <title>Introduction to TEMPLATE</title>
39
40 <para>
41 The <application>TEMPLATE</application> package contains...
42 This is useful for...
43 </para>
44
45 <!-- if it builds but hasn't been tested: -->
46 &lfs71_built;
47 <!-- if it works: -->
48 &lfs71_checked;
49
50 <bridgehead renderas="sect3">Package Information</bridgehead>
51 <itemizedlist spacing="compact">
52 <listitem>
53 <para>
54 Download (HTTP): <ulink url="&TEMPLATE-download-http;"/>
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download (FTP): <ulink url="&TEMPLATE-download-ftp;"/>
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Download MD5 sum: &TEMPLATE-md5sum;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Download size: &TEMPLATE-size;
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Estimated disk space required: &TEMPLATE-buildsize;
75 </para>
76 </listitem>
77 <listitem>
78 <para>
79 Estimated build time: &TEMPLATE-time;
80 </para>
81 </listitem>
82 </itemizedlist>
83
84 <!-- As required -->
85 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
86 <itemizedlist spacing="compact">
87 <listitem>
88 <para>
89 Required patch:
90 <ulink url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/>
91 </para>
92 </listitem>
93 </itemizedlist>
94
95 <bridgehead renderas="sect3">TEMPLATE Dependencies</bridgehead>
96
97 <bridgehead renderas="sect4">Required</bridgehead>
98 <para role="required">
99 <xref linkend="BLFS DEPENDENCY"/>
100 </para>
101
102 <!-- As required -->
103 <bridgehead renderas="sect4">Recommended</bridgehead>
104 <para role="recommended">
105 <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink> and
106 <xref linkend="BLFS DEPENDENCY"/>.
107 </para>
108
109 <!-- As required -->
110 <bridgehead renderas="sect4">Optional</bridgehead>
111 <para role="optional">
112 <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>.
113 </para>
114
115 <para condition="html" role="usernotes">
116 User Notes: <ulink url="&blfs-wiki;/TEMPLATE"/>
117 </para>
118 </sect2>
119
120 <!-- Optional section for packages that need a specific kernel
121 configuration-->
122 <sect2 role="kernel" id="TEMPLATE-kernel">
123 <title>Kernel Configuration</title>
124
125 <para>
126 Enable the following options in the kernel configuration and recompile the
127 kernel if necessary:
128 </para>
129
130<!-- Spaces are significant in <screen> sections -->
131<screen><literal>Master section:
132 Subsection:
133 Required Option: M or Y
134 Incompatible option: N</literal></screen>
135
136 <para>
137 Select the appropriate sub-options that appear when the above options are
138 selected.
139 </para>
140
141 <indexterm zone="TEMPLATE TEMPLATE-kernel">
142 <primary sortas="d-TEMPLATE">TEMPLATE</primary>
143 </indexterm>
144 </sect2>
145
146 <!--Required section-->
147 <sect2 role="installation">
148 <title>Installation of TEMPLATE</title>
149
150 <para>
151 Install <application>TEMPLATE</application> by running the following
152 commands:
153 </para>
154
155<!-- Spaces are significant in <screen> sections -->
156<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
157make</userinput></screen>
158
159 <!-- Optional section. Use one of the two mentions below about a test
160 suite, delete the line that is not applicable. Of course, if the
161 test suite uses syntax other than 'make check', revise the
162 line to reflect the actual syntax to run the test suite -->
163
164 <para>
165 This package does not come with a test suite.
166 </para>
167
168 <para>
169 To test the results, issue: <command>make check</command>.
170 </para>
171
172 <para>
173 Now, as the <systemitem class="username">root</systemitem> user:
174 </para>
175
176<screen role="root"><userinput>make install</userinput></screen>
177 </sect2>
178
179 <!--Optional section-->
180 <sect2 role="commands">
181 <title>Command Explanations</title>
182
183 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
184 href="../../xincludes/static-libraries.xml"/>
185
186 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
187 href="../../xincludes/gtk-doc-rebuild.xml"/>
188
189 <para>
190 <command>COMMAND</command>: This command does something.
191 </para>
192
193 <para>
194 <parameter>--SWITCH=PARAMETER</parameter>: This parameter does something
195 mandatory for BLFS purposes.
196 </para>
197
198 <para>
199 <option>--OPTION</option>: This option does something optionally per the
200 user's desires.
201 </para>
202 </sect2>
203
204 <sect2 role="using">
205 <title>Using TEMPLATE</title>
206
207 <para>
208 Stuff about how to use TEMPLATE to do something.
209 </para>
210 </sect2>
211
212 <!--Optional section-->
213 <sect2 role="configuration">
214 <title>Configuring TEMPLATE</title>
215
216 <sect3 id="TEMPLATE-config">
217 <title>Config Files</title>
218 <para>
219 <filename>~/.Configfilename1</filename> and
220 <filename>/etc/path/Configfilename2</filename>.
221 </para>
222
223 <indexterm zone="TEMPLATE TEMPLATE-config">
224 <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
225 </indexterm>
226
227 <indexterm zone="TEMPLATE TEMPLATE-config">
228 <primary
229 sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
230 </indexterm>
231 </sect3>
232
233 <sect3><title>Configuration Information</title>
234
235 <para>
236 Blah blah blah about config.
237 </para>
238
239<screen><userinput>USER CONFIG COMMANDS</userinput></screen>
240
241<screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
242
243 <!-- File creation. Add the appropriate <indexterm> block if needed.-->
244 <para>
245 Create the file .... for ...
246 </para>
247
248<screen role="root"><userinput>cat &gt;&gt; /PATH/FILENAME &lt;&lt; "EOF"
249<literal># Begin FILENAME
250
251TEXT
252
253# End FILENAME</literal>
254EOF</userinput></screen>
255 </sect3>
256
257 <sect3 id="TEMPLATE-init">
258 <title>Boot Script</title>
259
260 <para>
261 To automatically start the <command>TEMPLATE</command> daemon when the
262 system is rebooted, install the
263 <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
264 <xref linkend="bootscripts"/> package.
265 </para>
266
267 <indexterm zone="TEMPLATE TEMPLATE-init">
268 <primary sortas="f-TEMPLATE">TEMPLATE</primary>
269 </indexterm>
270
271<screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
272 </sect3>
273 </sect2>
274
275 <!--Required section-->
276 <sect2 role="content">
277 <title>Contents</title>
278
279 <segmentedlist>
280 <segtitle>Installed Program(s)</segtitle>
281 <segtitle>Installed Librar(y,ies)</segtitle>
282 <segtitle>Installed Director(y,ies)</segtitle>
283
284 <seglistitem>
285 <seg>
286 PROGRAM1, PROGRAM2 and PROGRAM3.
287 </seg>
288 <seg>
289 libLIBRARY1.so, libLIBRARY2.so and libLIBRARY3.so.
290 </seg>
291 <seg>
292 /etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
293 /usr/share/TEMPLATE-&TEMPLATE-version;,
294 /usr/share/doc/TEMPLATE-&TEMPLATE-version; and
295 /var/lib/TEMPLATE.
296 </seg>
297 </seglistitem>
298 </segmentedlist>
299
300 <variablelist>
301 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
302 <?dbfo list-presentation="list"?>
303 <?dbhtml list-presentation="table"?>
304
305 <!-- If the program or library name conflicts (is the same) as the
306 package name, add -prog or -lib to the varlistentry entity id
307 and the 2nd entry of the indexterm zone entity -->
308
309 <varlistentry id="PROGRAM1">
310 <term><command>PROGRAM1</command></term>
311 <listitem>
312 <para>
313 does this .....
314 </para>
315 <indexterm zone="TEMPLATE PROGRAM1">
316 <primary sortas="b-PROGRAM1">PROGRAM1</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="PROGRAM2">
322 <term><command>PROGRAM2</command></term>
323 <listitem>
324 <para>
325 does this .....
326 </para>
327 <indexterm zone="TEMPLATE PROGRAM2">
328 <primary sortas="b-PROGRAM2">PROGRAM2</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="libLIBRARY1">
334 <term><filename class="libraryfile">libLIBRARY1.so</filename></term>
335 <listitem>
336 <para>
337 contains functions that .....
338 </para>
339 <indexterm zone="TEMPLATE libLIBRARY1">
340 <primary sortas="c-libLIBRARY1">libLIBRARY1.so</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344 </variablelist>
345 </sect2>
346</sect1>
Note: See TracBrowser for help on using the repository browser.