[d3edf27] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[d3edf27] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[e248af7] | 7 | <!-- Place this in the packages.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">
|
---|
[6fe407f4] | 17 | <!-- SBU should be rounded to nearer integer if greater than 10, to one
|
---|
| 18 | decimal if less than 10, and should be "less than 0.1 SBU" if
|
---|
| 19 | less than 0.1. If the SBU without parallelisation is too long,
|
---|
[1ae4746] | 20 | it is acceptable to give the value "with parallelism=N", where
|
---|
[6fe407f4] | 21 | N is the number of threads used. Note that some build systems
|
---|
[1ae4746] | 22 | automatically fix N equal to the number of available CPU cores
|
---|
| 23 | on the machine. -->
|
---|
[d3edf27] | 24 | ]>
|
---|
| 25 |
|
---|
[4705fa4] | 26 | <!-- Try to keep the indentation used in this file-->
|
---|
[1ae02579] | 27 | <sect1 id="TEMPLATE" xreflabel="TEMPLATE-&TEMPLATE-version;">
|
---|
[4705fa4] | 28 | <?dbhtml filename="TEMPLATE.html"?>
|
---|
[46daaa1] | 29 |
|
---|
| 30 |
|
---|
[17bcb81] | 31 | <!-- No other tags inside any title.
|
---|
[54d58907] | 32 | Use Title Case in All Titles
|
---|
[6fe407f4] | 33 | (i.e., Capitalize Everything
|
---|
| 34 | *Except* Articles, Short Prepositions,
|
---|
| 35 | and Coordinating Conjunctions.-->
|
---|
[4705fa4] | 36 | <title>TEMPLATE-&TEMPLATE-version;</title>
|
---|
[46daaa1] | 37 |
|
---|
[4705fa4] | 38 | <indexterm zone="TEMPLATE">
|
---|
| 39 | <primary sortas="a-TEMPLATE">TEMPLATE</primary>
|
---|
| 40 | </indexterm>
|
---|
[46daaa1] | 41 |
|
---|
[4705fa4] | 42 | <!--Required section-->
|
---|
| 43 | <sect2 role="package">
|
---|
| 44 | <title>Introduction to TEMPLATE</title>
|
---|
[46daaa1] | 45 |
|
---|
[14aeac4] | 46 | <para>
|
---|
| 47 | The <application>TEMPLATE</application> package contains...
|
---|
| 48 | This is useful for...
|
---|
| 49 | </para>
|
---|
[46daaa1] | 50 |
|
---|
[a4a52f4] | 51 | <!-- if it builds but hasn't been tested: -->
|
---|
[bfd20b5b] | 52 | &lfs1?_built;
|
---|
[a4a52f4] | 53 | <!-- if it works: -->
|
---|
[bfd20b5b] | 54 | &lfs1?_checked;
|
---|
[a4a52f4] | 55 |
|
---|
[4705fa4] | 56 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 57 | <itemizedlist spacing="compact">
|
---|
| 58 | <listitem>
|
---|
[14aeac4] | 59 | <para>
|
---|
| 60 | Download (HTTP): <ulink url="&TEMPLATE-download-http;"/>
|
---|
| 61 | </para>
|
---|
[4705fa4] | 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
[14aeac4] | 64 | <para>
|
---|
| 65 | Download (FTP): <ulink url="&TEMPLATE-download-ftp;"/>
|
---|
| 66 | </para>
|
---|
[4705fa4] | 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
[14aeac4] | 69 | <para>
|
---|
| 70 | Download MD5 sum: &TEMPLATE-md5sum;
|
---|
| 71 | </para>
|
---|
[4705fa4] | 72 | </listitem>
|
---|
| 73 | <listitem>
|
---|
[14aeac4] | 74 | <para>
|
---|
| 75 | Download size: &TEMPLATE-size;
|
---|
| 76 | </para>
|
---|
[4705fa4] | 77 | </listitem>
|
---|
| 78 | <listitem>
|
---|
[14aeac4] | 79 | <para>
|
---|
| 80 | Estimated disk space required: &TEMPLATE-buildsize;
|
---|
| 81 | </para>
|
---|
[4705fa4] | 82 | </listitem>
|
---|
| 83 | <listitem>
|
---|
[14aeac4] | 84 | <para>
|
---|
| 85 | Estimated build time: &TEMPLATE-time;
|
---|
| 86 | </para>
|
---|
[f2c510ee] | 87 | </listitem>
|
---|
[4705fa4] | 88 | </itemizedlist>
|
---|
[46daaa1] | 89 |
|
---|
[4705fa4] | 90 | <!-- As required -->
|
---|
| 91 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 92 | <itemizedlist spacing="compact">
|
---|
| 93 | <listitem>
|
---|
[14aeac4] | 94 | <para>
|
---|
| 95 | Required patch:
|
---|
| 96 | <ulink url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/>
|
---|
| 97 | </para>
|
---|
[4705fa4] | 98 | </listitem>
|
---|
| 99 | </itemizedlist>
|
---|
[46daaa1] | 100 |
|
---|
[4705fa4] | 101 | <bridgehead renderas="sect3">TEMPLATE Dependencies</bridgehead>
|
---|
[46daaa1] | 102 |
|
---|
[4705fa4] | 103 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[14aeac4] | 104 | <para role="required">
|
---|
[161767fb] | 105 | <xref linkend="BLFS_DEPENDENCY"/> <!-- notice no period as this is not
|
---|
| 106 | a sentence. If there are more than two, they must be separated by commas
|
---|
| 107 | with the last member having "and" in front of it. The use of a serial
|
---|
| 108 | comma is preferred (a comma after the next to last member before the
|
---|
| 109 | "and"). BLFS_DEPENDENCY should be an "id" attribute defined somewhere
|
---|
| 110 | in the book (usually in a <sect1>). -->
|
---|
[7a65888] | 111 | <xref role="runtime" linkend="RUNTIME_DEPENDENCY"/> (runtime)
|
---|
[6fe407f4] | 112 | <!-- Specifying that a dependency is a runtime one may avoid circular
|
---|
[7a65888] | 113 | dependencies. Add role="runtime" to help jhalfs -->
|
---|
[14aeac4] | 114 | </para>
|
---|
[46daaa1] | 115 |
|
---|
[dbb03a0] | 116 | <!-- It may be nice to have a separate section for runtime dependencies.
|
---|
[2f0555f] | 117 | Do it as follows. -->
|
---|
[dbb03a0] | 118 | <bridgehead renderas="sect4">Required at runtime</bridgehead>
|
---|
| 119 | <para role="required">
|
---|
| 120 | <xref role="runtime" linkend="RUNTIME_DEPENDENCY"/>
|
---|
| 121 | </para>
|
---|
| 122 |
|
---|
[4705fa4] | 123 | <!-- As required -->
|
---|
| 124 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[14aeac4] | 125 | <para role="recommended">
|
---|
[161767fb] | 126 | <xref linkend="BLFS_DEPENDENCY"/> <!-- notice no period as this is not
|
---|
| 127 | a sentence. See above for the use of "and" and commas. Normally, neither
|
---|
| 128 | required nor recommended dependencies should be <ulink>. -->
|
---|
[7a65888] | 129 | <xref linkend="ANOTHER_RECOMMENDED_DEP"/> (required if building
|
---|
| 130 | <xref role="nodep" linkend="SOME_FANCY_PACKAGE"/>) <!-- You may need
|
---|
| 131 | to refer to another package, which is not a dependency. Use the role
|
---|
| 132 | attibute with value "nodep". -->
|
---|
| 133 | <!-- See above for runtime dependencies -->
|
---|
[14aeac4] | 134 | </para>
|
---|
[46daaa1] | 135 |
|
---|
[4705fa4] | 136 | <!-- As required -->
|
---|
| 137 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[14aeac4] | 138 | <para role="optional">
|
---|
[161767fb] | 139 | <xref linkend="BLFS_DEPENDENCY"/> and
|
---|
[8bf11809] | 140 | <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>
|
---|
[161767fb] | 141 | <!-- notice no period as this is not a sentence. See above for the use
|
---|
[6fe407f4] | 142 | of commas and "and". The order should be <xref> before <ulink>.-->
|
---|
| 143 | <!-- See above for references to another package which is not a
|
---|
[7a65888] | 144 | dependency. -->
|
---|
[14aeac4] | 145 | </para>
|
---|
[46daaa1] | 146 |
|
---|
[a1bb0d9] | 147 | <!-- Only use this if you want to note something in the wiki
|
---|
[14aeac4] | 148 | <para condition="html" role="usernotes">
|
---|
[a1bb0d9] | 149 | Editor Notes: <ulink url="&blfs-wiki;/TEMPLATE"/>
|
---|
[14aeac4] | 150 | </para>
|
---|
[a1bb0d9] | 151 | -->
|
---|
[4705fa4] | 152 | </sect2>
|
---|
[46daaa1] | 153 |
|
---|
[d615263] | 154 | <!-- Optional section for packages that need a specific kernel
|
---|
| 155 | configuration-->
|
---|
[64fecc4] | 156 | <sect2 role="kernel" id="TEMPLATE-kernel">
|
---|
[4705fa4] | 157 | <title>Kernel Configuration</title>
|
---|
[46daaa1] | 158 |
|
---|
[14aeac4] | 159 | <para>
|
---|
| 160 | Enable the following options in the kernel configuration and recompile the
|
---|
| 161 | kernel if necessary:
|
---|
| 162 | </para>
|
---|
[46daaa1] | 163 |
|
---|
| 164 | <!-- Spaces are significant in <screen> sections -->
|
---|
[ca40dcac] | 165 | <screen><literal>Master section --->
|
---|
| 166 | Subsection --->
|
---|
[161767fb] | 167 | [*] Required parameter [CONFIG_REQU_PAR]
|
---|
| 168 | <*> Required parameter (not as module) [CONFIG_REQU_PAR_NMOD]
|
---|
| 169 | <*/M> Required parameter (could be a module) [CONFIG_REQU_PAR_MOD]
|
---|
| 170 | <*/M/ > Optional parameter [CONFIG_OPT_PAR]
|
---|
| 171 | [ ] Incompatible parameter [CONFIG_INCOMP_PAR]
|
---|
| 172 | < > Incompatible parameter (even as module) [CONFIG_INCOMP_PAR_MOD]</literal></screen>
|
---|
[46daaa1] | 173 |
|
---|
[14aeac4] | 174 | <para>
|
---|
| 175 | Select the appropriate sub-options that appear when the above options are
|
---|
[8d99b03f] | 176 | selected. As much as possible, the layout should be the same as in
|
---|
[6fe407f4] | 177 | kernel configuration menus.
|
---|
[14aeac4] | 178 | </para>
|
---|
[46daaa1] | 179 |
|
---|
[4705fa4] | 180 | <indexterm zone="TEMPLATE TEMPLATE-kernel">
|
---|
| 181 | <primary sortas="d-TEMPLATE">TEMPLATE</primary>
|
---|
| 182 | </indexterm>
|
---|
| 183 | </sect2>
|
---|
[46daaa1] | 184 |
|
---|
[4705fa4] | 185 | <!--Required section-->
|
---|
| 186 | <sect2 role="installation">
|
---|
| 187 | <title>Installation of TEMPLATE</title>
|
---|
[46daaa1] | 188 |
|
---|
[14aeac4] | 189 | <para>
|
---|
| 190 | Install <application>TEMPLATE</application> by running the following
|
---|
| 191 | commands:
|
---|
| 192 | </para>
|
---|
[46daaa1] | 193 |
|
---|
| 194 | <!-- Spaces are significant in <screen> sections -->
|
---|
[14aeac4] | 195 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[eaf6a1cd] | 196 | make</userinput></screen>
|
---|
[46daaa1] | 197 |
|
---|
[76b2b9e] | 198 | <!-- Optional paragraph. Add it when some instructions for building
|
---|
| 199 | documentation need optional or external packages. The remap="doc"
|
---|
[6fe407f4] | 200 | attribute signals that kind of instructions. Note: instructions
|
---|
[76b2b9e] | 201 | for generating documentation that can be built with
|
---|
| 202 | recommended/required/LFS book packages may be included in the
|
---|
| 203 | same block as configure and make. -->
|
---|
| 204 |
|
---|
| 205 | <para>
|
---|
| 206 | If you have installed <xref linkend="optional-dep"/>, you can build
|
---|
| 207 | the documentation (or additional formats of the documentation) by issuing: </para>
|
---|
| 208 |
|
---|
| 209 | <screen remap="doc"><userinput>make -C doc pdf</userinput></screen>
|
---|
| 210 |
|
---|
| 211 | <!-- adjust the instructions as needed. -->
|
---|
| 212 |
|
---|
[6fe407f4] | 213 | <!-- Optional paragraph. Use one of the two formats below about the test
|
---|
| 214 | suite; delete the line that is not applicable. Of course, if the
|
---|
[8e46700] | 215 | test suite uses syntax other than 'make check', revise the
|
---|
| 216 | line to reflect the actual syntax to run the test suite -->
|
---|
| 217 |
|
---|
[14aeac4] | 218 | <para>
|
---|
| 219 | This package does not come with a test suite.
|
---|
| 220 | </para>
|
---|
[46daaa1] | 221 |
|
---|
[14aeac4] | 222 | <para>
|
---|
| 223 | To test the results, issue: <command>make check</command>.
|
---|
| 224 | </para>
|
---|
| 225 |
|
---|
[76b2b9e] | 226 | <!-- Sometimes, more complex instructions are needed for running tests, or
|
---|
| 227 | they need to be run as root. They can then be put inside screen
|
---|
| 228 | tags using the remap="test" attribute as in the following example: -->
|
---|
| 229 |
|
---|
| 230 | <para>
|
---|
| 231 | If you want to run the tests, first create some needed files:
|
---|
| 232 | </para>
|
---|
| 233 |
|
---|
| 234 | <screen remap="test"><userinput>make prepare-tests</userinput></screen>
|
---|
| 235 |
|
---|
| 236 | <para>
|
---|
| 237 | Then run the tests as the <systemitem class="username">root</systemitem>
|
---|
| 238 | user:
|
---|
| 239 | </para>
|
---|
| 240 |
|
---|
| 241 | <screen role="root" remap="test"><userinput>make tests</userinput></screen>
|
---|
| 242 |
|
---|
[14aeac4] | 243 | <para>
|
---|
| 244 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 245 | </para>
|
---|
[46daaa1] | 246 |
|
---|
[eaf6a1cd] | 247 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[46daaa1] | 248 |
|
---|
[76b2b9e] | 249 | <!-- Optional paragraph for documentation that has been generated using
|
---|
[2f0555f] | 250 | optional/external packages: -->
|
---|
[76b2b9e] | 251 |
|
---|
| 252 | <para>
|
---|
| 253 | If you have built the optional documentation, install it as the
|
---|
| 254 | <systemitem class="username">root</systemitem> user:
|
---|
| 255 | </para>
|
---|
| 256 |
|
---|
| 257 | <screen role="root"
|
---|
| 258 | remap="doc"><userinput>install -vdm 755 /usr/share/doc/template-&template-version; &&
|
---|
| 259 | mv doc/* /usr/share/doc/template-&template-version;</userinput></screen>
|
---|
[3ca8be3] | 260 | </sect2>
|
---|
[76b2b9e] | 261 |
|
---|
[4705fa4] | 262 | <!--Optional section-->
|
---|
| 263 | <sect2 role="commands">
|
---|
| 264 | <title>Command Explanations</title>
|
---|
[46daaa1] | 265 |
|
---|
[a26f3f8f] | 266 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[692b244c] | 267 | href="../../xincludes/static-libraries.xml"/>
|
---|
[14aeac4] | 268 |
|
---|
[17bcb81] | 269 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 270 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 271 |
|
---|
[14aeac4] | 272 | <para>
|
---|
| 273 | <command>COMMAND</command>: This command does something.
|
---|
| 274 | </para>
|
---|
[46daaa1] | 275 |
|
---|
[14aeac4] | 276 | <para>
|
---|
[8bf11809] | 277 | <parameter>--PARAMETER</parameter>: This parameter does something
|
---|
| 278 | mandatory for BLFS purposes. It will be in the instructions above. It is
|
---|
| 279 | not optional and is why it is listed as a parameter and not an option.
|
---|
[14aeac4] | 280 | </para>
|
---|
[46daaa1] | 281 |
|
---|
[14aeac4] | 282 | <para>
|
---|
| 283 | <option>--OPTION</option>: This option does something optionally per the
|
---|
[8bf11809] | 284 | user's desires. It is not listed in the instructions above, but instead,
|
---|
| 285 | is listed here because many (some) readers may want to include it.
|
---|
[14aeac4] | 286 | </para>
|
---|
[4705fa4] | 287 | </sect2>
|
---|
[46daaa1] | 288 |
|
---|
[3ca8be3] | 289 | <!--Optional section-->
|
---|
[5603a81] | 290 | <sect2 role="using">
|
---|
| 291 | <title>Using TEMPLATE</title>
|
---|
| 292 |
|
---|
| 293 | <para>
|
---|
[8bf11809] | 294 | Stuff about how to use TEMPLATE to do something. This section is rarely
|
---|
| 295 | used.
|
---|
[5603a81] | 296 | </para>
|
---|
| 297 | </sect2>
|
---|
| 298 |
|
---|
[4705fa4] | 299 | <!--Optional section-->
|
---|
| 300 | <sect2 role="configuration">
|
---|
| 301 | <title>Configuring TEMPLATE</title>
|
---|
[46daaa1] | 302 |
|
---|
[4705fa4] | 303 | <sect3 id="TEMPLATE-config">
|
---|
| 304 | <title>Config Files</title>
|
---|
[14aeac4] | 305 | <para>
|
---|
| 306 | <filename>~/.Configfilename1</filename> and
|
---|
[8bf11809] | 307 | <filename>/etc/path/Configfilename2</filename> <!-- notice no period as this is not a sentence-->
|
---|
[14aeac4] | 308 | </para>
|
---|
[46daaa1] | 309 |
|
---|
[4705fa4] | 310 | <indexterm zone="TEMPLATE TEMPLATE-config">
|
---|
| 311 | <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
|
---|
| 312 | </indexterm>
|
---|
[46daaa1] | 313 |
|
---|
[4705fa4] | 314 | <indexterm zone="TEMPLATE TEMPLATE-config">
|
---|
[d615263] | 315 | <primary
|
---|
| 316 | sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
|
---|
[4705fa4] | 317 | </indexterm>
|
---|
| 318 | </sect3>
|
---|
[46daaa1] | 319 |
|
---|
[4705fa4] | 320 | <sect3><title>Configuration Information</title>
|
---|
[46daaa1] | 321 |
|
---|
[14aeac4] | 322 | <para>
|
---|
| 323 | Blah blah blah about config.
|
---|
| 324 | </para>
|
---|
[46daaa1] | 325 |
|
---|
[eaf6a1cd] | 326 | <screen><userinput>USER CONFIG COMMANDS</userinput></screen>
|
---|
[46daaa1] | 327 |
|
---|
[eaf6a1cd] | 328 | <screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
|
---|
[46daaa1] | 329 |
|
---|
[b8dba81] | 330 | <!-- File creation. Add the appropriate <indexterm> block if needed.-->
|
---|
[14aeac4] | 331 | <para>
|
---|
| 332 | Create the file .... for ...
|
---|
| 333 | </para>
|
---|
[46daaa1] | 334 |
|
---|
[eaf6a1cd] | 335 | <screen role="root"><userinput>cat >> /PATH/FILENAME << "EOF"
|
---|
| 336 | <literal># Begin FILENAME
|
---|
[46daaa1] | 337 |
|
---|
[eaf6a1cd] | 338 | TEXT
|
---|
[46daaa1] | 339 |
|
---|
[eaf6a1cd] | 340 | # End FILENAME</literal>
|
---|
| 341 | EOF</userinput></screen>
|
---|
[4705fa4] | 342 | </sect3>
|
---|
[46daaa1] | 343 |
|
---|
[4705fa4] | 344 | <sect3 id="TEMPLATE-init">
|
---|
| 345 | <title>Boot Script</title>
|
---|
[46daaa1] | 346 |
|
---|
[14aeac4] | 347 | <para>
|
---|
| 348 | To automatically start the <command>TEMPLATE</command> daemon when the
|
---|
| 349 | system is rebooted, install the
|
---|
| 350 | <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
|
---|
[3c7bd00] | 351 | <xref linkend="bootscripts" revision="sysv"/>
|
---|
| 352 | <xref linkend="systemd-units" revision="systemd"/> package as the
|
---|
[8bf11809] | 353 | <systemitem class="username">root</systemitem> user:
|
---|
[14aeac4] | 354 | </para>
|
---|
[46daaa1] | 355 |
|
---|
| 356 | <indexterm zone="TEMPLATE TEMPLATE-init">
|
---|
[4705fa4] | 357 | <primary sortas="f-TEMPLATE">TEMPLATE</primary>
|
---|
[46daaa1] | 358 | </indexterm>
|
---|
| 359 |
|
---|
[eaf6a1cd] | 360 | <screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
|
---|
[4705fa4] | 361 | </sect3>
|
---|
| 362 | </sect2>
|
---|
[46daaa1] | 363 |
|
---|
| 364 | <!--Required section-->
|
---|
[4705fa4] | 365 | <sect2 role="content">
|
---|
| 366 | <title>Contents</title>
|
---|
[46daaa1] | 367 |
|
---|
[4705fa4] | 368 | <segmentedlist>
|
---|
| 369 | <segtitle>Installed Program(s)</segtitle>
|
---|
| 370 | <segtitle>Installed Librar(y,ies)</segtitle>
|
---|
| 371 | <segtitle>Installed Director(y,ies)</segtitle>
|
---|
[46daaa1] | 372 |
|
---|
[8bf11809] | 373 | <!-- If there were no programs, libraries, or directories created, then
|
---|
| 374 | we would list the section as "None". However, a decision must have
|
---|
| 375 | been made to change the "None" to just removing the whole section
|
---|
| 376 | because I've noticed that many packages have had the "None"
|
---|
| 377 | removed and the section completely removed as well. The reasoning
|
---|
[6fe407f4] | 378 | was that by putting "None", it appears as if we know there are none.
|
---|
[8bf11809] | 379 | Without anything it appears as we are not sure. -->
|
---|
[0d7900a] | 380 |
|
---|
[4705fa4] | 381 | <seglistitem>
|
---|
[14aeac4] | 382 | <seg>
|
---|
[d429f8af] | 383 | PROGRAM1, PROGRAM2 and PROGRAM3<!-- no period here since it is not
|
---|
| 384 | a sentence -->
|
---|
[14aeac4] | 385 | </seg>
|
---|
| 386 | <seg>
|
---|
[d429f8af] | 387 | libLIBRARY1.so, libLIBRARY2.so and libLIBRARY3.so<!-- no period here
|
---|
| 388 | since it is not a sentence -->
|
---|
[14aeac4] | 389 | </seg>
|
---|
| 390 | <seg>
|
---|
| 391 | /etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
|
---|
| 392 | /usr/share/TEMPLATE-&TEMPLATE-version;,
|
---|
| 393 | /usr/share/doc/TEMPLATE-&TEMPLATE-version; and
|
---|
[d429f8af] | 394 | /var/lib/TEMPLATE<!-- no period here
|
---|
| 395 | since it is not a sentence -->
|
---|
[14aeac4] | 396 | </seg>
|
---|
[4705fa4] | 397 | </seglistitem>
|
---|
| 398 | </segmentedlist>
|
---|
[46daaa1] | 399 |
|
---|
[4705fa4] | 400 | <variablelist>
|
---|
| 401 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 402 | <?dbfo list-presentation="list"?>
|
---|
| 403 | <?dbhtml list-presentation="table"?>
|
---|
[46daaa1] | 404 |
|
---|
[6fe407f4] | 405 | <!-- If the program or library name conflicts with (is the same as) the
|
---|
[fb3dd289] | 406 | package name, add -prog or -lib to the varlistentry entity id
|
---|
[4705fa4] | 407 | and the 2nd entry of the indexterm zone entity -->
|
---|
[46daaa1] | 408 |
|
---|
[4705fa4] | 409 | <varlistentry id="PROGRAM1">
|
---|
| 410 | <term><command>PROGRAM1</command></term>
|
---|
| 411 | <listitem>
|
---|
[14aeac4] | 412 | <para>
|
---|
[b935cc3] | 413 | does this ..... (no period at the end)
|
---|
[14aeac4] | 414 | </para>
|
---|
[4705fa4] | 415 | <indexterm zone="TEMPLATE PROGRAM1">
|
---|
| 416 | <primary sortas="b-PROGRAM1">PROGRAM1</primary>
|
---|
| 417 | </indexterm>
|
---|
| 418 | </listitem>
|
---|
| 419 | </varlistentry>
|
---|
[46daaa1] | 420 |
|
---|
[4705fa4] | 421 | <varlistentry id="PROGRAM2">
|
---|
| 422 | <term><command>PROGRAM2</command></term>
|
---|
| 423 | <listitem>
|
---|
[14aeac4] | 424 | <para>
|
---|
[b935cc3] | 425 | does this ..... (no period at the end)
|
---|
[14aeac4] | 426 | </para>
|
---|
[4705fa4] | 427 | <indexterm zone="TEMPLATE PROGRAM2">
|
---|
| 428 | <primary sortas="b-PROGRAM2">PROGRAM2</primary>
|
---|
| 429 | </indexterm>
|
---|
| 430 | </listitem>
|
---|
| 431 | </varlistentry>
|
---|
[46daaa1] | 432 |
|
---|
[4705fa4] | 433 | <varlistentry id="libLIBRARY1">
|
---|
[14aeac4] | 434 | <term><filename class="libraryfile">libLIBRARY1.so</filename></term>
|
---|
[4705fa4] | 435 | <listitem>
|
---|
[14aeac4] | 436 | <para>
|
---|
[b935cc3] | 437 | contains functions that ..... (no period at the end)
|
---|
[14aeac4] | 438 | </para>
|
---|
[4705fa4] | 439 | <indexterm zone="TEMPLATE libLIBRARY1">
|
---|
[14aeac4] | 440 | <primary sortas="c-libLIBRARY1">libLIBRARY1.so</primary>
|
---|
[4705fa4] | 441 | </indexterm>
|
---|
| 442 | </listitem>
|
---|
| 443 | </varlistentry>
|
---|
| 444 | </variablelist>
|
---|
| 445 | </sect2>
|
---|
[46daaa1] | 446 | </sect1>
|
---|