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