source: template/template.xml@ a4a52f4

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 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 a4a52f4 was a4a52f4, checked in by Andrew Benton <andy@…>, 10 years ago

The zombie is still moving
gnucash and slib are back in the book

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

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