Changeset 0536361


Ignore:
Timestamp:
05/15/2005 09:00:51 PM (19 years ago)
Author:
Manuel Canales Esparcia <manuel@…>
Branches:
10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 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, 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/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal
Children:
d718d6ad
Parents:
9ad96f5
Message:

Tagged scrollkeeper.xml

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@4272 af4574ff-66df-0310-9fd7-8a98e5e911e0

File:
1 edited

Legend:

Unmodified
Added
Removed

  • gnome/core/scrollkeeper.xml

    r9ad96f5 r0536361  
    55  %general-entities;
    66
    7 <!ENTITY scrollkeeper-download-http "http://ftp.gnome.org/pub/GNOME/sources/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
    8 <!ENTITY scrollkeeper-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
    9 <!ENTITY scrollkeeper-md5sum "b175e582a6cec3e50a9de73a5bb7455a">
    10 <!ENTITY scrollkeeper-size "546 KB">
    11 <!ENTITY scrollkeeper-buildsize "12 MB">
    12 <!ENTITY scrollkeeper-time "0.1 SBU">
     7  <!ENTITY scrollkeeper-download-http "http://ftp.gnome.org/pub/GNOME/sources/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
     8  <!ENTITY scrollkeeper-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
     9  <!ENTITY scrollkeeper-md5sum "b175e582a6cec3e50a9de73a5bb7455a">
     10  <!ENTITY scrollkeeper-size "546 KB">
     11  <!ENTITY scrollkeeper-buildsize "12 MB">
     12  <!ENTITY scrollkeeper-time "0.1 SBU">
    1313]>
    1414
    1515<sect1 id="scrollkeeper" xreflabel="ScrollKeeper-&scrollkeeper-version;">
    16 <sect1info>
    17 <othername>$LastChangedBy$</othername>
    18 <date>$Date$</date>
    19 </sect1info>
    20 <?dbhtml filename="scrollkeeper.html"?>
    21 <title>ScrollKeeper-&scrollkeeper-version;</title>
    22 <indexterm zone="scrollkeeper">
    23 <primary sortas="a-ScrollKeeper">ScrollKeeper</primary></indexterm>
     16  <?dbhtml filename="scrollkeeper.html"?>
    2417
    25 <sect2>
     18  <sect1info>
     19    <othername>$LastChangedBy$</othername>
     20    <date>$Date$</date>
     21  </sect1info>
    2622
    27 <title>Introduction to <application>ScrollKeeper</application></title>
     23  <title>ScrollKeeper-&scrollkeeper-version;</title>
    2824
    29 <para>The <application>ScrollKeeper</application> package contains a
    30 cataloging system for documentation. This is useful for managing documentation
    31 metadata and providing an <acronym>API</acronym> to help browsers find, sort
    32 and search the document catalog.</para>
     25  <indexterm zone="scrollkeeper">
     26    <primary sortas="a-ScrollKeeper">ScrollKeeper</primary>
     27  </indexterm>
    3328
    34 <sect3><title>Package information</title>
    35 <itemizedlist spacing='compact'>
    36 <listitem><para>Download (HTTP): <ulink
    37 url="&scrollkeeper-download-http;"/></para></listitem>
    38 <listitem><para>Download (FTP): <ulink
    39 url="&scrollkeeper-download-ftp;"/></para></listitem>
    40 <listitem><para>Download MD5 sum: &scrollkeeper-md5sum;</para></listitem>
    41 <listitem><para>Download size: &scrollkeeper-size;</para></listitem>
    42 <listitem><para>Estimated disk space required:
    43 &scrollkeeper-buildsize;</para></listitem>
    44 <listitem><para>Estimated build time:
    45 &scrollkeeper-time;</para></listitem></itemizedlist>
    46 </sect3>
     29  <sect2 role="package">
     30    <title>Introduction to ScrollKeeper</title>
    4731
    48 <sect3><title><application>ScrollKeeper</application> dependencies</title>
    49 <sect4><title>Required</title>
    50 <para><xref linkend="intltool"/>,
    51 <xref linkend="libxslt"/> and
    52 <xref linkend="DocBook"/></para>
    53 </sect4>
    54 </sect3>
     32    <para>The <application>ScrollKeeper</application> package contains a
     33    cataloging system for documentation. This is useful for managing
     34    documentation metadata and providing an API to help browsers find, sort
     35    and search the document catalog.</para>
    5536
    56 </sect2>
     37    <bridgehead renderas="sect3">Package Information</bridgehead>
     38    <itemizedlist spacing="compact">
     39      <listitem>
     40        <para>Download (HTTP): <ulink url="&scrollkeeper-download-http;"/></para>
     41      </listitem>
     42      <listitem>
     43        <para>Download (FTP): <ulink url="&scrollkeeper-download-ftp;"/></para>
     44      </listitem>
     45      <listitem>
     46        <para>Download MD5 sum: &scrollkeeper-md5sum;</para>
     47      </listitem>
     48      <listitem>
     49        <para>Download size: &scrollkeeper-size;</para>
     50      </listitem>
     51      <listitem>
     52        <para>Estimated disk space required: &scrollkeeper-buildsize;</para>
     53      </listitem>
     54      <listitem>
     55        <para>Estimated build time: &scrollkeeper-time;</para>
     56      </listitem>
     57    </itemizedlist>
    5758
    58 <sect2>
    59 <title>Installation of <application>ScrollKeeper</application></title>
     59    <bridgehead renderas="sect3">ScrollKeeper Dependencies</bridgehead>
    6060
    61 <para>Install <application>ScrollKeeper</application> by running the following
    62 commands:</para>
     61    <bridgehead renderas="sect4">Required</bridgehead>
     62    <para><xref linkend="intltool"/>,
     63    <xref linkend="libxslt"/> and
     64    <xref linkend="DocBook"/></para>
    6365
    64 <screen><userinput><command>./configure --prefix=/usr --sysconfdir=/etc \
     66  </sect2>
     67
     68  <sect2 role="installation">
     69    <title>Installation of ScrollKeeper</title>
     70
     71    <para>Install <application>ScrollKeeper</application> by running the
     72    following commands:</para>
     73
     74<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
    6575    --localstatedir=/var --disable-static \
    6676    --with-omfdirs=/usr/share/omf:/opt/gnome/share/omf:\
    6777/opt/kde-&kde-version;/share/omf:/opt/gnome-&gnome-version;/share/omf &amp;&amp;
    68 make</command></userinput></screen>
     78make</userinput></screen>
    6979
    70 <para>This package does not come with a test suite.</para>
     80    <para>This package does not come with a test suite.</para>
    7181
    72 <para>Now, as the root user:</para>
     82    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
    7383
    74 <screen><userinput role='root'><command>make install</command></userinput></screen>
     84<screen role="root"><userinput>make install</userinput></screen>
    7585
    76 </sect2>
     86  </sect2>
    7787
    78 <sect2>
    79 <title>Command explanations</title>
     88  <sect2 role="commands">
     89    <title>Command Explanations</title>
    8090
    81 <para><parameter>--sysconfdir=/etc</parameter>: This switch puts the
    82 configuration files in <filename class="directory">/etc</filename> instead of
    83 <filename class='directory'>/usr/etc</filename>.</para>
     91    <para><parameter>--sysconfdir=/etc</parameter>: This switch puts the
     92    configuration files in <filename class="directory">/etc</filename>
     93    instead of <filename class='directory'>/usr/etc</filename>.</para>
    8494
    85 <para><parameter>--localstatedir=/var</parameter>: This switch puts
    86 <application>ScrollKeeper</application>'s database directory in
    87 <filename class="directory">/var/lib/scrollkeeper</filename>.</para>
     95    <para><parameter>--localstatedir=/var</parameter>: This switch puts
     96    <application>ScrollKeeper</application>'s database directory in
     97    <filename class="directory">/var/lib/scrollkeeper</filename>.</para>
    8898
    89 <para><option>--disable-static</option>: This switch prevents
    90 the static library from being built.</para>
     99    <para><parameter>--disable-static</parameter>: This switch prevents
     100    the static library from being built.</para>
    91101
    92 <para><parameter>--with-omfdirs=...</parameter>: This switch defines the
    93 locations of <filename>OMF</filename> files for
    94 <application>ScrollKeeper</application>. This information is stored in
    95 <filename>/etc/scrollkeeper.conf</filename> and can be updated manually,
    96 if necessary.</para>
    97 </sect2>
     102    <para><parameter>--with-omfdirs=...</parameter>: This switch defines the
     103    locations of <filename>OMF</filename> files for
     104    <application>ScrollKeeper</application>. This information is stored in
     105    <filename>/etc/scrollkeeper.conf</filename> and can be updated manually,
     106    if necessary.</para>
    98107
    99 <sect2>
    100 <title>Configuring <application>ScrollKeeper</application></title>
     108  </sect2>
    101109
    102 <sect3 id="scrollkeeper-config"><title>Config files</title>
    103 <para><filename>/etc/scrollkeeper.conf</filename></para>
    104 <indexterm zone="scrollkeeper scrollkeeper-config">
    105 <primary sortas="e-etc-scrollkeeper.conf">/etc/scrollkeeper.conf</primary>
    106 </indexterm>
    107 </sect3>
     110  <sect2 role="configuration">
     111    <title>Configuring ScrollKeeper</title>
    108112
    109 <sect3><title>Configuration Information</title>
     113    <sect3 id="scrollkeeper-config">
     114      <title>Config Files</title>
    110115
    111 <para>The configuration file sets the <envar>OMF_DIR</envar> variable to the
    112 location of all of the <filename class="directory">omf</filename> directories
    113 in the system. This was set in the <command>configure</command> command so no
    114 futher action is needed until another <filename>OMF</filename> directory is
    115 created.</para>
    116 </sect3>
     116      <para><filename>/etc/scrollkeeper.conf</filename></para>
    117117
    118 </sect2>
     118      <indexterm zone="scrollkeeper scrollkeeper-config">
     119        <primary sortas="e-etc-scrollkeeper.conf">/etc/scrollkeeper.conf</primary>
     120      </indexterm>
    119121
    120 <sect2>
    121 <title>Contents</title>
     122    </sect3>
    122123
    123 <segmentedlist>
    124 <segtitle>Installed Programs</segtitle>
    125 <segtitle>Installed Library</segtitle>
    126 <segtitle>Installed Directories</segtitle>
     124    <sect3>
     125      <title>Configuration Information</title>
    127126
    128 <seglistitem>
    129 <seg>scrollkeeper-config, scrollkeeper-extract, scrollkeeper-gen-seriesid,
    130 scrollkeeper-get-cl, scrollkeeper-get-content-list,
    131 scrollkeeper-get-extended-content-list, scrollkeeper-get-index-from-docpath,
    132 scrollkeeper-get-toc-from-docpath, scrollkeeper-get-toc-from-id,
    133 scrollkeeper-install, scrollkeeper-preinstall, scrollkeeper-rebuilddb,
    134 scrollkeeper-uninstall and scrollkeeper-update</seg>
    135 <seg>libscrollkeeper.so</seg>
    136 <seg>/usr/share/doc/scrollkeeper-&scrollkeeper-version;,
    137 /usr/share/omf/scrollkeeper, /usr/share/scrollkeeper,
    138 /usr/share/xml/scrollkeeper and /var/lib/scrollkeeper</seg>
    139 </seglistitem>
    140 </segmentedlist>
     127      <para>The configuration file sets the <envar>OMF_DIR</envar> variable
     128      to the location of all of the <filename class="directory">omf</filename>
     129      directories in the system. This was set in the <command>configure</command>
     130      command so no futher action is needed until another <filename>OMF</filename>
     131      directory is created.</para>
    141132
    142 <variablelist>
    143 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
    144 <?dbfo list-presentation="list"?>
     133    </sect3>
    145134
    146 <varlistentry>
    147 <term><command>ScrollKeeper utility programs</command></term>
    148 <listitem><para>The <application>ScrollKeeper</application> utility programs
    149 and scripts listed above are for performing installation, building, getting
    150 and updating table of contents files.</para>
    151 </listitem>
    152 </varlistentry>
     135  </sect2>
    153136
    154 <varlistentry id="libscrollkeeper">
    155 <term><filename class='libraryfile'>libscrollkeeper.so</filename></term>
    156 <listitem><para>provides the <acronym>API</acronym> necessary for help
    157 browsers to interact with documentation written to utilize
    158 <application>ScrollKeeper</application>.</para>
    159 <indexterm zone="scrollkeeper libscrollkeeper">
    160 <primary sortas="c-libscrollkeeper">libscrollkeeper.so</primary>
    161 </indexterm></listitem>
    162 </varlistentry>
    163 </variablelist>
     137  <sect2 role="content">
     138    <title>Contents</title>
    164139
    165 </sect2>
     140    <segmentedlist>
     141      <segtitle>Installed Programs</segtitle>
     142      <segtitle>Installed Library</segtitle>
     143      <segtitle>Installed Directories</segtitle>
     144
     145      <seglistitem>
     146        <seg>scrollkeeper-config, scrollkeeper-extract, scrollkeeper-gen-seriesid,
     147        scrollkeeper-get-cl, scrollkeeper-get-content-list,
     148        scrollkeeper-get-extended-content-list, scrollkeeper-get-index-from-docpath,
     149        scrollkeeper-get-toc-from-docpath, scrollkeeper-get-toc-from-id,
     150        scrollkeeper-install, scrollkeeper-preinstall, scrollkeeper-rebuilddb,
     151        scrollkeeper-uninstall, and scrollkeeper-update</seg>
     152        <seg>libscrollkeeper.so</seg>
     153        <seg>/usr/share/doc/scrollkeeper-&scrollkeeper-version;,
     154        /usr/share/omf/scrollkeeper, /usr/share/scrollkeeper,
     155        /usr/share/xml/scrollkeeper, and /var/lib/scrollkeeper</seg>
     156      </seglistitem>
     157    </segmentedlist>
     158
     159    <variablelist>
     160      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     161      <?dbfo list-presentation="list"?>
     162      <?dbhtml list-presentation="table"?>
     163
     164      <varlistentry>
     165        <term><command>ScrollKeeper utility programs</command></term>
     166        <listitem>
     167          <para>The <application>ScrollKeeper</application> utility programs
     168          and scripts listed above are for performing installation, building,
     169          getting and updating table of contents files.</para>
     170        </listitem>
     171      </varlistentry>
     172
     173      <varlistentry id="libscrollkeeper">
     174        <term><filename class='libraryfile'>libscrollkeeper.so</filename></term>
     175        <listitem>
     176          <para>provides the API necessary for help
     177          browsers to interact with documentation written to utilize
     178          <application>ScrollKeeper</application>.</para>
     179          <indexterm zone="scrollkeeper libscrollkeeper">
     180            <primary sortas="c-libscrollkeeper">libscrollkeeper.so</primary>
     181          </indexterm>
     182        </listitem>
     183      </varlistentry>
     184
     185    </variablelist>
     186
     187  </sect2>
    166188
    167189</sect1>
Note: See TracChangeset for help on using the changeset viewer.