Mercurial > noffle
annotate noffle.1 @ 14:97ef217c3d89 noffle
[svn] Prepare for version 1.0pre5
| author | enz |
|---|---|
| date | Tue, 18 Apr 2000 07:11:50 +0100 |
| parents | 0838ae9606b2 |
| children | 84bfdb5600b2 |
| rev | line source |
|---|---|
| 0 | 1 |
| 2 .TH noffle 1 | |
|
3
0838ae9606b2
[svn] Documented default value for thread-follow-time option.
enz
parents:
0
diff
changeset
|
3 .\" $Id: noffle.1 8 2000-01-06 09:32:21Z enz $ |
| 0 | 4 .SH NAME |
| 5 noffle \- Usenet package optimized for dialup connections. | |
| 6 | |
| 7 .SH SYNOPSIS | |
| 8 | |
| 9 .B noffle | |
| 10 \-a | \-\-article <message id>|all | |
| 11 .br | |
| 12 .B noffle | |
| 13 \-d | \-\-database | |
| 14 .br | |
| 15 .B noffle | |
| 16 \-e | \-\-expire <days> | |
| 17 .br | |
| 18 .B noffle | |
| 19 \-f | \-\-fetch | |
| 20 .br | |
| 21 .B noffle | |
| 22 \-g | \-\-groups | |
| 23 .br | |
| 24 .B noffle | |
| 25 \-h | \-\-help | |
| 26 .br | |
| 27 .B noffle | |
| 28 \-l | \-\-list | |
| 29 .br | |
| 30 .B noffle | |
| 31 \-n | \-\-online | |
| 32 .br | |
| 33 .B noffle | |
| 34 \-o | \-\-offline | |
| 35 .br | |
| 36 .B noffle | |
| 37 \-q | \-\-query groups|desc|times | |
| 38 .br | |
| 39 .B noffle | |
| 40 \-R | \-\-requested | |
| 41 .br | |
| 42 .B noffle | |
| 43 \-r | \-\-server | |
| 44 .br | |
| 45 .B noffle | |
| 46 \-s | \-\-subscribe-over <group> | |
| 47 .br | |
| 48 .B noffle | |
| 49 \-S | \-\-subscribe-full <group> | |
| 50 .br | |
| 51 .B noffle | |
| 52 \-t | \-\-subscribe-thread <group> | |
| 53 .br | |
| 54 .B noffle | |
| 55 \-u | \-\-unsubscribe <group> | |
| 56 | |
| 57 .SH DESCRIPTION | |
| 58 | |
| 59 .B NOFFLE | |
| 60 is an Usenet package optimized for low speed dialup Internet connections | |
| 61 and few users. | |
| 62 The | |
| 63 .B noffle | |
| 64 program is used for running and steering of the proxy news server, | |
| 65 for retrieving new articles from the remote server and for | |
| 66 expiring old articles from the database. | |
| 67 .B NOFFLE | |
| 68 can fetch newsgroups in one of the following modes: | |
| 69 .TP | |
| 70 .B full | |
| 71 fetch full articles, | |
| 72 .TP | |
| 73 .B over | |
| 74 fetch only article overviews by default. Opening an article marks it | |
| 75 for download next time online, | |
| 76 .TP | |
| 77 .B thread | |
| 78 like | |
| 79 .B over, | |
| 80 but download articles full if an article of the same thread already has | |
| 81 been downloaded. | |
| 82 | |
| 83 .SH OPTIONS | |
| 84 | |
| 85 .TP | |
| 86 .B \-a, \-\-article <message id>|all | |
| 87 Write article <message id> to standard output. Message Id must contain | |
| 88 the leading '<' and trailing '>' (quote the argument to avoid shell | |
| 89 interpretation of '<' and '>'). | |
| 90 .br | |
| 91 If "all" is given as message Id, all articles are shown. | |
| 92 | |
| 93 .TP | |
| 94 .B \-d, \-\-database | |
| 95 Write the complete content of the article database to standard output. | |
| 96 | |
| 97 .TP | |
| 98 .B \-e, \-\-expire <days> | |
| 99 Delete all articles older than <days> days from the database. | |
| 100 Should be run regularily from | |
| 101 .BR crond (8). | |
| 102 | |
| 103 .TP | |
| 104 .B \-f, \-\-fetch | |
| 105 Get new newsfeed from the remote server. | |
| 106 Updates the list of the existing newsgroups, | |
| 107 fetches new articles overviews or full articles from subscribed | |
| 108 groups (see | |
| 109 .B fetchlist | |
| 110 ), | |
| 111 delivers all posted articles to the remote server, | |
| 112 and retrieves all articles marked for download. | |
| 113 .B noffle --fetch | |
| 114 should be run in the | |
| 115 .B ip-up | |
| 116 script of | |
| 117 .BR pppd (8). | |
| 118 | |
| 119 .TP | |
| 120 .B \-g, \-\-groups | |
| 121 List all groups available at remote server. | |
| 122 .br | |
| 123 Format (fields separated by tabs): | |
| 124 .br | |
| 125 <name> <server> <first> <last> <remote next> <created> <last access> <desc> | |
| 126 | |
| 127 .TP | |
| 128 .B \-h, \-\-help | |
| 129 Print a list of all options. | |
| 130 | |
| 131 .TP | |
| 132 .B \-l, \-\-list | |
| 133 List all groups that are presently to be fetched and their fetch mode. | |
| 134 .br | |
| 135 Format: <groupname> <server> full|thread|over | |
| 136 | |
| 137 .TP | |
| 138 .B \-n, \-\-online | |
| 139 Put | |
| 140 .B NOFFLE | |
| 141 to online status. Requested articles or overviews of selected | |
| 142 groups are immediately fetched from the remote server. | |
| 143 Should be run in the | |
| 144 .B ip-up | |
| 145 script of | |
| 146 .BR pppd (8). | |
| 147 | |
| 148 .TP | |
| 149 .B \-o, \-\-offline | |
| 150 Put | |
| 151 .B NOFFLE | |
| 152 to offline status. Requested articles not already in the | |
| 153 database are marked for download. | |
| 154 Should be run in the | |
| 155 .B ip-down | |
| 156 script of | |
| 157 .BR pppd (8). | |
| 158 | |
| 159 .TP | |
| 160 .B \-q, \-\-query groups|desc|times | |
| 161 Query information about all groups from the remote server and merge it to | |
| 162 the | |
| 163 .B groupinfo | |
| 164 file. This must be run after installing | |
| 165 .B noffle | |
| 166 or sometimes after a change of the remote news server or corruption | |
| 167 of the file. It can take some time on slow connections. | |
| 168 .B groups | |
| 169 retrieves the list of the existing newsgroups | |
| 170 (resets all local article counters), | |
| 171 .B desc | |
| 172 retrieves all newsgroup descriptions, | |
| 173 .B times | |
| 174 retrieves the creation times of the newsgroups. | |
| 175 | |
| 176 .TP | |
| 177 .B \-r, \-\-server | |
| 178 Run as NNTP server on standard input and standard output. This is | |
| 179 intended to be called by | |
| 180 .BR inetd (8) | |
| 181 and should be registered in | |
| 182 .B /etc/inetd.conf. | |
| 183 Error and logging messages are put to the | |
| 184 .BR syslogd (8) | |
| 185 daemon which is usually configured to write them to | |
| 186 .B /var/log/news. | |
| 187 A list of the NNTP commands that are understood by | |
| 188 .B noffle | |
| 189 can be retrieved by running the server and typing | |
| 190 .B HELP. | |
| 191 | |
| 192 .TP | |
| 193 .B \-R, \-\-requested | |
| 194 List articles that are marked for download. | |
| 195 | |
| 196 Format: <message-id> <server> | |
| 197 | |
| 198 .TP | |
| 199 .B \-s, \-\-subscribe-over <group> | |
| 200 Add group with name <group> to list of groups that are presently to be fetched | |
| 201 (in over mode). | |
| 202 | |
| 203 .TP | |
| 204 .B \-S, \-\-subscribe-full <group> | |
| 205 Add group with name <group> to list of groups that are presently to be fetched | |
| 206 (in full mode). | |
| 207 | |
| 208 .TP | |
| 209 .B \-t, \-\-subscribe-thread <group> | |
| 210 Add group with name <group> to list of groups that are presently to be fetched | |
| 211 (in thread mode). | |
| 212 | |
| 213 .TP | |
| 214 .B \-u, \-\-unsubscribe <group> | |
| 215 Remove group with name <group> from list of groups that are presently to | |
| 216 be fetched. | |
| 217 | |
| 218 .SH FILES | |
| 219 | |
| 220 There exists a spool directory (default | |
| 221 .I /var/spool/news), | |
| 222 and a config file (default | |
| 223 .I /etc/noffle.conf). | |
| 224 | |
| 225 .PP | |
| 226 | |
| 227 .TP | |
| 228 .B <config file> | |
| 229 Configuration file. Comment lines begin with | |
| 230 .I #. | |
| 231 Definition lines may contain: | |
| 232 .br | |
| 233 .B server <hostname>[:<port>] [<user> <pass>] | |
| 234 Name of the remote server. If no port given, port 119 is used. | |
| 235 Username and password for servers that need authentication | |
| 236 (Original AUTHINFO). The password may not contain white-spaces. | |
| 237 If there are multiple server entries in the config file, all of them are | |
| 238 used for getting groups. In this case the first server should be | |
| 239 the one of your main provider. Note that you must always run | |
| 240 "noffle --query groups" after making changes to the server entries. | |
| 241 .br | |
| 242 .B max-fetch <n> | |
| 243 Never get more than <n> articles. If there are more, the oldest ones | |
| 244 are discarded. | |
| 245 .br | |
| 246 Default: 300 | |
| 247 .br | |
| 248 .B mail-to <address> | |
| 249 Receiver of failed postings. If empty then failed postings are returned | |
| 250 to the sender (taking the address from the article's Sender, X-Sender or | |
| 251 From field, in this order). | |
| 252 .br | |
| 253 Default: <empty string> | |
| 254 .br | |
| 255 .B auto-unsubscribe yes|no | |
| 256 Automatically remove groups from fetch list if they have not been | |
| 257 accessed for a number days. | |
| 258 .br | |
| 259 Default: no | |
| 260 .br | |
| 261 .B auto-unsubscribe-days <n> | |
| 262 Number of days used for auto-unsubscribe option. | |
| 263 .br | |
| 264 Default: 30 | |
| 265 .br | |
| 266 .B thread-follow-time <n> | |
| 267 Automatically mark articles for download in thread mode, if they | |
| 268 are referencing an article that has been opened by a reader within the last | |
| 269 <n> days. | |
| 270 .br | |
|
3
0838ae9606b2
[svn] Documented default value for thread-follow-time option.
enz
parents:
0
diff
changeset
|
271 Default: 7 |
|
0838ae9606b2
[svn] Documented default value for thread-follow-time option.
enz
parents:
0
diff
changeset
|
272 .br |
| 0 | 273 .B connect-timeout <n> |
| 274 Timeout for connecting to remote server in seconds. | |
| 275 .br | |
| 276 Default: 30 | |
| 277 .br | |
| 278 .B auto-subscribe yes|no | |
| 279 Automatically put groups on fetch list if someone reads them. | |
| 280 <mode> can be full, over, thread (depending on the fetch mode) or | |
| 281 off (do not subscribe automatically). Condition for putting a group | |
| 282 on the list is that an article is opened. For this reason there is | |
| 283 always a pseudo article visible in groups that are not on the fetch list. | |
| 284 .br | |
| 285 Default: no | |
| 286 .br | |
| 287 .B auto-subscribe-mode full|thread|over | |
| 288 Mode for auto-subscribe option. | |
| 289 .br | |
| 290 Default: over | |
| 291 .br | |
| 292 .B remove-messageid yes|no | |
| 293 Remove Message-ID from posted articles. Some remote servers can generate | |
| 294 Message-IDs. | |
| 295 .br | |
| 296 Default: no | |
| 297 .br | |
| 298 .B replace-messageid yes|no | |
| 299 Replace Message-ID of posted articles by a Message-ID generated by | |
| 300 NOFFLE. Some news readers generate Message-IDs that are not accepted by | |
| 301 some servers. For generating Message-IDs, the domain name of your system should | |
| 302 be a valid domain name. If you are in a local domain, set it to your | |
| 303 provider's domain name. | |
| 304 .br | |
| 305 Default: yes | |
| 306 .br | |
| 307 | |
| 308 .TP | |
| 309 .B <spool dir>/fetchlist | |
| 310 List of newsgroups that are presently to be fetched. | |
| 311 .br | |
| 312 | |
| 313 .TP | |
| 314 .B <spool dir>/data/groupinfo.gdbm | |
| 315 Database with groups in | |
| 316 .BR gdbm(3) | |
| 317 format. | |
| 318 | |
| 319 .TP | |
| 320 .B <spool dir>/data/articles.gdbm | |
| 321 Database with articles in | |
| 322 .BR gdbm(3) | |
| 323 format. | |
| 324 | |
| 325 .TP | |
| 326 .B <spool dir>/lock/ | |
| 327 Lock files and files indicating online/offline status. | |
| 328 | |
| 329 .TP | |
| 330 .B <spool dir>/outgoing/ | |
| 331 Posted articles to be delivered to the remote server. | |
| 332 | |
| 333 .TP | |
| 334 .B <spool dir>/overview/ | |
| 335 Text file per group with article overviews. | |
| 336 | |
| 337 .TP | |
| 338 .B <spool dir>/requested/ | |
| 339 Message IDs of articles marked for download. | |
| 340 | |
| 341 | |
| 342 .SH SEE ALSO | |
| 343 | |
| 344 .BR crond (8) | |
| 345 .BR inetd (8), | |
| 346 .BR pppd (8), | |
| 347 .br | |
| 348 .B RFC 977, | |
| 349 .B RFC 1036, | |
| 350 .br | |
| 351 .B IETF drafts on common NNTP extensions: | |
| 352 .br | |
| 353 .B http://www.karlsruhe.org/ | |
| 354 .br | |
| 355 .B NOFFLE home page: | |
| 356 .br | |
| 357 .B http://home.t-online.de/home/markus.enzenberger/noffle.html | |
| 358 | |
| 359 .SH AUTHORS | |
| 360 | |
| 361 Markus Enzenberger <markus.enzenberger@t-online.de> | |
| 362 .br | |
| 363 Volker Wysk <volker.wysk@student.uni-tuebingen.de> | |
| 364 | |
| 365 1998-1999. |