5cba939acae2875460a73312fcbb72ada4459f5e
[usenet/yapfaq.git] / yapfaq.pl
1 #! /usr/bin/perl -W
2 #
3 # yapfaq Version 0.8.1 by Thomas Hochstein
4 # (Original author: Marc Brockschmidt)
5 #
6 # This script posts any project described in its config-file. Most people
7 # will use it in combination with cron(8).
8
9 # Copyright (C) 2003 Marc Brockschmidt <marc@marcbrockschmidt.de>
10 # Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
11 #
12 # It can be redistributed and/or modified under the same terms under 
13 # which Perl itself is published.
14
15 our $VERSION = "0.9-prelease";
16
17 # Please do not change this setting!
18 # You may override the default .rc file (.yapfaqrc) by using "-c .rc file"
19 my $RCFile = '.yapfaqrc';
20 # Valid configuration variables for use in a .rc file
21 my @ValidConfVars = ('NNTPServer','NNTPUser','NNTPPass','Sender','ConfigFile','Program');
22
23 ################################### Defaults ###################################
24 # Please do not change anything in here!
25 # Use a runtime configuration file (.yapfaqrc by default) to override defaults.
26 my %Config = (NNTPServer => "",
27               NNTPUser   => "",
28               NNTPPass   => "",
29               Sender     => "",
30               ConfigFile => "yapfaq.cfg",
31               Program    => "");
32
33 ################################# Main program #################################
34
35 use strict;
36 use Net::NNTP;
37 use Net::Domain qw(hostfqdn);
38 use Date::Calc qw(Add_Delta_YM Add_Delta_Days Delta_Days Today);
39 use Fcntl ':flock'; # import LOCK_* constants
40 use Getopt::Std;
41 $Getopt::Std::STANDARD_HELP_VERSION = 1;
42 my ($TDY, $TDM, $TDD) = Today(); #TD: Today's date
43
44 # read commandline options
45 my %Options;
46 getopts('Vhvpdt:f:c:s:', \%Options);
47 # -V: print version / copyright information
48 if ($Options{'V'}) {
49   print "$0 v $VERSION\nCopyright (c) 2003 Marc Brockschmidt <marc\@marcbrockschmidt.de>\nCopyright (c) 2010 Thomas Hochstein <thh\@inter.net>\n";
50   print "This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.\n";
51   exit(0);
52 }
53 # -h: feed myself to perldoc
54 if ($Options{'h'}) {
55   exec ('perldoc', $0);
56   exit(0);
57 };
58 # -f: set $Faq
59 my ($Faq) = $Options{'f'} if ($Options{'f'});
60
61 # read runtime configuration (configuration variables)
62 $RCFile = $Options{'c'} if ($Options{'c'});
63 if (-f $RCFile) {
64   readrc (\$RCFile,\%Config);
65 } else {
66   warn "$0: W: .rc file $RCFile does not exist!\n";
67 }
68
69 $Options{'s'} = $Config{'Program'} if (defined($Config{'Program'}) && $Config{'Program'} && !defined($Options{'s'}));
70
71 # read configuration (configured FAQs)
72 my @Config;
73 readconfig (\$Config{'ConfigFile'}, \@Config, \$Faq);
74
75 # for each FAQ:
76 # - parse configuration
77 # - read status data
78 # - if FAQ is due: call postfaq()
79 foreach (@Config) { 
80   my ($LPD,$LPM,$LPY) = (01, 01, 0001);  #LP: Last posting-date
81   my ($NPY,$NPM,$NPD);                   #NP: Next posting-date
82   my $SupersedeMID;
83   
84   my ($ActName,$File,$PFreq,$Expire) =($$_{'name'},$$_{'file'},$$_{'posting-frequency'},$$_{'expires'});
85   my ($From,$Subject,$NG,$Fup2)=($$_{'from'},$$_{'subject'},$$_{'ngs'},$$_{'fup2'});
86   my ($MIDF,$ReplyTo,$ExtHea)=($$_{'mid-format'},$$_{'reply-to'},$$_{'extraheader'});
87   my ($Supersede)            =($$_{'supersede'});
88
89   # -f: loop if not FAQ to post
90   next if (defined($Faq) && $ActName ne $Faq);
91         
92   # read status data
93   if (open (FH, "<$File.cfg")) {
94     while(<FH>){
95       if (/##;; Lastpost:\s*(\d{1,2})\.(\d{1,2})\.(\d{2}(\d{2})?)/){
96         ($LPD, $LPM, $LPY) = ($1, $2, $3);
97       } elsif (/^##;;\s*LastMID:\s*(<\S+@\S+>)\s*$/) {
98         $SupersedeMID = $1;
99       }
100     }
101     close FH;
102   } else { 
103     warn "$0: W: Couldn't open $File.cfg: $!\n";
104   }
105
106   $SupersedeMID = "" unless $Supersede;
107
108   ($NPY,$NPM,$NPD) = calcdelta ($LPY,$LPM,$LPD,$PFreq);
109
110   # if FAQ is due: get it out
111   if (Delta_Days($NPY,$NPM,$NPD,$TDY,$TDM,$TDD) >= 0 or ($Options{'p'})) {
112     if($Options{'d'}) {
113           print "$ActName: Would be posted now (but running in simulation mode [$0 -d]).\n" if $Options{'v'};
114         } else {
115       postfaq(\$ActName,\$File,\$From,\$Subject,\$NG,\$Fup2,\$MIDF,\$ExtHea,\$Config{'Sender'},\$TDY,\$TDM,\$TDD,\$ReplyTo,\$SupersedeMID,\$Expire);
116         }
117   } elsif($Options{'v'}) {
118     print "$ActName: Nothing to do.\n";
119   }
120 }
121
122 exit;
123
124 #################################### readrc ####################################
125 # Takes a filename and the reference to an array which contains the valid options
126
127 sub readrc{
128   my ($File, $Config) = @_;
129
130   print "Reading $$File.\n" if($Options{'v'});
131
132   open FH, "<$$File" or die "$0: Can't open $$File: $!";
133   while (<FH>) {
134     if (/^\s*(\S+)\s*=\s*'?(.*?)'?\s*(#.*$|$)/) {
135       if (grep(/$1/,@ValidConfVars)) {
136         $$Config{$1} = $2 if $2 ne '';
137       } else {
138         warn "$0: W: $1 is not a valid configuration variable (reading from $$File)\n";
139       }
140     }
141   }
142 }
143
144 ################################## readconfig ##################################
145 # Takes a filename, a reference to an array, which will hold hashes with
146 # the data from $File, and - optionally - the name of the (single) FAQ to post
147
148 sub readconfig{
149   my ($File, $Config, $Faq) = @_;
150   my ($LastEntry, $Error, $i) = ('','',0);
151
152   print "Reading configuration from $$File.\n" if($Options{'v'});
153
154   open FH, "<$$File" or die "$0: E: Can't open $$File: $!";
155   while (<FH>) {
156     next if (defined($$Faq) && !/^\s*=====\s*$/ && defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} ne $$Faq );
157     if (/^(\s*(\S+)\s*=\s*'?(.*?)'?\s*(#.*$|$)|^(.*?)'?\s*(#.*$|$))/ && not /^\s*$/) {
158       $LastEntry = lc($2) if $2;
159       $$Config[$i]{$LastEntry} .= $3 if $3;  
160       $$Config[$i]{$LastEntry} .= "\n$5" if $5 && $5;
161     } 
162     if (/^\s*=====\s*$/) {
163       $i++;
164     }
165   }
166   close FH;
167
168   #Check saved values:
169   for $i (0..$i){
170     next if (defined($$Faq) && defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} ne $$Faq );
171     unless(defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} =~ /^\S+$/) {
172       $Error .= "E: The name of your project \"$$Config[$i]{'name'}\" is not defined or contains whitespaces.\n"
173     }
174     unless(defined($$Config[$i]{'file'}) && -f $$Config[$i]{'file'}) {
175       $Error .= "E: The file to post for your project \"$$Config[$i]{'name'}\" is not defined or does not exist.\n"
176     }
177     unless(defined($$Config[$i]{'from'}) && $$Config[$i]{'from'} =~ /\S+\@(\S+\.)?\S{2,}\.\S{2,}/) {
178       $Error .= "E: The From header for your project \"$$Config[$i]{'name'}\" seems to be incorrect.\n"
179     }
180     unless(defined($$Config[$i]{'ngs'}) && $$Config[$i]{'ngs'} =~ /^\S+$/) {
181       $Error .= "E: The Newsgroups header for your project \"$$Config[$i]{'name'}\" is not defined or contains whitespaces.\n"
182     }
183     unless(defined($$Config[$i]{'subject'})) {
184       $Error .= "E: The Subject header for your project \"$$Config[$i]{'name'}\" is not defined.\n"
185     }
186     unless(!$$Config[$i]{'fup2'} || $$Config[$i]{'fup2'} =~ /^\S+$/) {
187       $Error .= "E: The Followup-To header for your project \"$$Config[$i]{'name'}\" contains whitespaces.\n"
188     }
189     unless(defined($$Config[$i]{'posting-frequency'}) && $$Config[$i]{'posting-frequency'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
190       $Error .= "E: The Posting-frequency for your project \"$$Config[$i]{'name'}\" is invalid.\n"
191     }
192     unless(!$$Config[$i]{'expires'} || $$Config[$i]{'expires'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
193       warn "$0: W: The Expires for your project \"$$Config[$i]{'name'}\" is invalid - set to 3 month.\n";
194       $$Config[$i]{'expires'} = '3m'; # set default (3 month) if expires is unset or invalid
195     }
196     unless(!$$Config[$i]{'mid-format'} || $$Config[$i]{'mid-format'} =~ /^<\S+\@(\S+\.)?\S{2,}\.\S{2,}>/) {
197       warn "$0: W: The Message-ID format for your project \"$$Config[$i]{'name'}\" seems to be invalid - set to default.\n";
198       $$Config[$i]{'mid-format'} = '<%n-%d.%m.%y@'.hostfqdn.'>'; # set default if mid-format is invalid
199     }
200   }
201   $Error .= "-" x 25 . 'program terminated' . "-" x 25 . "\n" if $Error;
202   die $Error if $Error;
203 }
204
205 ################################# calcdelta #################################
206 # Takes a date (year,  month and day) and a time period (1d, 1w, 1m, 1y, ...)
207 # and adds the latter to the former
208
209 sub calcdelta {
210   my ($Year, $Month, $Day, $Period) = @_;
211   my ($NYear, $NMonth, $NDay);
212
213   if ($Period =~ /(\d+)\s*([dw])/) { # Is counted in days or weeks: Use Add_Delta_Days.
214     ($NYear, $NMonth, $NDay) = Add_Delta_Days($Year, $Month, $Day, (($2 eq "w")?$1 * 7: $1 * 1));
215   } elsif ($Period =~ /(\d+)\s*([my])/) { #Is counted in months or years: Use Add_Delta_YM
216     ($NYear, $NMonth, $NDay) = Add_Delta_YM($Year, $Month, $Day, (($2 eq "m")?(0,$1):($1,0)));
217   }
218   return ($NYear, $NMonth, $NDay);
219 }
220
221 ################################ updatestatus ###############################
222 # Takes a MID and a status file name
223 # and writes status information to disk
224
225 sub updatestatus {
226   my ($ActName, $File, $date, $MID) = @_;
227   
228   print "$$ActName: Save status information.\n" if($Options{'v'});
229
230   open (FH, ">$$File.cfg") or die "$0: E: Can't open $$File.cfg: $!";
231   print FH "##;; Lastpost: $date\n";
232   print FH "##;; LastMID: $MID\n";
233   close FH;
234 }
235   
236 ################################## postfaq ##################################
237 # Takes a filename and many other vars.
238 #
239 # It reads the data-file $File and then posts the article.
240
241 sub postfaq {
242   my ($ActName,$File,$From,$Subject,$NG,$Fup2,$MIDF,$ExtraHeaders,$Sender,$TDY,$TDM,$TDD,$ReplyTo,$Supersedes,$Expire) = @_;
243   my (@Header,@Body,$MID,$InRealBody,$LastModified);
244
245   print "$$ActName: Preparing to post.\n" if($Options{'v'});
246   
247   #Prepare MID:
248   $$TDM = ($$TDM < 10 && $$TDM !~ /^0/) ? "0" . $$TDM : $$TDM;
249   $$TDD = ($$TDD < 10 && $$TDD !~ /^0/) ? "0" . $$TDD : $$TDD;
250   my $Timestamp = time;
251
252   $MID = $$MIDF;
253   $MID = '<%n-%d.%m.%y@'.hostfqdn.'>' if !defined($MID); # set to default if unset
254   $MID =~ s/\%n/$$ActName/g;
255   $MID =~ s/\%d/$$TDD/g;
256   $MID =~ s/\%m/$$TDM/g;
257   $MID =~ s/\%y/$$TDY/g;
258   $MID =~ s/\%t/$Timestamp/g;
259
260   #Now get the body:
261   open (FH, "<$$File");
262   while (<FH>){  
263     s/\r//;
264     push (@Body, $_), next if $InRealBody;
265     $InRealBody++ if /^$/;
266     $LastModified = $1 if /^Last-modified:\s*(\S+)\s*$/i;
267     push @Body, $_;
268   }
269   close FH;
270   push @Body, "\n" if ($Body[-1] ne "\n");
271
272   #Create Date- and Expires-Header:
273   my @time = localtime;
274   my $ss =  ($time[0]<10) ? "0" . $time[0] : $time[0];
275   my $mm =  ($time[1]<10) ? "0" . $time[1] : $time[1];
276   my $hh =  ($time[2]<10) ? "0" . $time[2] : $time[2];
277   my $day = $time[3];
278   my $month = ($time[4]+1<10) ? "0" . ($time[4]+1) : $time[4]+1;
279   my $monthN = ("Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec")[$time[4]];
280   my $wday = ("Sun","Mon","Tue","Wed","Thu","Fri","Sat")[$time[6]];
281   my $year = (1900 + $time[5]);
282   my $tz = $time[8] ? " +0200" : " +0100";
283
284   $$Expire = '3m' if !$$Expire; # set default if unset: 3 month
285
286   my ($expY,$expM,$expD) = calcdelta ($year,$month,$day,$$Expire);
287   my $expmonthN = ("Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec")[$expM-1];
288
289   my $date = "$day $monthN $year " . $hh . ":" . $mm . ":" . $ss . $tz;
290   my $expdate = "$expD $expmonthN $expY $hh:$mm:$ss$tz";
291  
292   #Replace %LM by the content of the news.answer-pseudo-header Last-modified:
293   if ($LastModified) {
294     $$Subject =~ s/\%LM/$LastModified/;
295   } else {
296     $$Subject =~ s/[<\[{\(]?\%LM[>\]}\)]?//;
297   }
298
299   # Test mode?
300   if($Options{'t'} and $Options{'t'} !~ /console/i) {
301     $$NG = $Options{'t'};
302   }
303
304   #Now create the complete Header:
305   push @Header, "From: $$From\n";
306   push @Header, "Newsgroups: $$NG\n";
307   push @Header, "Followup-To: $$Fup2\n" if $$Fup2;
308   push @Header, "Subject: $$Subject\n";
309   push @Header, "Message-ID: $MID\n";
310   push @Header, "Supersedes: $$Supersedes\n" if $$Supersedes;
311   push @Header, "Date: $date\n";
312   push @Header, "Expires: $expdate\n";
313   push @Header, "Sender: $$Sender\n" if $$Sender;
314   push @Header, "Mime-Version: 1.0\n";
315   push @Header, "Reply-To: $$ReplyTo\n" if $$ReplyTo;
316   push @Header, "Content-Type: text/plain; charset=ISO-8859-15\n";
317   push @Header, "Content-Transfer-Encoding: 8bit\n";
318   push @Header, "User-Agent: yapfaq/$VERSION\n";
319   if ($$ExtraHeaders) {
320     push @Header, "$_\n" for (split /\n/, $$ExtraHeaders);
321   }
322
323   my @Article = (@Header, "\n", @Body);
324
325   # post article
326   print "$$ActName: Posting article ...\n" if($Options{'v'});
327   my $failure = post(\@Article);
328   
329   if ($failure) {
330     print "$$ActName: Posting failed, ERROR.dat may have more information.\n" if($Options{'v'} && (!defined($Options{'t'}) || $Options{'t'} !~ /console/i));
331   } else {
332     updatestatus($ActName, $File, "$day.$month.$year", $MID) if !defined($Options{'t'});
333   }
334 }
335
336 ################################## post ##################################
337 # Takes a complete article (Header and Body).
338 #
339 # It opens a connection to $NNTPServer and posts the message.
340
341 sub post {
342   my ($ArticleR) = @_;
343   my ($failure) = -1;
344
345   # test mode - print article to console
346   if(defined($Options{'t'}) and $Options{'t'} =~ /console/i) {
347     print "-----BEGIN--------------------------------------------------\n";
348     print @$ArticleR;
349     print "------END---------------------------------------------------\n";
350   # pipe article to script
351   } elsif(defined($Options{'s'})) {
352     open (POST, "| $Options{'s'}") or die "$0: E: Cannot fork $Options{'s'}: $!\n";
353     print POST @$ArticleR;
354     close POST;
355     if ($? == 0) {
356       $failure = 0;
357     } else {
358       warn "$0: W: $Options{'s'} exited with status ", ($? >> 8), "\n";
359       $failure = $?;
360     }
361   # post article
362   } else {
363     my $NewsConnection = Net::NNTP->new($Config{'NNTPServer'}, Reader => 1) or die "$0: E: Can't connect to news server '$Config{'NNTPServer'}'!\n";
364     $NewsConnection->authinfo ($Config{'NNTPUser'}, $Config{'NNTPPass'}) if (defined($Config{'NNTPUser'}));
365     $NewsConnection->post();
366     $NewsConnection->datasend (@$ArticleR);
367     $NewsConnection->dataend();
368
369     if ($NewsConnection->ok()) {
370       $failure = 0;
371     # Posting failed? Save to ERROR.dat
372     } else {
373           warn "$0: W: Posting failed!\n";
374       open FH, ">>ERROR.dat";
375       print FH "\nPosting failed! Saving to ERROR.dat. Response from news server:\n";
376       print FH $NewsConnection->code();
377       print FH $NewsConnection->message();
378       print FH "\n";
379       print FH @$ArticleR;
380       print FH "-" x 80, "\n";
381       close FH;
382     }
383     $NewsConnection->quit();
384   }
385   return $failure;
386 }
387
388 __END__
389
390 ################################ Documentation #################################
391
392 =head1 NAME
393
394 yapfaq - Post Usenet FAQs I<(yet another postfaq)>
395
396 =head1 SYNOPSIS
397
398 B<yapfaq> [B<-Vhvpd>] [B<-t> I<newsgroups> | CONSOLE] [B<-f> I<project name>] [B<-s> I<program>] [B<-c> I<.rc file>]
399
400 =head1 REQUIREMENTS
401
402 =over 2
403
404 =item -
405
406 Perl 5.8 or later
407
408 =item -
409
410 Net::NNTP
411
412 =item -
413
414 Date::Calc
415
416 =item -
417
418 Getopt::Std
419
420 =back
421
422 Furthermore you need access to a news server to actually post FAQs.
423
424 =head1 DESCRIPTION
425
426 B<yapfaq> posts (one or more) FAQs to Usenet with a certain posting
427 frequency (every n days, weeks, months or years), adding all necessary
428 headers as defined in its config file (by default F<yapfaq.cfg>).
429
430 =head2 Configuration
431
432 F<yapfaq.cfg> consists of one or more blocks, separated by C<=====> on
433 a single line, each containing the configuration for one FAQ as a set
434 of definitions in the form of I<param = value>. Everything after a "#"
435 sign is ignored so you may comment your configuration file.
436
437 =over 4
438
439 =item B<Name> = I<project name>
440
441 A name referring to your FAQ, also used for generation of a Message-ID.
442
443 This value must be set.
444
445 =item B<File> = I<file name>
446
447 A file containing the message body of your FAQ and all pseudo headers
448 (subheaders in the news.answers style).
449
450 This value must be set.
451
452 =item B<Posting-frequency> = I<time period>
453
454 The posting frequency defines how often your FAQ will be posted.
455 B<yapfaq> will only post your FAQ if this period of time has passed
456 since the last posting.
457
458 You can declare that time period either in I<B<d>ays> or I<B<w>weeks>
459 or I<B<m>onths> or I<B<y>ears>.
460
461 This value must be set.
462
463 =item B<Expires> = I<time period> (optional)
464
465 The period of time after which your message will expire. An Expires
466 header will be calculated adding this time period to today's date.
467
468 You can declare this  time period either in I<B<d>ays> or I<B<w>weeks>
469 or I<B<m>onths> or I<B<y>ears>.
470
471 This setting is optional; the default is 3 months.
472
473 =item B<From> = I<author>
474
475 The author of your FAQ as it will appear in the From header of the
476 message.
477
478 This value must be set.
479
480 =item B<Subject> = I<subject>
481
482 The title of your FAQ as it will appear in the Subject header of the
483 message.
484
485 You may use the special string C<%LM> which will be replaced with
486 the contents of the Last-Modified subheader in your I<File>.
487
488 This value must be set.
489
490 =item B<NGs> = I<newsgroups>
491
492 A comma-separated list of newsgroup(s) to post your FAQ to as it will
493 appear in the Newsgroups header of the message.
494
495 This value must be set.
496
497 =item B<Fup2> = I<newsgroup | poster>  (optional)
498
499 A comma-separated list of newsgroup(s) or the special string I<poster>
500 as it will appear in the Followup-To header of the message.
501
502 This setting is optional.
503
504 =item B<MID-Format> = I<pattern>  (optional)
505
506 A pattern from which the message ID is generated as it will appear in
507 the Message-ID header of the message.
508
509 You may use the special strings C<%n> for the I<Name> of your project,
510 C<%d> for the date the message is posted, C<%m> for the month, C<%y>
511 for the year and C<%t> for a time stamp (number of seconds since the
512 epoch), respectively.
513
514 This setting is optional; the default is '<%n-%d.%m.%y@I<YOURHOST>>'
515 where I<YOURHOST> is the fully qualified domain name (FQDN) of the
516 host B<yapfaq> is running on. Obviously that will only work if you
517 have defined a reasonable hostname that the hostfqdn() function of
518 Net::Domain can return.
519
520 =item B<Supersede> = I<yes>  (optional)
521
522 Add Supersedes header to the message containing the Message-ID header
523 of the last posting.
524
525 This setting is optional; you should set it to yes or leave it out.
526
527 =item B<ExtraHeader> = I<additional headers>  (optional)
528
529 The contents of I<ExtraHeader> is added verbatim to the headers of
530 your message so you can add custom headers like Approved.
531
532 This setting is optional.
533
534 =back
535
536 =head3 Example configuration file
537
538     # name of your project
539     Name = 'testpost'
540     
541     # file to post (complete body and pseudo-headers)
542     # ($File.cfg contains data on last posting and last MID)
543     File = 'test.txt'
544     
545     # how often your project should be posted
546     # use (d)ay OR (w)eek OR (m)onth OR (y)ear
547     Posting-frequency = '1d'
548     
549     # time period after which the posting should expire
550     # use (d)ay OR (w)eek OR (m)onth OR (y)ear
551     # Expires = '3m'
552     
553     # header "From:"
554     From = 'test@domain.invalid'
555     
556     # header "Subject:"
557     # (may contain "%LM" which will be replaced by the contents of the
558     #  Last-Modified pseudo header).
559     Subject = 'test noreply ignore'
560     
561     # comma-separated list of newsgroup(s) to post to
562     # (header "Newsgroups:")
563     NGs = 'de.test'
564     
565     # header "Followup-To:"
566     # Fup2 = 'poster'
567     
568     # Message-ID ("%n" is $Name)
569     # MID-Format = '<%n-%d.%m.%y@domain.invalid>'
570     
571     # Supersede last posting?
572     Supersede = yes
573     
574     # extra headers (appended verbatim)
575     # use this for custom headers like "Approved:"
576     ExtraHeader = 'Approved: moderator@domain.invalid
577     X-Header: Some text'
578     
579     # other projects may follow separated with "====="
580     =====
581     
582     Name = 'othertest'
583     File = 'test.txt'
584     Posting-frequency = '2m'
585     From = 'My Name <my.name@domain.invalid>'
586     Subject = 'Test of yapfag <%LM>'
587     NGs = 'de.test,de.alt.test'
588     Fup2 = 'de.test'
589     MID-Format = '<%n-%m.%y@domain.invalid>'
590     Supersede = yes
591
592 =head3 Status Information
593
594 Information about the last post and about how to form message IDs for
595 posts is stored in a file named F<I<project name>.cfg> which will be
596 generated if it does not exist. Each of those status files will
597 contain two lines, the first being the date of the last time the FAQ
598 was posted and the second being the message ID of that incarnation.
599
600 =head2 Runtime Configuration
601
602 Apart from configuring which FAQ(s) to post you may (re)set some
603 runtime configuration variables via the .rcfile (by default
604 F<.yapfaqrc>). F<.yapfaqrc> must contain one definition in the form of
605 I<param = value> on each line; everything after a "#" sign is ignored.
606
607 If you omit some settings they will be set to default values hardcoded
608 in F<yapfaq.pl>.
609
610 B<Please note that all parameter names are case-sensitive!>
611
612 =over 4
613
614 =item B<NNTPServer> = I<NNTP server> (mandatory)
615
616 Host name of the NNTP server to post to. Must be set (or omitted; the
617 default is "localhost"); if set to en empty string, B<yapfaq> falls
618 back to Perl's build-in defaults (contents of environment variables
619 NNTPSERVER and NEWSHOST; if not set, default from Net::Config; if not
620 set, "news" is used).
621
622 =item B<NNTPUser> = I<user name> (optional)
623
624 User name used for authentication with the NNTP server (I<AUTHINFO
625 USER>).
626
627 This setting is optional; if it is not set, I<NNTPPass> is ignored and
628 no authentication is tried.
629
630 =item B<NNTPPass> = I<password> (optional)
631
632 Password used for authentication with the NNTP server (I<AUTHINFO
633 PASS>).
634
635 This setting is optional; it must be set if I<NNTPUser> is present.
636
637 =item B<Sender> = I<Sender header> (optional)
638
639 The Sender header that will be added to every posted message.
640
641 This setting is optional.
642
643 =item B<ConfigFile> = I<configuration file> (mandatory)
644
645 The configuration file defining the FAQ(s) to post. Must be set (or
646 omitted; the default is "yapfaq.cfg").
647
648 =item B<Program> = I<file name> (optional)
649
650 A program the article is piped to instead of posting it to Usenet.
651 See option "-f" below (which takes preference).
652
653 This setting is optional.
654
655 =back
656
657 =head3 Example runtime configuration file
658
659     NNTPServer = 'localhost'
660     NNTPUser   = ''
661     NNTPPass   = ''
662     Sender     = ''
663     ConfigFile = 'yapfaq.cfg'
664     Program    = ''
665
666 =head3 Using more than one runtime configuration
667
668 You may use more than one runtime configuration file with the B<-c>
669 option (see below).
670
671 =head1 OPTIONS
672
673 =over 3
674
675 =item B<-V> (version)
676
677 Print out version and copyright information on B<yapfaq> and exit.
678
679 =item B<-h> (help)
680
681 Print this man page and exit.
682
683 =item B<-v> (verbose)
684
685 Print out status information while running to STDOUT.
686
687 =item B<-p> (post unconditionally)
688
689 Post (all) FAQs unconditionally ignoring the posting frequency setting.
690
691 You may want to use this with the B<-f> option (see below).
692
693 =item B<-d> (dry run)
694
695 Start B<yapfaq> in simulation mode, i.e. don't post anything and don't
696 update any status information.
697
698 =item B<-t> I<newsgroup(s) | CONSOLE> (test)
699
700 Don't post to the newsgroups defined in F<yqpfaq.cfg>, but to the
701 newsgroups given after B<-t> as a comma-separated list or print the
702 FAQs to STDOUT separated by lines of dashes if the special string
703 C<CONSOLE> is given.  This can be used to preview what B<yapfaq> would
704 do without embarassing yourself on Usenet.  The status files are not
705 updated when this option is given.
706
707 You may want to use this with the B<-f> option (see below).
708
709 =item B<-f> I<project name>
710
711 Just deal with one FAQ only.
712
713 By default B<yapfaq> will work on all FAQs that are defined in
714 F<yapfaq.cfg>, check whether they are due for posting and - if they
715 are - post them. Consequently when the B<-p> option is set all FAQs
716 will be posted unconditionally. That may not be what you want to
717 achieve, so you can limit the operation of B<yapfaq> to the named FAQ
718 only.
719
720 =item B<-s> I<program> (pipe to script)
721
722 Instead of posting the article(s) to Usenet pipe them to the external
723 I<program> on STDIN (which may post the article(s) then). A return
724 value of 0 will be considered success.
725
726 For example, you may want to use the I<inews> utility from the INN package
727 or the much more powerful replacement I<tinews.pl> from
728 I<ftp://ftp.tin.org/tin/tools/tinews.pl> which is able to sign postings.
729
730 If I<Program> is also defined in the runtime configuration file (by default
731 F<.yapfaqrc>), B<-s> takes preference.
732
733 =item B<-c> I<.rc file>
734
735 Load another runtime configuration file (.rc file) than F<.yaofaq.rc>.
736
737 You may for example define another usenet server to post your FAQ(s)
738 to or load another configuration file defining (an)other FAQ(s).
739
740 =back
741
742 =head1 EXAMPLES
743
744 Post all FAQs that are due for posting:
745
746     yapfaq
747
748 Do a dry run, showing which FAQs would be posted:
749
750     yapfaq -dv
751
752 Do a test run and print on STDOUT what the FAQ I<myfaq> would look
753 like when posted, regardless whether it is due for posting or not:
754
755     yapfaq -pt CONSOLE -f myfaq
756
757 Do a "real" test run and post the FAQ I<myfaq> to I<de.test>, but only
758 if it is due:
759
760     yapfaq -t de.test -f myfaq
761
762 Post all FAQs (that are due for posting) using inews from INN:
763
764     yapfaq -s inews
765
766 Do a dry run using a runtime configuration from .alternaterc, showing
767 which FAQs would be posted:
768
769     yapfaq -dvc .alternaterc
770
771 =head1 ENVIRONMENT
772
773 =over 4
774
775 =item NNTPSERVER
776
777 The default NNTP server to post to, used by the Net::NNTP module. You
778 can also  specify the server using the runtime configuration file (by
779 default F<.yapfaqrc>).
780
781 =back
782
783 =head1 FILES
784
785 =over 4
786
787 =item F<yapfaq.pl>
788
789 The script itself.
790
791 =item F<.yapfaqrc>
792
793 Runtime configuration file for B<yapfaq>.
794
795 =item F<yapfaq.cfg>
796
797 Configuration file for B<yapfaq>.
798
799 =item F<*.cfg>
800
801 Status data on FAQs.
802
803 The status files will be created on successful posting if they don't
804 already exist. The first line of the file will be the date of the last
805 time the FAQ was posted and the second line will be the message ID of
806 the last post of that FAQ.
807
808 =back
809
810 =head1 BUGS
811
812 Please report any bugs or feature request to the author or use the
813 bug tracker at L<http://bugs.th-h.de/>!
814
815 =head1 SEE ALSO
816
817 L<http://th-h.de/download/scripts.php> will have the current
818 version of this program.
819
820 This program is maintained using the Git version control system. You
821 may clone L<git://code.th-h.de/usenet/yapfaq.git> to check out the
822 current development tree or browse it on the web via
823 L<http://code.th-h.de/?p=usenet/yapfaq.git>.
824
825 =head1 AUTHOR
826
827 Thomas Hochstein <thh@inter.net>
828
829 Original author (up to version 0.5b, dating from 2003):
830 Marc Brockschmidt <marc@marcbrockschmidt.de>
831
832 =head1 COPYRIGHT AND LICENSE
833
834 Copyright (c) 2003 Marc Brockschmidt <marc@marcbrockschmidt.de>
835
836 Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
837
838 This program is free software; you may redistribute it and/or modify it
839 under the same terms as Perl itself.
840
841 =cut
This page took 0.030556 seconds and 2 git commands to generate.