Improvements to pingd.conf(5) by Colin

1 files changed, 30 insertions, 25 deletions

diff --git a/doc/pingd.conf.pod b/doc/pingd.conf.pod
index cfa2d94..50c2a5b 100644
--- a/doc/pingd.conf.pod
+++ b/doc/pingd.conf.pod
@@ -93,7 +93,7 @@ secret.
 
 =item B<dev_urandom>
 
-Where to read weak random data from - currently used only for generating
+Where to read weak random data from - currently used only for 
 garbage generation.
 
 	Default: 'dev_urandom' => '/dev/urandom',
@@ -116,8 +116,8 @@ parameters.
 
 =item B<hash_len> [integer]
 
-Echolot uses email addresses like C<foo+some_data=MAC@domain>. MAC
-is Message Authentication Code used to verify that the address
+Echolot uses email addresses of the form C<foo+some_data=MAC@domain>. MAC
+is a 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.
@@ -131,14 +131,14 @@ B<hash_len> is the number of characters to include in the email address.
 
 The length of one character in reliability and latency stats.  One
 character usually stands for exactly one day (hence the name of this
-config option).  Changing it in production use if probably a bad idea
-bug shortening it might come in handy during debugging.
+config option).  Changing it in production use is probably a bad idea
+but shortening it might come in handy during debugging.
 
 	Default: 'seconds_per_day' => 24*60*60,
 
 =item B<stats_days> [integer]
 
-How many day (or whatever you configured seconds_per_day to really be)
+How many days (or whatever you configured seconds_per_day to really be)
 to have in the stats.  This is 12 days.
 
 	Default: 'stats_days' => 12,
@@ -250,7 +250,8 @@ When building stats and we have chain pinging enabled
 This can be a CPU intensive task therefore it's not updated
 every time stats are built.
 
-	Default: 'chainping_update' => 4*60*60, # chain stats should never be older than 4 hours
+	Default: 'chainping_update' => 4*60*60, # chain stats should never
+						#  be older than 4 hours
 
 =item B<buildkeys> [seconds]
 
@@ -290,10 +291,14 @@ How often to query remailers for new keys and configuration data
 seconds. The same request to the same remailer is sent only every 
 B<getkeyconf_every_nth_time> time.
 
-	Default: 'getkeyconf_interval'       => 5*60,    # send out requests every 5 minutes
-	         'getkeyconf_every_nth_time' => 24*60/5, # send out the same request to the same remailer once a day
+	Default: 'getkeyconf_interval'       => 5*60,    # send out requests
+							 #  every 5 minutes
+	         'getkeyconf_every_nth_time' => 24*60/5, # send out the same
+							 #  request to the same
+							 #  remailer once a day
 	Example: 'getkeyconf_interval'       => 10*60,
-	         'getkeyconf_every_nth_time' => 2*24*60/10, # new request every other day
+	         'getkeyconf_every_nth_time' => 2*24*60/10, # new request every
+							    #  other day
 
 =item B<check_resurrection> [seconds]
 
@@ -364,7 +369,7 @@ expired after this time.
 
 =item B<reliable_auto_add_min> [integer]
 
-How many different remailers need to list an address in Reliable's remailer-conf
+How many different remailers need to list an address in a remailer-conf
 reply to get it committed to the list of remailer addresses.
 
 	Default: 'reliable_auto_add_min' => 3,
@@ -415,7 +420,7 @@ After how long to expire header From: lines.
 
 =item B<cleanup_tmpdir> [seconds]
 
-How often to clean cruft from the temp directory.
+How often to clean old files from the temp directory.
 	Default: 'cleanup_tmpdir'   => 24*60*60, # daily
 
 =item B<metadata_backup> [seconds]
@@ -496,7 +501,7 @@ The Thesaurus index file.
 
 =item B<fromlinesindexfile>
 
-The Thesaurus index file.
+The From Lines index file.
 
 	Default: 'fromlinesindexfile' => 'results/from',
 
@@ -516,7 +521,7 @@ The file to write the index.html to (relative to the result directory).
 
 =item B<gnupghome>
 
-The directory which is used as temporal GnuPG home for all keyring and
+The directory which is used as temporary GnuPG home for all keyring and
 encryption/decryption actions.
 
 	Default: 'gnupghome' => 'gnupghome',
@@ -541,7 +546,7 @@ include path information.
 
 =item B<mixhome>
 
-The directory which is used as temporal Mixmaster home for all keyring and
+The directory which is used as temporary Mixmaster home for all keyring and
 encryption/decryption actions.
 
 	Default: 'mixhome' => 'mixhome',
@@ -655,8 +660,8 @@ The extension that such metafiles (see above) should have.
 =item B<random_garbage> [integer]
 
 Pings usually are quite short.  Some 100 bytes are sufficient to relay
-all the information that is required.  To make them not that out that
-extremly, pings are padded using random garbage of random length.
+all the information that is required.  To make them not stand out that
+obviously, pings are padded using random garbage of random length.
 
 B<random_garbage> is the top limit for the amount of bytes to add.  The
 actual number is randomly generated and uniformly distributed over
@@ -686,15 +691,15 @@ Show the results of our chainpinging in public stats.
 
 =item B<chainping_fudge>
 
-Which factor of messages may get lost in addition to the guessed loss
-derived from one-hop stats before a chain is declared broken.
+What proportion of the expected replies derived from one-hop stats
+must return before a chain is not declared broken.
 
 	Default: 'chainping_fudge' => 0.3, # if less than 0.3 * rel1 * rel2 make it, the chain is really broken
 
 =item B<chainping_grace>
 
-Which factor of time in addition to the guessed latency
-derived from one-hop stats before a chain ping is considered list
+The factor of time in addition to the guessed latency
+derived from one-hop stats before a chain ping is considered lost
 
 	Default: 'chainping_grace' => 1.5, # don't count pings sent no longer than 1.5 * (lat1 + lat2) ago
 
@@ -715,7 +720,7 @@ declaring a chain broken.
 =item B<chainping_allbad_factor>
 
 How many chains C<(A x)> must be bad before C<(A *)> is listed.
-The amount is given as factor of all available remailers.
+The value is given as a proportion of all available remailers.
 
 	Default: chainping_allbad_factor => 0.5, # at least 50% of possible chains (A x) need to fail for (A *) to be listed in broken chains
 
@@ -761,7 +766,7 @@ Pings mixmaster remailers.
 
 =item B<which_chainpings>
 
-B<which_chainpings> controls some respects of chain pinging.
+B<which_chainpings> controls some aspects of chain pinging.
 It's a hash over chaintypes - currently B<mix> and B<cpunk>.
 Each entry is a reference to an array which specifies the
 preference for key types in that chaintype.
@@ -771,8 +776,8 @@ preference for key types in that chaintype.
 	   'mix' => [ qw{mix} ]
 	  },
 
-This means that in case of cpunk chain pings we prefer
-using cpunk-dsa over cpunk-rsa which in return we prefer
+This means that in the case of cpunk chain pings we prefer
+using cpunk-dsa over cpunk-rsa which in turn we prefer
 to cpunk-clear.  For mix there's only mix.
 
 =item B<pings_weight>