source: template/template.xml@ 8c18dbc

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!-- Place this in the general.ent file
  <!ENTITY template-version "">
  -->

  <!ENTITY template-download-http "http://">
  <!ENTITY template-download-ftp  "ftp://">
  <!ENTITY template-md5sum        "MD5 sum">
  <!ENTITY template-size          "?? MB">
  <!ENTITY template-buildsize     "?? MB">
  <!ENTITY template-time          "?? SBU">
]>

<sect1 id="template" xreflabel="template-&template-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="template.html"?>
<title><application>template</application>-&template-version;</title>

<sect2>
<title>Introduction to <application>template</application></title>

<para>The <application>template</application> package contains... 
This is useful for...</para>

<sect3><title>Package information</title>
<itemizedlist spacing="compact">
<listitem><para>Download (HTTP): 
<ulink url="&template-download-http;"/></para></listitem>
<listitem><para>Download (FTP): 
<ulink url="&template-download-ftp;"/></para></listitem>
<listitem><para>Download MD5 sum: 
&template-md5sum;</para></listitem>
<listitem><para>Download size: 
&template-size;</para></listitem>
<listitem><para>Estimated disk space required: 
&template-buildsize;</para></listitem>
<listitem><para>Estimated build time: 
&template-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title>Additional downloads</title>
<itemizedlist spacing="compact">
<listitem><para>Required Patch: <ulink
url="&patch-root;/template-&template-version;-patch_name-patch_version.patch"/></para>
</listitem></itemizedlist>
</sect3>

<sect3><title><application>template</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="BLFS DEPENDENCY"/></para>
</sect4>

<sect4><title>Optional</title>
<para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>template</application></title>

<para>Install <application>template</application> by running the following 
commands:</para>

<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><command>COMMAND</command>: This command does something.</para>

<para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does 
something mandatory for BLFS purposes.</para>

<para><option>--OPTION</option>: This option does something optionally
per the user's desires.</para>

</sect2>

<sect2>
<title>Configuring <application>template</application></title>

<sect3><title>Config files</title>
<para><filename>List of config files</filename></para>
</sect3>

<sect3><title>Configuration Information</title>

<para><userinput>USERINPUT GOES HERE</userinput> Blah blah blah about config.
</para>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>template</application> package contains 
<command>LISTOFEXEC</command>, <filename>LISTOFFILES</filename>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>item1</title>
<para><command>item1</command> does this</para></sect3>

<sect3><title>item2</title>
<para><filename>item2</filename> does that</para></sect3>

</sect2>

</sect1>