scrollkeeper-config(1) [debian man page]

scrollkeeper-config(1)						   User Commands					    scrollkeeper-config(1)

NAME

       scrollkeeper-config - helper script for building with scrollkeeper

SYNOPSIS

       scrollkeeper-config [--help] [--version] [--prefix=dir] [--localstatedir] [--pkglocalstatedir] [--pkgdatadir] [--omfdir]

DESCRIPTION

       The  scrollkeeper-config  tool is used to determine the compiler and linker flags that should be used to compile and link programs that use
       the scrollkeeper library.

OPTIONS

       The following options are supported:

       --help	       Print a usage summary.

       --localstatedir Outputs the localstatedir used to install scrollkeeper.

       --omfdir        Directory where scrollkeeper searches for OMF files.

       --pkgdatadir    Outputs the directory under datadir where scrollkeeper keeps its non-variable (that is, non-database) files.

       --pkglocalstatedOutputs	the directory under localstatedir where scrollkeeper keeps its database.

       --prefix=dir    If specified, use dir instead of the installation prefix that the library was built with.

       --version       Print the currently installed version of the library on the standard output.

EXAMPLES

       Example 1: Getting the scrollkeeper library version

       example% scrollkeeper-config --version

EXIT STATUS

       The following exit values are returned:

       0	Application exited successfully

       >0	Application exited with failure

FILES

       The following files are used by this application:

       /usr/bin/scrollkeeper-coExecutable for the scrollkeeper helper script

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWgnome-libs		   |
       +-----------------------------+-----------------------------+
       |Interface stability	     |External			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       pkg-config(1), scrollkeeper(1)

NOTES

       This man page was originally written by Chris Waters (xtifr@debian.org) for Debian GNU/Linux. Rewritten by Brian Cameron, Sun Microsystems,
       using  information  from  the orbit2-config(1)  man page, by Dick Porter (dick@acm.org) and Elliot Lee (sopwith@redhat.com). scrollkeeper--
       specific text was written by Laszlo Kovacs (laszlo.kovacs@sun.com) and Dan Mueth (d-mueth@uchicago.edu).

SunOS 5.10							    11 Jan 2003 					    scrollkeeper-config(1)

SCROLLKEEPER-UPDATE(8)					      System Manager's Manual					    SCROLLKEEPER-UPDATE(8)

NAME

       scrollkeeper-update - identify new, modified, or removed OMF files and update the scrollkeeper databases

SYNOPSIS

       scrollkeeper-update [ -v ] [ -q ] [ -p database-directory ] [ -o omf-directories ]

DESCRIPTION

       This  synchronizes  the	scrollkeeper database with the OMF directory.  It searches the scrollkeeper OMF directory to identify if any files
       were added, removed, or modified and updates its internal database files to reflect any changes.

       This utility is generally executed as the last step of installation, after the OMF file is copied into place.  It  is  also  typically  the
       last  step  of uninstallation, after the OMF file is removed.  Using this, an administrator can easily manually install and uninstall docu-
       ments into the database.  It can also be run to guarantee the database is fully up-to-date.

       Note that because scrollkeeper-update is normally run during installation and its output is typically seen by users, non-critical  warnings
       and  errors  such as those caused by invalid metadata are written to the log file instead of to the terminal. Developers should use the log
       file to identify any problems.

OPTIONS

       -v     Be verbose: Say which scrollkeeper-install and scrollkeeper-uninstall commands are being run to bring the database up to date.

       -q     Run in quiet mode, suppressing output of all but the most serious warning and error messages to STDOUT.  Note that  most	output	to
	      the log file will be unchanged.

       -p database-directory
	      Use  database-directory  as  the	directory  for	the scrollkeeper database rather than the usual one obtained by running omf-config
	      --pkglocalstatedir.

       -o omf-directories
	      Examine the directories named in omf-directories rather than the one usual one obtained by running scrollkeeper-config --omfdir  (or
	      specified in the OMF_DIR environment variable if set).  The omf-directories should be a colon-separated list of directories.

ENVIRONMENT

       OMF_DIR
	      If  no  -o  option is specified, this variable overrides the scrollkeeper-config-provided OMF directory.	It should be a colon-sepa-
	      rated list of directories.

FILES

       /var/lib/scrollkeeper/scrollkeeper_docs
       /var/lib/scrollkeeper/TOC/<docnumber>
       /var/lib/scrollkeeper/<locale>/scrollkeeper_cl.xml
       /var/lib/scrollkeeper/<locale>/scrollkeeper_extended_cl.xml
       /var/log/scrollkeeper.log

AUTHOR

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

SEE ALSO

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

scrollkeeper							    Dec 5, 2001 					    SCROLLKEEPER-UPDATE(8)