[d3edf27] | 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
|
---|
[43fd8be] | 8 | <!ENTITY TEMPLATE-version "">
|
---|
[d3edf27] | 9 | -->
|
---|
| 10 |
|
---|
[43fd8be] | 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">
|
---|
[d3edf27] | 17 | ]>
|
---|
| 18 |
|
---|
[43fd8be] | 19 | <sect1 id="TEMPLATE-package" xreflabel="TEMPLATE-&TEMPLATE-version;">
|
---|
[5ac54e51] | 20 | <sect1info>
|
---|
[5cd0959d] | 21 | <othername>$LastChangedBy$</othername>
|
---|
| 22 | <date>$Date$</date>
|
---|
[5ac54e51] | 23 | </sect1info>
|
---|
[43fd8be] | 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>
|
---|
[f45b1953] | 28 |
|
---|
[d3edf27] | 29 | <sect2>
|
---|
[43fd8be] | 30 | <title>Introduction to <application>TEMPLATE</application></title>
|
---|
[d3edf27] | 31 |
|
---|
[43fd8be] | 32 | <para>The <application>TEMPLATE</application> package contains...
|
---|
[5091d1a] | 33 | This is useful for...</para>
|
---|
[d3edf27] | 34 |
|
---|
| 35 | <sect3><title>Package information</title>
|
---|
[0590c1b6] | 36 | <itemizedlist spacing="compact">
|
---|
[9ebf027] | 37 | <listitem><para>Download (HTTP):
|
---|
[43fd8be] | 38 | <ulink url="&TEMPLATE-download-http;"/></para></listitem>
|
---|
[9ebf027] | 39 | <listitem><para>Download (FTP):
|
---|
[43fd8be] | 40 | <ulink url="&TEMPLATE-download-ftp;"/></para></listitem>
|
---|
[9ebf027] | 41 | <listitem><para>Download MD5 sum:
|
---|
[43fd8be] | 42 | &TEMPLATE-md5sum;</para></listitem>
|
---|
[9ebf027] | 43 | <listitem><para>Download size:
|
---|
[43fd8be] | 44 | &TEMPLATE-size;</para></listitem>
|
---|
[9ebf027] | 45 | <listitem><para>Estimated disk space required:
|
---|
[43fd8be] | 46 | &TEMPLATE-buildsize;</para></listitem>
|
---|
[9ebf027] | 47 | <listitem><para>Estimated build time:
|
---|
[43fd8be] | 48 | &TEMPLATE-time;</para></listitem></itemizedlist>
|
---|
[d3edf27] | 49 | </sect3>
|
---|
| 50 |
|
---|
[0590c1b6] | 51 | <sect3><title>Additional downloads</title>
|
---|
| 52 | <itemizedlist spacing="compact">
|
---|
[43fd8be] | 53 | <listitem><para>Required Patch: <ulink
|
---|
| 54 | url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
|
---|
[1a3dd316] | 55 | </listitem></itemizedlist>
|
---|
| 56 | </sect3>
|
---|
[0590c1b6] | 57 |
|
---|
[43fd8be] | 58 | <sect3><title><application>TEMPLATE</application> dependencies</title>
|
---|
[d3edf27] | 59 | <sect4><title>Required</title>
|
---|
[1a3dd316] | 60 | <para><xref linkend="BLFS DEPENDENCY"/></para>
|
---|
| 61 | </sect4>
|
---|
| 62 |
|
---|
[d3edf27] | 63 | <sect4><title>Optional</title>
|
---|
[1a3dd316] | 64 | <para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para>
|
---|
| 65 | </sect4>
|
---|
[d3edf27] | 66 | </sect3>
|
---|
| 67 |
|
---|
| 68 | </sect2>
|
---|
| 69 |
|
---|
| 70 | <sect2>
|
---|
[43fd8be] | 71 | <title>Installation of <application>TEMPLATE</application></title>
|
---|
[d3edf27] | 72 |
|
---|
[43fd8be] | 73 | <para>Install <application>TEMPLATE</application> by running the following
|
---|
[1a3dd316] | 74 | commands:</para>
|
---|
[d3edf27] | 75 |
|
---|
[1a3dd316] | 76 | <screen><userinput><command>./configure --prefix=/usr &&
|
---|
| 77 | make &&
|
---|
| 78 | make install</command></userinput></screen>
|
---|
[d3edf27] | 79 |
|
---|
| 80 | </sect2>
|
---|
| 81 |
|
---|
| 82 | <sect2>
|
---|
| 83 | <title>Command explanations</title>
|
---|
| 84 |
|
---|
| 85 | <para><command>COMMAND</command>: This command does something.</para>
|
---|
| 86 |
|
---|
[5091d1a] | 87 | <para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
|
---|
[a119e79] | 88 | something mandatory for BLFS purposes.</para>
|
---|
[0590c1b6] | 89 |
|
---|
[a119e79] | 90 | <para><option>--OPTION</option>: This option does something optionally
|
---|
| 91 | per the user's desires.</para>
|
---|
[0590c1b6] | 92 |
|
---|
[d3edf27] | 93 | </sect2>
|
---|
| 94 |
|
---|
| 95 | <sect2>
|
---|
[43fd8be] | 96 | <title>Configuring <application>TEMPLATE</application></title>
|
---|
[d3edf27] | 97 |
|
---|
| 98 | <sect3><title>Config files</title>
|
---|
[43fd8be] | 99 | <para><filename id="SomeUniqueName1">Configfilename1</filename>,
|
---|
| 100 | <indexterm zone="TEMPLATE-package SomeUniqueName1">
|
---|
| 101 | <primary sortas="e-SomeUniqueName1">Configfilename1</primary></indexterm>
|
---|
| 102 | <filename id="SomeUniqueName2">Configfilename2</filename></para>
|
---|
| 103 | <indexterm zone="TEMPLATE-package SomeUniqueName2">
|
---|
| 104 | <primary sortas="e-SomeUniqueName2">Configfilename2</primary></indexterm>
|
---|
[d3edf27] | 105 | </sect3>
|
---|
| 106 |
|
---|
| 107 | <sect3><title>Configuration Information</title>
|
---|
| 108 |
|
---|
| 109 | <para><userinput>USERINPUT GOES HERE</userinput> Blah blah blah about config.
|
---|
| 110 | </para>
|
---|
[43fd8be] | 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>
|
---|
[d3edf27] | 120 | </sect3>
|
---|
| 121 |
|
---|
| 122 | </sect2>
|
---|
| 123 |
|
---|
| 124 | <sect2>
|
---|
| 125 | <title>Contents</title>
|
---|
| 126 |
|
---|
[43fd8be] | 127 | <segmentedlist>
|
---|
| 128 | <segtitle>Installed Program(s)</segtitle>
|
---|
| 129 | <segtitle>Installed Script(s)</segtitle>
|
---|
| 130 | <segtitle>Installed Librar(y,ies)</segtitle>
|
---|
| 131 | <segtitle>Installed Director(y,ies)</segtitle>
|
---|
| 132 | <seglistitem>
|
---|
| 133 | <seg>PROGRAM1, PROGRAM2 and PROGRAM3</seg>
|
---|
| 134 | <seg>SCRIPT1, SCRIPT2 and SCRIPT3</seg>
|
---|
| 135 | <seg>libLIBRARY1, libLIBRARY2 and libLIBRARY3</seg>
|
---|
| 136 | <seg>/etc/TEMPLATE, /var/lib/TEMPLATE, /usr/lib/TEMPLATE,
|
---|
| 137 | /usr/share/TEMPLATE-&TEMPLATE-version; and
|
---|
| 138 | and /usr/share/doc/TEMPLATE-&TEMPLATE-version;</seg>
|
---|
| 139 | </seglistitem>
|
---|
| 140 | </segmentedlist>
|
---|
| 141 |
|
---|
| 142 | <variablelist>
|
---|
| 143 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 144 | <?dbfo list-presentation="list"?>
|
---|
| 145 |
|
---|
| 146 | <varlistentry id="PROGRAM1">
|
---|
| 147 | <term><command>PROGRAM1</command></term>
|
---|
| 148 | <listitem><para>does this .....</para>
|
---|
| 149 | <indexterm zone="TEMPLATE-package PROGRAM1">
|
---|
| 150 | <primary sortas="b-PROGRAM1">PROGRAM1</primary></indexterm>
|
---|
| 151 | </listitem>
|
---|
| 152 | </varlistentry>
|
---|
| 153 |
|
---|
| 154 | <varlistentry id="SCRIPT1">
|
---|
| 155 | <term><command>SCRIPT1</command></term>
|
---|
| 156 | <listitem><para>does this .....</para>
|
---|
| 157 | <indexterm zone="TEMPLATE-package SCRIPT1">
|
---|
| 158 | <primary sortas="d-SCRIPT1">SCRIPT1</primary></indexterm>
|
---|
| 159 | </listitem>
|
---|
| 160 | </varlistentry>
|
---|
| 161 |
|
---|
| 162 | <varlistentry id="libLIBRARY1">
|
---|
| 163 | <term><filename class='libraryfile'>libLIBRARY1</filename></term>
|
---|
| 164 | <listitem><para> contains functions that .....</para>
|
---|
| 165 | <indexterm zone="TEMPLATE-package libLIBRARY1">
|
---|
| 166 | <primary sortas="c-libLIBRARY1">libLIBRARY1</primary></indexterm>
|
---|
| 167 | </listitem>
|
---|
| 168 | </varlistentry>
|
---|
| 169 | </variablelist>
|
---|
[d3edf27] | 170 |
|
---|
| 171 | </sect2>
|
---|
[f45b1953] | 172 |
|
---|
[87930b0f] | 173 | </sect1>
|
---|
[f45b1953] | 174 |
|
---|