Add comments pointing to .yapfaqrc to source.
authorThomas Hochstein <thh@inter.net>
Wed, 14 Apr 2010 08:10:28 +0000 (10:10 +0200)
committerThomas Hochstein <thh@inter.net>
Wed, 14 Apr 2010 08:10:28 +0000 (10:10 +0200)
Signed-off-by: Thomas Hochstein <thh@inter.net>
yapfaq.pl

index 57ca99b..b509d9b 100644 (file)
--- a/yapfaq.pl
+++ b/yapfaq.pl
 
 my $Version = "0.8-prelease";
 
 
 my $Version = "0.8-prelease";
 
+# Please do not change this setting!
+# You may override the default .rc file (.yapfaqrc) by using "-c .rc file"
 my $RCFile = '.yapfaqrc';
 my $RCFile = '.yapfaqrc';
+# Valid configuration variables for use in a .rc file
 my @ValidConfVars = ('NNTPServer','NNTPUser','NNTPPass','Sender','ConfigFile',
                      'UsePGP','pgp','PGPVersion','PGPSigner','PGPPass',
                      'PathtoPGPPass','pgpbegin','pgpend','pgptmpf','pgpheader');
 
 my @ValidConfVars = ('NNTPServer','NNTPUser','NNTPPass','Sender','ConfigFile',
                      'UsePGP','pgp','PGPVersion','PGPSigner','PGPPass',
                      'PathtoPGPPass','pgpbegin','pgpend','pgptmpf','pgpheader');
 
-################################### Defaults ##################################
+################################### Defaults ###################################
+# Please do not change anything in here!
+# Use a runtime configuration file (.yapfaqrc by default) to override defaults.
 my %Config = (NNTPServer => "",
               NNTPUser   => "",
               NNTPPass   => "",
 my %Config = (NNTPServer => "",
               NNTPUser   => "",
               NNTPPass   => "",
@@ -50,7 +55,7 @@ my @PGPorderheaders = ('from', 'newsgroups', 'subject', 'control',
        'content-transfer-encoding', 'summary', 'keywords', 'cancel-lock',
        'cancel-key', 'also-control', 'x-pgp', 'user-agent');
 
        'content-transfer-encoding', 'summary', 'keywords', 'cancel-lock',
        'cancel-key', 'also-control', 'x-pgp', 'user-agent');
 
-############################# End of Configuration #############################
+################################# Main program #################################
 
 use strict;
 use Net::NNTP;
 
 use strict;
 use Net::NNTP;
This page took 0.012353 seconds and 4 git commands to generate.