docs patch for ovdb
Heath Kehoe
heath.kehoe at intermec.com
Wed Jun 7 19:08:56 UTC 2000
This patch contains documentation updates for ovdb, and should go in
both the BETA and CURRENT trees. It modifies doc/pod/ovdb.pod
and doc/man/ovdb.5
-Heath
*** doc/pod/ovdb.pod.dist Fri Jun 2 05:07:55 2000
--- doc/pod/ovdb.pod Wed Jun 7 13:52:42 2000
***************
*** 5,19 ****
=head1 DESCRIPTION
Ovdb is a storage method that uses the BerkeleyDB library to store overview
! data. It requires version 2.6.x or later of the BerkeleyDB library; it has been
! tested with versions 2.7.7 and 3.0.55. Ovdb makes use of the full
! transaction/logging/locking functionality of the BerkeleyDB environment.
! BerkeleyDB may be downloaded from http://www.sleepycat.com .
The BerkeleyDB distribution is (by default) installed into
F</usr/local/BerkeleyDB>, with subdirectories F<lib/>, F<include/>, and
F<bin/> for the library, headers, and support tools, respectively.
! Version 3.x uses F</usr/local/BerkeleyDB.3.0> instead.
Ovdb uses some of the support tools in the F<bin/> subdirectory; namely
F<db_archive>, F<db_checkpoint>, and F<db_deadlock>.
--- 5,21 ----
=head1 DESCRIPTION
Ovdb is a storage method that uses the BerkeleyDB library to store overview
! data. It requires version 2.6.x or later of the BerkeleyDB library; it is
! known to work well with version 2.7.7. There is also a 3.0.55, but it is
! not very stable (though ovdb will compile correctly with it).
! Ovdb makes use of the full transaction/logging/locking functionality of the
! BerkeleyDB environment. BerkeleyDB may be downloaded from
! http://www.sleepycat.com .
The BerkeleyDB distribution is (by default) installed into
F</usr/local/BerkeleyDB>, with subdirectories F<lib/>, F<include/>, and
F<bin/> for the library, headers, and support tools, respectively.
! Version 3.x uses F</usr/local/BerkeleyDB.3.x> instead.
Ovdb uses some of the support tools in the F<bin/> subdirectory; namely
F<db_archive>, F<db_checkpoint>, and F<db_deadlock>.
***************
*** 29,39 ****
the other overview methods. Plan on needing at least 1.1 KB for every
article in your spool (not counting crossposts). So, if you have 5
million articles, you'll need at least 5.5 GB of disk space for ovdb.
Plus, you'll need additional space for transaction logs: at least 40 MB,
! preferably 100 MB or more. (The logs may be on a different filesystem
! -- see the DB_CONFIG section.) If space is running tight, you can shrink
! the ovXXXX database files by dumping and reloading them (to remove unused
! space within the database file).
=head1 CONFIGURATION
--- 31,42 ----
the other overview methods. Plan on needing at least 1.1 KB for every
article in your spool (not counting crossposts). So, if you have 5
million articles, you'll need at least 5.5 GB of disk space for ovdb.
+ With BerkeleyDB 2.x, the db files are 'grow only'; the library will
+ not shrink them, even if data is removed. So, reserving extra space
+ above the estimate is a good idea.
Plus, you'll need additional space for transaction logs: at least 40 MB,
! preferably 100 MB. (The logs may be on a different filesystem
! -- see the DB_CONFIG section.)
=head1 CONFIGURATION
***************
*** 126,132 ****
Runs C<ovdb_recover>. This will perform any needed recovery on the
database; e.g., if there was a crash that may have left the database
! in an inconsistent state. This is done before innd is started.
=item *
--- 129,137 ----
Runs C<ovdb_recover>. This will perform any needed recovery on the
database; e.g., if there was a crash that may have left the database
! in an inconsistent state. This is done before innd is started. If
! the innd.pid file is present but innd is not running (i.e., unclean
! shutdown), rc.news will supply the C<-f> argument to C<ovdb_recover>
=item *
***************
*** 145,151 ****
If a program accessing the database crashes, or otherwise exits
uncleanly, it might leave a stale lock in the database. This lock
could cause other processes to deadlock on that stale lock. To
! fix this, shut down all processes that access overview (using
C<kill -9> if necessary) then run C<ovdb_recover -f> as the
news user, e.g.: C<su news -c "/PATHBIN/ovdb_recover -f">
This will remove all locks plus repair any damage caused by
--- 150,156 ----
If a program accessing the database crashes, or otherwise exits
uncleanly, it might leave a stale lock in the database. This lock
could cause other processes to deadlock on that stale lock. To
! fix this, shut down all news processes (using
C<kill -9> if necessary) then run C<ovdb_recover -f> as the
news user, e.g.: C<su news -c "/PATHBIN/ovdb_recover -f">
This will remove all locks plus repair any damage caused by
*** doc/man/ovdb.5.dist Fri Jun 2 05:07:39 2000
--- doc/man/ovdb.5 Wed Jun 7 13:59:57 2000
***************
*** 1,5 ****
.\" Automatically generated by Pod::Man version 1.02
! .\" Tue Apr 11 17:15:14 2000
.\"
.\" Standard preamble:
.\" ======================================================================
--- 1,5 ----
.\" Automatically generated by Pod::Man version 1.02
! .\" Wed Jun 7 13:59:57 2000
.\"
.\" Standard preamble:
.\" ======================================================================
***************
*** 138,144 ****
.\" ======================================================================
.\"
.IX Title "ovdb 5"
! .TH ovdb 5 "INN 2.3" "2000-04-11" "InterNetNews Documentation"
.UC
.SH "NAME"
ovdb \- Overview storage method for \s-1INN\s0
--- 138,144 ----
.\" ======================================================================
.\"
.IX Title "ovdb 5"
! .TH ovdb 5 "INN 2.3" "2000-06-07" "InterNetNews Documentation"
.UC
.SH "NAME"
ovdb \- Overview storage method for \s-1INN\s0
***************
*** 145,159 ****
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Ovdb is a storage method that uses the BerkeleyDB library to store overview
! data. It requires version 2.6.x or later of the BerkeleyDB library; it has been
! tested with versions 2.7.7 and 3.0.55. Ovdb makes use of the full
! transaction/logging/locking functionality of the BerkeleyDB environment.
! BerkeleyDB may be downloaded from http://www.sleepycat.com .
.PP
The BerkeleyDB distribution is (by default) installed into
\&\fI/usr/local/BerkeleyDB\fR, with subdirectories \fIlib/\fR, \fIinclude/\fR, and
\&\fIbin/\fR for the library, headers, and support tools, respectively.
! Version 3.x uses \fI/usr/local/BerkeleyDB.3.0\fR instead.
Ovdb uses some of the support tools in the \fIbin/\fR subdirectory; namely
\&\fIdb_archive\fR, \fIdb_checkpoint\fR, and \fIdb_deadlock\fR.
.SH "INSTALLATION"
--- 145,161 ----
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Ovdb is a storage method that uses the BerkeleyDB library to store overview
! data. It requires version 2.6.x or later of the BerkeleyDB library; it is
! known to work well with version 2.7.7. There is also a 3.0.55, but it is
! not very stable (though ovdb will compile correctly with it).
! Ovdb makes use of the full transaction/logging/locking functionality of the
! BerkeleyDB environment. BerkeleyDB may be downloaded from
! http://www.sleepycat.com .
.PP
The BerkeleyDB distribution is (by default) installed into
\&\fI/usr/local/BerkeleyDB\fR, with subdirectories \fIlib/\fR, \fIinclude/\fR, and
\&\fIbin/\fR for the library, headers, and support tools, respectively.
! Version 3.x uses \fI/usr/local/BerkeleyDB.3.x\fR instead.
Ovdb uses some of the support tools in the \fIbin/\fR subdirectory; namely
\&\fIdb_archive\fR, \fIdb_checkpoint\fR, and \fIdb_deadlock\fR.
.SH "INSTALLATION"
***************
*** 168,178 ****
the other overview methods. Plan on needing at least 1.1 \s-1KB\s0 for every
article in your spool (not counting crossposts). So, if you have 5
million articles, you'll need at least 5.5 \s-1GB\s0 of disk space for ovdb.
Plus, you'll need additional space for transaction logs: at least 40 \s-1MB\s0,
! preferably 100 \s-1MB\s0 or more. (The logs may be on a different filesystem
! \&\-\- see the \s-1DB_CONFIG\s0 section.) If space is running tight, you can shrink
! the ovXXXX database files by dumping and reloading them (to remove unused
! space within the database file).
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
To enable ovdb, set the \fIovmethod\fR parameter in \fIinn.conf\fR to \f(CW\*(C`ovdb\*(C'\fR.
--- 170,181 ----
the other overview methods. Plan on needing at least 1.1 \s-1KB\s0 for every
article in your spool (not counting crossposts). So, if you have 5
million articles, you'll need at least 5.5 \s-1GB\s0 of disk space for ovdb.
+ With BerkeleyDB 2.x, the db files are 'grow only'; the library will
+ not shrink them, even if data is removed. So, reserving extra space
+ above the estimate is a good idea.
Plus, you'll need additional space for transaction logs: at least 40 \s-1MB\s0,
! preferably 100 \s-1MB\s0. (The logs may be on a different filesystem
! \&\-\- see the \s-1DB_CONFIG\s0 section.)
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
To enable ovdb, set the \fIovmethod\fR parameter in \fIinn.conf\fR to \f(CW\*(C`ovdb\*(C'\fR.
***************
*** 250,256 ****
.Ip "\(bu" 4
Runs \f(CW\*(C`ovdb_recover\*(C'\fR. This will perform any needed recovery on the
database; e.g., if there was a crash that may have left the database
! in an inconsistent state. This is done before innd is started.
.Ip "\(bu" 4
Runs \f(CW\*(C`dbprocs start\*(C'\fR. This starts the \s-1DB\s0 housekeeping processes.
.PP
--- 253,261 ----
.Ip "\(bu" 4
Runs \f(CW\*(C`ovdb_recover\*(C'\fR. This will perform any needed recovery on the
database; e.g., if there was a crash that may have left the database
! in an inconsistent state. This is done before innd is started. If
! the innd.pid file is present but innd is not running (i.e., unclean
! shutdown), rc.news will supply the \f(CW\*(C`\-f\*(C'\fR argument to \f(CW\*(C`ovdb_recover\*(C'\fR
.Ip "\(bu" 4
Runs \f(CW\*(C`dbprocs start\*(C'\fR. This starts the \s-1DB\s0 housekeeping processes.
.PP
***************
*** 264,270 ****
If a program accessing the database crashes, or otherwise exits
uncleanly, it might leave a stale lock in the database. This lock
could cause other processes to deadlock on that stale lock. To
! fix this, shut down all processes that access overview (using
\&\f(CW\*(C`kill \-9\*(C'\fR if necessary) then run \f(CW\*(C`ovdb_recover \-f\*(C'\fR as the
news user, e.g.: \f(CW\*(C`su news \-c "/PATHBIN/ovdb_recover \-f"\*(C'\fR
This will remove all locks plus repair any damage caused by
--- 269,275 ----
If a program accessing the database crashes, or otherwise exits
uncleanly, it might leave a stale lock in the database. This lock
could cause other processes to deadlock on that stale lock. To
! fix this, shut down all news processes (using
\&\f(CW\*(C`kill \-9\*(C'\fR if necessary) then run \f(CW\*(C`ovdb_recover \-f\*(C'\fR as the
news user, e.g.: \f(CW\*(C`su news \-c "/PATHBIN/ovdb_recover \-f"\*(C'\fR
This will remove all locks plus repair any damage caused by
More information about the inn-patches
mailing list