scrollkeeper-gen-seriesid(1) [suse man page]

SCROLLKEEPER-UPDATE(1)					      General Commands Manual					    SCROLLKEEPER-UPDATE(1)

NAME

       scrollkeeper-gen-seriesid - generate a unique id for a document series for use in an OMF metadata file

SYNOPSIS

       scrollkeeper-gen-seriesid [--help]

DESCRIPTION

       This  generates	a  unique id for use as the seriesid attribute to the relation element in the OMF metadata.  This id is referred to as the
       "series id" or "seriesid".

       The seriesid is used to specify a group (or series) of documents which are related.  For example, multiple versions, formats, and  transla-
       tions  of  a  single document are considered to be in the same series.  Thus, any new version, translation, etc. of a pre-existing document
       should inherit the seriesid of the original document.  Only document series which have never been assigned a seriesid in  the  past  should
       use scrollkeeper-gen-seriesid to obtain a new seriesid.

       ScrollKeeper uses the seriesid of documents to identify which documents are related to each other.  For example, when creating the contents
       list, ScrollKeeper must identify if two documents are in the same series in order to display the most complete set of documents on the sys-
       tem,  using  locale  fallback  for  documents  which may not be translated into a given locale, without displaying the same document in two
       locales.

OPTIONS

       --help Show usage (help) information.

AUTHOR

       Laszlo Kovacs   <laszlo.kovacs@sun.com>
       Dan Mueth       <d-mueth@uchicago.edu>

SEE ALSO

       scrollkeeper-config(1),	scrollkeeper.conf(5),  scrollkeeper(7),   scrollkeeper-preinstall(8),	scrollkeeper-rebuilddb(8),   scrollkeeper-
       update(8)

scrollkeeper							    Dec 5, 2001 					    SCROLLKEEPER-UPDATE(1)

SCROLLKEEPER.CONF(5)                                            File Formats Manual                                           SCROLLKEEPER.CONF(5)

NAME

       scrollkeeper.conf - ScrollKeeper configuration file

SYNOPSIS

       System-wide configuration of ScrollKeeper

DESCRIPTION

       The  system-wide  scrollkeeper.conf  file  is  typically  installed  at  /etc/scrollkeeper.conf.  It stores the default OMF paths which are
       searched by scrollkeeper-update (8) to update the ScrollKeeper documentation catalog.  The paths are held by the OMF_DIR variable which  is
       assigned to a colon (:) delimited list of paths.

       Comment lines begin with the (#) character.

EXAMPLE

       A typical scrollkeeper.conf file will look like:

       # Comment
       OMF_DIR=/usr/share/omf:/usr/local/share/omf:/opt/gnome/share/omf:/opt/gnome-2.0/share/omf:/opt/kde/omf

NOTES

       Any user on the system is able to use the scrollkeeper-update (8) command to generate a ScrollKeeper database at any path that the user has
       write permission to.  The user can over-ride the system default OMF_DIR path variable by  setting  a  shell  variable  of  the  same  name,
       OMF_DIR.  In this way, a user can create a document catalog which contains a superset of the system documentation, or a completely indepen-
       dent set of documents which the user may be interested in.

       Note that most applications will register its documentation at install time, and unregister it at uninstall time.  Thus, a user  who  keeps
       their  own  personal ScrollKeeper database may need to periodically run scrollkeeper-update (8) manually (or with cron) to keep their data-
       base up-to-date.

AUTHOR

       Laszlo Kovacs   <laszlo.kovacs@sun.com>
       Dan Mueth       <d-mueth@uchicago.edu>

SEE ALSO

       scrollkeeper-config(1), scrollkeeper-gen-seriesid(1), scrollkeeper(7), scrollkeeper-preinstall(8), scrollkeeper-rebuilddb(8), scrollkeeper-
       update(8)

ScrollKeeper                                                        Dec 5, 2001                                               SCROLLKEEPER.CONF(5)