| 1 | Automatic Article Checker\r |
| 2 | v1.6 Copyright (C) June 2, 1999 by Heinrich Schramm\r |
| 3 | mailto:heinrich@schramm.com\r |
| 4 | \r |
| 5 | converted to perl by Wilfried Klaebe <wk@orion.toppoint.de>\r |
| 6 | (not really converted, more or less rewritten in perl)\r |
| 7 | \r |
| 8 | modified & enhanced (more or less rewritten ;-))\r |
| 9 | by Thomas Hochstein <THochstein@gmx.de> since March/April 2000\r |
| 10 | (c) artchk.pl (mod.) January 06, 2001 by Thomas Hochstein\r |
| 11 | \r |
| 12 | Version: 1.2.01 BETA\r |
| 13 | \r |
| 14 | _________ ATTENTION please! - This is a BETA version! _________\r |
| 15 | \r |
| 16 | ---------------------------------------------------------------------------\r |
| 17 | This program is free software; you can redistribute it and/or modify it\r |
| 18 | under the terms of the GNU General Public License as published by the Free\r |
| 19 | Software Foundation; either version 2 of the License, or (at your option)\r |
| 20 | any later version.\r |
| 21 | This program is distributed in the hope that it will be useful, but\r |
| 22 | WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r |
| 23 | or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\r |
| 24 | for more details.\r |
| 25 | ---------------------------------------------------------------------------\r |
| 26 | \r |
| 27 | (1) REQUIREMENTS\r |
| 28 | \r |
| 29 | * Perl 5.x\r |
| 30 | * the "News::NNTPClient"-module from CPAN.\r |
| 31 | * the "MIME::QuotedPrint"-module from CPAN.\r |
| 32 | * the "MIME::Base64"-module from CPAN.\r |
| 33 | * the "Net::DNS"-module from CPAN.\r |
| 34 | * a (local) NNTP-server\r |
| 35 | \r |
| 36 | (2) INSTALLATION\r |
| 37 | \r |
| 38 | * Install\r |
| 39 | - artchk.pl # main program\r |
| 40 | \r |
| 41 | and\r |
| 42 | \r |
| 43 | - sample.ini # .ini-file: server, port, user/password, groups, counter\r |
| 44 | - sample.rc # .rc-file: customize headers / body of followups\r |
| 45 | - domains # valid TLDs for MID-FQDNs\r |
| 46 | \r |
| 47 | to the same directory.\r |
| 48 | \r |
| 49 | The last three files must reside in the same directory as the first, or\r |
| 50 | you have to specify the path to them when invoking artchk.pl\r |
| 51 | \r |
| 52 | You may specify different .ini-/.rc-files when invoking artchk.pl\r |
| 53 | \r |
| 54 | * Modify "sample.ini" to fit your needs and rename it to "artchk.pl.ini"\r |
| 55 | (default) or anything you like.\r |
| 56 | \r |
| 57 | The .ini-file has to contain\r |
| 58 | - parameters\r |
| 59 | - the special word "checkgroups:" including the colon\r |
| 60 | - a list of groups to check\r |
| 61 | \r |
| 62 | The parameters are written one on a line, "parametername = parameter".\r |
| 63 | Allowed parameters are:\r |
| 64 | - reader : the newsserver (and port) you read the postings from,\r |
| 65 | "server.name,port"\r |
| 66 | This entry is necessary; you can drop the port.\r |
| 67 | Default for port is 119.\r |
| 68 | - reader_user : your username for authorization\r |
| 69 | Default: (none) ---> no authorization\r |
| 70 | - reader_pass : your password for authorization\r |
| 71 | - poster : the newsserver (and port) you post to,\r |
| 72 | "server.name,port"\r |
| 73 | Default: [none] ---> post to the server you read from\r |
| 74 | You can drop the port. Default for port is 119.\r |
| 75 | - reader_user : your username for authorization\r |
| 76 | Default: [none] ---> no authorization\r |
| 77 | - reader_pass : your password for authorization\r |
| 78 | - trigger_check : a regular expression for the string that initiates\r |
| 79 | a check when found in "Subject:".\r |
| 80 | Default: check\r |
| 81 | You should change "[header]" in the .rc-file accordingly!\r |
| 82 | - trigger_ignore: a regular expression for the string that stops a check\r |
| 83 | in auto-mode (see below) when found in "Subject:" or\r |
| 84 | first line of body.\r |
| 85 | Default: (ignore)|(no[ ]*repl(y|(ies)))\r |
| 86 | You should change "[header-auto]" in the .rc-file accordingly!\r |
| 87 | - rcfile : the name of your .rc-file\r |
| 88 | Default: [name of .ini-file]\r |
| 89 | - killfile : the name of your .kill-file\r |
| 90 | Default: [name of .ini-file]\r |
| 91 | \r |
| 92 | You can place comment lines in between; they may NOT contain a "=".\r |
| 93 | \r |
| 94 | The list of groups is in the following format:\r |
| 95 | - the name of a group to check\r |
| 96 | - a single space and a "y" or "n" to enable/disable auto-mode. Set it\r |
| 97 | to "n" - artchk will only post followups to postings with\r |
| 98 | trigger_check in the subject (but if trigger_check is\r |
| 99 | found, it _will_ post a followup, even if trigger_ignore is\r |
| 100 | also found)\r |
| 101 | to "y" - auto-mode; artchk will also post followups if it found\r |
| 102 | something to correct as long as trigger_ignore is _not_\r |
| 103 | found in the subject or the first line of the body and no\r |
| 104 | killfile-expresion matches\r |
| 105 | \r |
| 106 | You may NOT place anything else after the magic word "checkgroups:".\r |
| 107 | \r |
| 108 | - Example:\r |
| 109 | reader = server.pro.vider,119\r |
| 110 | reader_user = user\r |
| 111 | reader_pass = pass\r |
| 112 | ---> We do not have another posting server.\r |
| 113 | checkgroups:\r |
| 114 | de.test y\r |
| 115 | de.alt.test n\r |
| 116 | \r |
| 117 | * Modify "sample.rc" to fit your needs and rename it to "artchk.pl.rc"\r |
| 118 | (default) or anything you like.\r |
| 119 | \r |
| 120 | - [head]-Section:\r |
| 121 | Edit at least the "From:" header configuration.\r |
| 122 | Edit or delete the "Sender:" header.\r |
| 123 | Edit or delete the "Path:" header.\r |
| 124 | Edit or delete the "Reply-To:" header.\r |
| 125 | Add any other headers you like,\r |
| 126 | e.g. "X-Checkbot-Owner: My Name <my.name@do.main.invalid>"\r |
| 127 | Do _NOT_ insert a "Newsgroups:" header!\r |
| 128 | Do _NOT_ insert "Subject:", "Message-ID:", "References:" or "X-Artchk-Version:"!\r |
| 129 | \r |
| 130 | - Edit the [header]-/[header-auto]- and/or [footer] text section if\r |
| 131 | you like. You should do that if you have changed the trigger_check/\r |
| 132 | trigger_ignore-settings!\r |
| 133 | \r |
| 134 | - Later on, you can edit the other sections as you like. Please be\r |
| 135 | sure to have a look at the source code in this case to understand\r |
| 136 | how these sections are used.\r |
| 137 | \r |
| 138 | - Later on, you may add sections with special tips for certain\r |
| 139 | newsclients. Those sections will be printed out immediately after\r |
| 140 | the standard-reply. They have the form of [standard-nr] with nr being\r |
| 141 | one of\r |
| 142 | \r |
| 143 | oe (Outlook Express, all versions)\r |
| 144 | moz (Mozilla, all versions)\r |
| 145 |