source: template/template.xml@ b1d34414

<?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-package" xreflabel="TEMPLATE-&TEMPLATE-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="TEMPLATE.html"?>
<title><application>TEMPLATE</application>-&TEMPLATE-version;</title>
<indexterm zone="TEMPLATE-package">
<primary sortas="a-TEMPLATE-package">TEMPLATE</primary></indexterm>

<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 id="TEMPLATE-config"><title>Config files</title>
<para><filename>~/.Configfilename1</filename> and 
<filename>/etc/path/Configfilename2</filename></para>

<indexterm zone="TEMPLATE-package TEMPLATE-config">
<primary sortas="e-AA.Configfilename1">/path/to/Configfilename1</primary>
</indexterm>
<indexterm zone="TEMPLATE-package TEMPLATE-config">
<primary sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
</indexterm>
</sect3>

<sect3><title>Configuration information</title>

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

<para id="TEMPLATE-init">To automatically start the 
<command>TEMPLATE</command> daemon when the system is rebooted, install the 
<filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the 
<xref linkend="intro-important-bootscripts"/> package.</para> 
<indexterm zone="TEMPLATE-package TEMPLATE-init"> 
<primary sortas="f-TEMPLATE-init">TEMPLATE</primary></indexterm> 

<screen><userinput><command>make install-TEMPLATE</command></userinput></screen>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Program(s)</segtitle>
<segtitle>Installed Librar(y,ies)</segtitle>
<segtitle>Installed Director(y,ies)</segtitle>
<seglistitem>
<seg>PROGRAM1, PROGRAM2 and PROGRAM3</seg>
<seg>libLIBRARY1, libLIBRARY2 and libLIBRARY3</seg>
<seg>/etc/TEMPLATE, /usr/lib/TEMPLATE, 
/usr/share/TEMPLATE-&TEMPLATE-version;, 
/usr/share/doc/TEMPLATE-&TEMPLATE-version; and 
/var/lib/TEMPLATE</seg>
</seglistitem>
</segmentedlist>

<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>

<varlistentry id="PROGRAM1">
<term><command>PROGRAM1</command></term>
<listitem><para>does this .....</para>
<indexterm zone="TEMPLATE-package PROGRAM1">
<primary sortas="b-PROGRAM1">PROGRAM1</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="PROGRAM2">
<term><command>PROGRAM2</command></term>
<listitem><para>does this .....</para>
<indexterm zone="TEMPLATE-package PROGRAM2">
<primary sortas="d-PROGRAM2">PROGRAM2</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="libLIBRARY1">
<term><filename class='libraryfile'>libLIBRARY1</filename></term>
<listitem><para>contains functions that .....</para>
<indexterm zone="TEMPLATE-package libLIBRARY1">
<primary sortas="c-libLIBRARY1">libLIBRARY1</primary></indexterm>
</listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>