Mercurial > noffle

comparison docs/noffle.1 @ 294:c2704f070c5c noffle

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[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
comparison
equal deleted inserted replaced
293:b0e754727abf 294:c2704f070c5c
1 .TH noffle 1 1 .TH noffle 1
2 .\" $Id: noffle.1 425 2003-01-30 15:49:23Z bears $ 2 .\" $Id: noffle.1 426 2003-01-31 15:34:47Z bears $
3 .SH NAME 3 .SH NAME
4 noffle \- Usenet package optimized for dialup connections. 4 noffle \- Usenet package optimized for dialup connections.
5 5
6 .SH SYNOPSIS 6 .SH SYNOPSIS
7 7
115 .PP 115 .PP
116 Note that 116 Note that
117 .B NOFFLE 117 .B NOFFLE
118 cannot exchange the contents of local groups with other news servers. 118 cannot exchange the contents of local groups with other news servers.
119 119
120 .PP
121 Many
122 .B NOFFLE
123 options are only available to news administrators. News administrators are
124 users who are either
125 .IR root ,
126 the NOFFLE news user (typically
127 .IR news ),
128 or in the NOFFLE news group (typically group
129 .IR news ).
130
120 .SH OPTIONS 131 .SH OPTIONS
121 132
122 .TP 133 .TP
123 .B \-a, \-\-article <message id>|all 134 .B \-a, \-\-article <message id>|all
124 Write article <message id> to standard output. Message Id must contain 135 Write article <message id> to standard output. Message Id must contain
131 .B \-c, \-\-cancel <message id> 142 .B \-c, \-\-cancel <message id>
132 Cancel the article from the database and remove it from the queue of 143 Cancel the article from the database and remove it from the queue of
133 outbound messages if it has not already been sent. Message Id must 144 outbound messages if it has not already been sent. Message Id must
134 contain the leading '<' and trailing '>' (quote the argument to avoid 145 contain the leading '<' and trailing '>' (quote the argument to avoid
135 shell interpretation of '<' and '>'). 146 shell interpretation of '<' and '>').
147 .br
148 This option is only available to news administrators.
136 149
137 .TP 150 .TP
138 .B \-C, \-\-create <local newsgroup name> 151 .B \-C, \-\-create <local newsgroup name>
139 Create a new local newsgroup with the given name. The name should 152 Create a new local newsgroup with the given name. The name should
140 conform to the usual newsgroup naming rules to avoid confusing 153 conform to the usual newsgroup naming rules to avoid confusing
141 newsreaders. 154 newsreaders.
155 .br
156 This option is only available to news administrators.
142 157
143 .TP 158 .TP
144 .B \-d, \-\-database 159 .B \-d, \-\-database
145 Write the complete content of the article database to standard output. 160 Write the complete content of the article database to standard output.
146 161
147 .TP 162 .TP
148 .B \-D, \-\-delete <newsgroup name> 163 .B \-D, \-\-delete <newsgroup name>
149 Delete the newsgroup with the given name. All articles that only 164 Delete the newsgroup with the given name. All articles that only
150 belong to the group are deleted as well. 165 belong to the group are deleted as well.
166 .br
167 This option is only available to news administrators.
151 168
152 .TP 169 .TP
153 .B \-e, \-\-expire 170 .B \-e, \-\-expire
154 Delete all articles that have not been accessed recently from the 171 Delete all articles that have not been accessed recently from the
155 database. 172 database.
158 .br 175 .br
159 The default expire period is 14 days. This can be changed and 176 The default expire period is 14 days. This can be changed and
160 custom expiry periods set for individual newsgroups or sets of 177 custom expiry periods set for individual newsgroups or sets of
161 newsgroups in 178 newsgroups in
162 .B /etc/noffle.conf. 179 .B /etc/noffle.conf.
180 .br
181 This option is only available to news administrators.
163 182
164 .TP 183 .TP
165 .B \-f, \-\-fetch [server pattern] 184 .B \-f, \-\-fetch [server pattern]
166 Get new newsfeed from the remote servers. 185 Get new newsfeed from the remote servers.
167 Updates the list of the existing newsgroups, 186 Updates the list of the existing newsgroups,
184 .B noffle.conf (5) 203 .B noffle.conf (5)
185 for careful seeting of the settings 204 for careful seeting of the settings
186 .B getgroups 205 .B getgroups
187 and 206 and
188 .B omitgroups. 207 .B omitgroups.
189 208 .br
209 This option is only available to news administrators.
210
190 .TP 211 .TP
191 .B \-g, \-\-groups 212 .B \-g, \-\-groups
192 List all groups available at remote server. 213 List all groups available at remote server.
193 .br 214 .br
194 Format (fields separated by tabs): 215 Format (fields separated by tabs):
206 Format: <groupname> <server> full|thread|over 227 Format: <groupname> <server> full|thread|over
207 228
208 .TP 229 .TP
209 .B \-m | \-\-modify desc <newsgroup name> <group description> 230 .B \-m | \-\-modify desc <newsgroup name> <group description>
210 Modify the description of the named newsgroup. 231 Modify the description of the named newsgroup.
232 .br
233 This option is only available to news administrators.
211 234
212 .TP 235 .TP
213 .B \-m | \-\-modify post <local newsgroup name> <permission> 236 .B \-m | \-\-modify post <local newsgroup name> <permission>
214 Modify the posting permission on a local newsgroup. <permission> must 237 Modify the posting permission on a local newsgroup. <permission> must
215 be either 'y' (yes, posting allowed), 'm' (moderated, posting allowed 238 be either 'y' (yes, posting allowed), 'm' (moderated, posting allowed
216 only if article has 'Approved:' header) or 'n' (no, posting not allowed). 239 only if article has 'Approved:' header) or 'n' (no, posting not allowed).
217 Attempts to post to a newsgroup with posting disallowed will be rejected. 240 Attempts to post to a newsgroup with posting disallowed will be rejected.
241 .br
242 This option is only available to news administrators.
218 243
219 .TP 244 .TP
220 .B \-n, \-\-online 245 .B \-n, \-\-online
221 Put 246 Put
222 .B NOFFLE 247 .B NOFFLE
227 subscribing to them. 252 subscribing to them.
228 Should be run in the 253 Should be run in the
229 .B ip-up 254 .B ip-up
230 script of 255 script of
231 .BR pppd (8). 256 .BR pppd (8).
257 .br
258 This option is only available to news administrators.
232 259
233 .TP 260 .TP
234 .B \-o, \-\-offline 261 .B \-o, \-\-offline
235 Put 262 Put
236 .B NOFFLE 263 .B NOFFLE
238 database are marked for download. 265 database are marked for download.
239 Should be run in the 266 Should be run in the
240 .B ip-down 267 .B ip-down
241 script of 268 script of
242 .BR pppd (8). 269 .BR pppd (8).
270 .br
271 This option is only available to news administrators.
243 272
244 .TP 273 .TP
245 .B \-O | \-\-outgoing [server pattern] 274 .B \-O | \-\-outgoing [server pattern]
246 List message IDs and destination server of articles queued for 275 List message IDs and destination server of articles queued for
247 posting. 276 posting.
277 .br
278 This option is only available to news administrators.
248 279
249 .TP 280 .TP
250 .B \-p, \-\-post 281 .B \-p, \-\-post
251 Read a news article from standard input and post it. 282 Read a news article from standard input and post it.
252 Posting always observes the group post permission flag. 283 Posting always observes the group post permission flag.
268 .B desc 299 .B desc
269 retrieves all newsgroup descriptions. If a 300 retrieves all newsgroup descriptions. If a
270 .B server 301 .B server
271 .B pattern 302 .B pattern
272 is specified, only matching servers from noffle.conf will be queried. 303 is specified, only matching servers from noffle.conf will be queried.
304 .br
305 This option is only available to news administrators.
273 306
274 .TP 307 .TP
275 .B \-r, \-\-server 308 .B \-r, \-\-server
276 Run as NNTP server on standard input and standard output. This is 309 Run as NNTP server on standard input and standard output. This is
277 intended to be called by 310 intended to be called by
284 .B /var/log/news. 317 .B /var/log/news.
285 A list of the NNTP commands that are understood by 318 A list of the NNTP commands that are understood by
286 .B noffle 319 .B noffle
287 can be retrieved by running the server and typing 320 can be retrieved by running the server and typing
288 .B HELP. 321 .B HELP.
322 .br
323 This option is only available to news administrators.
289 324
290 .TP 325 .TP
291 .B \-B, \-\-rebuild 326 .B \-B, \-\-rebuild
292 Rebuild the article database. This build a fresh copy of the 327 Rebuild the article database. This build a fresh copy of the
293 .B NOFFLE 328 .B NOFFLE
294 article database. All locally held groups are scanned, and all articles 329 article database. All locally held groups are scanned, and all articles
295 currently active in those groups are copied from the old article 330 currently active in those groups are copied from the old article
296 database to the new one. The new one then replaces the old one. 331 database to the new one. The new one then replaces the old one.
297 This can be useful in cases of article database corruption. 332 This can be useful in cases of article database corruption.
333 .br
334 This option is only available to news administrators.
298 335
299 .TP 336 .TP
300 .B \-R, \-\-requested 337 .B \-R, \-\-requested
301 List articles that are marked for download. 338 List articles that are marked for download.
302 339
304 341
305 .TP 342 .TP
306 .B \-s, \-\-subscribe-over <group> 343 .B \-s, \-\-subscribe-over <group>
307 Add group with name <group> to list of groups that are presently to be fetched 344 Add group with name <group> to list of groups that are presently to be fetched
308 (in over mode). 345 (in over mode).
346 .br
347 This option is only available to news administrators.
309 348
310 .TP 349 .TP
311 .B \-S, \-\-subscribe-full <group> 350 .B \-S, \-\-subscribe-full <group>
312 Add group with name <group> to list of groups that are presently to be fetched 351 Add group with name <group> to list of groups that are presently to be fetched
313 (in full mode). 352 (in full mode).
353 .br
354 This option is only available to news administrators.
314 355
315 .TP 356 .TP
316 .B \-t, \-\-subscribe-thread <group> 357 .B \-t, \-\-subscribe-thread <group>
317 Add group with name <group> to list of groups that are presently to be fetched 358 Add group with name <group> to list of groups that are presently to be fetched
318 (in thread mode). 359 (in thread mode).
360 .br
361 This option is only available to news administrators.
319 362
320 .TP 363 .TP
321 .B \-u, \-\-unsubscribe <group> 364 .B \-u, \-\-unsubscribe <group>
322 Remove group with name <group> from list of groups that are presently to 365 Remove group with name <group> from list of groups that are presently to
323 be fetched. 366 be fetched.
367 .br
368 This option is only available to news administrators.
369
370 .TP
371 .B \-v, \-\-version
372 Reports the
373 .B NOFFLE
374 version number.
324 375
325 .SH NOTES 376 .SH NOTES
326 377
327 If the 378 If the
328 .I noffle 379 .I noffle