home *** CD-ROM | disk | FTP | other *** search
/ Unix System Administration Handbook 1997 October / usah_oct97.iso / news / nov.tar / doc / install next >
Text File  |  1993-06-25  |  3KB  |  167 lines
  1. .TL
  2. Setting up the news overview database
  3. (pre-Cleanup-Release version)
  4. .AU
  5. Geoff Collyer
  6. .AI
  7. Software Tool & Die
  8. .SH
  9. Introduction
  10. .PP
  11. My original hope was that
  12. the news reader maintainers would pick up this code,
  13. and that it would be quickly incorporated into the Cleanup Release
  14. of C News, which was supposed to have happened at the end of April, 1993,
  15. and thus most people wouldn't have to deal with setting up
  16. the news overview database
  17. (\c
  18. .I nov )
  19. directly.
  20. The Cleanup Release has slipped,
  21. so until it happens,
  22. here are interim installation instructions.
  23. .PP
  24. This distribution includes code to add to the February 1993
  25. C News release (Performance Release with known.problems fixed),
  26. plus code to add to news readers to access the
  27. .I nov
  28. database
  29. (see
  30. .B doc/rationale
  31. for an overview).
  32. .PP
  33. The basic idea is that replacing the relevant
  34. .I relaynews
  35. sources with the ones in
  36. .B c.news/relay
  37. and recompiling
  38. .I relaynews
  39. should add the necessary hook to
  40. .I relaynews .
  41. You then have to install some of the other machinery,
  42. notably
  43. .I mkov
  44. and the wrapper scripts
  45. (domkov, newsrun, etc.).
  46. This will generate the
  47. .B .overview
  48. files that constitute the
  49. .I nov
  50. database.
  51. .PP
  52. Proof-of-concept versions of
  53. .I nn ,
  54. .I trn ,
  55. and
  56. .I vnews
  57. can be found in
  58. .B world.std.com:src/news/*.dist.tar.Z.
  59. Better versions should be available from the maintainers of these
  60. news readers.
  61. .SH
  62. Setup
  63. .PP
  64. In the root directory of the distribution tree,
  65. type
  66. .B make ;
  67. this will build everything you should need except the new
  68. .I relaynews .
  69. Verify that
  70. .B maint/*ov
  71. and
  72. .B maint/initdb
  73. have the right path names embedded in them
  74. for your system,
  75. then copy them to NEWSBIN/maint.
  76. In
  77. .B c.news ,
  78. .B doexpire
  79. and
  80. .B newsrun
  81. are modified versions that invoke the appropriate
  82. .I nov
  83. maintenance machinery;
  84. you may want to diff them with your existing ones rather than just
  85. blindingly installing them.
  86. .PP
  87. .B c.news/relay
  88. contains drop-in replacements for their corresponding source
  89. files in the February 1993 updated Performance Release.
  90. You can either copy these sources into your C News tree
  91. (into
  92. .B relay )
  93. or diff them against your sources and merge in any changes
  94. you may have made.
  95. NB:
  96. the version of
  97. .B libc/fgetfln.c
  98. in the
  99. .I nov
  100. distribution fixes a nasty bug and you should copy it on top of
  101. the one in your C News tree
  102. (in
  103. .B libc ).
  104. Then rebuild all of C News by rerunning the
  105. .B conf/doit.*
  106. scripts,
  107. notably
  108. .B doit.bin .
  109. You could just rebuild and install
  110. .I relaynews ,
  111. but getting the fixed
  112. .B fgetfln.c
  113. into everything is worth doing.
  114. .PP
  115. Some of the scripts in
  116. .B maint
  117. expect
  118. .I gawk
  119. in
  120. .B /usr/local/bin/gawk ;
  121. you can use
  122. .I nawk
  123. instead or possibly even
  124. .I awk .
  125. .PP
  126. The manual pages in the
  127. .B man
  128. directory should be installed somewhere suitable.
  129. .SH
  130. Initialisation
  131. .PP
  132. You can either run
  133. .I maint/initdb
  134. which takes a long time,
  135. but generates
  136. .I .overview
  137. files for all news on your machine,
  138. or you can just let C News create
  139. .I .overview
  140. entries for news as it arrives;
  141. in a few days,
  142. you'll have a
  143. .I nov
  144. database for most of the news on your machine.
  145. .SH
  146. Caveats
  147. .PP
  148. The
  149. .I relaynews
  150. regression test may fail after applying these changes,
  151. probably due to the presence of a new file,
  152. NEWSCTL/headers.
  153. .SH
  154. Newsreader Hooks
  155. .PP
  156. The
  157. .B libnov
  158. directory contains a reference implementation of an access
  159. library for
  160. .I nov .
  161. Feel free to modify this code to suit your needs,
  162. but
  163. .I please
  164. keep the database format the same.
  165. Note the existence of an extension field in
  166. .I nov .
  167.