[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 |
|
---|
[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"?>
|
---|
| 27 | <title><application>TEMPLATE</application>-&TEMPLATE-version;</title>
|
---|
[1ae02579] | 28 | <indexterm zone="TEMPLATE">
|
---|
[197d9d4] | 29 | <primary sortas="a-TEMPLATE">TEMPLATE</primary>
|
---|
| 30 | </indexterm>
|
---|
[f45b1953] | 31 |
|
---|
[d3edf27] | 32 | <sect2>
|
---|
[43fd8be] | 33 | <title>Introduction to <application>TEMPLATE</application></title>
|
---|
[d3edf27] | 34 |
|
---|
[43fd8be] | 35 | <para>The <application>TEMPLATE</application> package contains...
|
---|
[5091d1a] | 36 | This is useful for...</para>
|
---|
[d3edf27] | 37 |
|
---|
| 38 | <sect3><title>Package information</title>
|
---|
[0590c1b6] | 39 | <itemizedlist spacing="compact">
|
---|
[197d9d4] | 40 | <listitem><para>Download (HTTP):
|
---|
| 41 | <ulink url="&TEMPLATE-download-http;"/></para></listitem>
|
---|
| 42 | <listitem><para>Download (FTP):
|
---|
| 43 | <ulink url="&TEMPLATE-download-ftp;"/></para></listitem>
|
---|
| 44 | <listitem><para>Download MD5 sum:
|
---|
| 45 | &TEMPLATE-md5sum;</para></listitem>
|
---|
| 46 | <listitem><para>Download size:
|
---|
| 47 | &TEMPLATE-size;</para></listitem>
|
---|
| 48 | <listitem><para>Estimated disk space required:
|
---|
| 49 | &TEMPLATE-buildsize;</para></listitem>
|
---|
| 50 | <listitem><para>Estimated build time:
|
---|
| 51 | &TEMPLATE-time;</para></listitem></itemizedlist>
|
---|
[d3edf27] | 52 | </sect3>
|
---|
| 53 |
|
---|
[197d9d4] | 54 | <sect3>
|
---|
| 55 | <title>Additional downloads</title>
|
---|
| 56 | <itemizedlist spacing="compact">
|
---|
| 57 | <listitem><para>Required patch: <ulink
|
---|
| 58 | url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
|
---|
| 59 | </listitem>
|
---|
| 60 | </itemizedlist>
|
---|
[1a3dd316] | 61 | </sect3>
|
---|
[0590c1b6] | 62 |
|
---|
[43fd8be] | 63 | <sect3><title><application>TEMPLATE</application> dependencies</title>
|
---|
[197d9d4] | 64 | <sect4><title>Required</title>
|
---|
| 65 | <para><xref linkend="BLFS DEPENDENCY"/></para>
|
---|
| 66 | </sect4>
|
---|
[1a3dd316] | 67 |
|
---|
[197d9d4] | 68 | <sect4><title>Optional</title>
|
---|
| 69 | <para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para>
|
---|
| 70 | </sect4>
|
---|
[d3edf27] | 71 | </sect3>
|
---|
| 72 |
|
---|
| 73 | </sect2>
|
---|
| 74 |
|
---|
| 75 | <sect2>
|
---|
[43fd8be] | 76 | <title>Installation of <application>TEMPLATE</application></title>
|
---|
[d3edf27] | 77 |
|
---|
[43fd8be] | 78 | <para>Install <application>TEMPLATE</application> by running the following
|
---|
[1a3dd316] | 79 | commands:</para>
|
---|
[d3edf27] | 80 |
|
---|
[1a3dd316] | 81 | <screen><userinput><command>./configure --prefix=/usr &&
|
---|
[3b4a48a] | 82 | make</command></userinput></screen>
|
---|
| 83 |
|
---|
| 84 | <para>Now, as the root user:</para>
|
---|
| 85 |
|
---|
[706d27c] | 86 | <screen><userinput role='root'><command>make install</command></userinput></screen>
|
---|
[d3edf27] | 87 |
|
---|
| 88 | </sect2>
|
---|
| 89 |
|
---|
| 90 | <sect2>
|
---|
| 91 | <title>Command explanations</title>
|
---|
| 92 |
|
---|
| 93 | <para><command>COMMAND</command>: This command does something.</para>
|
---|
| 94 |
|
---|
[5091d1a] | 95 | <para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
|
---|
[a119e79] | 96 | something mandatory for BLFS purposes.</para>
|
---|
[0590c1b6] | 97 |
|
---|
[a119e79] | 98 | <para><option>--OPTION</option>: This option does something optionally
|
---|
| 99 | per the user's desires.</para>
|
---|
[0590c1b6] | 100 |
|
---|
[d3edf27] | 101 | </sect2>
|
---|
| 102 |
|
---|
| 103 | <sect2>
|
---|
[43fd8be] | 104 | <title>Configuring <application>TEMPLATE</application></title>
|
---|
[d3edf27] | 105 |
|
---|
[197d9d4] | 106 | <sect3 id="TEMPLATE-config">
|
---|
| 107 | <title>Config files</title>
|
---|
| 108 | <para><filename>~/.Configfilename1</filename> and
|
---|
| 109 | <filename>/etc/path/Configfilename2</filename></para>
|
---|
| 110 |
|
---|
| 111 | <indexterm zone="TEMPLATE TEMPLATE-config">
|
---|
| 112 | <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
|
---|
| 113 | </indexterm>
|
---|
| 114 |
|
---|
| 115 | <indexterm zone="TEMPLATE TEMPLATE-config">
|
---|
| 116 | <primary sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
|
---|
| 117 | </indexterm>
|
---|
[d3edf27] | 118 | </sect3>
|
---|
| 119 |
|
---|
[80ff2bf1] | 120 | <sect3><title>Configuration information</title>
|
---|
[d3edf27] | 121 |
|
---|
[197d9d4] | 122 | <para><userinput role='root'>USERINPUT GOES HERE</userinput> Blah blah blah
|
---|
| 123 | about config.</para>
|
---|
[43fd8be] | 124 |
|
---|
[197d9d4] | 125 | <para id="TEMPLATE-init">To automatically start the
|
---|
| 126 | <command>TEMPLATE</command> daemon when the system is rebooted, install the
|
---|
| 127 | <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
|
---|
| 128 | <xref linkend="intro-important-bootscripts"/> package.</para>
|
---|
| 129 |
|
---|
| 130 | <indexterm zone="TEMPLATE TEMPLATE-init">
|
---|
| 131 | <primary sortas="f-TEMPLATE">TEMPLATE</primary>
|
---|
| 132 | </indexterm>
|
---|
[43fd8be] | 133 |
|
---|
[706d27c] | 134 | <screen><userinput role='root'><command>make install-TEMPLATE</command></userinput></screen>
|
---|
[d3edf27] | 135 | </sect3>
|
---|
| 136 |
|
---|
| 137 | </sect2>
|
---|
| 138 |
|
---|
| 139 | <sect2>
|
---|
| 140 | <title>Contents</title>
|
---|
| 141 |
|
---|
[43fd8be] | 142 | <segmentedlist>
|
---|
[197d9d4] | 143 | <segtitle>Installed Program(s)</segtitle>
|
---|
| 144 | <segtitle>Installed Librar(y,ies)</segtitle>
|
---|
| 145 | <segtitle>Installed Director(y,ies)</segtitle>
|
---|
| 146 |
|
---|
| 147 | <seglistitem>
|
---|
| 148 | <seg>PROGRAM1, PROGRAM2 and PROGRAM3</seg>
|
---|
| 149 | <seg>libLIBRARY1, libLIBRARY2 and libLIBRARY3</seg>
|
---|
| 150 | <seg>/etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
|
---|
| 151 | /usr/share/TEMPLATE-&TEMPLATE-version;,
|
---|
| 152 | /usr/share/doc/TEMPLATE-&TEMPLATE-version; and
|
---|
| 153 | /var/lib/TEMPLATE</seg>
|
---|
| 154 | </seglistitem>
|
---|
[43fd8be] | 155 | </segmentedlist>
|
---|
| 156 |
|
---|
| 157 | <variablelist>
|
---|
[197d9d4] | 158 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 159 | <?dbfo list-presentation="list"?>
|
---|
[43fd8be] | 160 |
|
---|
[1ae02579] | 161 | <!-- If the program or library name conflicts (is the same) as the
|
---|
| 162 | package name, add -prog or -lib to the varlistentry entity id
|
---|
| 163 | and the 2nd entry of the indexterm zone entity -->
|
---|
| 164 |
|
---|
[43fd8be] | 165 | <varlistentry id="PROGRAM1">
|
---|
[197d9d4] | 166 | <term><command>PROGRAM1</command></term>
|
---|
| 167 | <listitem>
|
---|
| 168 | <para>does this .....</para>
|
---|
| 169 | <indexterm zone="TEMPLATE PROGRAM1">
|
---|
| 170 | <primary sortas="b-PROGRAM1">PROGRAM1</primary>
|
---|
| 171 | </indexterm>
|
---|
| 172 | </listitem>
|
---|
[43fd8be] | 173 | </varlistentry>
|
---|
| 174 |
|
---|
[e48dd79] | 175 | <varlistentry id="PROGRAM2">
|
---|
[197d9d4] | 176 | <term><command>PROGRAM2</command></term>
|
---|
| 177 | <listitem>
|
---|
| 178 | <para>does this .....</para>
|
---|
| 179 | <indexterm zone="TEMPLATE PROGRAM2">
|
---|
| 180 | <primary sortas="b-PROGRAM2">PROGRAM2</primary>
|
---|
| 181 | </indexterm>
|
---|
| 182 | </listitem>
|
---|
[43fd8be] | 183 | </varlistentry>
|
---|
| 184 |
|
---|
| 185 | <varlistentry id="libLIBRARY1">
|
---|
[197d9d4] | 186 | <term><filename class='libraryfile'>libLIBRARY1.[so,a]</filename></term>
|
---|
| 187 | <listitem>
|
---|
| 188 | <para>contains functions that .....</para>
|
---|
| 189 | <indexterm zone="TEMPLATE libLIBRARY1">
|
---|
| 190 | <primary sortas="c-libLIBRARY1">libLIBRARY1.[so,a]</primary>
|
---|
| 191 | </indexterm>
|
---|
| 192 | </listitem>
|
---|
[43fd8be] | 193 | </varlistentry>
|
---|
[197d9d4] | 194 |
|
---|
[43fd8be] | 195 | </variablelist>
|
---|
[d3edf27] | 196 |
|
---|
| 197 | </sect2>
|
---|
[f45b1953] | 198 |
|
---|
[87930b0f] | 199 | </sect1>
|
---|
[f45b1953] | 200 |
|
---|