aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authoronefang2019-06-25 15:15:33 +1000
committeronefang2019-06-25 15:15:33 +1000
commit1356a175a7c9a022a45df198e976d94dc53a38a6 (patch)
tree0b9f504218231bceb9e76d2daaccbed65bbcc8fc
parentAdd the actual source code, and the basic documentation. (diff)
downloadapt-panopticon-1356a175a7c9a022a45df198e976d94dc53a38a6.zip
apt-panopticon-1356a175a7c9a022a45df198e976d94dc53a38a6.tar.gz
apt-panopticon-1356a175a7c9a022a45df198e976d94dc53a38a6.tar.bz2
apt-panopticon-1356a175a7c9a022a45df198e976d94dc53a38a6.tar.xz
Add actual markdown.
-rw-r--r--README.md48
1 files changed, 34 insertions, 14 deletions
diff --git a/README.md b/README.md
index 415025c..4217dc0 100644
--- a/README.md
+++ b/README.md
@@ -13,9 +13,9 @@ will be maintained. Currently the shell scripts and Python scripts are
13actually being used I think. Evilham asked me to write this, after I 13actually being used I think. Evilham asked me to write this, after I
14badgered him about his Python scripts. 14badgered him about his Python scripts.
15 15
16The source code is at https://sledjhamr.org/cgit/mirror-checker-lua/ 16The source code is at [https://sledjhamr.org/cgit/mirror-checker-lua/]
17 17
18The issue tracker is at https://sledjhamr.org/mantisbt/project_page.php?project_id=13 18The issue tracker is at [https://sledjhamr.org/mantisbt/project_page.php?project_id=13]
19 19
20 20
21Installation. 21Installation.
@@ -51,45 +51,65 @@ the easy to read emails (once I write that bit).
51Note that unlike typical commands, you can't run single character options 51Note that unlike typical commands, you can't run single character options
52together, so this is wrong - 52together, so this is wrong -
53 53
54./mirror-checker.lua -vvv 54```Shell Session
55$ ./mirror-checker.lua -vvv
56```
55 57
56Instead do this - 58Instead do this -
57 59
58./mirror-checker.lua -v -v -v 60```Shell Session
61$ ./mirror-checker.lua -v -v -v
62```
59 63
60Just run the script to do all of the tests - 64Just run the script to do all of the tests -
61 65
62./mirror-checker.lua 66```Shell Session
67$ ./mirror-checker.lua
68```
63 69
64Which will print any errors. If you don't want to see errors - 70Which will print any errors. If you don't want to see errors -
65 71
66./mirror-checker.lua -q 72```Shell Session
73$ ./mirror-checker.lua -q
74```
67 75
68If you want to see warnings to (as usual, the more -v options, the more 76If you want to see warnings to (as usual, the more -v options, the more
69details) - 77details) -
70 78
71./mirror-checker.lua -v 79```Shell Session
80$ ./mirror-checker.lua -v
81```
72 82
73Or use the usual options for the help and version number - 83Or use the usual options for the help and version number -
74 84
75./mirror-checker.lua -h 85```Shell Session
76./mirror-checker.lua --help 86$ ./mirror-checker.lua -h
77./mirror-checker.lua --version 87$ ./mirror-checker.lua --help
88$ ./mirror-checker.lua --version
89```
78 90
79To run the tests on a specific mirror, for example pkgmaster.devuan.org - 91To run the tests on a specific mirror, for example pkgmaster.devuan.org -
80 92
81./mirror-checker.lua pkgmaster.devuan.org 93```Shell Session
94$ ./mirror-checker.lua pkgmaster.devuan.org
95```
82 96
83You can use the --tests option to tune which tests are run, for example 97You can use the --tests option to tune which tests are run, for example
84to stop IPv6 tests, coz you don't have IPv6 - 98to stop IPv6 tests, coz you don't have IPv6 -
85 99
86./mirror-checker.lua --tests=-IPv6 100```Shell Session
101$ ./mirror-checker.lua --tests=-IPv6
102```
87 103
88To do the same, but not run the HTTPS tests either - 104To do the same, but not run the HTTPS tests either -
89 105
90./mirror-checker.lua --tests=-IPv6,-https 106```Shell Session
107$ ./mirror-checker.lua --tests=-IPv6,-https
108```
91 109
92To only run the http integrity tests, only on IPv6 - 110To only run the http integrity tests, only on IPv6 -
93 111
94./mirror-checker.lua --tests=http,Integrity,IPv6 112```Shell Session
113$ ./mirror-checker.lua --tests=http,Integrity,IPv6
114```
95 115