1SCROLLKEEPER.CONF(5) File Formats Manual SCROLLKEEPER.CONF(5)
2
3
4
6 scrollkeeper.conf - ScrollKeeper configuration file
7
9 System-wide configuration of ScrollKeeper
10
11
13 The system-wide scrollkeeper.conf file is typically installed at
14 /etc/scrollkeeper.conf. It stores the default OMF paths which are
15 searched by scrollkeeper-update [4m(8) to update the ScrollKeeper documen‐
16 tation catalog. The paths are held by the OMF_DIR variable which is
17 assigned to a colon (:) delimited list of paths.
18
19 Comment lines begin with the (#) character.
20
21
23 A typical scrollkeeper.conf file will look like:
24
25 # Comment
26 OMF_DIR=/usr/share/omf:/usr/local/share/omf:/opt/gnome/share/omf:/opt/gnome-2.0/share/omf:/opt/kde/omf
27
28
29
31 Any user on the system is able to use the scrollkeeper-update [4m(8) com‐
32 mand to generate a ScrollKeeper database at any path that the user has
33 write permission to. The user can over-ride the system default OMF_DIR
34 path variable by setting a shell variable of the same name, OMF_DIR.
35 In this way, a user can create a document catalog which contains a
36 superset of the system documentation, or a completely independent set
37 of documents which the user may be interested in.
38
39 Note that most applications will register its documentation at install
40 time, and unregister it at uninstall time. Thus, a user who keeps
41 their own personal ScrollKeeper database may need to periodically run
42 scrollkeeper-update [4m(8) manually (or with cron) to keep their database
43 up-to-date.
44
45
47 Laszlo Kovacs <laszlo.kovacs@sun.com>
48 Dan Mueth <d-mueth@uchicago.edu>
49
50
52 scrollkeeper-config(1), scrollkeeper-gen-seriesid(1), scrollkeeper(7),
53 scrollkeeper-preinstall(8), scrollkeeper-rebuilddb(8), scrollkeeper-
54 update(8)
55
56
57
58
59ScrollKeeper Dec 5, 2001 SCROLLKEEPER.CONF(5)