doc/pod/active.pod

   1 =head1 NAME
   2
   3 active - List of newsgroups carried by the server
   4
   5 =head1 DESCRIPTION
   6
   7 The file I<pathdb>/active lists the newsgroups carried by INN.  This file
   8 is generally maintained using ctlinnd(8) to create and remove groups, or
   9 by letting controlchan(8) do so on the basis of received control messages.
  10 This file should not be edited directly without throttling B<innd>, and
  11 must be reloaded using B<ctlinnd> before B<innd> is unthrottled.  Editing
  12 it directly even with those precautions may make it inconsistent with the
  13 overview database and won't update F<active.times>, so B<ctlinnd> should
  14 be used to make modifications whenever possible.
  15
  16 Each newsgroup should be listed only once.  Each line specifies one group.
  17 The order of groups does not matter.  Within each newsgroup, received
  18 articles for that group are assigned monotonically increasing numbers as
  19 unique names.  If an article is posted to newsgroups not mentioned in this
  20 file, those newsgroups are ignored.
  21
  22 If none of the newsgroups listed in the Newsgroups header of an article
  23 are present in this file, the article is either rejected (if I<wanttrash>
  24 is false in F<inn.conf>), or is filed into the newsgroup C<junk> and only
  25 propagated to sites that receive the C<junk> newsgroup (if I<wanttrash> is
  26 true).
  27
  28 Each line of this file consists of four fields separated by a space:
  29
  30     <name> <high> <low> <flag>
  31
  32 The first field is the name of the newsgroup.  The newsgroup C<junk> is
  33 special, as mentioned above.  The newsgroup C<control> and any newsgroups
  34 beginning with C<control.> are also special; control messages are filed
  35 into a control.* newsgroup named after the type of control message if that
  36 group exists, and otherwise are filed into the newsgroup C<control>
  37 (without regard to what newsgroups are listed in the Newsgroups header).
  38 If I<mergetogroups> is set to true in F<inn.conf>, newsgroups that begin
  39 with C<to.> are also treated specially; see innd(8).
  40
  41 The second field is the highest article number that has been used in that
  42 newsgroup.  The third field is the lowest article number in the group;
  43 this number is not guaranteed to be accurate, and should only be taken to
  44 be a hint.  It is normally updated nightly as part of the expire process;
  45 see news.daily(8) and look for C<lowmark> or C<renumber> for more details.
  46 Note that because of article cancellations, there may be gaps in the
  47 numbering sequence.  If the lowest article number is greater then the
  48 highest article number, then there are no articles in the newsgroup.  In
  49 order to make it possible to update an entry in-place without rewriting
  50 the entire file, the second and third fields are padded out with leading
  51 zeros to make them a fixed width.
  52
  53 The fourth field contains one of the following flags:
  54
  55     y         Local postings are allowed.
  56     m         The group is moderated and all postings must be approved.
  57     n         No local postings are allowed, only articles from peers.
  58     j         Articles are filed in the junk group instead.
  59     x         No local postings and ignored for articles from peers.
  60     =foo.bar  Articles are filed in the group foo.bar instead.
  61
  62 If a newsgroup has the C<j> flag, no articles will be filed in that
  63 newsgroup, and local postings to that group will be rejected.  If an
  64 article for that newsgroup is received from a remote site, and it is not
  65 crossposted to some other valid group, it will be filed into the C<junk>
  66 newsgroup instead.  This is different than simply not listing the group,
  67 since the article will still be accepted and can be propagated to other
  68 sites, and the C<junk> group can be made available to readers if wished.
  69
  70 If the <flag> field begins with an equal sign, the newsgroup is an alias.
  71 Articles cannot be posted to that newsgroup, but they can be received from
  72 other sites.  Any articles received from peers for that newsgroup are
  73 treated as if they were actually posted to the group named after the equal
  74 sign.  Note that the Newsgroups header of the articles are not modified.
  75 (Alias groups are typically used during a transition and are typically
  76 created manually with ctlinnd(8).)  An alias should not point to another
  77 alias.
  78
  79 =head1 HISTORY
  80
  81 Written by Rich $alz <rsalz@uunet.uu.net> for InterNetNews.  Converted to
  82 POD by Russ Allbery <rra@stanford.edu>.
  83
  84 $Id: active.pod 6773 2004-05-17 05:48:54Z rra $
  85
  86 =head1 SEE ALSO
  87
  88 active.times(5), controlchan(8), ctlinnd(8), inn.conf(5), innd(8),
  89 news.daily(8)
  90
  91 =cut