- Timestamp:
- 05/16/2005 11:51:14 AM (19 years ago)
- Branches:
- 10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 12.2, 6.1, 6.2, 6.2.0, 6.2.0-rc1, 6.2.0-rc2, 6.3, 6.3-rc1, 6.3-rc2, 6.3-rc3, 7.10, 7.4, 7.5, 7.6, 7.6-blfs, 7.6-systemd, 7.7, 7.8, 7.9, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, basic, bdubbs/svn, elogind, gimp3, gnome, kde5-13430, kde5-14269, kde5-14686, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, krejzi/svn, lazarus, lxqt, nosym, perl-modules, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, systemd-11177, systemd-13485, trunk, upgradedb, xry111/for-12.3, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/spidermonkey128, xry111/test-20220226, xry111/xf86-video-removal
- Children:
- f570280
- Parents:
- 89f473d
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
template/template.xml
r89f473d r46daaa1 20 20 <sect1 id="TEMPLATE" xreflabel="TEMPLATE-&TEMPLATE-version;"> 21 21 <?dbhtml filename="TEMPLATE.html"?> 22 22 23 23 <sect1info> 24 24 <othername>$LastChangedBy$</othername> 25 25 <date>$Date$</date> 26 26 </sect1info> 27 27 28 28 <!-- No other tags inside any title--> 29 29 <!-- Use Title Case in All Titles … … 37 37 -Lowercase the "to" in an infinitive."--> 38 38 <title>TEMPLATE-&TEMPLATE-version;</title> 39 39 40 40 <indexterm zone="TEMPLATE"> 41 41 <primary sortas="a-TEMPLATE">TEMPLATE</primary> 42 42 </indexterm> 43 43 44 44 <!--Required section--> 45 45 <sect2 role="package"> 46 46 <title>Introduction to TEMPLATE</title> 47 47 48 48 <para>The <application>TEMPLATE</application> package contains... 49 49 This is useful for...</para> 50 50 51 51 <bridgehead renderas="sect3">Package Information</bridgehead> 52 52 <itemizedlist spacing="compact"> … … 70 70 </listitem> 71 71 </itemizedlist> 72 72 73 73 <!-- As required --> 74 74 <bridgehead renderas="sect3">Additional Downloads</bridgehead> … … 79 79 </listitem> 80 80 </itemizedlist> 81 81 82 82 <bridgehead renderas="sect3">TEMPLATE Dependencies</bridgehead> 83 83 84 84 <bridgehead renderas="sect4">Required</bridgehead> 85 85 <para><xref linkend="BLFS DEPENDENCY"/></para> 86 86 87 87 <!-- As required --> 88 88 <bridgehead renderas="sect4">Recommended</bridgehead> 89 89 <para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>, 90 90 <xref linkend="BLFS DEPENDENCY"/></para> 91 91 92 92 <!-- As required --> 93 93 <bridgehead renderas="sect4">Optional</bridgehead> 94 94 <para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para> 95 96 </sect2> 97 95 96 </sect2> 97 98 98 <!-- Optional section for packages that need a specific kernel configuration--> 99 99 <sect2 role="kernel" id='TEMPLATE-kernel'> 100 100 <title>Kernel Configuration</title> 101 101 102 102 <para>Enable the following options in the kernel configuration 103 103 and recompile the kernel if neccessary:</para> 104 105 <!-- Spaces are significant in <screen> sections --> 104 105 <!-- Spaces are significant in <screen> sections --> 106 106 <screen><literal>Master section: 107 107 Subsection: 108 108 Required Option: M or Y 109 109 Incompatible option: N</literal></screen> 110 110 111 111 <para>Select the appropriate sub-options that appear when the above options 112 112 are selected.</para> 113 113 114 114 <indexterm zone="TEMPLATE TEMPLATE-kernel"> 115 115 <primary sortas="d-TEMPLATE">TEMPLATE</primary> 116 116 </indexterm> 117 118 </sect2> 119 117 118 </sect2> 119 120 120 <!--Required section--> 121 121 <sect2 role="installation"> 122 122 <title>Installation of TEMPLATE</title> 123 123 124 124 <para>Install <application>TEMPLATE</application> by running the following 125 125 commands:</para> 126 127 <!-- Spaces are significant in <screen> sections --> 126 127 <!-- Spaces are significant in <screen> sections --> 128 128 <screen><userinput>./configure --prefix=/usr && 129 129 make</userinput></screen> 130 130 131 131 <para>To test the results, issue: <command>make check</command>.</para> 132 132 133 133 <para>Now, as the <systemitem class="username">root</systemitem> user:</para> 134 134 135 135 <screen role="root"><userinput>make install</userinput></screen> 136 137 </sect2> 138 136 137 </sect2> 138 139 139 <!--Optional section--> 140 140 <sect2 role="commands"> 141 141 <title>Command Explanations</title> 142 142 143 143 <para><command>COMMAND</command>: This command does something.</para> 144 144 145 145 <para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does 146 146 something mandatory for BLFS purposes.</para> 147 147 148 148 <para><option>--OPTION</option>: This option does something optionally 149 149 per the user's desires.</para> 150 151 </sect2> 152 150 151 </sect2> 152 153 153 <!--Optional section--> 154 154 <sect2 role="configuration"> 155 155 <title>Configuring TEMPLATE</title> 156 156 157 157 <sect3 id="TEMPLATE-config"> 158 158 <title>Config Files</title> 159 159 <para><filename>~/.Configfilename1</filename> and 160 160 <filename>/etc/path/Configfilename2</filename></para> 161 161 162 162 <indexterm zone="TEMPLATE TEMPLATE-config"> 163 163 <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary> 164 164 </indexterm> 165 165 166 166 <indexterm zone="TEMPLATE TEMPLATE-config"> 167 167 <primary sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary> 168 168 </indexterm> 169 169 </sect3> 170 170 171 171 <sect3><title>Configuration Information</title> 172 172 173 173 <para>Blah blah blah about config.</para> 174 174 175 175 <screen><userinput>USER CONFIG COMMANDS</userinput></screen> 176 176 177 177 <screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen> 178 178 179 179 <!-- File creation. Add the appropiate <indexterm> block if needed.--> 180 180 <para>Create the file .... for ...</para> 181 181 182 182 <screen role="root"><userinput>cat >> /PATH/FILENAME << "EOF" 183 183 <literal># Begin FILENAME 184 184 185 185 TEXT 186 186 187 187 # End FILENAME</literal> 188 188 EOF</userinput></screen> 189 189 190 190 </sect3> 191 191 192 192 <sect3 id="TEMPLATE-init"> 193 193 <title>Boot Script</title> 194 194 195 195 <para>To automatically start the <command>TEMPLATE</command> daemon 196 when the system is rebooted, install the <filename>/etc/rc.d/init.d/TEMPLATE</filename> 197 bootscript from the <xref linkend="intro-important-bootscripts"/> package.</para> 198 199 <indexterm zone="TEMPLATE TEMPLATE-init"> 196 when the system is rebooted, install the 197 <filename>/etc/rc.d/init.d/TEMPLATE</filename> 198 bootscript from the 199 <xref linkend="intro-important-bootscripts"/> package.</para> 200 201 <indexterm zone="TEMPLATE TEMPLATE-init"> 200 202 <primary sortas="f-TEMPLATE">TEMPLATE</primary> 201 </indexterm> 202 203 </indexterm> 204 203 205 <screen role="root"><userinput>make install-TEMPLATE</userinput></screen> 204 206 205 207 </sect3> 206 207 </sect2> 208 209 <!--Required section--> 208 209 </sect2> 210 211 <!--Required section--> 210 212 <sect2 role="content"> 211 213 <title>Contents</title> 212 214 213 215 <segmentedlist> 214 216 <segtitle>Installed Program(s)</segtitle> 215 217 <segtitle>Installed Librar(y,ies)</segtitle> 216 218 <segtitle>Installed Director(y,ies)</segtitle> 217 219 218 220 <seglistitem> 219 221 <seg>PROGRAM1, PROGRAM2, and PROGRAM3</seg> … … 225 227 </seglistitem> 226 228 </segmentedlist> 227 229 228 230 <variablelist> 229 231 <bridgehead renderas="sect3">Short Descriptions</bridgehead> 230 232 <?dbfo list-presentation="list"?> 231 233 <?dbhtml list-presentation="table"?> 232 234 233 235 <!-- If the program or library name conflicts (is the same) as the 234 236 package name, add -prog or -lib to the varlistentry entity id 235 237 and the 2nd entry of the indexterm zone entity --> 236 238 237 239 <varlistentry id="PROGRAM1"> 238 240 <term><command>PROGRAM1</command></term> … … 244 246 </listitem> 245 247 </varlistentry> 246 248 247 249 <varlistentry id="PROGRAM2"> 248 250 <term><command>PROGRAM2</command></term> … … 254 256 </listitem> 255 257 </varlistentry> 256 258 257 259 <varlistentry id="libLIBRARY1"> 258 260 <term><filename class='libraryfile'>libLIBRARY1.[so,a]</filename></term> … … 264 266 </listitem> 265 267 </varlistentry> 266 268 267 269 </variablelist> 268 269 </sect2> 270 270 271 </sect2> 272 271 273 </sect1> 272
Note:
See TracChangeset
for help on using the changeset viewer.