Initial commit.

[usenet/artchk.git] / readme.txt

                    Automatic Article Checker\r
    v1.6  Copyright (C) June 2, 1999  by Heinrich Schramm\r
                  mailto:heinrich@schramm.com\r
\r
converted to perl by Wilfried Klaebe <wk@orion.toppoint.de>\r
  (not really converted, more or less rewritten in perl)\r
\r
modified & enhanced (more or less rewritten ;-))\r
  by Thomas Hochstein <THochstein@gmx.de> since March/April 2000\r
(c) artchk.pl (mod.) January 06, 2001 by Thomas Hochstein\r
\r
Version: 1.2.01 BETA\r
\r
_________ ATTENTION please! - This is a BETA version! _________\r
\r
---------------------------------------------------------------------------\r
This program is free software; you can redistribute it and/or modify it\r
under the terms of the GNU General Public License as published by the Free\r
Software Foundation; either version 2 of the License, or (at your option)\r
any later version.\r
This program is distributed in the hope that it will be useful, but\r
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\r
for more details.\r
---------------------------------------------------------------------------\r
\r
(1) REQUIREMENTS\r
\r
* Perl 5.x\r
* the "News::NNTPClient"-module from CPAN.\r
* the "MIME::QuotedPrint"-module from CPAN.\r
* the "MIME::Base64"-module from CPAN.\r
* the "Net::DNS"-module from CPAN.\r
* a (local) NNTP-server\r
\r
(2) INSTALLATION\r
\r
* Install\r
    - artchk.pl     # main program\r
\r
  and\r
\r
    - sample.ini    # .ini-file: server, port, user/password, groups, counter\r
    - sample.rc     # .rc-file: customize headers / body of followups\r
    - domains       # valid TLDs for MID-FQDNs\r
\r
  to the same directory.\r
\r
  The last three files must reside in the same directory as the first, or\r
  you have to specify the path to them when invoking artchk.pl\r
\r
  You may specify different .ini-/.rc-files when invoking artchk.pl\r
\r
* Modify "sample.ini" to fit your needs and rename it to "artchk.pl.ini"\r
  (default) or anything you like.\r
\r
  The .ini-file has to contain\r
  - parameters\r
  - the special word "checkgroups:" including the colon\r
  - a list of groups to check\r
\r
  The parameters are written one on a line, "parametername = parameter".\r
  Allowed parameters are:\r
  - reader        : the newsserver (and port) you read the postings from,\r
                    "server.name,port"\r
                    This entry is necessary; you can drop the port.\r
                    Default for port is 119.\r
  - reader_user   : your username for authorization\r
                    Default: (none) ---> no authorization\r
  - reader_pass   : your password for authorization\r
  - poster        : the newsserver (and port) you post to,\r
                    "server.name,port"\r
                    Default: [none] ---> post to the server you read from\r
                    You can drop the port. Default for port is 119.\r
  - reader_user   : your username for authorization\r
                    Default: [none] ---> no authorization\r
  - reader_pass   : your password for authorization\r
  - trigger_check : a regular expression for the string that initiates\r
                    a check when found in "Subject:".\r
                    Default: check\r
                    You should change "[header]" in the .rc-file accordingly!\r
  - trigger_ignore: a regular expression for the string that stops a check\r
                    in auto-mode (see below) when found in "Subject:" or\r
                    first line of body.\r
                    Default: (ignore)|(no[ ]*repl(y|(ies)))\r
                    You should change "[header-auto]" in the .rc-file accordingly!\r
  - rcfile        : the name of your .rc-file\r
                    Default: [name of .ini-file]\r
  - killfile      : the name of your .kill-file\r
                    Default: [name of .ini-file]\r
\r
  You can place comment lines in between; they may NOT contain a "=".\r
\r
  The list of groups is in the following format:\r
  - the name of a group to check\r
  - a single space and a "y" or "n" to enable/disable auto-mode. Set it\r
    to "n" - artchk will only post followups to postings with\r
             trigger_check in the subject (but if trigger_check is\r
             found, it _will_ post a followup, even if trigger_ignore is\r
             also found)\r
    to "y" - auto-mode; artchk will also post followups if it found\r
             something to correct as long as trigger_ignore is _not_\r
             found in the subject or the first line of the body and no\r
	     killfile-expresion matches\r
\r
  You may NOT place anything else after the magic word "checkgroups:".\r
\r
  - Example:\r
       reader        = server.pro.vider,119\r
       reader_user   = user\r
       reader_pass   = pass\r
       ---> We do not have another posting server.\r
       checkgroups:\r
       de.test y\r
       de.alt.test n\r
\r
* Modify "sample.rc" to fit your needs and rename it to "artchk.pl.rc"\r
  (default) or anything you like.\r
\r
    - [head]-Section:\r
      Edit at least the "From:" header configuration.\r
      Edit or delete the "Sender:" header.\r
      Edit or delete the "Path:" header.\r
      Edit or delete the "Reply-To:" header.\r
      Add any other headers you like,\r
      e.g. "X-Checkbot-Owner: My Name <my.name@do.main.invalid>"\r
      Do _NOT_ insert a "Newsgroups:" header!\r
      Do _NOT_ insert "Subject:", "Message-ID:", "References:" or "X-Artchk-Version:"!\r
\r
    - Edit the [header]-/[header-auto]- and/or [footer] text section if\r
      you like. You should do that if you have changed the trigger_check/\r
      trigger_ignore-settings!\r
\r
    - Later on, you can edit the other sections as you like. Please be\r
      sure to have a look at the source code in this case to understand\r
      how these sections are used.\r
\r
    - Later on, you may add sections with special tips for certain\r
      newsclients. Those sections will be printed out immediately after\r
      the standard-reply. They have the form of [standard-nr] with nr being\r
      one of\r
\r
         oe (Outlook Express, all versions)\r
         moz (Mozilla, all versions)\r