source: template/template.xml@ 5254d12

10.0 10.1 11.0 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 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 5254d12 was 5254d12, checked in by Randy McMurchy <randy@…>, 16 years ago

Standardized the id tag name of the Bootscripts package

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

  • Property mode set to 100644
File size: 9.2 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 <keywordset>
27 <!-- The actual package name but without .bz2 or .gz extension -->
28 <keyword role="package">TEMPLATE-&TEMPLATE-version;.tar</keyword>
29 <!-- The subdir under BLFS/conglomeration/ in where the package
30 is stored on the FTP mirrors -->
31 <keyword role="ftpdir">TEMPLATE</keyword>
32 </keywordset>
33 </sect1info>
34
35 <!-- No other tags inside any title-->
36 <!-- Use Title Case in All Titles
37 The "The Chicago Manual of Style":
38 "-Always capitalize the first and the last word.
39 -Capitalize all nouns, pronouns, adjectives, verbs, adverbs, and
40 subordinate conjunctions ("as", "because", "although").
41 -Lowercase all articles, coordinate conjunctions ("and", "or", "nor"),
42 and prepositions regardless of length, when they are other than the
43 first or last word.
44 -Lowercase the "to" in an infinitive."-->
45 <title>TEMPLATE-&TEMPLATE-version;</title>
46
47 <indexterm zone="TEMPLATE">
48 <primary sortas="a-TEMPLATE">TEMPLATE</primary>
49 </indexterm>
50
51 <!--Required section-->
52 <sect2 role="package">
53 <title>Introduction to TEMPLATE</title>
54
55 <para>The <application>TEMPLATE</application> package contains...
56 This is useful for...</para>
57
58 <bridgehead renderas="sect3">Package Information</bridgehead>
59 <itemizedlist spacing="compact">
60 <listitem>
61 <para>Download (HTTP): <ulink url="&TEMPLATE-download-http;"/></para>
62 </listitem>
63 <listitem>
64 <para>Download (FTP): <ulink url="&TEMPLATE-download-ftp;"/></para>
65 </listitem>
66 <listitem>
67 <para>Download MD5 sum: &TEMPLATE-md5sum;</para>
68 </listitem>
69 <listitem>
70 <para>Download size: &TEMPLATE-size;</para>
71 </listitem>
72 <listitem>
73 <para>Estimated disk space required: &TEMPLATE-buildsize;</para>
74 </listitem>
75 <listitem>
76 <para>Estimated build time: &TEMPLATE-time;</para>
77 </listitem>
78 </itemizedlist>
79
80 <!-- As required -->
81 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
82 <itemizedlist spacing="compact">
83 <listitem>
84 <para>Required patch: <ulink
85 url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
86 </listitem>
87 </itemizedlist>
88
89 <bridgehead renderas="sect3">TEMPLATE Dependencies</bridgehead>
90
91 <bridgehead renderas="sect4">Required</bridgehead>
92 <para role="required"><xref linkend="BLFS DEPENDENCY"/></para>
93
94 <!-- As required -->
95 <bridgehead renderas="sect4">Recommended</bridgehead>
96 <para role="recommended"><ulink url="http://www.some.url/">EXTERNAL 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 DEPENDENCY</ulink></para>
102
103 </sect2>
104
105 <!-- Optional section for packages that need a specific kernel configuration-->
106 <sect2 role="kernel" id='TEMPLATE-kernel'>
107 <title>Kernel Configuration</title>
108
109 <para>Enable the following options in the kernel configuration
110 and recompile the kernel if necessary:</para>
111
112<!-- Spaces are significant in <screen> sections -->
113<screen><literal>Master section:
114 Subsection:
115 Required Option: M or Y
116 Incompatible option: N</literal></screen>
117
118 <para>Select the appropriate sub-options that appear when the above options
119 are selected.</para>
120
121 <indexterm zone="TEMPLATE TEMPLATE-kernel">
122 <primary sortas="d-TEMPLATE">TEMPLATE</primary>
123 </indexterm>
124
125 </sect2>
126
127 <!--Required section-->
128 <sect2 role="installation">
129 <title>Installation of TEMPLATE</title>
130
131 <para>Install <application>TEMPLATE</application> by running the following
132 commands:</para>
133
134<!-- Spaces are significant in <screen> sections -->
135<screen><userinput>./configure --prefix=/usr &amp;&amp;
136make</userinput></screen>
137
138 <!-- Use one of the two mentions below about a test suite,
139 delete the line that is not applicable. Of course, if the
140 test suite uses syntax other than 'make check', revise the
141 line to reflect the actual syntax to run the test suite -->
142
143 <para>This package does not come with a test suite.</para>
144 <para>To test the results, issue: <command>make check</command>.</para>
145
146 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
147
148<screen role="root"><userinput>make install</userinput></screen>
149
150 </sect2>
151
152 <!--Optional section-->
153 <sect2 role="commands">
154 <title>Command Explanations</title>
155
156 <para><command>COMMAND</command>: This command does something.</para>
157
158 <para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
159 something mandatory for BLFS purposes.</para>
160
161 <para><option>--OPTION</option>: This option does something optionally
162 per the user's desires.</para>
163
164 </sect2>
165
166 <!--Optional section-->
167 <sect2 role="configuration">
168 <title>Configuring TEMPLATE</title>
169
170 <sect3 id="TEMPLATE-config">
171 <title>Config Files</title>
172 <para><filename>~/.Configfilename1</filename> and
173 <filename>/etc/path/Configfilename2</filename></para>
174
175 <indexterm zone="TEMPLATE TEMPLATE-config">
176 <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
177 </indexterm>
178
179 <indexterm zone="TEMPLATE TEMPLATE-config">
180 <primary sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
181 </indexterm>
182 </sect3>
183
184 <sect3><title>Configuration Information</title>
185
186 <para>Blah blah blah about config.</para>
187
188<screen><userinput>USER CONFIG COMMANDS</userinput></screen>
189
190<screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
191
192 <!-- File creation. Add the appropiate <indexterm> block if needed.-->
193 <para>Create the file .... for ...</para>
194
195<screen role="root"><userinput>cat &gt;&gt; /PATH/FILENAME &lt;&lt; "EOF"
196<literal># Begin FILENAME
197
198TEXT
199
200# End FILENAME</literal>
201EOF</userinput></screen>
202
203 </sect3>
204
205 <sect3 id="TEMPLATE-init">
206 <title>Boot Script</title>
207
208 <para>To automatically start the <command>TEMPLATE</command> daemon
209 when the system is rebooted, install the
210 <filename>/etc/rc.d/init.d/TEMPLATE</filename>
211 bootscript from the
212 <xref linkend="bootscripts"/> package.</para>
213
214 <indexterm zone="TEMPLATE TEMPLATE-init">
215 <primary sortas="f-TEMPLATE">TEMPLATE</primary>
216 </indexterm>
217
218<screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
219
220 </sect3>
221
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
282 </variablelist>
283
284 </sect2>
285
286</sect1>
Note: See TracBrowser for help on using the repository browser.