chiark / gitweb /
wip manpage
[inn-innduct.git] / doc / man / active.5
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 "ACTIVE 5"
132 .TH ACTIVE 5 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
133 .SH "NAME"
134 active \- List of newsgroups carried by the server
135 .SH "DESCRIPTION"
136 .IX Header "DESCRIPTION"
137 The file \fIpathdb\fR/active lists the newsgroups carried by \s-1INN\s0.  This file
138 is generally maintained using \fIctlinnd\fR\|(8) to create and remove groups, or
139 by letting \fIcontrolchan\fR\|(8) do so on the basis of received control messages.
140 This file should not be edited directly without throttling \fBinnd\fR, and
141 must be reloaded using \fBctlinnd\fR before \fBinnd\fR is unthrottled.  Editing
142 it directly even with those precautions may make it inconsistent with the
143 overview database and won't update \fIactive.times\fR, so \fBctlinnd\fR should
144 be used to make modifications whenever possible.
145 .PP
146 Each newsgroup should be listed only once.  Each line specifies one group.
147 The order of groups does not matter.  Within each newsgroup, received
148 articles for that group are assigned monotonically increasing numbers as
149 unique names.  If an article is posted to newsgroups not mentioned in this
150 file, those newsgroups are ignored.
151 .PP
152 If none of the newsgroups listed in the Newsgroups header of an article
153 are present in this file, the article is either rejected (if \fIwanttrash\fR
154 is false in \fIinn.conf\fR), or is filed into the newsgroup \f(CW\*(C`junk\*(C'\fR and only
155 propagated to sites that receive the \f(CW\*(C`junk\*(C'\fR newsgroup (if \fIwanttrash\fR is
156 true).
157 .PP
158 Each line of this file consists of four fields separated by a space:
159 .PP
160 .Vb 1
161 \&    <name> <high> <low> <flag>
162 .Ve
163 .PP
164 The first field is the name of the newsgroup.  The newsgroup \f(CW\*(C`junk\*(C'\fR is
165 special, as mentioned above.  The newsgroup \f(CW\*(C`control\*(C'\fR and any newsgroups
166 beginning with \f(CW\*(C`control.\*(C'\fR are also special; control messages are filed
167 into a control.* newsgroup named after the type of control message if that
168 group exists, and otherwise are filed into the newsgroup \f(CW\*(C`control\*(C'\fR
169 (without regard to what newsgroups are listed in the Newsgroups header).
170 If \fImergetogroups\fR is set to true in \fIinn.conf\fR, newsgroups that begin
171 with \f(CW\*(C`to.\*(C'\fR are also treated specially; see \fIinnd\fR\|(8).
172 .PP
173 The second field is the highest article number that has been used in that
174 newsgroup.  The third field is the lowest article number in the group;
175 this number is not guaranteed to be accurate, and should only be taken to
176 be a hint.  It is normally updated nightly as part of the expire process;
177 see \fInews.daily\fR\|(8) and look for \f(CW\*(C`lowmark\*(C'\fR or \f(CW\*(C`renumber\*(C'\fR for more details.
178 Note that because of article cancellations, there may be gaps in the
179 numbering sequence.  If the lowest article number is greater then the
180 highest article number, then there are no articles in the newsgroup.  In
181 order to make it possible to update an entry in-place without rewriting
182 the entire file, the second and third fields are padded out with leading
183 zeros to make them a fixed width.
184 .PP
185 The fourth field contains one of the following flags:
186 .PP
187 .Vb 6
188 \&    y         Local postings are allowed.
189 \&    m         The group is moderated and all postings must be approved.
190 \&    n         No local postings are allowed, only articles from peers.
191 \&    j         Articles are filed in the junk group instead.
192 \&    x         No local postings and ignored for articles from peers.
193 \&    =foo.bar  Articles are filed in the group foo.bar instead.
194 .Ve
195 .PP
196 If a newsgroup has the \f(CW\*(C`j\*(C'\fR flag, no articles will be filed in that
197 newsgroup, and local postings to that group will be rejected.  If an
198 article for that newsgroup is received from a remote site, and it is not
199 crossposted to some other valid group, it will be filed into the \f(CW\*(C`junk\*(C'\fR
200 newsgroup instead.  This is different than simply not listing the group,
201 since the article will still be accepted and can be propagated to other
202 sites, and the \f(CW\*(C`junk\*(C'\fR group can be made available to readers if wished.
203 .PP
204 If the <flag> field begins with an equal sign, the newsgroup is an alias.
205 Articles cannot be posted to that newsgroup, but they can be received from
206 other sites.  Any articles received from peers for that newsgroup are
207 treated as if they were actually posted to the group named after the equal
208 sign.  Note that the Newsgroups header of the articles are not modified.
209 (Alias groups are typically used during a transition and are typically
210 created manually with \fIctlinnd\fR\|(8).)  An alias should not point to another
211 alias.
212 .SH "HISTORY"
213 .IX Header "HISTORY"
214 Written by Rich \f(CW$alz\fR <rsalz@uunet.uu.net> for InterNetNews.  Converted to
215 \&\s-1POD\s0 by Russ Allbery <rra@stanford.edu>.
216 .PP
217 $Id: active.5 7880 2008-06-16 20:37:13Z iulius $
218 .SH "SEE ALSO"
219 .IX Header "SEE ALSO"
220 \&\fIactive.times\fR\|(5), \fIcontrolchan\fR\|(8), \fIctlinnd\fR\|(8), \fIinn.conf\fR\|(5), \fIinnd\fR\|(8),
221 \&\fInews.daily\fR\|(8)