version 2, including all changes.
.
| Rev |
Author |
# |
Line |
| 1 |
perry |
1 |
SCROLLKEEPER.CONF |
| |
|
2 |
!!!SCROLLKEEPER.CONF |
| |
|
3 |
NAME |
| |
|
4 |
SYNOPSIS |
| |
|
5 |
DESCRIPTION |
| |
|
6 |
EXAMPLE |
| |
|
7 |
NOTES |
| |
|
8 |
AUTHOR |
| |
|
9 |
SEE ALSO |
| |
|
10 |
---- |
| |
|
11 |
!!NAME |
| |
|
12 |
|
| |
|
13 |
|
| 2 |
perry |
14 |
scrollkeeper.conf - !ScrollKeeper configuration file |
| 1 |
perry |
15 |
!!SYNOPSIS |
| |
|
16 |
|
| |
|
17 |
|
| 2 |
perry |
18 |
System-wide configuration of !ScrollKeeper |
| 1 |
perry |
19 |
!!DESCRIPTION |
| |
|
20 |
|
| |
|
21 |
|
| |
|
22 |
The system-wide scrollkeeper.conf file is typically |
| |
|
23 |
installed at /etc/scrollkeeper.conf. It stores the default |
| |
|
24 |
OMF paths which are searched by ''scrollkeeper-update |
| 2 |
perry |
25 |
(8)'' to update the !ScrollKeeper documentation catalog. |
| 1 |
perry |
26 |
The paths are held by the OMF_DIR variable which is assigned |
| |
|
27 |
to a colon (:) delimited list of paths. |
| |
|
28 |
|
| |
|
29 |
|
| |
|
30 |
Comment lines begin with the (#) character. |
| |
|
31 |
!!EXAMPLE |
| |
|
32 |
|
| |
|
33 |
|
| |
|
34 |
A typical scrollkeeper.conf file will look |
| |
|
35 |
like: |
| |
|
36 |
|
| |
|
37 |
|
| |
|
38 |
# Comment |
| |
|
39 |
OMF_DIR=/usr/share/omf:/usr/local/share/omf:/opt/gnome/share/omf:/opt/gnome-2.0/share/omf:/opt/kde/omf |
| |
|
40 |
!!NOTES |
| |
|
41 |
|
| |
|
42 |
|
| |
|
43 |
Any user on the system is able to use the |
| |
|
44 |
''scrollkeeper-update (8)'' command to generate a |
| 2 |
perry |
45 |
!ScrollKeeper database at any path that the user has write |
| 1 |
perry |
46 |
permission to. The user can over-ride the system default |
| |
|
47 |
OMF_DIR path variable by setting a shell variable of the |
| |
|
48 |
same name, OMF_DIR. In this way, a user can create a |
| |
|
49 |
document catalog which contains a superset of the system |
| |
|
50 |
documentation, or a completely independent set of documents |
| |
|
51 |
which the user may be interested in. |
| |
|
52 |
|
| |
|
53 |
|
| |
|
54 |
Note that most applications will register its documentation |
| |
|
55 |
at install time, and unregister it at uninstall time. Thus, |
| 2 |
perry |
56 |
a user who keeps their own personal !ScrollKeeper database |
| 1 |
perry |
57 |
may need to periodically run ''scrollkeeper-update (8)'' |
| |
|
58 |
manually (or with cron) to keep their database |
| |
|
59 |
up-to-date. |
| |
|
60 |
!!AUTHOR |
| |
|
61 |
|
| |
|
62 |
|
| |
|
63 |
Laszlo Kovacs |
| |
|
64 |
Dan Mueth |
| |
|
65 |
!!SEE ALSO |
| |
|
66 |
|
| |
|
67 |
|
| |
|
68 |
scrollkeeper-config(1), scrollkeeper-gen-seriesid(1), |
| |
|
69 |
scrollkeeper(7), scrollkeeper-preinstall(8), |
| |
|
70 |
scrollkeeper-rebuilddb(8), |
| |
|
71 |
scrollkeeper-update(8) |
| |
|
72 |
---- |
