Update 'trunk/ripnews/README.md'

This commit is contained in:
ward 2020-03-11 06:17:59 +00:00
parent 22b88262d0
commit 64eaf7c89f

View file

@ -1,6 +1,4 @@
# $Dwarf: README,v 1.20 2005/03/01 09:18:25 ward Exp $
# $Source$
# Ripnews
Ripnews is a bulk downloader for usenet. It's quite flexible in terms of
configuration. Some of it's features are:
@ -9,13 +7,12 @@ configuration. Some of it's features are:
- newsrc file support (one newsrc file per server)
- flexible but simple configuration
Configuration:
==============
## Configuration:
I'll just give a commented example config, it should be pretty clear,
after that I'll list the possible options.
<== cut here ==>
```
# Set the default NNTPSERVER to localhost
NNTPSERVER=localhost
# If you need authentication
@ -97,11 +94,11 @@ alt.binaries.sounds.mp3.classical {
beethoven \
)
}
<== cut here ==>
```
Supported commandline options:
------------------------------
## Commandline options:
```
"-I", "--include" Set include pattern.
"-c", "--configfile" Specify a different config file. Default
.ripnewsrc
@ -116,10 +113,11 @@ Supported commandline options:
"-T", "--test" Set test mode. Newsrc files will not be writen
to.
"-X", "--exclude" Set exclude pattern.
```
Supported config options:
-------------------------
# Supported config options:
```
OPT_I=<pattern> Set include pattern.
OPT_IF=<patter> Set include from pattern. Filters on poster.
OPT_L=<bool> Set long filenames.
@ -166,9 +164,9 @@ OPT_SD=<pattern> Set DELEXT just for single part messages.
INCLUDEFILE=<file> Include another file, only works in main config.
PRIMARYTHRES=<int> At least this percentage of the post has to be found
on the first server.
```
Ruby patterns:
--------------
## Ruby patterns:
Ruby patterns are a lot like perl patterns, but there are some
differences. (?i) is the modifier to turn on case insensitivity, unlike
@ -184,31 +182,30 @@ empty string. This can have the result that you exclude everything if
you use it with OPT_X, or include everything with OPT_I. You have been
warned.
Other features:
===============
## Other features:
You can make a running ripnews process reread it's configuration by
sending it a SIGHUP.
Where can I find newsservers:
=============================
## Where can I find newsservers:
freenews.maxbaud.net
www.newzbot.com
www.gj.net/~bhkraft
Known bugs:
===========
## Known bugs:
There are no known bugs at this moment. If you find any, please let me
know. As with all my software, if it breaks you get to keep _both_
pieces.
Credits:
========
## Credits:
- Stijn Hoop for adding yEnc support
Contact info:
=============
## Contact info:
New problems can be reported directly to me at <ward@wouts.nl>. Patches
welcome ;)