summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/pingd.conf.pod64
1 files changed, 33 insertions, 31 deletions
diff --git a/doc/pingd.conf.pod b/doc/pingd.conf.pod
index 1735ae7..79dca05 100644
--- a/doc/pingd.conf.pod
+++ b/doc/pingd.conf.pod
@@ -2,12 +2,12 @@
=head1 NAME
-pingd.conf - configuration file for the echolot ping daemon
+pingd.conf - configuration file for the Echolot ping daemon
=head1 DESCRIPTION
-The file B<pingd.conf> sets configuration parameteres for the echolot pingd(1).
-It is a perl script that gets eval()ed from withing pingd. It has to set the
+The file B<pingd.conf> sets configuration parameters for the Echolot pingd(1).
+It is a Perl script that gets eval()ed from withing pingd. It has to set the
values in the $CONFIG hash.
=cut
@@ -27,7 +27,7 @@ A short name for your site/pinger. Is used in the statistics produced.
=item B<my_localpart>
-The local part of the pingers email address.
+The local part of the pinger's email address.
In C<pinger@example.com> the localpart is C<pinger>.
@@ -36,7 +36,7 @@ In C<pinger@example.com> the localpart is C<pinger>.
=item B<my_domain>
-The domain part of the pingers email address.
+The domain part of the pinger's email address.
In C<pinger@example.com> the localpart is C<example.com>.
@@ -94,7 +94,7 @@ parameters.
=item B<hash_len> [integer]
Echolot uses email addresses like C<foo+some_data=MAC@domain>. MAC
-is Message Authentification Code used to verify that the address
+is Message Authentication Code used to verify that the address
was actually generated by this pinger using a secret which is set
from random data the first time you run B<pingd>. Echolot uses MD5
as the MAC hash function.
@@ -141,17 +141,17 @@ Show new remailers in public stats by default.
=over
-=item B<seperate_rlists> [bool]
+=item B<separate_rlists> [bool]
-Also build sperate rlists with data from only DSA pings, only RSA pings and
-only plaintext pings.
+Also build separate rlists with data from only DSA pings, only RSA pings and
+only unencrypted pings.
- Default: 'seperate_rlists' => 0,
- Example: 'seperate_rlists' => 1,
+ Default: 'separate_realists' => 0,
+ Example: 'separate_rlists' => 1,
=item B<combined_list> [bool]
-Build a combinded list of all different stats too. While this is no
+Build a combined list of all different stats too. While this is no
standard format it is nice to read for a human eye.
Default: 'combined_list' => 0,
@@ -220,7 +220,7 @@ commit them to the list of remailers.
=item B<expire> [seconds]
-How often to expire old keys, pingds and remailers
+How often to expire old keys, pings and remailers
Default: 'expire' => 24*60*60, # daily
Example: 'expire' => 8*60*60, # every 8 hours
@@ -243,26 +243,28 @@ B<getkeyconf_every_nth_time> time.
How often to check assumed dead remailers for resurrection.
- Default: 'getkeyconf' => 7*24*60*60, # weekly
- Example: 'getkeyconf' => 24*24*60*60, # every other week
+ Default: 'check_resurrection' => 7*24*60*60, # weekly
+ Example: 'check_resurrection' => 24*24*60*60, # every other week
=item B<pinger_interval> [seconds]
=item B<ping_every_nth_time> [integer]
How often to send pings. Pings are sent every B<pinger_interval> seconds. The
-same remailer is pinged every B<ping_every_nth_time>. This is done this way in
-order to avoid spikes.
+same remailer is pinged every B<ping_every_nth_time> time pings are sent (This
+means the same remailer is pinged every B<pinger_interval> *
+B<ping_every_nth_time> seconds). It is done this way in order to avoid
+spikes.
Default: 'pinger_interval' => 5*60, # send out pings every 5 minutes
'ping_every_nth_time' => 48, # send out pings to the same remailer every 48 calls, i.e. every 4 hours
- Example: 'pinger_interval' => 60*60, # send out pings every minute
+ Example: 'pinger_interval' => 60, # send out pings every minute
'ping_every_nth_time' => 60, # send out pings to the same remailer every 60 calls, i.e. every hour
=item B<addresses_default_ttl> [integer]
How many times to request remailer-xxx from a remailer (done every
-B<getkeyconf> seconds, daily per default) without a reply before it is asumed
+B<getkeyconf> seconds, daily per default) without a reply before it is assumed
dead.
Default: 'addresses_default_ttl' => 5, # getkeyconf seconds (days if getkeyconf is 24*60*60, the default)
@@ -334,7 +336,7 @@ After which time to expire files in the thesaurus directory.
=item B<homedir>
-The base directory of the echolot installation. All other filenames and
+The base directory of the Echolot installation. All other filenames and
directorynames are local to this directory. B<pingd> changes into this
directory upon startup.
@@ -379,7 +381,7 @@ show set to false are shown here too).
Default: 'private_resultdir' => 'results',
-=item B<gnupghome>
+=item B<indexfilebasename>
The file to write the index.html to (relative to the result directory).
@@ -395,10 +397,10 @@ encryption/decryption actions.
=item B<gnupg>
-Name of the GnuPG executeable. If it is not in your PATH make sure to
+Name of the GnuPG executable. If it is not in your PATH make sure to
include path information.
-If B<gnupg> is an empty string, the C<GnuPG::Interfae> default (usually B<gpg>)
+If B<gnupg> is an empty string, the C<GnuPG::Interface> default (usually B<gpg>)
is used.
Default: 'gnupg' => '',
@@ -410,11 +412,11 @@ The directory which is used as temporal Mixmaster home for all keyring and
encryption/decryption actions.
Default: 'mixhome' => 'mixhome',
- Example: 'mixmaster' => '/home/pinger/Mix',
+ Example: 'mixhome' => '/home/pinger/Mix',
=item B<mixmaster>
-Name of the mixmaster executeable. If it is not in your PATH make sure to
+Name of the mixmaster executable. If it is not in your PATH make sure to
include path information.
Default: 'mixmaster' => 'mix',
@@ -437,7 +439,7 @@ to the daemon process which reads and empties the file.
=item B<pidfile>
-The daemon's pid file. The daemon's Process ID is stored in this file.
+The daemon's PID file. The daemon's Process ID is stored in this file.
As long as it exists pingd refuses to start up in daemon mode.
Default: 'pidfile' => 'pingd.pid',
@@ -512,7 +514,7 @@ Send out CPunk pings to CPunk remailers with their RSA key.
=item B<cpunk-clear>
-Send out plaintext pings to CPunk remailers that don't have pgponly
+Send out unencrypted pings to CPunk remailers that don't have pgponly
in their capsstring.
=item B<mix>
@@ -538,7 +540,7 @@ Pings mixmaster remailers.
=item B<templates>
-The template files are used to generate the HTML version of all echolot output.
+The template files are used to generate the HTML version of all Echolot output.
It is a hash that has the following keys:
B<thesaurusindexfile>,
B<mlist>,
@@ -579,18 +581,18 @@ B<clist>.
=item B<remailerxxxtext>
The text to send along with remailer-xxx queries.
-The tempalte variables address and operator_address are substituted for their
+The template variables address and operator_address are substituted for their
real values.
Default: 'remailerxxxtext' => "Hello,\n".
"\n".
- "This message requests remailer configation data. The pinging software thinks\n".
+ "This message requests remailer configuration data. The pinging software thinks\n".
"<TMPL_VAR NAME=\"address\"> is a remailer. Either it has been told so by the\n".
"maintainer of the pinger or it found the address in a remailer-conf or\n".
"remailer-key reply of some other remailer.\n".
"\n".
"If this is _not_ a remailer, you can tell this pinger that and it will stop\n".
- "sending you those requests immediatly (otherwise it will try a few more times).\n".
+ "sending you those requests immediately (otherwise it will try a few more times).\n".
"Just reply and make sure the following is the first line of your message:\n".
" not a remailer\n".
"\n".