source: template/template.xml@ 17bcb81

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/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">
]>

<!-- Try to keep the indentation used in this file-->
<sect1 id="TEMPLATE" xreflabel="TEMPLATE-&TEMPLATE-version;">
  <?dbhtml filename="TEMPLATE.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <!-- No other tags inside any title.
       Use Title Case in All Titles -->
  <title>TEMPLATE-&TEMPLATE-version;</title>

  <indexterm zone="TEMPLATE">
    <primary sortas="a-TEMPLATE">TEMPLATE</primary>
  </indexterm>

  <!--Required section-->
  <sect2 role="package">
    <title>Introduction to TEMPLATE</title>

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

    <!-- if it builds but hasn't been tested: -->
    &lfs71_built;
    <!-- if it works: -->
    &lfs71_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <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>

    <!-- As required -->
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/>
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">TEMPLATE Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="BLFS DEPENDENCY"/>
    </para>

    <!-- As required -->
    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink> and
      <xref linkend="BLFS DEPENDENCY"/>.
    </para>

    <!-- As required -->
    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>.
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/TEMPLATE"/>
    </para>
  </sect2>

  <!-- Optional section for packages that need a specific kernel
  configuration-->
  <sect2 role="kernel" id="TEMPLATE-kernel">
    <title>Kernel Configuration</title>

    <para>
      Enable the following options in the kernel configuration and recompile the
      kernel if necessary:
    </para>

<!-- Spaces are significant in <screen> sections -->
<screen><literal>Master section:
  Subsection:
    Required Option: M or Y
    Incompatible option: N</literal></screen>

    <para>
      Select the appropriate sub-options that appear when the above options are
      selected.
    </para>

    <indexterm zone="TEMPLATE TEMPLATE-kernel">
      <primary sortas="d-TEMPLATE">TEMPLATE</primary>
    </indexterm>
  </sect2>

  <!--Required section-->
  <sect2 role="installation">
    <title>Installation of TEMPLATE</title>

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

<!-- Spaces are significant in <screen> sections -->
<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>

    <!-- Optional section. Use one of the two mentions below about a test
         suite, delete the line that is not applicable. Of course, if the
         test suite uses syntax other than 'make check', revise the
         line to reflect the actual syntax to run the test suite -->

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>
  </sect2>

  <!--Optional section-->
  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>

    <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>

  <!--Optional section-->
  <sect2 role="configuration">
    <title>Configuring TEMPLATE</title>

    <sect3 id="TEMPLATE-config">
      <title>Config Files</title>
      <para>
        <filename>~/.Configfilename1</filename> and
        <filename>/etc/path/Configfilename2</filename>.
      </para>

      <indexterm zone="TEMPLATE TEMPLATE-config">
        <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
      </indexterm>

      <indexterm zone="TEMPLATE TEMPLATE-config">
        <primary
        sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
      </indexterm>
    </sect3>

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

      <para>
        Blah blah blah about config.
      </para>

<screen><userinput>USER CONFIG COMMANDS</userinput></screen>

<screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>

      <!-- File creation. Add the appropriate <indexterm> block if needed.-->
      <para>
        Create the file .... for ...
      </para>

<screen role="root"><userinput>cat &gt;&gt; /PATH/FILENAME &lt;&lt; "EOF"
<literal># Begin FILENAME

TEXT

# End FILENAME</literal>
EOF</userinput></screen>
    </sect3>

    <sect3  id="TEMPLATE-init">
      <title>Boot Script</title>

      <para>
        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="bootscripts"/> package.
      </para>

      <indexterm zone="TEMPLATE TEMPLATE-init">
        <primary sortas="f-TEMPLATE">TEMPLATE</primary>
      </indexterm>

<screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
    </sect3>
  </sect2>

  <!--Required section-->
  <sect2 role="content">
    <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.so, libLIBRARY2.so and libLIBRARY3.so.
        </seg>
        <seg>
          /etc/TEMPLATE, /usr/include/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"?>
      <?dbhtml list-presentation="table"?>

      <!-- If the program or library name conflicts (is the same) as the
      package name, add -prog or -lib to the varlistentry entity id
      and the 2nd entry of the indexterm zone entity -->

      <varlistentry id="PROGRAM1">
        <term><command>PROGRAM1</command></term>
        <listitem>
          <para>
            does this .....
          </para>
          <indexterm zone="TEMPLATE 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 PROGRAM2">
            <primary sortas="b-PROGRAM2">PROGRAM2</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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