chiark / gitweb /
REORG Delete everything that's not innduct or build system or changed for innduct
[innduct.git] / doc / man / ovdb_init.8
diff --git a/doc/man/ovdb_init.8 b/doc/man/ovdb_init.8
deleted file mode 100644 (file)
index 92075ea..0000000
+++ /dev/null
@@ -1,234 +0,0 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
-.\"
-.\" Standard preamble:
-.\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Vb \" Begin verbatim text
-.ft CW
-.nf
-.ne \\$1
-..
-.de Ve \" End verbatim text
-.ft R
-.fi
-..
-.\" Set up some character translations and predefined strings.  \*(-- will
-.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
-.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
-.ie n \{\
-.    ds -- \(*W-
-.    ds PI pi
-.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
-.    ds L" ""
-.    ds R" ""
-.    ds C` ""
-.    ds C' ""
-'br\}
-.el\{\
-.    ds -- \|\(em\|
-.    ds PI \(*p
-.    ds L" ``
-.    ds R" ''
-'br\}
-.\"
-.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
-.\" entries marked with X<> in POD.  Of course, you'll have to process the
-.\" output yourself in some meaningful fashion.
-.if \nF \{\
-.    de IX
-.    tm Index:\\$1\t\\n%\t"\\$2"
-..
-.    nr % 0
-.    rr F
-.\}
-.\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
-.\"
-.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
-.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
-.    \" fudge factors for nroff and troff
-.if n \{\
-.    ds #H 0
-.    ds #V .8m
-.    ds #F .3m
-.    ds #[ \f1
-.    ds #] \fP
-.\}
-.if t \{\
-.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-.    ds #V .6m
-.    ds #F 0
-.    ds #[ \&
-.    ds #] \&
-.\}
-.    \" simple accents for nroff and troff
-.if n \{\
-.    ds ' \&
-.    ds ` \&
-.    ds ^ \&
-.    ds , \&
-.    ds ~ ~
-.    ds /
-.\}
-.if t \{\
-.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
-.\}
-.    \" troff and (daisy-wheel) nroff accents
-.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
-.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
-.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
-.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
-.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
-.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
-.ds ae a\h'-(\w'a'u*4/10)'e
-.ds Ae A\h'-(\w'A'u*4/10)'E
-.    \" corrections for vroff
-.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
-.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-.    \" for low resolution devices (crt and lpr)
-.if \n(.H>23 .if \n(.V>19 \
-\{\
-.    ds : e
-.    ds 8 ss
-.    ds o a
-.    ds d- d\h'-1'\(ga
-.    ds D- D\h'-1'\(hy
-.    ds th \o'bp'
-.    ds Th \o'LP'
-.    ds ae ae
-.    ds Ae AE
-.\}
-.rm #[ #] #H #V #F C
-.\" ========================================================================
-.\"
-.IX Title "OVDB_INIT 8"
-.TH OVDB_INIT 8 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
-.SH "NAME"
-ovdb_init \- Prepare ovdb database for use
-.SH "SYNOPSYS"
-.IX Header "SYNOPSYS"
-ovdb_init [\f(CW\*(C`\-u\*(C'\fR|\f(CW\*(C`\-r\*(C'\fR]
-.SH "DESCRIPTION"
-.IX Header "DESCRIPTION"
-This command must be run before any other process can access the
-overview database.  It performs the following steps:
-.IP "1" 4
-.IX Item "1"
-Creates the database environment, if necessary
-.IP "2" 4
-.IX Item "2"
-If the database is idle (and if the \f(CW\*(C`\-u\*(C'\fR option is not specified),
-it performs a normal recovery.  The recovery will remove stale locks,
-recreate the memory pool cache, and repair any damage caused by a system
-crash or improper shutdown.
-.IP "3" 4
-.IX Item "3"
-If the \f(CW\*(C`\-u\*(C'\fR option is specified, it performs any necessary upgrades
-to the database.  See the \s-1UPGRADING\s0 section below.
-.IP "4" 4
-.IX Item "4"
-Starts the \s-1DB\s0 housekeeping processes (ovdb_monitor) if they're not
-already running. (Unless the \f(CW\*(C`\-r\*(C'\fR option is specified).
-.IP "5" 4
-.IX Item "5"
-Starts the ovdb readserver (ovdb_server) processes if \f(CW\*(C`readserver\*(C'\fR
-in \fIovdb.conf\fR is \f(CW\*(C`true\*(C'\fR, and if they're not
-already running. (Unless the \f(CW\*(C`\-r\*(C'\fR option is specified).
-.PP
-Returns exit status of 0 if all steps were completed successfully.
-In the event of an error, messages are written to syslog and/or stderr.
-.PP
-If a recovery was attempted but it failed, the database may be
-damaged beyond repair, requiring a rebuild with \fImakehistory\fR\|(8).
-.PP
-This command is normally invoked automatically by \fIrc.news\fR\|(8).
-.PP
-It is \s-1OK\s0 to run this command multiple times.
-.SH "OPTIONS"
-.IX Header "OPTIONS"
-.ie n .IP """\-r""" 4
-.el .IP "\f(CW\-r\fR" 4
-.IX Item "-r"
-Perform recovery only.  \f(CW\*(C`ovdb_monitor\*(C'\fR is not started.
-.ie n .IP """\-u""" 4
-.el .IP "\f(CW\-u\fR" 4
-.IX Item "-u"
-Perform any needed upgrades.  Recovery is not attempted.
-\&\f(CW\*(C`ovdb_monitor\*(C'\fR is started if the upgrade succeeded.
-.SH "UPGRADING"
-.IX Header "UPGRADING"
-There are two situations in which the database will need to be
-upgraded:
-.IP "\(bu" 4
-You upgrade the BerkeleyDB library to a newer version, for example
-from 2.7.7 to 3.1.17.  In this case, the BerkeleyDB db\->\fIupgrade()\fR
-method is used.
-.IP "\(bu" 4
-You upgrade ovdb to a newer major version; i.e., ovdb\-1.0 to ovdb\-2.0.
-.PP
-In both of these cases, the database is upgraded in\-place; and the
-upgrade can not be undone.  Do not interrupt the upgrade process once
-it has started, because there is a risk of irrepairable corruption.
-The upgrade may take several minutes to complete.
-If an upgrade does get interrupted, try running the upgrade again.
-.PP
-Here's an example procedure to upgrade a database created with BerkeleyDB
-2.7.7 to use BerkeleyDB 3.1.17:
-.IP "1" 4
-.IX Item "1"
-Build and install the BerkeleyDB 3.1.17
-.IP "2" 4
-.IX Item "2"
-Run configure in the \s-1INN\s0 source tree and make sure it picks up the
-right BerkeleyDB directory (e.g., /usr/local/BerkeleyDB.3.1)
-.IP "3" 4
-.IX Item "3"
-Do a \f(CW\*(C`make\*(C'\fR
-.IP "4" 4
-.IX Item "4"
-Shut down \s-1INN\s0 (e.g., with \f(CW\*(C`rc.news stop\*(C'\fR).  Be sure to kill all nnrpds as
-well.
-.IP "5" 4
-.IX Item "5"
-Do a \f(CW\*(C`make update\*(C'\fR to install the new binaries.
-.IP "6" 4
-.IX Item "6"
-Run \f(CW\*(C`ovdb_init \-u\*(C'\fR as the news user.
-.IP "7" 4
-.IX Item "7"
-Start \s-1INN\s0 with \f(CW\*(C`rc.news\*(C'\fR
-.PP
-It is \s-1OK\s0 to specify \f(CW\*(C`\-u\*(C'\fR even if no upgrades are needed.
-.SH "HISTORY"
-.IX Header "HISTORY"
-Written by Heath Kehoe <hakehoe@avalon.net> for InterNetNews.
-.SH "SEE ALSO"
-.IX Header "SEE ALSO"
-\&\fIovdb\fR\|(5), \fImakehistory\fR\|(8)