diff docs/noffle.1 @ 294:c2704f070c5c noffle

[svn] * docs/noffle.1: Add 'news admin only' to affected options.
author bears
date Fri, 31 Jan 2003 15:34:47 +0000
parents b0e754727abf
children fd66260b3479
line wrap: on
line diff
--- a/docs/noffle.1	Thu Jan 30 15:49:23 2003 +0000
+++ b/docs/noffle.1	Fri Jan 31 15:34:47 2003 +0000
@@ -1,5 +1,5 @@
 .TH noffle 1
-.\" $Id: noffle.1 425 2003-01-30 15:49:23Z bears $
+.\" $Id: noffle.1 426 2003-01-31 15:34:47Z bears $
 .SH NAME
 noffle \- Usenet package optimized for dialup connections.
 
@@ -117,6 +117,17 @@
 .B NOFFLE
 cannot exchange the contents of local groups with other news servers.
 
+.PP
+Many
+.B NOFFLE
+options are only available to news administrators. News administrators are
+users who are either
+.IR root ,
+the NOFFLE news user (typically
+.IR news ),
+or in the NOFFLE news group (typically group
+.IR news ).
+
 .SH OPTIONS
 
 .TP
@@ -133,12 +144,16 @@
 outbound messages if it has not already been sent. Message Id must
 contain the leading '<' and trailing '>' (quote the argument to avoid
 shell interpretation of '<' and '>').
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-C, \-\-create <local newsgroup name>
 Create a new local newsgroup with the given name. The name should
 conform to the usual newsgroup naming rules to avoid confusing
 newsreaders.
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-d, \-\-database
@@ -148,6 +163,8 @@
 .B \-D, \-\-delete <newsgroup name>
 Delete the newsgroup with the given name. All articles that only
 belong to the group are deleted as well.
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-e, \-\-expire
@@ -160,6 +177,8 @@
 custom expiry periods set for individual newsgroups or sets of
 newsgroups in
 .B /etc/noffle.conf.
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-f, \-\-fetch [server pattern]
@@ -186,7 +205,9 @@
 .B getgroups
 and
 .B omitgroups.
-
+.br
+This option is only available to news administrators.
+ 
 .TP
 .B \-g, \-\-groups
 List all groups available at remote server.
@@ -208,6 +229,8 @@
 .TP
 .B \-m | \-\-modify desc <newsgroup name> <group description>
 Modify the description of the named newsgroup.
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-m | \-\-modify post <local newsgroup name> <permission>
@@ -215,6 +238,8 @@
 be either 'y' (yes, posting allowed), 'm' (moderated, posting allowed
 only if article has 'Approved:' header) or 'n' (no, posting not allowed).
 Attempts to post to a newsgroup with posting disallowed will be rejected.
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-n, \-\-online
@@ -229,6 +254,8 @@
 .B ip-up
 script of
 .BR pppd (8).
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-o, \-\-offline
@@ -240,11 +267,15 @@
 .B ip-down
 script of
 .BR pppd (8).
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-O | \-\-outgoing [server pattern]
 List message IDs and destination server of articles queued for
 posting.
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-p, \-\-post
@@ -270,6 +301,8 @@
 .B server
 .B pattern
 is specified, only matching servers from noffle.conf will be queried.
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-r, \-\-server
@@ -286,6 +319,8 @@
 .B noffle
 can be retrieved by running the server and typing
 .B HELP.
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-B, \-\-rebuild
@@ -295,6 +330,8 @@
 currently active in those groups are copied from the old article
 database to the new one. The new one then replaces the old one.
 This can be useful in cases of article database corruption.
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-R, \-\-requested
@@ -306,21 +343,35 @@
 .B \-s, \-\-subscribe-over <group>
 Add group with name <group> to list of groups that are presently to be fetched
 (in over mode).
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-S, \-\-subscribe-full <group>
 Add group with name <group> to list of groups that are presently to be fetched
 (in full mode).
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-t, \-\-subscribe-thread <group>
 Add group with name <group> to list of groups that are presently to be fetched
 (in thread mode).
+.br
+This option is only available to news administrators.
 
 .TP
 .B \-u, \-\-unsubscribe <group>
 Remove group with name <group> from list of groups that are presently to
 be fetched.
+.br
+This option is only available to news administrators.
+
+.TP
+.B \-v, \-\-version
+Reports the
+.B NOFFLE
+version number.
 
 .SH NOTES