3 # yapfaq Version 0.6 by Thomas Hochstein
4 # (Original author: Marc Brockschmidt)
6 # This script posts any project described in its config-file. Most people
7 # will use it in combination with cron(8).
9 # Copyright (C) 2003 Marc Brockschmidt <marc@marcbrockschmidt.de>
10 # Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
12 # It can be redistributed and/or modified under the same terms under
13 # which Perl itself is published.
15 my $Version = "0.6.2";
17 my $RCFile = '.yapfaqrc';
18 my @ValidConfVars = ('NNTPServer','NNTPUser','NNTPPass','Sender','ConfigFile',
19 'UsePGP','pgp','PGPVersion','PGPSigner','PGPPass',
20 'PathtoPGPPass','pgpbegin','pgpend','pgptmpf','pgpheader');
22 ################################### Defaults ##################################
23 my %Config = (NNTPServer => "localhost",
27 ConfigFile => "yapfaq.cfg",
30 ################################## PGP-Config #################################
31 pgp => '/usr/bin/pgp', # path to pgp
32 PGPVersion => '2', # Use 2 for 2.X, 5 for PGP > 2.X and GPG for GPG
33 PGPSigner => '', # sign as who?
34 PGPPass => '', # pgp2 only
35 PathtoPGPPass => '', # pgp2, pgp5 and gpg
36 pgpbegin => '-----BEGIN PGP SIGNATURE-----', # Begin of PGP-Signature
37 pgpend => '-----END PGP SIGNATURE-----', # End of PGP-Signature
38 pgptmpf => 'pgptmp', # temporary file for PGP.
39 pgpheader => 'X-PGP-Sig');
41 my @PGPSignHeaders = ('From', 'Newsgroups', 'Subject', 'Control',
42 'Supersedes', 'Followup-To', 'Date', 'Sender', 'Approved',
43 'Message-ID', 'Reply-To', 'Cancel-Lock', 'Cancel-Key',
44 'Also-Control', 'Distribution');
46 my @PGPorderheaders = ('from', 'newsgroups', 'subject', 'control',
47 'supersedes', 'followup-To', 'date', 'organization', 'lines',
48 'sender', 'approved', 'distribution', 'message-id',
49 'references', 'reply-to', 'mime-version', 'content-type',
50 'content-transfer-encoding', 'summary', 'keywords', 'cancel-lock',
51 'cancel-key', 'also-control', 'x-pgp', 'user-agent');
53 ############################# End of Configuration #############################
57 use Net::Domain qw(hostfqdn);
58 use Date::Calc qw(Add_Delta_YM Add_Delta_Days Delta_Days Today);
59 use Fcntl ':flock'; # import LOCK_* constants
61 my ($TDY, $TDM, $TDD) = Today(); #TD: Today's date
63 # read commandline options
65 getopts('Vhvpdt:f:c:s:', \%Options);
66 # -V: print version / copyright information
68 print "$0 v $Version\nCopyright (c) 2003 Marc Brockschmidt <marc\@marcbrockschmidt.de>\nCopyright (c) 2010 Thomas Hochstein <thh\@inter.net>\n";
69 print "This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.\n";
72 # -h: feed myself to perldoc
78 my ($Faq) = $Options{'f'} if ($Options{'f'});
80 # read runtime configuration (configuration variables)
81 $RCFile = $Options{'c'} if ($Options{'c'});
83 readrc (\$RCFile,\%Config);
85 warn "$0: W: .rc file $RCFile does not exist!\n";
88 # read configuration (configured FAQs)
90 readconfig (\$Config{'ConfigFile'}, \@Config, \$Faq);
93 # - parse configuration
95 # - if FAQ is due: call postfaq()
97 my ($LPD,$LPM,$LPY) = (01, 01, 0001); #LP: Last posting-date
98 my ($NPY,$NPM,$NPD); #NP: Next posting-date
101 my ($ActName,$File,$PFreq,$Expire) =($$_{'name'},$$_{'file'},$$_{'posting-frequency'},$$_{'expires'});
102 my ($From,$Subject,$NG,$Fup2)=($$_{'from'},$$_{'subject'},$$_{'ngs'},$$_{'fup2'});
103 my ($MIDF,$ReplyTo,$ExtHea)=($$_{'mid-format'},$$_{'reply-to'},$$_{'extraheader'});
104 my ($Supersede) =($$_{'supersede'});
106 # -f: loop if not FAQ to post
107 next if (defined($Faq) && $ActName ne $Faq);
110 if (open (FH, "<$File.cfg")) {
112 if (/##;; Lastpost:\s*(\d{1,2})\.(\d{1,2})\.(\d{2}(\d{2})?)/){
113 ($LPD, $LPM, $LPY) = ($1, $2, $3);
114 } elsif (/^##;;\s*LastMID:\s*(<\S+@\S+>)\s*$/) {
120 warn "$0: W: Couldn't open $File.cfg: $!\n";
123 $SupersedeMID = "" unless $Supersede;
125 ($NPY,$NPM,$NPD) = calcdelta ($LPY,$LPM,$LPD,$PFreq);
127 # if FAQ is due: get it out
128 if (Delta_Days($NPY,$NPM,$NPD,$TDY,$TDM,$TDD) >= 0 or ($Options{'p'})) {
130 print "$ActName: Would be posted now (but running in simulation mode [$0 -d]).\n" if $Options{'v'};
132 postfaq(\$ActName,\$File,\$From,\$Subject,\$NG,\$Fup2,\$MIDF,\$ExtHea,\$Config{'Sender'},\$TDY,\$TDM,\$TDD,\$ReplyTo,\$SupersedeMID,\$Expire);
134 } elsif($Options{'v'}) {
135 print "$ActName: Nothing to do.\n";
141 #################################### readrc ####################################
142 # Takes a filename and the reference to an array which contains the valid options
145 my ($File, $Config) = @_;
147 print "Reading $$File.\n" if($Options{'v'});
149 open FH, "<$$File" or die "$0: Can't open $$File: $!";
151 if (/^\s*(\S+)\s*=\s*'?(.*?)'?\s*(#.*$|$)/) {
152 if (grep(/$1/,@ValidConfVars)) {
153 $$Config{$1} = $2 if $2 ne '';
155 warn "$0: W: $1 is not a valid configuration variable (reading from $$File)\n";
161 ################################## readconfig ##################################
162 # Takes a filename, a reference to an array, which will hold hashes with
163 # the data from $File, and - optionally - the name of the (single) FAQ to post
166 my ($File, $Config, $Faq) = @_;
167 my ($LastEntry, $Error, $i) = ('','',0);
169 print "Reading configuration.\n" if($Options{'v'});
171 open FH, "<$$File" or die "$0: E: Can't open $$File: $!";
173 next if (defined($$Faq) && !/^\s*=====\s*$/ && defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} ne $$Faq );
174 if (/^(\s*(\S+)\s*=\s*'?(.*?)'?\s*(#.*$|$)|^(.*?)'?\s*(#.*$|$))/ && not /^\s*$/) {
175 $LastEntry = lc($2) if $2;
176 $$Config[$i]{$LastEntry} .= $3 if $3;
177 $$Config[$i]{$LastEntry} .= "\n$5" if $5 && $5;
179 if (/^\s*=====\s*$/) {
187 next if (defined($$Faq) && defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} ne $$Faq );
188 unless(defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} =~ /^\S+$/) {
189 $Error .= "E: The name of your project \"$$Config[$i]{'name'}\" is not defined or contains whitespaces.\n"
191 unless(defined($$Config[$i]{'file'}) && -f $$Config[$i]{'file'}) {
192 $Error .= "E: The file to post for your project \"$$Config[$i]{'name'}\" is not defined or does not exist.\n"
194 unless(defined($$Config[$i]{'from'}) && $$Config[$i]{'from'} =~ /\S+\@(\S+\.)?\S{2,}\.\S{2,}/) {
195 $Error .= "E: The From header for your project \"$$Config[$i]{'name'}\" seems to be incorrect.\n"
197 unless(defined($$Config[$i]{'ngs'}) && $$Config[$i]{'ngs'} =~ /^\S+$/) {
198 $Error .= "E: The Newsgroups header for your project \"$$Config[$i]{'name'}\" is not defined or contains whitespaces.\n"
200 unless(defined($$Config[$i]{'subject'})) {
201 $Error .= "E: The Subject header for your project \"$$Config[$i]{'name'}\" is not defined.\n"
203 unless(!$$Config[$i]{'fup2'} || $$Config[$i]{'fup2'} =~ /^\S+$/) {
204 $Error .= "E: The Followup-To header for your project \"$$Config[$i]{'name'}\" contains whitespaces.\n"
206 unless(defined($$Config[$i]{'posting-frequency'}) && $$Config[$i]{'posting-frequency'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
207 $Error .= "E: The Posting-frequency for your project \"$$Config[$i]{'name'}\" is invalid.\n"
209 unless(!$$Config[$i]{'expires'} || $$Config[$i]{'expires'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
210 warn "$0: W: The Expires for your project \"$$Config[$i]{'name'}\" is invalid - set to 3 month.\n";
212 unless(defined($$Config[$i]{'mid-format'}) && $$Config[$i]{'mid-format'} =~ /^<\S+\@\S{2,}\.\S{2,}>$/) {
213 warn "$0: W: The Expires for your project \"$$Config[$i]{'name'}\" seems to be invalid - set to default.\n";
216 $Error .= "-" x 25 . 'program terminated' . "-" x 25 . "\n" if $Error;
217 die $Error if $Error;
220 ################################# calcdelta #################################
221 # Takes a date (year, month and day) and a time period (1d, 1w, 1m, 1y, ...)
222 # and adds the latter to the former
225 my ($Year, $Month, $Day, $Period) = @_;
226 my ($NYear, $NMonth, $NDay);
228 if ($Period =~ /(\d+)\s*([dw])/) { # Is counted in days or weeks: Use Add_Delta_Days.
229 ($NYear, $NMonth, $NDay) = Add_Delta_Days($Year, $Month, $Day, (($2 eq "w")?$1 * 7: $1 * 1));
230 } elsif ($Period =~ /(\d+)\s*([my])/) { #Is counted in months or years: Use Add_Delta_YM
231 ($NYear, $NMonth, $NDay) = Add_Delta_YM($Year, $Month, $Day, (($2 eq "m")?(0,$1):($1,0)));
233 return ($NYear, $NMonth, $NDay);
236 ################################ updatestatus ###############################
237 # Takes a MID and a status file name
238 # and writes status information to disk
241 my ($ActName, $File, $date, $MID) = @_;
243 print "$$ActName: Save status information.\n" if($Options{'v'});
245 open (FH, ">$$File.cfg") or die "$0: E: Can't open $$File.cfg: $!";
246 print FH "##;; Lastpost: $date\n";
247 print FH "##;; LastMID: $MID\n";
251 ################################## postfaq ##################################
252 # Takes a filename and many other vars.
254 # It reads the data-file $File and then posts the article.
257 my ($ActName,$File,$From,$Subject,$NG,$Fup2,$MIDF,$ExtraHeaders,$Sender,$TDY,$TDM,$TDD,$ReplyTo,$Supersedes,$Expire) = @_;
258 my (@Header,@Body,$MID,$InRealBody,$LastModified);
260 print "$$ActName: Preparing to post.\n" if($Options{'v'});
263 $$TDM = ($$TDM < 10 && $$TDM !~ /^0/) ? "0" . $$TDM : $$TDM;
264 $$TDD = ($$TDD < 10 && $$TDD !~ /^0/) ? "0" . $$TDD : $$TDD;
267 $MID = '<%n-%d.%m.%y@'.hostfqdn.'>' if !defined($MID);
268 $MID =~ s/\%n/$$ActName/g;
269 $MID =~ s/\%d/$$TDD/g;
270 $MID =~ s/\%m/$$TDM/g;
271 $MID =~ s/\%y/$$TDY/g;
274 open (FH, "<$$File");
277 push (@Body, $_), next if $InRealBody;
278 $InRealBody++ if /^$/;
279 $LastModified = $1 if /^Last-modified: (\S+)$/i;
283 push @Body, "\n" if ($Body[-1] ne "\n");
285 #Create Date- and Expires-Header:
286 my @time = localtime;
287 my $ss = ($time[0]<10) ? "0" . $time[0] : $time[0];
288 my $mm = ($time[1]<10) ? "0" . $time[1] : $time[1];
289 my $hh = ($time[2]<10) ? "0" . $time[2] : $time[2];
291 my $month = ($time[4]+1<10) ? "0" . ($time[4]+1) : $time[4]+1;
292 my $monthN = ("Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec")[$time[4]];
293 my $wday = ("Sun","Mon","Tue","Wed","Thu","Fri","Sat")[$time[6]];
294 my $year = (1900 + $time[5]);
295 my $tz = $time[8] ? " +0200" : " +0100";
297 $$Expire = '3m' if !$$Expire; # set default if unset: 3 month
299 my ($expY,$expM,$expD) = calcdelta ($year,$month,$day,$$Expire);
300 my $expmonthN = ("Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec")[$expM-1];
302 my $date = "$day $monthN $year " . $hh . ":" . $mm . ":" . $ss . $tz;
303 my $expdate = "$expD $expmonthN $expY $hh:$mm:$ss$tz";
305 #Replace %LM by the content of the news.answer-pseudo-header Last-modified:
307 $$Subject =~ s/\%LM/$LastModified/;
311 if($Options{'t'} and $Options{'t'} !~ /console/i) {
312 $$NG = $Options{'t'};
315 #Now create the complete Header:
316 push @Header, "From: $$From\n";
317 push @Header, "Newsgroups: $$NG\n";
318 push @Header, "Followup-To: $$Fup2\n" if $$Fup2;
319 push @Header, "Subject: $$Subject\n";
320 push @Header, "Message-ID: $MID\n";
321 push @Header, "Supersedes: $$Supersedes\n" if $$Supersedes;
322 push @Header, "Date: $date\n";
323 push @Header, "Expires: $expdate\n";
324 push @Header, "Sender: $$Sender\n" if $$Sender;
325 push @Header, "Mime-Version: 1.0\n";
326 push @Header, "Reply-To: $$ReplyTo\n" if $$ReplyTo;
327 push @Header, "Content-Type: text/plain; charset=ISO-8859-15\n";
328 push @Header, "Content-Transfer-Encoding: 8bit\n";
329 push @Header, "User-Agent: yapfaq/$Version\n";
330 if ($$ExtraHeaders) {
331 push @Header, "$_\n" for (split /\n/, $$ExtraHeaders);
334 # sign article if $UsePGP is true
335 my @Article = ($Config{'UsePGP'})?@{signpgp(\@Header, \@Body)}:(@Header, "\n", @Body);
338 print "$$ActName: Posting article ...\n" if($Options{'v'});
339 my $failure = post(\@Article);
342 print "$$ActName: Posting failed, ERROR.dat may have more information.\n" if($Options{'v'} && (!defined($Options{'t'}) || $Options{'t'} !~ /console/i));
344 updatestatus($ActName, $File, "$day.$month.$year", $MID) if !defined($Options{'t'});
348 ################################## post ##################################
349 # Takes a complete article (Header and Body).
351 # It opens a connection to $NNTPServer and posts the message.
357 # test mode - print article to console
358 if(defined($Options{'t'}) and $Options{'t'} =~ /console/i) {
359 print "-----BEGIN--------------------------------------------------\n";
361 print "------END---------------------------------------------------\n";
362 # pipe article to script
363 } elsif(defined($Options{'s'})) {
364 open (POST, "| $Options{'s'}") or die "$0: E: Cannot fork $Options{'s'}: $!\n";
365 print POST @$ArticleR;
370 warn "$0: W: $Options{'s'} exited with status ", ($? >> 8), "\n";
375 my $NewsConnection = Net::NNTP->new($Config{'NNTPServer'}, Reader => 1) or die "$0: E: Can't connect to news server '$Config{'NNTPServer'}'!\n";
376 $NewsConnection->authinfo ($Config{'NNTPUser'}, $Config{'NNTPPass'}) if (defined($Config{'NNTPUser'}));
377 $NewsConnection->post();
378 $NewsConnection->datasend (@$ArticleR);
379 $NewsConnection->dataend();
381 if ($NewsConnection->ok()) {
383 # Posting failed? Save to ERROR.dat
385 warn "$0: W: Posting failed!\n";
386 open FH, ">>ERROR.dat";
387 print FH "\nPosting failed! Saving to ERROR.dat. Response from news server:\n";
388 print FH $NewsConnection->code();
389 print FH $NewsConnection->message();
392 print FH "-" x 80, "\n";
395 $NewsConnection->quit();
400 #-------- sub getpgpcommand
401 # getpgpcommand generates the command to sign the message and returns it.
404 # - $PGPVersion: A scalar holding the PGPVersion
406 my ($PGPVersion) = @_;
409 if ($PGPVersion eq '2') {
410 if ($Config{'PathtoPGPPass'} && !$Config{'PGPPass'}) {
411 open (PGPPW, $Config{'PathtoPGPPass'}) or die "$0: E: Can't open $Config{'PathtoPGPPass'}: $!";
412 Config{'$PGPPass'} = <PGPPW>;
416 if (Config{'$PGPPass'}) {
417 $PGPCommand = "PGPPASS=\"".$Config{'PGPPass'}."\" ".$Config{'pgp'}." -u \"".$Config{'PGPSigner'}."\" +verbose=0 language='en' -saft <".$Config{'pgptmpf'}.".txt >".$Config{'pgptmpf'}.".txt.asc";
419 die "$0: E: PGP-Passphrase is unknown!\n";
421 } elsif ($PGPVersion eq '5') {
422 if ($Config{'PathtoPGPPass'}) {
423 $PGPCommand = "PGPPASSFD=2 ".$Config{'pgp'}."s -u \"".$Config{'PGPSigner'}."\" -t --armor -o ".$Config{'pgptmpf'}.".txt.asc -z -f < ".$Config{'pgptmpf'}.".txt 2<".$Config{'PathtoPGPPass'};
425 die "$0: E: PGP-Passphrase is unknown!\n";
427 } elsif ($PGPVersion =~ m/GPG/io) {
428 if (Config{'$PathtoPGPPass'}) {
429 $PGPCommand = $Config{'pgp'}." --digest-algo MD5 -a -u \"".$Config{'PGPSigner'}."\" -o ".$Config{'pgptmpf'}.".txt.asc --no-tty --batch --passphrase-fd 2 2<".$Config{'PathtoPGPPass'}." --clearsign ".$Config{'pgptmpf'}.".txt";
431 die "$0: E: Passphrase is unknown!\n";
434 die "$0: E: Unknown PGP-Version $PGPVersion!";
440 #-------- sub signarticle
441 # signarticle signs an articel and returns a reference to an array
442 # containing the whole signed Message.
445 # - $HeaderAR: A reference to a array containing the articles headers.
446 # - $BodyR: A reference to an array containing the body.
449 # - $MessageRef: A reference to an array containing the whole message.
451 my ($HeaderAR, $BodyR) = @_;
452 my (@pgphead, @pgpbody, $pgphead, $pgpbody, $header, $signheaders, @signheaders, $currentheader, $HeaderR, $line);
454 foreach my $line (@$HeaderAR) {
455 if ($line =~ /^(\S+):\s+(.*)$/s) {
457 $$HeaderR{lc($currentheader)} = "$1: $2";
459 $$HeaderR{lc($currentheader)} .= $line;
463 foreach (@PGPSignHeaders) {
464 if (defined($$HeaderR{lc($_)}) && $$HeaderR{lc($_)} =~ m/^[^\s:]+: .+/o) {
465 push @signheaders, $_;
469 $pgpbody = join ("", @$BodyR);
471 # Delete and create the temporary pgp-Files
472 unlink "$Config{'pgptmpf'}.txt";
473 unlink "$Config{'pgptmpf'}.txt.asc";
474 $signheaders = join(",", @signheaders);
476 $pgphead = "X-Signed-Headers: $signheaders\n";
477 foreach $header (@signheaders) {
478 if ($$HeaderR{lc($header)} =~ m/^[^\s:]+: (.+?)\n?$/so) {
479 $pgphead .= $header.": ".$1."\n";
483 open(FH, ">" . $Config{'pgptmpf'} . ".txt") or die "$0: E: can't open $Config{'pgptmpf'}: $!\n";
484 print FH $pgphead, "\n", $pgpbody;
485 print FH "\n" if ($Config{'PGPVersion'} =~ m/GPG/io); # workaround a pgp/gpg incompatibility - should IMHO be fixed in pgpverify
486 close(FH) or warn "$0: W: Couldn't close TMP: $!\n";
488 # Start PGP, then read the signature;
489 my $PGPCommand = getpgpcommand($Config{'PGPVersion'});
492 open (FH, "<" . $Config{'pgptmpf'} . ".txt.asc") or die "$0: E: can't open ".$Config{'pgptmpf'}.".txt.asc: $!\n";
493 $/ = "$Config{'pgpbegin'}\n";
495 unless (m/\Q$Config{'pgpbegin'}\E$/o) {
496 # unlink $Config{'pgptmpf'} . ".txt";
497 # unlink $Config{'pgptmpf'} . ".txt.asc";
498 die "$0: E: $Config{'pgpbegin'} not found in ".$Config{'pgptmpf'}.".txt.asc\n"
500 unlink($Config{'pgptmpf'} . ".txt") or warn "$0: W: Couldn't unlink $Config{'pgptmpf'}.txt: $!\n";
504 unless (m/^Version: (\S+)(?:\s(\S+))?/o) {
505 unlink $Config{'pgptmpf'} . ".txt";
506 unlink $Config{'pgptmpf'} . ".txt.asc";
507 die "$0: E: didn't find PGP Version line where expected.\n";
511 $$HeaderR{$Config{'pgpheader'}} = $1."-".$2." ".$signheaders;
513 $$HeaderR{$Config{'pgpheader'}} = $1." ".$signheaders;
516 do { # skip other pgp headers like
517 $_ = <FH>; # "charset:"||"comment:" until empty line
522 last if /^\Q$Config{'pgpend'}\E$/;
523 $$HeaderR{$Config{'pgpheader'}} .= "\n\t$_";
526 $$HeaderR{$Config{'pgpheader'}} .= "\n" unless ($$HeaderR{$Config{'pgpheader'}} =~ /\n$/s);
530 unlink $Config{'pgptmpf'} . ".txt";
531 unlink $Config{'pgptmpf'} . ".txt.asc";
532 die "$0: E: unexpected data following $Config{'pgpend'}\n";
535 unlink "$Config{'pgptmpf'}.txt.asc";
537 my $tmppgpheader = $Config{'pgpheader'} . ": " . $$HeaderR{$Config{'pgpheader'}};
538 delete $$HeaderR{$Config{'pgpheader'}};
541 foreach $header (@PGPorderheaders) {
542 if ($$HeaderR{$header} && $$HeaderR{$header} ne "\n") {
543 push(@pgphead, "$$HeaderR{$header}");
544 delete $$HeaderR{$header};
548 foreach $header (keys %$HeaderR) {
549 if ($$HeaderR{$header} && $$HeaderR{$header} ne "\n") {
550 push(@pgphead, "$$HeaderR{$header}");
551 delete $$HeaderR{$header};
555 push @pgphead, ("X-PGP-Key: " . $Config{'PGPSigner'} . "\n"), $tmppgpheader;
558 @pgpbody = split /$/m, $pgpbody;
559 my @pgpmessage = (@pgphead, "\n", @pgpbody);
565 ################################ Documentation #################################
569 yapfaq - Post Usenet FAQs I<(yet another postfaq)>
573 B<yapfaq> [B<-hvpd>] [B<-t> I<newsgroups> | CONSOLE] [B<-f> I<project name>] [B<-s> I<program>] [B<-c> I<.rc file>]
597 Furthermore you need access to a news server to actually post FAQs.
601 B<yapfaq> posts (one or more) FAQs to Usenet with a certain posting
602 frequency (every n days, weeks, months or years), adding all necessary
603 headers as defined in its config file (by default F<yapfaq.cfg>).
607 F<yapfaq.cfg> consists of one or more blocks, separated by C<=====> on
608 a single line, each containing the configuration for one FAQ as a set
609 of definitions in the form of I<param = value>. Everything after a "#"
610 sign is ignored so you may comment your configuration file.
614 =item B<Name> = I<project name>
616 A name referring to your FAQ, also used for generation of a Message-ID.
618 This value must be set.
620 =item B<File> = I<file name>
622 A file containing the message body of your FAQ and all pseudo headers
623 (subheaders in the news.answers style).
625 This value must be set.
627 =item B<Posting-frequency> = I<time period>
629 The posting frequency defines how often your FAQ will be posted.
630 B<yapfaq> will only post your FAQ if this period of time has passed
631 since the last posting.
633 You can declare that time period either in I<B<d>ays> or I<B<w>weeks>
634 or I<B<m>onths> or I<B<y>ears>.
636 This value must be set.
638 =item B<Expires> = I<time period>
640 The period of time after which your message will expire. An Expires
641 header will be calculated adding this time period to today's date.
643 You can declare this time period either in I<B<d>ays> or I<B<w>weeks>
644 or I<B<m>onths> or I<B<y>ears>.
646 This setting is optional; the default is 3 months.
648 =item B<From> = I<author>
650 The author of your FAQ as it will appear in the From header of the
653 This value must be set.
655 =item B<Subject> = I<subject>
657 The title of your FAQ as it will appear in the Subject header of the
660 You may use the special string C<%LM> which will be replaced with
661 the contents of the Last-Modified subheader in your I<File>.
663 This value must be set.
665 =item B<NGs> = I<newsgroups>
667 A comma-separated list of newsgroup(s) to post your FAQ to as it will
668 appear in the Newsgroups header of the message.
670 This value must be set.
672 =item B<Fup2> = I<newsgroup | poster>
674 A comma-separated list of newsgroup(s) or the special string I<poster>
675 as it will appear in the Followup-To header of the message.
677 This setting is optional.
679 =item B<MID-Format> = I<pattern>
681 A pattern from which the message ID is generated as it will appear in
682 the Message-ID header of the message.
684 You may use the special strings C<%n> for the I<Name> of your project,
685 C<%d> for the date the message is posted, C<%m> for the month and
686 C<%y> for the year, respectively.
688 This value must be set.
690 =item B<Supersede> = I<yes>
692 Add Supersedes header to the message containing the Message-ID header
695 This setting is optional; you should set it to yes or leave it out.
697 =item B<ExtraHeader> = I<additional headers>
699 The contents of I<ExtraHeader> is added verbatim to the headers of
700 your message so you can add custom headers like Approved.
702 This setting is optional.
706 =head3 Example configuration file
708 # name of your project
711 # file to post (complete body and pseudo-headers)
712 # ($File.cfg contains data on last posting and last MID)
715 # how often your project should be posted
716 # use (d)ay OR (w)eek OR (m)onth OR (y)ear
717 Posting-frequency = '1d'
719 # time period after which the posting should expire
720 # use (d)ay OR (w)eek OR (m)onth OR (y)ear
724 From = 'test@domain.invalid'
727 # (may contain "%LM" which will be replaced by the contents of the
728 # Last-Modified pseudo header).
729 Subject = 'test noreply ignore'
731 # comma-separated list of newsgroup(s) to post to
732 # (header "Newsgroups:")
735 # header "Followup-To:"
738 # Message-ID ("%n" is $Name)
739 MID-Format = '<%n-%d.%m.%y@domain.invalid>'
741 # Supersede last posting?
744 # extra headers (appended verbatim)
745 # use this for custom headers like "Approved:"
746 ExtraHeader = 'Approved: moderator@domain.invalid
749 # other projects may follow separated with "====="
754 Posting-frequency = '2m'
755 From = 'My Name <my.name@domain.invalid>'
756 Subject = 'Test of yapfag <%LM>'
757 NGs = 'de.test,de.alt.test'
759 MID-Format = '<%n-%m.%y@domain.invalid>'
762 =head3 Status Information
764 Information about the last post and about how to form message IDs for
765 posts is stored in a file named F<I<project name>.cfg> which will be
766 generated if it does not exist. Each of those status files will
767 contain two lines, the first being the date of the last time the FAQ
768 was posted and the second being the message ID of that incarnation.
770 =head2 Runtime Configuration
772 Apart from configuring which FAQ(s) to post you may (re)set some
773 runtime configuration variables via the .rcfile (by default
774 F<.yapfaqrc>). F<.yapfaqrc> must contain one definition in the form of
775 I<param = value> on each line; everything after a "#" sign is ignored.
777 If you omit some settings they will be set to default values hardcoded
780 B<Please note that all parameter names are case-sensitive!>
784 =item B<NNTPServer> = I<NNTP server> (mandatory)
786 Host name of the NNTP server to post to. Must be set (or omitted; the
787 default is "localhost"); if set to en empty string, B<yapfaq> falls
788 back to Perl's build-in defaults (contents of environment variables
789 NNTPSERVER and NEWSHOST; if not set, default from Net::Config; if not
790 set, "news" is used).
792 =item B<NNTPUser> = I<user name> (optional)
794 User name used for authentication with the NNTP server (I<AUTHINFO
797 This setting is optional; if it is not set, I<NNTPPass> is ignored and
798 no authentication is tried.
800 =item B<NNTPPass> = I<password> (optional)
802 Password used for authentication with the NNTP server (I<AUTHINFO
805 This setting is optional; it must be set if I<NNTPUser> is present.
807 =item B<Sender> = I<Sender header> (optional)
809 The Sender header that will be added to every posted message.
811 This setting is optional.
813 =item B<ConfigFile> = I<configuration file> (mandatory)
815 The configuration file defining the FAQ(s) to post. Must be set (or
816 omitted; the default is "yapfaq.cfg").
818 =item B<UsePGP> = I<whether to add a digital signature> (optional)
820 Boolean value (0 or 1) controlling whether the FAQs will get digitally
821 signed via an X-PGP-Sig header.
823 This setting is optional; the default is 0.
825 If you have set I<UsePGP> to 1, you must also supply the necessary
826 information on your PGP oder GPG installation; please refer to the
827 sample F<.yapfaqrc> file (see below) for more information on this
832 =head3 Example runtime configuration file
834 NNTPServer = 'localhost'
838 ConfigFile = 'yapfaq.cfg'
841 ################################## PGP-Config #################################
842 pgp = '/usr/bin/pgp' # path to pgp
843 PGPVersion = '2' # Use 2 for 2.X 5 for PGP > 2.X and GPG for GPG
844 PGPSigner = '' # sign as who?
845 PGPPass = '' # pgp2 only
846 PathtoPGPPass = '' # pgp2 pgp5 and gpg
847 pgpbegin = '-----BEGIN PGP SIGNATURE-----' # Begin of PGP-Signature
848 pgpend = '-----END PGP SIGNATURE-----' # End of PGP-Signature
849 pgptmpf = 'pgptmp' # temporary file for PGP.
850 pgpheader = 'X-PGP-Sig'
852 =head3 Using more than one runtime configuration
854 You may use more than one runtime configuration file with the B<-c>
861 =item B<-V> (version)
863 Print out version and copyright information on B<yapfaq> and exit.
867 Print this man page and exit.
869 =item B<-v> (verbose)
871 Print out status information while running to STDOUT.
873 =item B<-p> (post unconditionally)
875 Post (all) FAQs unconditionally ignoring the posting frequency setting.
877 You may want to use this with the B<-f> option (see below).
879 =item B<-d> (dry run)
881 Start B<yapfaq> in simulation mode, i.e. don't post anything and don't
882 update any status information.
884 =item B<-t> I<newsgroup(s) | CONSOLE> (test)
886 Don't post to the newsgroups defined in F<yqpfaq.cfg>, but to the
887 newsgroups given after B<-t> as a comma-separated list or print the
888 FAQs to STDOUT separated by lines of dashes if the special string
889 C<CONSOLE> is given. This can be used to preview what B<yapfaq> would
890 do without embarassing yourself on Usenet. The status files are not
891 updated when this option is given.
893 You may want to use this with the B<-f> option (see below).
895 =item B<-f> I<project name>
897 Just deal with one FAQ only.
899 By default B<yapfaq> will work on all FAQs that are defined in
900 F<yapfaq.cfg>, check whether they are due for posting and - if they
901 are - post them. Consequently when the B<-p> option is set all FAQs
902 will be posted unconditionally. That may not be what you want to
903 achieve, so you can limit the operation of B<yapfaq> to the named FAQ
906 =item B<-s> I<program> (pipe to script)
908 Instead of posting the article(s) to Usenet pipe them to the external
909 I<program> on STDIN (which may post the article(s) then). A return
910 value of 0 will be considered success.
912 =item B<-c> I<.rc file>
914 Load another runtime configuration file (.rc file) than F<.yaofaq.rc>.
916 You may for example define another usenet server to post your FAQ(s)
917 to or load another configuration file defining (an)other FAQ(s).
923 Post all FAQs that are due for posting:
927 Do a dry run, showing which FAQs would be posted:
931 Do a test run and print on STDOUT what the FAQ I<myfaq> would look
932 like when posted, regardless whether it is due for posting or not:
934 yapfaq -pt CONSOLE -f myfaq
936 Do a "real" test run and post the FAQ I<myfaq> to I<de.test>, but only
939 yapfaq -t de.test -f myfaq
943 There are no special environment variables used by B<yapfaq>.
955 Runtime configuration file for B<yapfaq>.
959 Configuration file for B<yapfaq>.
965 The status files will be created on successful posting if they don't
966 already exist. The first line of the file will be the date of the last
967 time the FAQ was posted and the second line will be the message ID of
968 the last post of that FAQ.
978 L<http://th-h.de/download/scripts.php> will have the current
979 version of this program.
983 Thomas Hochstein <thh@inter.net>
985 Original author (up to version 0.5b, dating from 2003):
986 Marc Brockschmidt <marc@marcbrockschmidt.de>
988 =head1 COPYRIGHT AND LICENSE
990 Copyright (c) 2003 Marc Brockschmidt <marc@marcbrockschmidt.de>
992 Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
994 This program is free software; you may redistribute it and/or modify it
995 under the same terms as Perl itself.