source: template/template.xml@ e48dd79

10.0 10.1 11.0 6.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 e48dd79 was e48dd79, checked in by Randy McMurchy <randy@…>, 17 years ago

Updated package template skeleton

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

  • Property mode set to 100644
File size: 5.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3 "http://www.oasis-open.org/docbook/xml/4.3/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-package" xreflabel="TEMPLATE-&TEMPLATE-version;">
20<sect1info>
21<othername>$LastChangedBy$</othername>
22<date>$Date$</date>
23</sect1info>
24<?dbhtml filename="TEMPLATE.html"?>
25<title><application>TEMPLATE</application>-&TEMPLATE-version;</title>
26<indexterm zone="TEMPLATE-package">
27<primary sortas="a-TEMPLATE">TEMPLATE</primary></indexterm>
28
29<sect2>
30<title>Introduction to <application>TEMPLATE</application></title>
31
32<para>The <application>TEMPLATE</application> package contains...
33This is useful for...</para>
34
35<sect3><title>Package information</title>
36<itemizedlist spacing="compact">
37<listitem><para>Download (HTTP):
38<ulink url="&TEMPLATE-download-http;"/></para></listitem>
39<listitem><para>Download (FTP):
40<ulink url="&TEMPLATE-download-ftp;"/></para></listitem>
41<listitem><para>Download MD5 sum:
42&TEMPLATE-md5sum;</para></listitem>
43<listitem><para>Download size:
44&TEMPLATE-size;</para></listitem>
45<listitem><para>Estimated disk space required:
46&TEMPLATE-buildsize;</para></listitem>
47<listitem><para>Estimated build time:
48&TEMPLATE-time;</para></listitem></itemizedlist>
49</sect3>
50
51<sect3><title>Additional downloads</title>
52<itemizedlist spacing="compact">
53<listitem><para>Required Patch: <ulink
54url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
55</listitem></itemizedlist>
56</sect3>
57
58<sect3><title><application>TEMPLATE</application> dependencies</title>
59<sect4><title>Required</title>
60<para><xref linkend="BLFS DEPENDENCY"/></para>
61</sect4>
62
63<sect4><title>Optional</title>
64<para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para>
65</sect4>
66</sect3>
67
68</sect2>
69
70<sect2>
71<title>Installation of <application>TEMPLATE</application></title>
72
73<para>Install <application>TEMPLATE</application> by running the following
74commands:</para>
75
76<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
77make &amp;&amp;
78make install</command></userinput></screen>
79
80</sect2>
81
82<sect2>
83<title>Command explanations</title>
84
85<para><command>COMMAND</command>: This command does something.</para>
86
87<para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
88something mandatory for BLFS purposes.</para>
89
90<para><option>--OPTION</option>: This option does something optionally
91per the user's desires.</para>
92
93</sect2>
94
95<sect2>
96<title>Configuring <application>TEMPLATE</application></title>
97
98<sect3><title>Config files</title>
99<para><filename id="SomeUniqueName1">/path/to/Configfilename1</filename>,
100<indexterm zone="TEMPLATE-package SomeUniqueName1">
101<primary sortas="e-SomeUniqueName1">/path/to/Configfilename1</primary></indexterm>
102<filename id="SomeUniqueName2">/path/to/Configfilename2</filename></para>
103<indexterm zone="TEMPLATE-package SomeUniqueName2">
104<primary sortas="e-SomeUniqueName2">/path/to/Configfilename2</primary></indexterm>
105</sect3>
106
107<sect3><title>Configuration Information</title>
108
109<para><userinput>USERINPUT GOES HERE</userinput> Blah blah blah about config.
110</para>
111
112<para id="TEMPLATE.init">To automatically start the
113<command>TEMPLATE</command> daemon when the system is rebooted, install the
114<filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
115<xref linkend="intro-important-bootscripts"/> package.</para>
116<indexterm zone="TEMPLATE-package TEMPLATE.init">
117<primary sortas="f-TEMPLATE.init">TEMPLATE</primary></indexterm>
118
119<screen><userinput><command>make install-TEMPLATE</command></userinput></screen>
120</sect3>
121
122</sect2>
123
124<sect2>
125<title>Contents</title>
126
127<segmentedlist>
128<segtitle>Installed Program(s)</segtitle>
129<segtitle>Installed Librar(y,ies)</segtitle>
130<segtitle>Installed Director(y,ies)</segtitle>
131<seglistitem>
132<seg>PROGRAM1, PROGRAM2 and PROGRAM3</seg>
133<seg>libLIBRARY1, libLIBRARY2 and libLIBRARY3</seg>
134<seg>/etc/TEMPLATE, /var/lib/TEMPLATE, /usr/lib/TEMPLATE,
135/usr/share/TEMPLATE-&TEMPLATE-version; and
136and /usr/share/doc/TEMPLATE-&TEMPLATE-version;</seg>
137</seglistitem>
138</segmentedlist>
139
140<variablelist>
141<bridgehead renderas="sect3">Short Descriptions</bridgehead>
142<?dbfo list-presentation="list"?>
143
144<varlistentry id="PROGRAM1">
145<term><command>PROGRAM1</command></term>
146<listitem><para>does this .....</para>
147<indexterm zone="TEMPLATE-package PROGRAM1">
148<primary sortas="b-PROGRAM1">PROGRAM1</primary></indexterm>
149</listitem>
150</varlistentry>
151
152<varlistentry id="PROGRAM2">
153<term><command>PROGRAM2</command></term>
154<listitem><para>does this .....</para>
155<indexterm zone="TEMPLATE-package PROGRAM2">
156<primary sortas="d-PROGRAM2">PROGRAM2</primary></indexterm>
157</listitem>
158</varlistentry>
159
160<varlistentry id="libLIBRARY1">
161<term><filename class='libraryfile'>libLIBRARY1</filename></term>
162<listitem><para>contains functions that .....</para>
163<indexterm zone="TEMPLATE-package libLIBRARY1">
164<primary sortas="c-libLIBRARY1">libLIBRARY1</primary></indexterm>
165</listitem>
166</varlistentry>
167</variablelist>
168
169</sect2>
170
171</sect1>
172
Note: See TracBrowser for help on using the repository browser.