source: template/template.xml@ ff769b8c

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 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 ff769b8c was ff769b8c, checked in by Manuel Canales Esparcia <manuel@…>, 16 years ago

Updated the XML sources to use DocBook XML DTD-4.4.

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

  • Property mode set to 100644
File size: 5.8 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<title><application>TEMPLATE</application>-&TEMPLATE-version;</title>
28<indexterm zone="TEMPLATE">
29 <primary sortas="a-TEMPLATE">TEMPLATE</primary>
30</indexterm>
31
32<sect2>
33<title>Introduction to <application>TEMPLATE</application></title>
34
35<para>The <application>TEMPLATE</application> package contains...
36This is useful for...</para>
37
38<sect3><title>Package information</title>
39<itemizedlist spacing="compact">
40 <listitem><para>Download (HTTP):
41 <ulink url="&TEMPLATE-download-http;"/></para></listitem>
42 <listitem><para>Download (FTP):
43 <ulink url="&TEMPLATE-download-ftp;"/></para></listitem>
44 <listitem><para>Download MD5 sum:
45 &TEMPLATE-md5sum;</para></listitem>
46 <listitem><para>Download size:
47 &TEMPLATE-size;</para></listitem>
48 <listitem><para>Estimated disk space required:
49 &TEMPLATE-buildsize;</para></listitem>
50 <listitem><para>Estimated build time:
51 &TEMPLATE-time;</para></listitem></itemizedlist>
52</sect3>
53
54<sect3>
55 <title>Additional downloads</title>
56 <itemizedlist spacing="compact">
57 <listitem><para>Required patch: <ulink
58 url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
59 </listitem>
60 </itemizedlist>
61</sect3>
62
63<sect3><title><application>TEMPLATE</application> dependencies</title>
64 <sect4><title>Required</title>
65 <para><xref linkend="BLFS DEPENDENCY"/></para>
66 </sect4>
67
68 <sect4><title>Optional</title>
69 <para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para>
70 </sect4>
71</sect3>
72
73</sect2>
74
75<sect2>
76<title>Installation of <application>TEMPLATE</application></title>
77
78<para>Install <application>TEMPLATE</application> by running the following
79commands:</para>
80
81<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
82make</command></userinput></screen>
83
84<para>Now, as the root user:</para>
85
86<screen><userinput role='root'><command>make install</command></userinput></screen>
87
88</sect2>
89
90<sect2>
91<title>Command explanations</title>
92
93<para><command>COMMAND</command>: This command does something.</para>
94
95<para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
96something mandatory for BLFS purposes.</para>
97
98<para><option>--OPTION</option>: This option does something optionally
99per the user's desires.</para>
100
101</sect2>
102
103<sect2>
104<title>Configuring <application>TEMPLATE</application></title>
105
106<sect3 id="TEMPLATE-config">
107 <title>Config files</title>
108 <para><filename>~/.Configfilename1</filename> and
109 <filename>/etc/path/Configfilename2</filename></para>
110
111 <indexterm zone="TEMPLATE TEMPLATE-config">
112 <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
113 </indexterm>
114
115 <indexterm zone="TEMPLATE TEMPLATE-config">
116 <primary sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
117 </indexterm>
118</sect3>
119
120<sect3><title>Configuration information</title>
121
122 <para><userinput role='root'>USERINPUT GOES HERE</userinput> Blah blah blah
123 about config.</para>
124
125 <para id="TEMPLATE-init">To automatically start the
126 <command>TEMPLATE</command> daemon when the system is rebooted, install the
127 <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
128 <xref linkend="intro-important-bootscripts"/> package.</para>
129
130 <indexterm zone="TEMPLATE TEMPLATE-init">
131 <primary sortas="f-TEMPLATE">TEMPLATE</primary>
132 </indexterm>
133
134<screen><userinput role='root'><command>make install-TEMPLATE</command></userinput></screen>
135</sect3>
136
137</sect2>
138
139<sect2>
140<title>Contents</title>
141
142<segmentedlist>
143 <segtitle>Installed Program(s)</segtitle>
144 <segtitle>Installed Librar(y,ies)</segtitle>
145 <segtitle>Installed Director(y,ies)</segtitle>
146
147 <seglistitem>
148 <seg>PROGRAM1, PROGRAM2 and PROGRAM3</seg>
149 <seg>libLIBRARY1, libLIBRARY2 and libLIBRARY3</seg>
150 <seg>/etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
151 /usr/share/TEMPLATE-&TEMPLATE-version;,
152 /usr/share/doc/TEMPLATE-&TEMPLATE-version; and
153 /var/lib/TEMPLATE</seg>
154 </seglistitem>
155</segmentedlist>
156
157<variablelist>
158 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
159 <?dbfo list-presentation="list"?>
160
161<!-- If the program or library name conflicts (is the same) as the
162package name, add -prog or -lib to the varlistentry entity id
163and the 2nd entry of the indexterm zone entity -->
164
165<varlistentry id="PROGRAM1">
166 <term><command>PROGRAM1</command></term>
167 <listitem>
168 <para>does this .....</para>
169 <indexterm zone="TEMPLATE PROGRAM1">
170 <primary sortas="b-PROGRAM1">PROGRAM1</primary>
171 </indexterm>
172 </listitem>
173</varlistentry>
174
175<varlistentry id="PROGRAM2">
176 <term><command>PROGRAM2</command></term>
177 <listitem>
178 <para>does this .....</para>
179 <indexterm zone="TEMPLATE PROGRAM2">
180 <primary sortas="b-PROGRAM2">PROGRAM2</primary>
181 </indexterm>
182 </listitem>
183</varlistentry>
184
185<varlistentry id="libLIBRARY1">
186 <term><filename class='libraryfile'>libLIBRARY1.[so,a]</filename></term>
187 <listitem>
188 <para>contains functions that .....</para>
189 <indexterm zone="TEMPLATE libLIBRARY1">
190 <primary sortas="c-libLIBRARY1">libLIBRARY1.[so,a]</primary>
191 </indexterm>
192 </listitem>
193</varlistentry>
194
195</variablelist>
196
197</sect2>
198
199</sect1>
200
Note: See TracBrowser for help on using the repository browser.