INN commit: trunk/doc (FAQ pod/makehistory.pod)

[INN Commit]

    Date: Saturday, February 21, 2009 @ 14:51:23
  Author: iulius
Revision: 8340

Mention that makehistory also generates dbz indices, contrary
to what the man page stated.
Also fix a few typos and wrong command-line commands.

Modified:
  trunk/doc/FAQ
  trunk/doc/pod/makehistory.pod

---------------------+
 FAQ                 |    2 +-
 pod/makehistory.pod |   18 ++++++++++--------
 2 files changed, 11 insertions(+), 9 deletions(-)

Modified: FAQ
===================================================================
--- FAQ	2009-02-21 22:49:15 UTC (rev 8339)
+++ FAQ	2009-02-21 22:51:23 UTC (rev 8340)
@@ -1450,6 +1450,6 @@
 to rebuild the history and overview databases.  When that finishes, cd to
 the $pathdb directory and run:
 
-    makedbz -s `wc -l history` -o
+    makedbz -s `wc -l < history` -o
 
 You should now be able to start the server and read and post news to it.

Modified: pod/makehistory.pod
===================================================================
--- pod/makehistory.pod	2009-02-21 22:49:15 UTC (rev 8339)
+++ pod/makehistory.pod	2009-02-21 22:51:23 UTC (rev 8340)
@@ -11,9 +11,11 @@
 
 B<makehistory> rebuilds the history(5) text file, which contains a list of
 message-IDs of articles already seen by the server.  It can also be used
-to rebuild the overview database.  Note that the dbz(3) indexes for the
-F<history> file are rebuilt by makedbz(8), not by B<makehistory> as in
-earlier versions of INN.
+to rebuild the overview database.  Note that even though the dbz(3) indices
+for the F<history> file are also rebuilt by B<makehistory>, it is useful
+to run makedbz(8) after makehistory(8) in order to improve the efficiency
+of the indices (B<makehistory> does not know how large to make the hash
+table at first run, unless it is given by the B<-s> flag).
 
 The default location of the F<history> text file is I<pathdb>/history; to
 specify an alternate location, use the B<-f> flag.
@@ -30,7 +32,7 @@
 overview buffers, and the like.
 
 If I<ovmethod> in F<inn.conf> is C<ovdb>, you must have the ovdb processes
-running while rebuilding overview.  <ovdb needs them available while
+running while rebuilding overview.  ovdb needs them available while
 writing overview entries.  You can start them by hand separate from the
 rest of the server by running B<ovdb_init>; see ovdb_init(8) for more
 details.
@@ -63,7 +65,7 @@
 =item B<-f> I<filename>
 
 Rather than writing directly to I<pathdb>/history, instead write to
-I<filename>.
+I<filename>, also in I<pathdb>.
 
 =item B<-I>
 
@@ -97,7 +99,7 @@
 
 =item B<-S>
 
-Rather than store the overview data into the overview database, just write
+Rather than storing the overview data into the overview database, just write
 it to standard output in a form suitable for feeding to B<overchan> later
 if wished.  When this option is used, B<-F>, B<-I>, B<-l>, and B<-T> are
 ignored.  This option only makes sense in combination with B<-O>.
@@ -148,10 +150,10 @@
 (replacing the path with your I<pathdb>, if it isn't the default).  Then
 look over the new F<history> file for problems and run:
 
-    makedbz -s `wc -l < history` -f history.n
+    makedbz -s `wc -l < history.n` -f history.n
 
 Then rename all of the files matching C<history.n.*> to C<history.*>,
-replacing the current history database and indexes.  After that, it's safe
+replacing the current history database and indices.  After that, it's safe
 to unthrottle B<innd>.
 
 For a simpler example: