[d3edf27] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[d3edf27] | 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 |
|
---|
[1ae02579] | 19 | <sect1 id="TEMPLATE" xreflabel="TEMPLATE-&TEMPLATE-version;">
|
---|
[197d9d4] | 20 |
|
---|
[5ac54e51] | 21 | <sect1info>
|
---|
[197d9d4] | 22 | <othername>$LastChangedBy$</othername>
|
---|
| 23 | <date>$Date$</date>
|
---|
[5ac54e51] | 24 | </sect1info>
|
---|
[197d9d4] | 25 |
|
---|
[43fd8be] | 26 | <?dbhtml filename="TEMPLATE.html"?>
|
---|
[eaf6a1cd] | 27 | <!-- No <application> tags in any title-->
|
---|
| 28 | <title>TEMPLATE-&TEMPLATE-version;</title>
|
---|
[1ae02579] | 29 | <indexterm zone="TEMPLATE">
|
---|
[197d9d4] | 30 | <primary sortas="a-TEMPLATE">TEMPLATE</primary>
|
---|
| 31 | </indexterm>
|
---|
[f45b1953] | 32 |
|
---|
[eaf6a1cd] | 33 | <!-- Added role attibutes to <sect2> tags to allow to have a different look
|
---|
| 34 | for each section, if needed-->
|
---|
| 35 | <sect2 role="package">
|
---|
| 36 | <title>Introduction to TEMPLATE</title>
|
---|
[d3edf27] | 37 |
|
---|
[43fd8be] | 38 | <para>The <application>TEMPLATE</application> package contains...
|
---|
[5091d1a] | 39 | This is useful for...</para>
|
---|
[d3edf27] | 40 |
|
---|
[eaf6a1cd] | 41 | <!-- Replaced <sect3> and <sect4> tags by <bridgehead> in this section
|
---|
| 42 | to reduce the number of <sectX> to be processed if numbered sections is
|
---|
| 43 | wanted in the future.-->
|
---|
| 44 | <bridgehead renderas="sect3">Package information</bridgehead>
|
---|
[0590c1b6] | 45 | <itemizedlist spacing="compact">
|
---|
[197d9d4] | 46 | <listitem><para>Download (HTTP):
|
---|
| 47 | <ulink url="&TEMPLATE-download-http;"/></para></listitem>
|
---|
| 48 | <listitem><para>Download (FTP):
|
---|
| 49 | <ulink url="&TEMPLATE-download-ftp;"/></para></listitem>
|
---|
| 50 | <listitem><para>Download MD5 sum:
|
---|
| 51 | &TEMPLATE-md5sum;</para></listitem>
|
---|
| 52 | <listitem><para>Download size:
|
---|
| 53 | &TEMPLATE-size;</para></listitem>
|
---|
| 54 | <listitem><para>Estimated disk space required:
|
---|
| 55 | &TEMPLATE-buildsize;</para></listitem>
|
---|
| 56 | <listitem><para>Estimated build time:
|
---|
[eaf6a1cd] | 57 | &TEMPLATE-time;</para></listitem>
|
---|
| 58 | </itemizedlist>
|
---|
[d3edf27] | 59 |
|
---|
[eaf6a1cd] | 60 | <bridgehead renderas="sect3">Additional downloads</bridgehead>
|
---|
| 61 | <itemizedlist spacing="compact">
|
---|
| 62 | <listitem><para>Required patch: <ulink
|
---|
| 63 | url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
|
---|
| 64 | </listitem>
|
---|
| 65 | </itemizedlist>
|
---|
[0590c1b6] | 66 |
|
---|
[eaf6a1cd] | 67 | <bridgehead renderas="sect3">TEMPLATE dependencies</bridgehead>
|
---|
[1a3dd316] | 68 |
|
---|
[eaf6a1cd] | 69 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 70 | <para><xref linkend="BLFS DEPENDENCY"/></para>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 73 | <para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para>
|
---|
[d3edf27] | 74 |
|
---|
| 75 | </sect2>
|
---|
| 76 |
|
---|
[eaf6a1cd] | 77 | <sect2 role="installation">
|
---|
| 78 | <title>Installation of TEMPLATE</title>
|
---|
[d3edf27] | 79 |
|
---|
[43fd8be] | 80 | <para>Install <application>TEMPLATE</application> by running the following
|
---|
[1a3dd316] | 81 | commands:</para>
|
---|
[d3edf27] | 82 |
|
---|
[eaf6a1cd] | 83 | <!-- Removed <command> tags. For file creation commands <literal> tags must be added
|
---|
| 84 | enclosing the actual text-->
|
---|
| 85 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 86 | make</userinput></screen>
|
---|
| 87 |
|
---|
| 88 | <!--Added the test sute execution-->
|
---|
| 89 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
[3b4a48a] | 90 |
|
---|
[eaf6a1cd] | 91 | <!--Added <systemitem> tag-->
|
---|
| 92 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[3b4a48a] | 93 |
|
---|
[eaf6a1cd] | 94 | <!--Changed where the role attribute is placed-->
|
---|
| 95 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[d3edf27] | 96 |
|
---|
| 97 | </sect2>
|
---|
| 98 |
|
---|
[eaf6a1cd] | 99 | <sect2 role="commands">
|
---|
[d3edf27] | 100 | <title>Command explanations</title>
|
---|
| 101 |
|
---|
| 102 | <para><command>COMMAND</command>: This command does something.</para>
|
---|
| 103 |
|
---|
[5091d1a] | 104 | <para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
|
---|
[a119e79] | 105 | something mandatory for BLFS purposes.</para>
|
---|
[0590c1b6] | 106 |
|
---|
[a119e79] | 107 | <para><option>--OPTION</option>: This option does something optionally
|
---|
| 108 | per the user's desires.</para>
|
---|
[0590c1b6] | 109 |
|
---|
[d3edf27] | 110 | </sect2>
|
---|
| 111 |
|
---|
[eaf6a1cd] | 112 | <sect2 role="configuration">
|
---|
| 113 | <title>Configuring TEMPLATE</title>
|
---|
[d3edf27] | 114 |
|
---|
[197d9d4] | 115 | <sect3 id="TEMPLATE-config">
|
---|
| 116 | <title>Config files</title>
|
---|
| 117 | <para><filename>~/.Configfilename1</filename> and
|
---|
| 118 | <filename>/etc/path/Configfilename2</filename></para>
|
---|
| 119 |
|
---|
| 120 | <indexterm zone="TEMPLATE TEMPLATE-config">
|
---|
| 121 | <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
|
---|
| 122 | </indexterm>
|
---|
| 123 |
|
---|
| 124 | <indexterm zone="TEMPLATE TEMPLATE-config">
|
---|
| 125 | <primary sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
|
---|
| 126 | </indexterm>
|
---|
[d3edf27] | 127 | </sect3>
|
---|
| 128 |
|
---|
[80ff2bf1] | 129 | <sect3><title>Configuration information</title>
|
---|
[eaf6a1cd] | 130 |
|
---|
| 131 | <!--Making this part more proper-->
|
---|
| 132 | <para>Blah blah blah about config.</para>
|
---|
[d3edf27] | 133 |
|
---|
[eaf6a1cd] | 134 | <screen><userinput>USER CONFIG COMMANDS</userinput></screen>
|
---|
| 135 |
|
---|
| 136 | <screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
|
---|
[43fd8be] | 137 |
|
---|
[eaf6a1cd] | 138 | <!-- File creation-->
|
---|
| 139 | <para>Create the file .... for ...</para>
|
---|
| 140 |
|
---|
| 141 | <screen role="root"><userinput>cat >> /PATH/FILENAME << "EOF"
|
---|
| 142 | <literal># Begin FILENAME
|
---|
| 143 |
|
---|
| 144 | TEXT
|
---|
| 145 |
|
---|
| 146 | # End FILENAME</literal>
|
---|
| 147 | EOF</userinput></screen>
|
---|
| 148 | <!-- -->
|
---|
| 149 |
|
---|
| 150 | <sect3 id="TEMPLATE-init">
|
---|
| 151 | <title>Boot Scripts</title>
|
---|
| 152 |
|
---|
| 153 | <para>To automatically start the <command>TEMPLATE</command> daemon
|
---|
| 154 | when the system is rebooted, install the
|
---|
[197d9d4] | 155 | <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
|
---|
| 156 | <xref linkend="intro-important-bootscripts"/> package.</para>
|
---|
| 157 |
|
---|
| 158 | <indexterm zone="TEMPLATE TEMPLATE-init">
|
---|
| 159 | <primary sortas="f-TEMPLATE">TEMPLATE</primary>
|
---|
| 160 | </indexterm>
|
---|
[43fd8be] | 161 |
|
---|
[eaf6a1cd] | 162 | <screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
|
---|
| 163 |
|
---|
[d3edf27] | 164 | </sect3>
|
---|
| 165 |
|
---|
| 166 | </sect2>
|
---|
| 167 |
|
---|
[eaf6a1cd] | 168 | <sect2 role="content">
|
---|
[d3edf27] | 169 | <title>Contents</title>
|
---|
| 170 |
|
---|
[43fd8be] | 171 | <segmentedlist>
|
---|
[197d9d4] | 172 | <segtitle>Installed Program(s)</segtitle>
|
---|
| 173 | <segtitle>Installed Librar(y,ies)</segtitle>
|
---|
| 174 | <segtitle>Installed Director(y,ies)</segtitle>
|
---|
| 175 |
|
---|
| 176 | <seglistitem>
|
---|
[eaf6a1cd] | 177 | <seg>PROGRAM1, PROGRAM2, and PROGRAM3</seg>
|
---|
| 178 | <seg>libLIBRARY1, libLIBRARY2, and libLIBRARY3</seg>
|
---|
[197d9d4] | 179 | <seg>/etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
|
---|
| 180 | /usr/share/TEMPLATE-&TEMPLATE-version;,
|
---|
[eaf6a1cd] | 181 | /usr/share/doc/TEMPLATE-&TEMPLATE-version;, and
|
---|
[197d9d4] | 182 | /var/lib/TEMPLATE</seg>
|
---|
| 183 | </seglistitem>
|
---|
[43fd8be] | 184 | </segmentedlist>
|
---|
| 185 |
|
---|
| 186 | <variablelist>
|
---|
[197d9d4] | 187 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 188 | <?dbfo list-presentation="list"?>
|
---|
[eaf6a1cd] | 189 | <!--Render this as a table for HTML output-->
|
---|
| 190 | <?dbhtml list-presentation="table"?>
|
---|
[43fd8be] | 191 |
|
---|
[1ae02579] | 192 | <!-- If the program or library name conflicts (is the same) as the
|
---|
| 193 | package name, add -prog or -lib to the varlistentry entity id
|
---|
| 194 | and the 2nd entry of the indexterm zone entity -->
|
---|
| 195 |
|
---|
[43fd8be] | 196 | <varlistentry id="PROGRAM1">
|
---|
[197d9d4] | 197 | <term><command>PROGRAM1</command></term>
|
---|
| 198 | <listitem>
|
---|
| 199 | <para>does this .....</para>
|
---|
| 200 | <indexterm zone="TEMPLATE PROGRAM1">
|
---|
| 201 | <primary sortas="b-PROGRAM1">PROGRAM1</primary>
|
---|
| 202 | </indexterm>
|
---|
| 203 | </listitem>
|
---|
[43fd8be] | 204 | </varlistentry>
|
---|
| 205 |
|
---|
[e48dd79] | 206 | <varlistentry id="PROGRAM2">
|
---|
[197d9d4] | 207 | <term><command>PROGRAM2</command></term>
|
---|
| 208 | <listitem>
|
---|
| 209 | <para>does this .....</para>
|
---|
| 210 | <indexterm zone="TEMPLATE PROGRAM2">
|
---|
| 211 | <primary sortas="b-PROGRAM2">PROGRAM2</primary>
|
---|
| 212 | </indexterm>
|
---|
| 213 | </listitem>
|
---|
[43fd8be] | 214 | </varlistentry>
|
---|
| 215 |
|
---|
| 216 | <varlistentry id="libLIBRARY1">
|
---|
[197d9d4] | 217 | <term><filename class='libraryfile'>libLIBRARY1.[so,a]</filename></term>
|
---|
| 218 | <listitem>
|
---|
| 219 | <para>contains functions that .....</para>
|
---|
| 220 | <indexterm zone="TEMPLATE libLIBRARY1">
|
---|
| 221 | <primary sortas="c-libLIBRARY1">libLIBRARY1.[so,a]</primary>
|
---|
| 222 | </indexterm>
|
---|
| 223 | </listitem>
|
---|
[43fd8be] | 224 | </varlistentry>
|
---|
[197d9d4] | 225 |
|
---|
[43fd8be] | 226 | </variablelist>
|
---|
[d3edf27] | 227 |
|
---|
| 228 | </sect2>
|
---|
[f45b1953] | 229 |
|
---|
[87930b0f] | 230 | </sect1>
|
---|
[f45b1953] | 231 |
|
---|