Penguin
Recent Changes
Blame: scrollkeeper-update(8)
EditPageHistoryDiffInfoLikePages
Annotated edit history of scrollkeeper-update(8) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 SCROLLKEEPER-UPDATE
2 !!!SCROLLKEEPER-UPDATE
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 ENVIRONMENT
8 FILES
9 AUTHOR
10 SEE ALSO
11 ----
12 !!NAME
13
14
15 scrollkeeper-update - identify new, modified, or removed OMF files and update the scrollkeeper databases
16 !!SYNOPSIS
17
18
19 __scrollkeeper-update__ [[ __-v__ ] [[ __-q__ ] [[
20 __-p__ ''database-directory'' ] [[ __-o__
21 ''omf-directories'' ]
22 !!DESCRIPTION
23
24
25 This synchronizes the scrollkeeper database with the OMF
26 directory. It searches the scrollkeeper OMF directory to
27 identify if any files were added, removed, or modified and
28 updates its internal database files to reflect any
29 changes.
30
31
32 This utility is generally executed as the last step of
33 installation, after the OMF file is copied into place. It is
34 also typically the last step of uninstallation, after the
35 OMF file is removed. Using this, an administrator can easily
36 manually install and uninstall documents into the database.
37 It can also be run to guarantee the database is fully
38 up-to-date.
39
40
41 Note that because __scrollkeeper-update__ is normally run
42 during installation and its output is typically seen by
43 users, non-critical warnings and errors such as those caused
44 by invalid metadata are written to the log file instead of
45 to the terminal. Developers should use the log file to
46 identify any problems.
47 !!OPTIONS
48
49
50 __-v__
51
52
53 Be verbose: Say which __scrollkeeper-install__ and
54 __scrollkeeper-uninstall__ commands are being run to
55 bring the database up to date.
56
57
58 __-q__
59
60
61 Run in quiet mode, suppressing output of all but the most
62 serious warning and error messages to STDOUT. Note that most
63 output to the log file will be unchanged.
64
65
66 __-p__ ''database-directory''
67
68
69 Use ''database-directory'' as the directory for the
70 scrollkeeper database rather than the usual one obtained by
71 running __omf-config --pkglocalstatedir__.
72
73
74 __-o__ ''omf-directories''
75
76
77 Examine the directories named in ''omf-directories''
78 rather than the one usual one obtained by running
79 __scrollkeeper-config --omfdir__ (or specified in the
80 __OMF_DIR__ environment variable if set). The
81 ''omf-directories'' should be a colon-separated list of
82 directories.
83 !!ENVIRONMENT
84
85
86 OMF_DIR
87
88
89 If no __-o__ option is specified, this variable overrides
90 the __scrollkeeper-config__-provided OMF directory. It
91 should be a colon-separated list of
92 directories.
93 !!FILES
94
95
96 __/var/lib/scrollkeeper/scrollkeeper_docs
97 /var/lib/scrollkeeper/TOC/
98 /var/lib/scrollkeeper/
99 /var/lib/scrollkeeper/
100 /var/log/scrollkeeper.log__
101 !!AUTHOR
102
103
104 Laszlo Kovacs
105 Dan Mueth
106 !!SEE ALSO
107
108
109 scrollkeeper-config(1), scrollkeeper-gen-seriesid(1),
110 scrollkeeper.conf(5), scrollkeeper(7),
111 scrollkeeper-preinstall(8),
112 scrollkeeper-rebuilddb(8)
113 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.