summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Palfrader <peter@palfrader.org>2002-12-13 06:44:21 +0000
committerPeter Palfrader <peter@palfrader.org>2002-12-13 06:44:21 +0000
commit29d1f181b53134940dc70b839977e042a6bc8be4 (patch)
treec5d17dd2d1dea5fcec6ecc40de8a7130adae8423
parenteefbaf93fee84bc9f37e07fe7d251d4006ad9df2 (diff)
Minor documentation fixes by Colin Tuckley
-rw-r--r--NEWS1
-rw-r--r--doc/pingd.conf.pod43
-rwxr-xr-xpingd28
3 files changed, 36 insertions, 36 deletions
diff --git a/NEWS b/NEWS
index aea6f57..f765bd4 100644
--- a/NEWS
+++ b/NEWS
@@ -1,6 +1,7 @@
Changes in
* Have support for translated templates
* Use CSS - they need to be trimmed, I don't like Sergiusz's colors
+ * Minor documentation fixes by Colin Tuckley
* thesaurusindexfile and indexfilebasename config values should not
longer have the extension (.html) in them
FIXME - handle this gracefully for now
diff --git a/doc/pingd.conf.pod b/doc/pingd.conf.pod
index a0af135..2ba3d0f 100644
--- a/doc/pingd.conf.pod
+++ b/doc/pingd.conf.pod
@@ -6,8 +6,8 @@ pingd.conf - configuration file for the Echolot ping daemon
=head1 DESCRIPTION
-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
+The file B<pingd.conf> sets configuration parameters for Echolot pingd(1).
+It is a Perl script that gets eval()ed from within pingd. It has to set the
values in the $CONFIG hash.
=cut
@@ -20,7 +20,7 @@ values in the $CONFIG hash.
=item B<sitename>
-A short name for your site/pinger. Is used in the statistics produced.
+A short name for your site/pinger. It is used in the statistics produced.
Default: none
Example: 'sitename' => 'testsite',
@@ -66,7 +66,7 @@ The B<recipient_delimiter> parameter specifies the separator between user names
and address extensions (user+foo).
If it is an empty string Echolot does not make use of user defined mailboxes
-but rather encodes the message type et al in a Comment/Realname part of an
+but rather encodes the message type etc in a Comment/Realname part of an
address.
The use of recipient_delimiter is strongly recommended if your MTA setup
@@ -167,23 +167,23 @@ only unencrypted pings.
=item B<combined_list> [bool]
-Build a combined list of all different stats too. While this is no
-standard format it is nice to read for a human eye.
+Build a combined list of all different stats too. While there is no
+standard format it is nice to read for the human eye.
Default: 'combined_list' => 0,
Example: 'combined_list' => 1,
=item B<thesaurus> [bool]
-Collect Thesaurus data and build Thesaurus' Index.
+Collect Thesaurus data and build Thesaurus Index.
Default: 'thesaurus' => 1,
Example: 'thesaurus' => 0,
=item B<stats_sort_by_latency>
-In statistics output remailers are sorted by reliability as the primary key.
-The secondary key usually is nickname. If you prefer to sort by latency rather
+In the statistics output remailers are sorted by reliability as the primary key.
+The secondary key is usually nickname. If you prefer to sort by latency rather
than nick set this to 1 (-1 if you want to reverse the order).
Default: 'stats_sort_by_latency' => 0,
@@ -207,7 +207,7 @@ How often to process incoming email.
=item B<buildstats> [seconds]
-How often to build mlist et al.
+How often to build mlist etc.
Default: 'buildstats' => 5*60, # every 5 minutes
Example: 'buildstats' => 60*60, # hourly
@@ -260,7 +260,7 @@ B<getkeyconf_every_nth_time> time.
How often to check assumed dead remailers for resurrection.
Default: 'check_resurrection' => 7*24*60*60, # weekly
- Example: 'check_resurrection' => 24*24*60*60, # every other week
+ Example: 'check_resurrection' => 14*24*60*60, # every other week
=item B<pinger_interval> [seconds]
@@ -288,7 +288,7 @@ dead.
=item B<check_resurrection_ttl> [integer]
-How many times to request remailer-xxx from a assumed dead remailer (done every
+How many times to request remailer-xxx from an assumed dead remailer (done every
B<check_resurrection> seconds, weekly per default) without a reply before it is
really considered dead.
@@ -299,14 +299,14 @@ really considered dead.
How long to keep information about a prospective address in the database.
Addresses that are not committed to the list of remailer addresses are
-expired after that time.
+expired after this time.
Default: 'prospective_addresses_ttl' => 5*24*60*60, # 5 days
Example: 'prospective_addresses_ttl' =>14*24*60*60, # 2 weeks
=item B<reliable_auto_add_min> [integer]
-How many different remailer need to list an address in Reliable's remailer-conf
+How many different remailers need to list an address in Reliable's remailer-conf
reply to get it committed to the list of remailer addresses.
Default: 'reliable_auto_add_min' => 3,
@@ -314,22 +314,21 @@ reply to get it committed to the list of remailer addresses.
=item B<expire_keys> [seconds]
-After which time to expire received keys if they were not updated
-by remailer-key replies.
+After how long to expire received keys if they were not updated by remailer-key replies.
Default: 'expire_keys' => 5*24*60*60, # 5 days
Example: 'expire_keys' => 7*24*60*60, # 1 week
=item B<expire_confs> [seconds]
-After which time to expire received remailer-conf replies.
+After how long to expire received remailer-conf replies.
Default: 'expire_confs' => 5*24*60*60, # 5 days
Example: 'expire_confs' => 7*24*60*60, # 1 week
=item B<expire_pings> [seconds]
-After which time to expire pings. 12 is the value of choice
+After how long to expire pings. 12 is the value of choice
because that is the time frame the statistics show. You should
not make this smaller than 12 days.
@@ -337,7 +336,7 @@ not make this smaller than 12 days.
=item B<expire_thesaurus> [seconds]
-After which time to expire files in the thesaurus directory.
+After how long to expire files in the thesaurus directory.
Default: 'expire_thesaurus' => 21*24*60*60, # 2 weeks
Example: 'expire_thesaurus' => 7*24*60*60, # 1 week
@@ -367,7 +366,7 @@ How many backups of metadata to keep.
=item B<homedir>
The base directory of the Echolot installation. All other filenames and
-directorynames are local to this directory. B<pingd> changes into this
+directory names are local to this directory. B<pingd> changes into this
directory upon startup.
Default: The directory in which pingd is.
@@ -441,7 +440,7 @@ is used.
Name of the gzip executable. If it is not in your PATH make sure to
include path information.
- Default: 'gnupg' => 'gzip',
+ Default: 'gzip' => 'gzip',
=item B<mixhome>
@@ -508,7 +507,7 @@ important infrastructure. If it does not exist, the part is skipped in
generated stats. Otherwise its content is copied in verbatim.
Default: 'sameop' => 'sameop.txt',
- Example conent:
+ Example content:
(xganon2 xganon)
(cracker redneck)
diff --git a/pingd b/pingd
index 4de236a..dad576f 100755
--- a/pingd
+++ b/pingd
@@ -3,7 +3,7 @@
$| = 1;
# (c) 2002 Peter Palfrader <peter@palfrader.org>
-# $Id: pingd,v 1.82 2002/10/25 11:00:07 weasel Exp $
+# $Id: pingd,v 1.83 2002/12/13 06:44:21 weasel Exp $
#
=pod
@@ -48,7 +48,7 @@ pingd - echolot ping daemon
=head1 DESCRIPTION
-pingd is a the heart of echolot. Echolot is a pinger for anonymous remailers.
+pingd is the heart of echolot. Echolot is a pinger for anonymous remailers.
A Pinger in the context of anonymous remailers is a program that regularily
sends messages through remailers to check their reliability. It then calculates
@@ -59,7 +59,7 @@ Additionally it collects configuration parameters and keys of all remailers and
offers them in a format readable by remailer clients.
When called without parameters pingd schedules tasks like sending pings,
-processing incoming mail and requesting remailer-xxx data and runs them in
+processing incoming mail and requesting remailer-xxx data and runs them at
configurable intervalls.
=head1 COMMANDS
@@ -78,7 +78,7 @@ Send the running pingd process a SIGTERM.
Sends a HUP signal to the daemon which instructs it to process the commands.
-For other affects of sending the HUP Signal see the SIGNALS section below.
+For other effects of sending the HUP Signal see the SIGNALS section below.
=item B<add> I<address> [I<address> ...]
@@ -162,7 +162,7 @@ Dumps the current configuration to standard output.
=item B<--basedir>
-The home directory to which everything else is relative to. See the BASE
+The home directory to which everything else is relative. See the BASE
DIRECTORY section below.
=item B<--verbose>
@@ -171,11 +171,11 @@ Verbose mode. Causes B<pingd> to print debugging messages about its progress.
=item B<--quiet>
-Quiet mode. Be even more quient than normally.
+Quiet mode. Be even quieter than normal.
=item B<--help>
-Print a short help and exit sucessfully.
+Print a short help message and exit sucessfully.
=item B<--version>
@@ -190,7 +190,7 @@ B<buildkeys>, or B<buildthesaurus> command.
Don't send a HUP signal to the daemon which instructs it to process the
commands after adding the command to the task list.
-Per default such a signal is sent.
+By default such a signal is sent.
=item B<--process>
@@ -208,10 +208,10 @@ Tell B<pingd> to detach.
=head1 BASE DIRECTORY
-The home directory to which everything else is relative to.
+The home directory to which everything else is relative.
Basedir defaults to whatever directory the B<pingd> binary is located. It can
-get overridden by the B<ECHOLOT_HOME> environment variable which in turn is
+be overridden by the B<ECHOLOT_HOME> environment variable which in turn is
weaker than the B<--basedir> setting.
This directory is then used to locate the configuration file B<pingd.conf> (see
@@ -221,7 +221,7 @@ The B<homedir> setting in B<pingd.conf> finally sets the base directory.
=head1 FILES
-The configuration file is searched in those places in that order:
+The configuration file is searched in these places in this order:
=over
@@ -255,12 +255,12 @@ The configuration file is searched in those places in that order:
On B<SIGINT>, B<SIGQUIT>, and B<SIGTERM> B<pingd> will schedule a shutdown
for as soon as the current actions are finished or immediatly if no actions are
-currently beeing processed. It will then write all metadata and pingdata to
+currently being processed. It will then write all metadata and pingdata to
disk and close all files cleanly before exiting.
On B<SIGHUP> <pingd> will execute any pending commands from the commands file
-(B<commands.txt> per default). It also closes and reopens the file 'output'
-which is used for stdout and stderr in case the daemon was told to detach.
+(B<commands.txt> by default). It also closes and reopens the file 'output'
+which is used for stdout and stderr when the daemon is running detached.
This can be used if you want to rotate that file.
=head1 AUTHOR