aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authoronefang2019-06-25 15:23:04 +1000
committeronefang2019-06-25 15:23:04 +1000
commita0669b30f3831cc57c8ac69adc9a822d305b50bb (patch)
tree0944a10fd56bd17ac0796fca7f1a08f4aa79839f /README.md
parentAdd actual markdown. (diff)
downloadapt-panopticon-a0669b30f3831cc57c8ac69adc9a822d305b50bb.zip
apt-panopticon-a0669b30f3831cc57c8ac69adc9a822d305b50bb.tar.gz
apt-panopticon-a0669b30f3831cc57c8ac69adc9a822d305b50bb.tar.bz2
apt-panopticon-a0669b30f3831cc57c8ac69adc9a822d305b50bb.tar.xz
OK, let's try THIS style of markdown.
Wish it was a real standard. lol
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files 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
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/](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](https://sledjhamr.org/mantisbt/project_page.php?project_id=13)
19 19
20 20
21Installation. 21Installation.
@@ -51,65 +51,45 @@ 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```Shell Session 54 $ ./mirror-checker.lua -vvv
55$ ./mirror-checker.lua -vvv
56```
57 55
58Instead do this - 56Instead do this -
59 57
60```Shell Session 58 $ ./mirror-checker.lua -v -v -v
61$ ./mirror-checker.lua -v -v -v
62```
63 59
64Just run the script to do all of the tests - 60Just run the script to do all of the tests -
65 61
66```Shell Session 62 $ ./mirror-checker.lua
67$ ./mirror-checker.lua
68```
69 63
70Which will print any errors. If you don't want to see errors - 64Which will print any errors. If you don't want to see errors -
71 65
72```Shell Session 66 $ ./mirror-checker.lua -q
73$ ./mirror-checker.lua -q
74```
75 67
76If you want to see warnings to (as usual, the more -v options, the more 68If you want to see warnings to (as usual, the more -v options, the more
77details) - 69details) -
78 70
79```Shell Session 71 $ ./mirror-checker.lua -v
80$ ./mirror-checker.lua -v
81```
82 72
83Or use the usual options for the help and version number - 73Or use the usual options for the help and version number -
84 74
85```Shell Session 75 $ ./mirror-checker.lua -h
86$ ./mirror-checker.lua -h 76 $ ./mirror-checker.lua --help
87$ ./mirror-checker.lua --help 77 $ ./mirror-checker.lua --version
88$ ./mirror-checker.lua --version
89```
90 78
91To run the tests on a specific mirror, for example pkgmaster.devuan.org - 79To run the tests on a specific mirror, for example pkgmaster.devuan.org -
92 80
93```Shell Session 81 $ ./mirror-checker.lua pkgmaster.devuan.org
94$ ./mirror-checker.lua pkgmaster.devuan.org
95```
96 82
97You can use the --tests option to tune which tests are run, for example 83You can use the --tests option to tune which tests are run, for example
98to stop IPv6 tests, coz you don't have IPv6 - 84to stop IPv6 tests, coz you don't have IPv6 -
99 85
100```Shell Session 86 $ ./mirror-checker.lua --tests=-IPv6
101$ ./mirror-checker.lua --tests=-IPv6
102```
103 87
104To do the same, but not run the HTTPS tests either - 88To do the same, but not run the HTTPS tests either -
105 89
106```Shell Session 90 $ ./mirror-checker.lua --tests=-IPv6,-https
107$ ./mirror-checker.lua --tests=-IPv6,-https
108```
109 91
110To only run the http integrity tests, only on IPv6 - 92To only run the http integrity tests, only on IPv6 -
111 93
112```Shell Session 94 $ ./mirror-checker.lua --tests=http,Integrity,IPv6
113$ ./mirror-checker.lua --tests=http,Integrity,IPv6
114```
115 95