Difference between revisions of "ScrollKeeper"

From CBLFS
Jump to navigationJump to search
(I added the package description from BLFS.)
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{| style="text-align: left; background-color: AliceBlue;"
 
{| style="text-align: left; background-color: AliceBlue;"
|-
+
|-valign="top"
 
!Download Source:
 
!Download Source:
| http://ftp.gnome.org/pub/gnome/sources/scrollkeeper/0.3/scrollkeeper-0.3.14.tar.bz2
+
| http://ftp.gnome.org/pub/gnome/sources/scrollkeeper/{{ScrollKeeper-Version2}}/scrollkeeper-{{ScrollKeeper-Version}}.tar.bz2
 
|}
 
|}
  
 
----
 
----
  
== Introduction to ScrollKeeper ==
+
{{Package-Introduction|ScrollKeeper is a cataloging system for documentation on open systems. It manages documentation metadata (as specified by the [http://metalab.unc.edu/osrt/omf/ Open Source Metadata Framework(OMF)]) and provides a simple API to allow help browsers to find, sort, and search the document catalog. It will also be able to communicate with catalog servers on the Net to search for documents which are not on the local system.|http://scrollkeeper.sourceforge.net/}}
 
 
The ScrollKeeper package contains a cataloging system for documentation. This is useful for managing documentation metadata and providing an API to help browsers find, sort and search the document catalog.
 
  
 
== Dependencies ==
 
== Dependencies ==
Line 15: Line 13:
 
=== Required ===
 
=== Required ===
 
* [[LibXSLT]]
 
* [[LibXSLT]]
* [[DocBook XML DTD-4.4]]
+
* [[DocBook-XML-4.1.2]]
  
 
* [[Perl Module XML::Parser]]
 
* [[Perl Module XML::Parser]]
 +
 
=== Optional ===
 
=== Optional ===
 
* [[Intltool]]
 
* [[Intltool]]
Line 27: Line 26:
 
  ./configure --prefix=/usr \
 
  ./configure --prefix=/usr \
 
     --sysconfdir=/etc --localstatedir=/var \
 
     --sysconfdir=/etc --localstatedir=/var \
     --disable-static --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
+
     --disable-static --with-omfdirs=/usr/share/omf:${GNOME_PREFIX}/share/omf:\
  /opt/kde-3.5.2/share/omf:\
+
  /opt/kde/share/omf:\
  /opt/gnome-2.14.2/share/omf &&
+
  /opt/gnome/share/omf &&
 
  make
 
  make
  
Line 35: Line 34:
  
 
  make install
 
  make install
 +
 +
=== Command Explanations ===
 +
 +
''--sysconfdir=/etc'': This switch puts the configuration files in /etc instead of /usr/etc.
 +
 +
''--localstatedir=/var'': This switch puts ScrollKeeper's database directory in /var/lib/scrollkeeper.
 +
 +
''--disable-static'': This switch prevents the static library from being built.
 +
 +
''--with-omfdirs=...'': This switch defines the locations of OMF files for ScrollKeeper. Change the locations if you have KDE and/or GNOME-2 installed in a prefix other than the ones shown. This information is stored in /etc/scrollkeeper.conf and can be updated manually, if necessary.
  
 
== Multilib ==
 
== Multilib ==
Line 47: Line 56:
 
     --sysconfdir=/etc --localstatedir=/var \
 
     --sysconfdir=/etc --localstatedir=/var \
 
     --disable-static --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
 
     --disable-static --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
  /opt/kde-3.5.2/share/omf:\
+
  /opt/kde/share/omf:\
  /opt/gnome-2.14.2/share/omf &&
+
  /opt/gnome/share/omf &&
 
  make
 
  make
  
Line 62: Line 71:
 
     --sysconfdir=/etc --localstatedir=/var \
 
     --sysconfdir=/etc --localstatedir=/var \
 
     --disable-static --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
 
     --disable-static --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
  /opt/kde-3.5.2/share/omf:\
+
  /opt/kde/share/omf:\
  /opt/gnome-2.14.2/share/omf &&
+
  /opt/gnome/share/omf &&
 
  make
 
  make
  
Line 76: Line 85:
 
     --sysconfdir=/etc --localstatedir=/var \
 
     --sysconfdir=/etc --localstatedir=/var \
 
     --disable-static --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
 
     --disable-static --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
  /opt/kde-3.5.2/share/omf:\
+
  /opt/kde/share/omf:\
  /opt/gnome-2.14.2/share/omf &&
+
  /opt/gnome/share/omf &&
 
  make
 
  make
  
Line 83: Line 92:
  
 
  make install
 
  make install
 +
 +
= Contents =
 +
 +
{| style="text-align: left;"
 +
|-valign="top"
 +
! Installed Programs:
 +
| scrollkeeper-config, scrollkeeper-extract, scrollkeeper-gen-seriesid, scrollkeeper-get-cl, scrollkeeper-get-content-list, scrollkeeper-get-extended-content-list, scrollkeeper-get-index-from-docpath, scrollkeeper-get-toc-from-docpath, scrollkeeper-get-toc-from-id, scrollkeeper-install, scrollkeeper-preinstall, scrollkeeper-rebuilddb, scrollkeeper-uninstall, and scrollkeeper-update
 +
|-valign="top"
 +
! Installed Libraries:
 +
| libscrollkeeper.so
 +
|-valign="top"
 +
! Installed Directories:
 +
| /usr/share/doc/scrollkeeper-{{ScrollKeeper-Version}}, /usr/share/{omf, {,xml/}scrollkeeper}, and /var/lib/scrollkeeper
 +
|}
 +
 +
=== Short Descriptions ===
 +
 +
{| style="text-align: left;"
 +
|-valign="top"
 +
! ScrollKeeper utility programs
 +
| The ScrollKeeper utility programs and scripts listed above are for performing installation, building, getting and updating table of contents files.
 +
|-valign="top"
 +
! libscrollkeeper.so
 +
| provides the API necessary for help browsers to interact with documentation written to utilize ScrollKeeper.
 +
|}
 +
 +
[[Category:General Utilities]]

Latest revision as of 02:19, 7 December 2010

Download Source: http://ftp.gnome.org/pub/gnome/sources/scrollkeeper/0.3/scrollkeeper-0.3.14.tar.bz2

Introduction to ScrollKeeper

ScrollKeeper is a cataloging system for documentation on open systems. It manages documentation metadata (as specified by the Open Source Metadata Framework(OMF)) and provides a simple API to allow help browsers to find, sort, and search the document catalog. It will also be able to communicate with catalog servers on the Net to search for documents which are not on the local system.

Project Homepage: http://scrollkeeper.sourceforge.net/

Dependencies

Required

Optional

Non-Multilib

Compile the package:

./configure --prefix=/usr \
    --sysconfdir=/etc --localstatedir=/var \
    --disable-static --with-omfdirs=/usr/share/omf:${GNOME_PREFIX}/share/omf:\
/opt/kde/share/omf:\
/opt/gnome/share/omf &&
make

Install the package

make install

Command Explanations

--sysconfdir=/etc: This switch puts the configuration files in /etc instead of /usr/etc.

--localstatedir=/var: This switch puts ScrollKeeper's database directory in /var/lib/scrollkeeper.

--disable-static: This switch prevents the static library from being built.

--with-omfdirs=...: This switch defines the locations of OMF files for ScrollKeeper. Change the locations if you have KDE and/or GNOME-2 installed in a prefix other than the ones shown. This information is stored in /etc/scrollkeeper.conf and can be updated manually, if necessary.

Multilib

/usr/bin/scrollkeeper-config is not wrapped because it does not contain any arch specific information

32Bit

Compile the package:

CC="gcc ${BUILD32}" USE_ARCH=32 ./configure --prefix=/usr \
    --sysconfdir=/etc --localstatedir=/var \
    --disable-static --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
/opt/kde/share/omf:\
/opt/gnome/share/omf &&
make

Install the package

make install

N32

Compile the package:

CC="gcc ${BUILDN32}" USE_ARCH=n32 ./configure --prefix=/usr --libdir=/usr/lib32 \
    --sysconfdir=/etc --localstatedir=/var \
    --disable-static --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
/opt/kde/share/omf:\
/opt/gnome/share/omf &&
make

Install the package

make install

64Bit

Compile the package:

CC="gcc ${BUILD64}" USE_ARCH=64 ./configure --prefix=/usr --libdir=/usr/lib64 \
    --sysconfdir=/etc --localstatedir=/var \
    --disable-static --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
/opt/kde/share/omf:\
/opt/gnome/share/omf &&
make

Install the package

make install

Contents

Installed Programs: scrollkeeper-config, scrollkeeper-extract, scrollkeeper-gen-seriesid, scrollkeeper-get-cl, scrollkeeper-get-content-list, scrollkeeper-get-extended-content-list, scrollkeeper-get-index-from-docpath, scrollkeeper-get-toc-from-docpath, scrollkeeper-get-toc-from-id, scrollkeeper-install, scrollkeeper-preinstall, scrollkeeper-rebuilddb, scrollkeeper-uninstall, and scrollkeeper-update
Installed Libraries: libscrollkeeper.so
Installed Directories: /usr/share/doc/scrollkeeper-0.3.14, /usr/share/{omf, {,xml/}scrollkeeper}, and /var/lib/scrollkeeper

Short Descriptions

ScrollKeeper utility programs The ScrollKeeper utility programs and scripts listed above are for performing installation, building, getting and updating table of contents files.
libscrollkeeper.so provides the API necessary for help browsers to interact with documentation written to utilize ScrollKeeper.