source: template/template.xml@ 343fb6d

10.0 10.1 11.0 6.1 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 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 343fb6d was eaf6a1cd, checked in by Manuel Canales Esparcia <manuel@…>, 17 years ago

Updated template.xml to match current edguide.
Updated stylesheets to match the new tagging.
Retagged nfs-utils.xml to match current template.xml and edguide tags policies.

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

  • Property mode set to 100644
File size: 6.9 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<sect1 id="TEMPLATE" xreflabel="TEMPLATE-&TEMPLATE-version;">
20
21<sect1info>
22 <othername>$LastChangedBy$</othername>
23 <date>$Date$</date>
24</sect1info>
25
26<?dbhtml filename="TEMPLATE.html"?>
27<!-- No <application> tags in any title-->
28<title>TEMPLATE-&TEMPLATE-version;</title>
29<indexterm zone="TEMPLATE">
30 <primary sortas="a-TEMPLATE">TEMPLATE</primary>
31</indexterm>
32
33<!-- Added role attibutes to <sect2> tags to allow to have a different look
34for each section, if needed-->
35<sect2 role="package">
36<title>Introduction to TEMPLATE</title>
37
38<para>The <application>TEMPLATE</application> package contains...
39This is useful for...</para>
40
41<!-- Replaced <sect3> and <sect4> tags by <bridgehead> in this section
42to reduce the number of <sectX> to be processed if numbered sections is
43wanted in the future.-->
44<bridgehead renderas="sect3">Package information</bridgehead>
45<itemizedlist spacing="compact">
46 <listitem><para>Download (HTTP):
47 <ulink url="&TEMPLATE-download-http;"/></para></listitem>
48 <listitem><para>Download (FTP):
49 <ulink url="&TEMPLATE-download-ftp;"/></para></listitem>
50 <listitem><para>Download MD5 sum:
51 &TEMPLATE-md5sum;</para></listitem>
52 <listitem><para>Download size:
53 &TEMPLATE-size;</para></listitem>
54 <listitem><para>Estimated disk space required:
55 &TEMPLATE-buildsize;</para></listitem>
56 <listitem><para>Estimated build time:
57 &TEMPLATE-time;</para></listitem>
58</itemizedlist>
59
60<bridgehead renderas="sect3">Additional downloads</bridgehead>
61<itemizedlist spacing="compact">
62 <listitem><para>Required patch: <ulink
63 url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
64 </listitem>
65</itemizedlist>
66
67<bridgehead renderas="sect3">TEMPLATE dependencies</bridgehead>
68
69<bridgehead renderas="sect4">Required</bridgehead>
70<para><xref linkend="BLFS DEPENDENCY"/></para>
71
72<bridgehead renderas="sect4">Optional</bridgehead>
73<para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para>
74
75</sect2>
76
77<sect2 role="installation">
78<title>Installation of TEMPLATE</title>
79
80<para>Install <application>TEMPLATE</application> by running the following
81commands:</para>
82
83<!-- Removed <command> tags. For file creation commands <literal> tags must be added
84enclosing the actual text-->
85<screen><userinput>./configure --prefix=/usr &amp;&amp;
86make</userinput></screen>
87
88<!--Added the test sute execution-->
89<para>To test the results, issue: <command>make check</command>.</para>
90
91<!--Added <systemitem> tag-->
92<para>Now, as the <systemitem class="username">root</systemitem> user:</para>
93
94<!--Changed where the role attribute is placed-->
95<screen role="root"><userinput>make install</userinput></screen>
96
97</sect2>
98
99<sect2 role="commands">
100<title>Command explanations</title>
101
102<para><command>COMMAND</command>: This command does something.</para>
103
104<para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
105something mandatory for BLFS purposes.</para>
106
107<para><option>--OPTION</option>: This option does something optionally
108per the user's desires.</para>
109
110</sect2>
111
112<sect2 role="configuration">
113<title>Configuring TEMPLATE</title>
114
115<sect3 id="TEMPLATE-config">
116 <title>Config files</title>
117 <para><filename>~/.Configfilename1</filename> and
118 <filename>/etc/path/Configfilename2</filename></para>
119
120 <indexterm zone="TEMPLATE TEMPLATE-config">
121 <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
122 </indexterm>
123
124 <indexterm zone="TEMPLATE TEMPLATE-config">
125 <primary sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
126 </indexterm>
127</sect3>
128
129<sect3><title>Configuration information</title>
130
131 <!--Making this part more proper-->
132 <para>Blah blah blah about config.</para>
133
134<screen><userinput>USER CONFIG COMMANDS</userinput></screen>
135
136<screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
137
138 <!-- File creation-->
139 <para>Create the file .... for ...</para>
140
141<screen role="root"><userinput>cat &gt;&gt; /PATH/FILENAME &lt;&lt; "EOF"
142<literal># Begin FILENAME
143
144TEXT
145
146# End FILENAME</literal>
147EOF</userinput></screen>
148 <!-- -->
149
150 <sect3 id="TEMPLATE-init">
151 <title>Boot Scripts</title>
152
153 <para>To automatically start the <command>TEMPLATE</command> daemon
154 when the system is rebooted, install the
155 <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
156 <xref linkend="intro-important-bootscripts"/> package.</para>
157
158 <indexterm zone="TEMPLATE TEMPLATE-init">
159 <primary sortas="f-TEMPLATE">TEMPLATE</primary>
160 </indexterm>
161
162<screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
163
164</sect3>
165
166</sect2>
167
168<sect2 role="content">
169<title>Contents</title>
170
171<segmentedlist>
172 <segtitle>Installed Program(s)</segtitle>
173 <segtitle>Installed Librar(y,ies)</segtitle>
174 <segtitle>Installed Director(y,ies)</segtitle>
175
176 <seglistitem>
177 <seg>PROGRAM1, PROGRAM2, and PROGRAM3</seg>
178 <seg>libLIBRARY1, libLIBRARY2, and libLIBRARY3</seg>
179 <seg>/etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
180 /usr/share/TEMPLATE-&TEMPLATE-version;,
181 /usr/share/doc/TEMPLATE-&TEMPLATE-version;, and
182 /var/lib/TEMPLATE</seg>
183 </seglistitem>
184</segmentedlist>
185
186<variablelist>
187 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
188 <?dbfo list-presentation="list"?>
189 <!--Render this as a table for HTML output-->
190 <?dbhtml list-presentation="table"?>
191
192<!-- If the program or library name conflicts (is the same) as the
193package name, add -prog or -lib to the varlistentry entity id
194and the 2nd entry of the indexterm zone entity -->
195
196<varlistentry id="PROGRAM1">
197 <term><command>PROGRAM1</command></term>
198 <listitem>
199 <para>does this .....</para>
200 <indexterm zone="TEMPLATE PROGRAM1">
201 <primary sortas="b-PROGRAM1">PROGRAM1</primary>
202 </indexterm>
203 </listitem>
204</varlistentry>
205
206<varlistentry id="PROGRAM2">
207 <term><command>PROGRAM2</command></term>
208 <listitem>
209 <para>does this .....</para>
210 <indexterm zone="TEMPLATE PROGRAM2">
211 <primary sortas="b-PROGRAM2">PROGRAM2</primary>
212 </indexterm>
213 </listitem>
214</varlistentry>
215
216<varlistentry id="libLIBRARY1">
217 <term><filename class='libraryfile'>libLIBRARY1.[so,a]</filename></term>
218 <listitem>
219 <para>contains functions that .....</para>
220 <indexterm zone="TEMPLATE libLIBRARY1">
221 <primary sortas="c-libLIBRARY1">libLIBRARY1.[so,a]</primary>
222 </indexterm>
223 </listitem>
224</varlistentry>
225
226</variablelist>
227
228</sect2>
229
230</sect1>
231
Note: See TracBrowser for help on using the repository browser.