commit 946c6e3c627ba55d32751b73f963f70d97f7cc09 Author: Arturo Filastò art@fuffa.org Date: Wed Oct 1 15:55:48 2014 +0200

Add manpages for oonideckgen and ooniresources --- MANIFEST.in | 2 ++ data/oonideckgen.1 | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++ data/ooniresources.1 | 78 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 165 insertions(+)

diff --git a/MANIFEST.in b/MANIFEST.in index 2abe681..da56999 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -5,5 +5,7 @@ include data/GeoIP.dat include data/GeoIPASNum.dat include data/GeoLiteCity.dat include data/ooniprobe.conf.sample +include data/oonideckgen.1 include data/ooniprobe.1 include data/oonireport.1 +include data/ooniresources.1 diff --git a/data/oonideckgen.1 b/data/oonideckgen.1 new file mode 100644 index 0000000..9406d98 --- /dev/null +++ b/data/oonideckgen.1 @@ -0,0 +1,85 @@ +." Man page generated from reStructuredText. +. +.TH "oonideckgen" "1" "October 1, 2014" "1.1.4" "oonideckgen" +.SH NAME +oonideckgen - tool for generating ooniprobe test decks +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\$1 \n[an-margin] +level \n[rst2man-indent-level] +level margin: \n[rst2man-indent\n[rst2man-indent-level]] +- +\n[rst2man-indent0] +\n[rst2man-indent1] +\n[rst2man-indent2] +.. +.de1 INDENT +." .rstReportMargin pre: +. RS \$1 +. nr rst2man-indent\n[rst2man-indent-level] \n[an-margin] +. nr rst2man-indent-level +1 +." .rstReportMargin post: +.. +.de UNINDENT +. RE +." indent \n[an-margin] +." old: \n[rst2man-indent\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +." new: \n[rst2man-indent\n[rst2man-indent-level]] +.in \n[rst2man-indent\n[rst2man-indent-level]]u +.. + +.SH SYNOPSIS +.B oonideckgen +.RB [ --version ] +.RB [ --help ] +.RB [ -c +.IR country-code] +.RB [ -o +.IR output] + +.SH DESCRIPTION +.sp +oonideckgen will generate a ooniprobe test deck for the specified country. This +will then allow the user to conduct measurements useful to assess internet +censorship in that country. + + +.SH OPTIONS + +.TP +.BR -^h " or " --help +Display this help and exit. +.TP +.BR -^c " or " --country-code +Specify the country code for which a test deck should be geneated +.TP +.BR -^o " or " --output +Specify in which directory the deck should be written. +.TP + + +.SH OONIDECKGEN +.sp +This tools will generate a test deck that include the following tests: + +* blocking/http_requests, with a set of relevant sites for the country to be analysed + +* blocking/dns_consistency, with all the DNS resolver of the country to be analysed and a set of relevant sites + +* manipulation/http_invalid_request_line + +* manipulation/http_header_field_manipulation + +If deckgen is run with no arugment a geoip lookup is done on the IP of the user +and that country is chosen. +In order to run deckgen you must have first have run ooniresource --update-inputs. +.sp + +.SH AUTHOR +The Tor Project +.SH COPYRIGHT +2014, The Tor Project +. diff --git a/data/ooniresources.1 b/data/ooniresources.1 new file mode 100644 index 0000000..5cd66cf --- /dev/null +++ b/data/ooniresources.1 @@ -0,0 +1,78 @@ +." Man page generated from reStructuredText. +. +.TH "ooniresources" "1" "October 1, 2014" "1.1.4" "ooniresources" +.SH NAME +ooniresources - tool for generating ooniprobe test decks +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\$1 \n[an-margin] +level \n[rst2man-indent-level] +level margin: \n[rst2man-indent\n[rst2man-indent-level]] +- +\n[rst2man-indent0] +\n[rst2man-indent1] +\n[rst2man-indent2] +.. +.de1 INDENT +." .rstReportMargin pre: +. RS \$1 +. nr rst2man-indent\n[rst2man-indent-level] \n[an-margin] +. nr rst2man-indent-level +1 +." .rstReportMargin post: +.. +.de UNINDENT +. RE +." indent \n[an-margin] +." old: \n[rst2man-indent\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +." new: \n[rst2man-indent\n[rst2man-indent-level]] +.in \n[rst2man-indent\n[rst2man-indent-level]]u +.. + +.SH SYNOPSIS +.B ooniresources +.RB [ --version ] +.RB [ --help ] +.RB [ --update-inputs ] +.RB [ --update-geoip ] + +.SH DESCRIPTION +.sp +ooniresources will update the resources that are needed for the functioning of +ooniprobe and related tools. + +.SH OPTIONS + +.TP +.BR -^h " or " --help +Display this help and exit. +.TP +.BR --update-inputs +This will update the inputs that are used for generating test decks with +oonideckgen. +.TP +.BR --update-geoip +This will update the maxmind geoip databases that are used for detecting the +probes country and ASN. +.TP + +.SH OONIRESOURCES +.sp +This tools will update the resources needed for running ooniprobe and +oonideckgen. +You don't need to run it very often, but it's just sufficient to run it once +every month of so as the data usually does not update or change that often. +If you are seeing some errors related to the geoip subsystem not having some +Maxmind databases, you probably want to run: +ooniresources --update-geoip. +If on the other hand you are interested in using oonideckgen, you should run: +ooniresources --update-inputs. +.sp + +.SH AUTHOR +The Tor Project +.SH COPYRIGHT +2014, The Tor Project +.