doc/man/overview.fmt.5

   1 .\" $Revision: 5909 $
   2 .TH OVERVIEW.FMT 5
   3 .SH NAME
   4 overview.fmt \- format of news overview database
   5 .SH DESCRIPTION
   6 The file
   7 .I <pathetc in inn.conf>/overview.fmt
   8 specifies the organization of the news overview database.
   9 Blank lines and lines beginning with a number sign (``#'') are ignored.
  10 The order of lines in this file is important; it determines the order
  11 in which the fields will appear in the database.
  12 .PP
  13 Most lines will consist of an article header name, optionally
  14 followed by a colon.
  15 A trailing set of lines can have the word ``full'' appear after the
  16 colon; this indicates that the header should appear as well as its value.
  17 .PP
  18 If this file is changed, new overview records will be constructed with
  19 the modified format.  If it is desired that existing records be updated to
  20 the new format, it is necessary to rebuild the overview database using
  21 .IR makehistory (8)
  22 after removing all existing overview files.
  23 .PP
  24 \&``Xref:full'' must be included, or
  25 .IR innd (8)
  26 and other programs which utilize overview method cannot start.
  27 .PP
  28 The default file, show below, is compatible with Geoff Collyer's ``nov''
  29 package:
  30 .PP
  31 .RS
  32 .nf
  33 Subject:
  34 From:
  35 Date:
  36 Message-ID:
  37 References:
  38 Bytes:
  39 Lines:
  40 Xref:full
  41 .fi
  42 .RE
  43 .PP
  44 Usually the only modifications which should be made to the default file
  45 are additions of new fields to the end of the file; all such fields
  46 should have ``full'' after the colon.  The first eight fields should
  47 remain in the same order as above.
  48 .SH HISTORY
  49 Written by Rich $alz <rsalz@uunet.uu.net> for InterNetNews.
  50 Intended to be compatible with the
  51 .I nov
  52 package written by Geoff Collyer <geoff@world.std.com>.
  53 .de R$
  54 This is revision \\$3, dated \\$4.
  55 ..
  56 .R$ $Id: overview.fmt.5 5909 2002-12-03 05:17:18Z vinocur $
  57 .SH "SEE ALSO"
  58 inn.conf(5)