From a0669b30f3831cc57c8ac69adc9a822d305b50bb Mon Sep 17 00:00:00 2001 From: onefang Date: Tue, 25 Jun 2019 15:23:04 +1000 Subject: OK, let's try THIS style of markdown. Wish it was a real standard. lol --- README.md | 48 ++++++++++++++---------------------------------- 1 file changed, 14 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 4217dc0..1643503 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ will be maintained. Currently the shell scripts and Python scripts are actually being used I think. Evilham asked me to write this, after I badgered him about his Python scripts. -The source code is at [https://sledjhamr.org/cgit/mirror-checker-lua/] +The source code is at [https://sledjhamr.org/cgit/mirror-checker-lua/](https://sledjhamr.org/cgit/mirror-checker-lua/) -The issue tracker is at [https://sledjhamr.org/mantisbt/project_page.php?project_id=13] +The issue tracker is at [https://sledjhamr.org/mantisbt/project_page.php?project_id=13](https://sledjhamr.org/mantisbt/project_page.php?project_id=13) Installation. @@ -51,65 +51,45 @@ the easy to read emails (once I write that bit). Note that unlike typical commands, you can't run single character options together, so this is wrong - -```Shell Session -$ ./mirror-checker.lua -vvv -``` + $ ./mirror-checker.lua -vvv Instead do this - -```Shell Session -$ ./mirror-checker.lua -v -v -v -``` + $ ./mirror-checker.lua -v -v -v Just run the script to do all of the tests - -```Shell Session -$ ./mirror-checker.lua -``` + $ ./mirror-checker.lua Which will print any errors. If you don't want to see errors - -```Shell Session -$ ./mirror-checker.lua -q -``` + $ ./mirror-checker.lua -q If you want to see warnings to (as usual, the more -v options, the more details) - -```Shell Session -$ ./mirror-checker.lua -v -``` + $ ./mirror-checker.lua -v Or use the usual options for the help and version number - -```Shell Session -$ ./mirror-checker.lua -h -$ ./mirror-checker.lua --help -$ ./mirror-checker.lua --version -``` + $ ./mirror-checker.lua -h + $ ./mirror-checker.lua --help + $ ./mirror-checker.lua --version To run the tests on a specific mirror, for example pkgmaster.devuan.org - -```Shell Session -$ ./mirror-checker.lua pkgmaster.devuan.org -``` + $ ./mirror-checker.lua pkgmaster.devuan.org You can use the --tests option to tune which tests are run, for example to stop IPv6 tests, coz you don't have IPv6 - -```Shell Session -$ ./mirror-checker.lua --tests=-IPv6 -``` + $ ./mirror-checker.lua --tests=-IPv6 To do the same, but not run the HTTPS tests either - -```Shell Session -$ ./mirror-checker.lua --tests=-IPv6,-https -``` + $ ./mirror-checker.lua --tests=-IPv6,-https To only run the http integrity tests, only on IPv6 - -```Shell Session -$ ./mirror-checker.lua --tests=http,Integrity,IPv6 -``` + $ ./mirror-checker.lua --tests=http,Integrity,IPv6 -- cgit v1.1