More documentation, and clean up the existing stuff.

1 files changed, 63 insertions, 23 deletions

diff --git a/README.md b/README.md
index 833f881..982a108 100644
--- a/README.md
+++ b/README.md
@@ -44,14 +44,21 @@ installed -
 * gzip
 * ionice, on Debian based systems it'll be in the util-linux package.
 * luajit
+* lua-rrd
 * LuaSocket, on Debian based systems it'll be in the lua-socket package.
 * md5sum and sha256, on Debian based systems they'll be in the coreutils package.
-* rrdtool, may need to include lua-rrd.
+* rrdtool
 * xz, on Debian based systems it'll be in the xz-utils package.
 
 If you want to have lots of graphs, also install
 [https://sledjhamr.org/cgit/apt-panopticon_cgp/](https://sledjhamr.org/cgit/apt-panopticon_cgp/).
 
+For the apt-panopticon_cgp package, which is used to show the detailed
+graphs, you'll need a web server that supports PHP.  apt-panopticon_cgp
+includes some support files for running PHP via CGI, which more web
+servers support.  You'll need php-cgi for that.
+
+
 Web installation.
 -----------------
 
@@ -83,8 +90,8 @@ Note that two runs of apt-panopticon have to happen ten minutes apart at
 least in order to see any data on the graphs.
 
 If you had already been running apt-panopticon for a while and have lots
-of data collected, the apt-panopticon-RRD-rescue.lua script can go
-through all of that and feed it to RRD.
+of data collected, the apt-panopticon-update-data.lua script can go
+through all of that and feed it to RRD / update the files.
 
 Using it.
 ---------
@@ -151,6 +158,8 @@ redirections.  Unless a specific mirror is given on the command line, the
 mirror_list.txt file from pkgmaster.devuan.org is used to select mirrors
 to test.
 
+explanations.html explains the tests in more detail.
+
 The --tests= option can be used to adjust the list of tests performed.
 
 * IPv4, perform the tests with IPv4 addresses (A records)
@@ -159,11 +168,15 @@ The --tests= option can be used to adjust the list of tests performed.
 * http, test HTTP protocol access.
 * https, test HTTPS protocol access.
 * rsync, test RSYNC protocol access.
-* DNS-RR, ???????????????
+* DNS-RR, Checks if the IPs for this mirror are part of the DNS-RR.
 * Protocol, warn if the protocol changed during a redirect.
+* Redirects test bad redirects, redirecting /DEVUAN/ to deb.devuan.org.
 * URL-Sanity, add gratuitous multiple slashes to the URLs.
-* Integrity, check PGP signatures.
-* Updated, check Release dates.
+* Integrity, check hashes and PGP signatures.
+* Updated, check Release dates and updated packages.
+
+Note that apt-panopticon will detect if you have no IPv6 conectivity, and
+disable IPv6 tests automatically.
 
 The old tests include a "DNS-RR" test, I'm not sure what that is.  I
 guess it checks if the mirror responds properly if it's accessed via it's
@@ -187,20 +200,6 @@ Print the help text.
 
 Print the version.
 
---tests
-
-Select which tests to run.  The arguments are comma separated.  A
-negative argument deselects a test.  Examples are given above.
-
---referenceSite
-
-The mirror to use as a reference for the tests, the default is
-pkgmaster.devuan.org.
-
---roundRobin
-
-The name of the DNS round robin domain, the default is deb.devuan.org.
-
 -v
 
 Print more verbose output.  Normally only CRITICAL and ERROR message sare
@@ -214,11 +213,52 @@ Only print CRITICAL messages.
 -k
 
 Keep any results from the previous runs, instead of deleting them before
-running the tests.
+running the tests.  This may or may not be obsolete.
+
+-4 and -6
+
+Used internally to pass around flags to make sure curl only tries to use
+IPv4 or IPv6 as appropriate.
+
+-o and -r
 
--n
+Used internally to keep track of -origin server and -redirect server.
 
-Don't fork the tests.  Normally each mirror is run in its own fork.
+--bandwidth, --low, --medium, --high, --more, and --all
+
+Enable and disable tests that use more or less bandwidth.  --bandwidth=x
+where x is a digit between 0 and 4, and the other options are aliases for
+those numbers.  So --bandwidth=0 is the same as --low.  --bandwidth=2 or
+--high is the default.
+
+--cgi
+
+Use the php.cgi versions of the URLs for the graphs.
+
+--maxtime, --retries, --timeout, and --timeouts
+
+Various paramaters to determine how long to wait for downloads to
+complete, how many retries to attempt for downloads that fail, how long
+to wait for a connection, and how many timeouts to tolerate.
+
+--referenceSite
+
+The mirror to use as a reference for the tests, the default is
+pkgmaster.devuan.org.
+
+--roundRobin
+
+The name of the DNS round robin domain, the default is deb.devuan.org.
+
+--reports
+
+Select which reports to generate.  The arguments are comma separated.  A
+negative argument deselects a report.
+
+--tests
+
+Select which tests to run.  The arguments are comma separated.  A
+negative argument deselects a test.  Examples are given above.
 
 
 Theory of operation.