Mercurial > noffle
diff docs/noffle.conf.5 @ 42:2467ff423c15 noffle
[svn] * AUTHORS.html, CHANGELOG.html, COPYING.html, README.html, FAQ.html,
NOTES.html, INSTALL.html: Removed files.
* AUTHORS, COPYING, ChangeLog, README, INSTALL, NEWS, docs/FAQ, docs/NOTES:
Added files.
* TODO.TXT: Renamed to TODO. Slightly changed formatting.
* README: Reformatted the file. Added info about CVS. Added a pointer to
the file INSTALL.
* noffle.1, noffle.conf.5: Moved to docs/
* LSM.TXT: Moved to docs/noffle.lsm. Small fix.
* INSTALL: Adapted to autoconf build-system. A few minor fixes.
author | uh1763 |
---|---|
date | Fri, 05 May 2000 21:26:14 +0100 |
parents | |
children | 32ba1198c6fa |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/noffle.conf.5 Fri May 05 21:26:14 2000 +0100 @@ -0,0 +1,200 @@ +.TH noffle.conf 5 +.\" $Id: noffle.conf.5 48 2000-05-05 20:26:14Z uh1763 $ +.SH NAME +noffle.conf \- Configuration file for NOFFLE news server + +.SH DESCRIPTION + +The +.B NOFFLE +news server - see +.BR noffle (1) +- takes its configuration from a configuration file. +By default this file is \fI/etc/noffle.conf\fP. + +.PP +.B noffle.conf +is a normal text file containing +.B NOFFLE +settings, one per line. + +.PP +Leading whitespace on a line is ignored, as is any comment +text. Comment text begins with a '#' character and continues to the +end of the line. Blank lines are permitted. + +.SH SETTINGS + +.TP +.B server <hostname>[:<port>] [<user> <pass>] +Name of the remote server. If no port given, port 119 is used. +Username and password for servers that need authentication +(Original AUTHINFO). The password may not contain white-spaces. +If there are multiple server entries in the config file, all of them are +used for getting groups. In this case the first server should be +the one of your main provider. Note that you must always +run 'noffle --query groups' +after making changes to the server entries. + +.TP +.B max-fetch <n> +Never get more than <n> articles. If there are more, the oldest ones +are discarded. +.br +Default: 300 + +.TP +.B mail-to <address> +Receiver of failed postings. If empty then failed postings are returned +to the sender (taking the address from the article's Sender, X-Sender or +From field, in this order). +.br +Default: <empty string> + +.TP +.B auto-unsubscribe yes|no +Automatically remove groups from fetch list if they have not been +accessed for a number days. +.br +Default: no + +.TP +.B auto-unsubscribe-days <n> +Number of days used for auto-unsubscribe option. +.br +Default: 30 + +.TP +.B thread-follow-time <n> +Automatically mark articles for download in thread mode, if they +are referencing an article that has been opened by a reader within the last +<n> days. +.br +Default: 7 + +.TP +.B connect-timeout <n> +Timeout for connecting to remote server in seconds. +.br +Default: 30 + +.TP +.B auto-subscribe yes|no +Automatically put groups on fetch list if someone reads them. +<mode> can be full, over, thread (depending on the fetch mode) or +off (do not subscribe automatically). Condition for putting a group +on the list is that an article is opened. For this reason there is +always a pseudo article visible in groups that are not on the fetch list. +.br +Default: no + +.TP +.B auto-subscribe-mode full|thread|over +Mode for auto-subscribe option. +.br +Default: over + +.TP +.B remove-messageid yes|no +Remove Message-ID from posted articles. Some remote servers can generate +Message-IDs. +.br +Default: no + +.TP +.B replace-messageid yes|no +Replace Message-ID of posted articles by a Message-ID generated by +NOFFLE. Some news readers generate Message-IDs that are not accepted by +some servers. For generating Message-IDs, the domain name of your system should +be a valid domain name. If you are in a local domain, set it to your +provider's domain name. +.br +Default: yes + +.TP +.B default-expire <n> +The default expiry period, in days. An expiry period of 0 means "never". +.br +Default: 14 + +.TP +.B expire <group pattern> <n> +The expiry period for a newsgroup or set of newsgroups, in days. The +expiry pattern can contain \fIwildcards\fP, and there can be multiple +.B expire +lines. When checking the expiry period for a group, the expiry +patterns are checked in the order in which they appear in +.I /etc/noffle.conf +until the first match occurs. If no pattern matches the group name, the +.B default expiry period +is used. An expiry period of 0 means "never". +.br +Default: no + +.SH "GROUP NAME WILDCARDS" + +.B NOFFLE +uses a wildcard format that closely matches filename-style wildcards. +\fIalt.binaries.*\fP, for example, matches all newsgroups under the +.I alt.binaries +hierarchy. A full description of the fomat (known as +.B wildmat +patterns) is as follows. + +.TP +.BI \e x +Turns off the special meaning of +.I x +and matches it directly; this is used mostly before a question mark or +asterisk, and is not special inside square brackets. +.TP +.B ? +Matches any single character. +.TP +.B * +Matches any sequence of zero or more characters. +.TP +.BI [ x...y ] +Matches any single character specified by the set +.IR x...y . +A minus sign may be used to indicate a range of characters. +That is, +.I [0\-5abc] +is a shorthand for +.IR [012345abc] . +More than one range may appear inside a character set; +.I [0-9a-zA-Z._] +matches almost all of the legal characters for a host name. +The close bracket, +.IR ] , +may be used if it is the first character in the set. +The minus sign, +.IR \- , +may be used if it is either the first or last character in the set. +.TP +.BI [^ x...y ] +This matches any character +.I not +in the set +.IR x...y , +which is interpreted as described above. +For example, +.I [^]\-] +matches any character other than a close bracket or minus sign. + + +.SH SEE ALSO + +.BR noffle (1) + +.SH AUTHORS + +Markus Enzenberger <markus.enzenberger@t-online.de> +.br +Volker Wysk <volker.wysk@student.uni-tuebingen.de> +.br +Jim Hague <jim.hague@acm.org> +.br +1998-2000. + +