INN commit: branches/2.5/doc/pod (6 files)
rra at isc.org
Sun Nov 15 09:29:51 UTC 2009
Date: Sunday, November 15, 2009 @ 01:29:51
Wording: "flag" -> "status" for the last field of the active
Also fix a typo in hook-python.
active.pod | 10 +++++-----
control.ctl.pod | 2 +-
ctlinnd.pod | 12 ++++++------
hook-perl.pod | 8 ++++----
hook-python.pod | 8 ++++----
tdx-util.pod | 14 +++++++-------
6 files changed, 27 insertions(+), 27 deletions(-)
--- active.pod 2009-11-15 09:29:41 UTC (rev 8803)
+++ active.pod 2009-11-15 09:29:51 UTC (rev 8804)
@@ -31,7 +31,7 @@
Each line of this file consists of four fields separated by a space:
- <name> <high> <low> <flag>
+ <name> <high> <low> <status>
The first field is the name of the newsgroup. The newsgroup C<junk> is
special, as mentioned above. The newsgroup C<control> and any newsgroups
@@ -54,7 +54,7 @@
the entire file, the second and third fields are padded out with leading
zeros to make them a fixed width.
-The fourth field contains one of the following flags:
+The fourth field contains one of the following status:
y Local postings are allowed.
m The group is moderated and all postings must be approved.
@@ -63,7 +63,7 @@
x No local postings, and articles from peers are ignored.
=foo.bar Articles are filed in the group foo.bar instead.
-If a newsgroup has the C<j> flag, no articles will be filed in that
+If a newsgroup has the C<j> status, no articles will be filed in that
newsgroup, and local postings to that group will be rejected. If an
article for that newsgroup is received from a remote site, and if it is not
crossposted to some other valid group, it will be filed into the C<junk>
@@ -71,7 +71,7 @@
since the article will still be accepted and can be propagated to other
sites, and the C<junk> group can be made available to readers if wished.
-If the <flag> field begins with an equal sign, the newsgroup is an alias.
+If the <status> field begins with an equal sign, the newsgroup is an alias.
Articles cannot be posted to that newsgroup, but they can be received from
other sites. Any articles received from peers for that newsgroup are
treated as if they were actually posted to the group named after the equal
@@ -100,7 +100,7 @@
has already been in use.)
There are more control.* pseudogroups here than needed by B<innd> to start;
-the corresponding control messages will be filed into them. The C<n> flag
+the corresponding control messages will be filed into them. The C<n> status
is so that users cannot post directly to these groups (control messages
should only be posted to the groups that they affect). If you do not want
these groups to be visible to clients, do not delete them but simply hide
--- control.ctl.pod 2009-11-15 09:29:41 UTC (rev 8803)
+++ control.ctl.pod 2009-11-15 09:29:51 UTC (rev 8804)
@@ -264,7 +264,7 @@
even though it comes from C<group-admin at isc.org> with a valid signature.
As for checkgroups, suppose your news server contains these groups for foo.*,
-all of them being unmoderated (C<y> flag in the F<active> file):
+all of them being unmoderated (C<y> status in the F<active> file):
--- ctlinnd.pod 2009-11-15 09:29:41 UTC (rev 8803)
+++ ctlinnd.pod 2009-11-15 09:29:51 UTC (rev 8804)
@@ -107,10 +107,10 @@
open the history database. If the server is paused or throttled for any
other reason, this command is rejected.
-=item changegroup I<group> I<mode>
+=item changegroup I<group> I<status>
-The newsgroup I<group> is changed so that its mode (the fourth field in
-the F<active> file) becomes I<mode>. This may be used to make an existing
+The newsgroup I<group> is changed so that its status (the fourth field in
+the F<active> file) becomes I<status>. This may be used to make an existing
group moderated or unmoderated, for example.
This command, unlike C<newgroup> or C<rmgroup>, can only be used while the
@@ -248,9 +248,9 @@
for that label in F<incoming.conf> is greater than I<max-connections>
within I<hold-time> seconds.
-=item newgroup I<group> [I<mode> [I<creator>]]
+=item newgroup I<group> [I<status> [I<creator>]]
-Create the specified newsgroup. The I<mode> parameter is the fourth field
+Create the specified newsgroup. The I<status> parameter is the fourth field
of the F<active> file entry, as described in active(5). If it is not an
equal sign, only the first character is used. I<creator> should be the
identity of the person creating the group. If the newsgroup already
@@ -258,7 +258,7 @@
I<creator>, encoded in UTF-8 if given, may be omitted; if so, it will
default to the newsmaster (as specified at configure time, normally
-C<usenet>). I<mode> may also be omitted; if so, it will default to C<y>
+C<usenet>). I<status> may also be omitted; if so, it will default to C<y>
(a normal, unmoderated group). The combination of defaults make it possible
to use the text of the Control: header directly (although don't do this
without checking the syntactic validity of the header first).
--- hook-perl.pod 2009-11-15 09:29:41 UTC (rev 8803)
+++ hook-perl.pod 2009-11-15 09:29:51 UTC (rev 8804)
@@ -254,11 +254,11 @@
-Returns the status of I<newsgroup> (the last field of the active file
+Returns the status of I<newsgroup> (the last field of the F<active> file
entry for that newsgroup). See active(5) for a description of the
-possible values and their meanings (the most common are "y" for an
-unmoderated group and "m" for a moderated group). If I<newsgroup> isn't
-in the active file, returns undef.
+possible values and their meanings (the most common are C<y> for an
+unmoderated group and C<m> for a moderated group). If I<newsgroup> isn't
+in the F<active> file, returns C<undef>.
--- hook-python.pod 2009-11-15 09:29:41 UTC (rev 8803)
+++ hook-python.pod 2009-11-15 09:29:51 UTC (rev 8804)
@@ -315,12 +315,12 @@
# Finally, do you want to see if a given newsgroup is moderated or
# whatever? INN.newsgroup returns the last field of a group's
# entry in active as a string.
- froupflag = INN.newsgroup('alt.fan.karl-malden.nose')
- if froupflag == '':
+ groupstatus = INN.newsgroup('alt.fan.karl-malden.nose')
+ if groupstatus == '':
moderated = 'no such newsgroup'
- elif froupflag == 'y':
+ elif groupstatus == 'y':
moderated = "nope"
- elif froupflag == 'm':
+ elif groupstatus == 'm':
moderated = "yep"
moderated = "something else"
--- tdx-util.pod 2009-11-15 09:29:41 UTC (rev 8803)
+++ tdx-util.pod 2009-11-15 09:29:51 UTC (rev 8804)
@@ -4,7 +4,7 @@
-B<tdx-util> [B<-AFcgiOo>] [B<-a> I<article>] [B<-f> I<flag>]
+B<tdx-util> [B<-AFcgiOo>] [B<-a> I<article>] [B<-f> I<status>]
[B<-n> I<newsgroup>] [B<-p> I<path>] [B<-R> I<path>]
@@ -32,7 +32,7 @@
also be given to specify a newsgroup to operate on.
To add a new newsgroup to the overview database, use B<-c>. A group must
-be specified with B<-n>. If the group flag is something other than C<y>,
+be specified with B<-n>. If the group status is something other than C<y>,
it should be specified with B<-f>, and the low and high article numbers
may be specified with B<-a>. If only one number is given rather than a
range, it will be taken to be the high water mark and the low mark will be
@@ -83,7 +83,7 @@
Create a new group in the overview database. The group must be specified
-with B<-n>. The newsgroup flag defaults to C<y> but may be set with
+with B<-n>. The newsgroup status defaults to C<y> but may be set with
B<-f>. The low and high article numbers default to 1 and 0 respectively,
but may be set with B<-a>. If only one number is given to B<-a>, it is
taken as the high article number.
@@ -102,10 +102,10 @@
To see what would be changed by B<-F>, run B<tdx-util> with B<-A> first.
-=item B<-f> I<flag>
+=item B<-f> I<status>
-When creating a newsgroup with B<-c>, set the flag of the newly created
-group to I<flag> instead of C<y>. Only useful with B<-c>.
+When creating a newsgroup with B<-c>, set the status of the newly created
+group to I<status> instead of C<y>. Only useful with B<-c>.
@@ -129,7 +129,7 @@
The fields are, in order, the newsgroup name, the high water mark, the low
water mark, the base article number (the point at which the group index
-begins), the count of articles in the group, the group status flag, the
+begins), the count of articles in the group, the group status, the
time (in seconds since epoch) when that newsgroup was deleted or 0 if it
hasn't been, and the inode of the index file for that group.
More information about the inn-committers