doc/man/ovdb_init.8

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  31 .\" nothing in troff, for use with C<>.
  32 .tr \(*W-
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "OVDB_INIT 8"
 132 .TH OVDB_INIT 8 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
 133 .SH "NAME"
 134 ovdb_init \- Prepare ovdb database for use
 135 .SH "SYNOPSYS"
 136 .IX Header "SYNOPSYS"
 137 ovdb_init [\f(CW\*(C`\-u\*(C'\fR|\f(CW\*(C`\-r\*(C'\fR]
 138 .SH "DESCRIPTION"
 139 .IX Header "DESCRIPTION"
 140 This command must be run before any other process can access the
 141 overview database.  It performs the following steps:
 142 .IP "1" 4
 143 .IX Item "1"
 144 Creates the database environment, if necessary
 145 .IP "2" 4
 146 .IX Item "2"
 147 If the database is idle (and if the \f(CW\*(C`\-u\*(C'\fR option is not specified),
 148 it performs a normal recovery.  The recovery will remove stale locks,
 149 recreate the memory pool cache, and repair any damage caused by a system
 150 crash or improper shutdown.
 151 .IP "3" 4
 152 .IX Item "3"
 153 If the \f(CW\*(C`\-u\*(C'\fR option is specified, it performs any necessary upgrades
 154 to the database.  See the \s-1UPGRADING\s0 section below.
 155 .IP "4" 4
 156 .IX Item "4"
 157 Starts the \s-1DB\s0 housekeeping processes (ovdb_monitor) if they're not
 158 already running. (Unless the \f(CW\*(C`\-r\*(C'\fR option is specified).
 159 .IP "5" 4
 160 .IX Item "5"
 161 Starts the ovdb readserver (ovdb_server) processes if \f(CW\*(C`readserver\*(C'\fR
 162 in \fIovdb.conf\fR is \f(CW\*(C`true\*(C'\fR, and if they're not
 163 already running. (Unless the \f(CW\*(C`\-r\*(C'\fR option is specified).
 164 .PP
 165 Returns exit status of 0 if all steps were completed successfully.
 166 In the event of an error, messages are written to syslog and/or stderr.
 167 .PP
 168 If a recovery was attempted but it failed, the database may be
 169 damaged beyond repair, requiring a rebuild with \fImakehistory\fR\|(8).
 170 .PP
 171 This command is normally invoked automatically by \fIrc.news\fR\|(8).
 172 .PP
 173 It is \s-1OK\s0 to run this command multiple times.
 174 .SH "OPTIONS"
 175 .IX Header "OPTIONS"
 176 .ie n .IP """\-r""" 4
 177 .el .IP "\f(CW\-r\fR" 4
 178 .IX Item "-r"
 179 Perform recovery only.  \f(CW\*(C`ovdb_monitor\*(C'\fR is not started.
 180 .ie n .IP """\-u""" 4
 181 .el .IP "\f(CW\-u\fR" 4
 182 .IX Item "-u"
 183 Perform any needed upgrades.  Recovery is not attempted.
 184 \&\f(CW\*(C`ovdb_monitor\*(C'\fR is started if the upgrade succeeded.
 185 .SH "UPGRADING"
 186 .IX Header "UPGRADING"
 187 There are two situations in which the database will need to be
 188 upgraded:
 189 .IP "\(bu" 4
 190 You upgrade the BerkeleyDB library to a newer version, for example
 191 from 2.7.7 to 3.1.17.  In this case, the BerkeleyDB db\->\fIupgrade()\fR
 192 method is used.
 193 .IP "\(bu" 4
 194 You upgrade ovdb to a newer major version; i.e., ovdb\-1.0 to ovdb\-2.0.
 195 .PP
 196 In both of these cases, the database is upgraded in\-place; and the
 197 upgrade can not be undone.  Do not interrupt the upgrade process once
 198 it has started, because there is a risk of irrepairable corruption.
 199 The upgrade may take several minutes to complete.
 200 If an upgrade does get interrupted, try running the upgrade again.
 201 .PP
 202 Here's an example procedure to upgrade a database created with BerkeleyDB
 203 2.7.7 to use BerkeleyDB 3.1.17:
 204 .IP "1" 4
 205 .IX Item "1"
 206 Build and install the BerkeleyDB 3.1.17
 207 .IP "2" 4
 208 .IX Item "2"
 209 Run configure in the \s-1INN\s0 source tree and make sure it picks up the
 210 right BerkeleyDB directory (e.g., /usr/local/BerkeleyDB.3.1)
 211 .IP "3" 4
 212 .IX Item "3"
 213 Do a \f(CW\*(C`make\*(C'\fR
 214 .IP "4" 4
 215 .IX Item "4"
 216 Shut down \s-1INN\s0 (e.g., with \f(CW\*(C`rc.news stop\*(C'\fR).  Be sure to kill all nnrpds as
 217 well.
 218 .IP "5" 4
 219 .IX Item "5"
 220 Do a \f(CW\*(C`make update\*(C'\fR to install the new binaries.
 221 .IP "6" 4
 222 .IX Item "6"
 223 Run \f(CW\*(C`ovdb_init \-u\*(C'\fR as the news user.
 224 .IP "7" 4
 225 .IX Item "7"
 226 Start \s-1INN\s0 with \f(CW\*(C`rc.news\*(C'\fR
 227 .PP
 228 It is \s-1OK\s0 to specify \f(CW\*(C`\-u\*(C'\fR even if no upgrades are needed.
 229 .SH "HISTORY"
 230 .IX Header "HISTORY"
 231 Written by Heath Kehoe <hakehoe@avalon.net> for InterNetNews.
 232 .SH "SEE ALSO"
 233 .IX Header "SEE ALSO"
 234 \&\fIovdb\fR\|(5), \fImakehistory\fR\|(8)