[tor-commits] [ooni-probe/master] Update manpages for ooniprobe, ooniresources, oonideckgen and oonireport.
art at torproject.org
art at torproject.org
Fri Apr 29 09:42:26 UTC 2016
commit a6897988fb96bae8816dd1bd7973a6e1781757f1
Author: Arturo Filastò <arturo at filasto.net>
Date: Tue Apr 26 21:40:32 2016 +0200
Update manpages for ooniprobe, ooniresources, oonideckgen and oonireport.
* Update versions of oonideckgen and ooniresources
* Clean up the help text of ooniprobe options
---
data/oonideckgen.1 | 7 +++++-
data/ooniprobe.1 | 18 ++++++++++++----
data/oonireport.1 | 4 ++--
data/ooniresources.1 | 22 ++++++++-----------
ooni/deckgen/__init__.py | 2 +-
ooni/oonicli.py | 54 +++++++++++++++++++++++++++-------------------
ooni/resources/__init__.py | 2 +-
7 files changed, 65 insertions(+), 44 deletions(-)
diff --git a/data/oonideckgen.1 b/data/oonideckgen.1
index f808165..e2c8fed 100644
--- a/data/oonideckgen.1
+++ b/data/oonideckgen.1
@@ -35,6 +35,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.B oonideckgen
.RB [ --version ]
.RB [ --help ]
+.RB [ --collector
+.IR httpo://collector-address.onion ]
.RB [ \-c
.IR country-code]
.RB [ \-o
@@ -56,6 +58,9 @@ Display this help and exit.
.BR \-\^c " or " \-\-country-code
Specify the country code for which a test deck should be geneated
.TP
+.BR \-\-collector
+Specify the address of the collector to use for submitting reports.
+.TP
.BR \-\^o " or " \-\-output
Specify in which directory the deck should be written.
.TP
@@ -81,5 +86,5 @@ In order to run deckgen you must have first have run ooniresources --update-inpu
.SH AUTHOR
The Tor Project
.SH COPYRIGHT
-2014, The Tor Project
+2016, The Tor Project
.
diff --git a/data/ooniprobe.1 b/data/ooniprobe.1
index cf3f593..5fa47b4 100644
--- a/data/ooniprobe.1
+++ b/data/ooniprobe.1
@@ -1,6 +1,5 @@
-.\" Man page generated from reStructuredText.
.
-.TH "ooniprobe" "1" "April 29, 2014" "1.0.2" "ooniprobe"
+.TH "ooniprobe" "1" "April 26, 2016" "1.4.0" "ooniprobe"
.SH NAME
ooniprobe - a network censorship measurement tool.
.
@@ -33,7 +32,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.SH SYNOPSIS
.B ooniprobe
-.RB [ \-hnsp ]
+.RB [ \-hnspgN ]
.RB [ --version ]
.RB [ --spew ]
.RB [ \-o
@@ -52,6 +51,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.IR configfile ]
.RB [ \-d
.IR datadir ]
+.RB [ \-a
+.IR annotations]
.I "test_name"
.SH DESCRIPTION
@@ -69,6 +70,12 @@ Display this help and exit.
.BR \-\^n " or " \-\-no\-collector
Disable reporting the net test results to an oonib collector.
.TP
+.BR \-\^N " or " \-\-no\-yamloo
+Disable writing report file to disk.
+.TP
+.BR \-\^g " or " \-\-no\-geoip
+Disable performing geoip lookup.
+.TP
.BR \-\^s " or " \-\-list
List all of the available net tests.
.TP
@@ -103,6 +110,9 @@ Specify a path to the ooniprobe configuration file.
.BR \-\^d " or " \-\-datadir
Specify a path to the ooniprobe data directory
.TP
+.BR \-\^a " or " \-\-annotations
+Annotate the report with a key:value[, key:value] format.
+.TP
.BR \-\-spew
Print an insanely verbose log of everything that happens.
Useful when debugging freezes or locks in complex code.
@@ -1096,5 +1106,5 @@ require for a researcher to assess what is the output of a test.
.SH AUTHOR
The Tor Project
.SH COPYRIGHT
-2014, The Tor Project
+2016, The Tor Project
.
diff --git a/data/oonireport.1 b/data/oonireport.1
index 7910e67..8a91009 100644
--- a/data/oonireport.1
+++ b/data/oonireport.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "oonireport" "1" "June 26, 2014" "1.0.2" "oonireport"
+.TH "oonireport" "1" "April 26, 2016" "0.1.0" "oonireport"
.SH NAME
oonireport - tool for managing ooniprobe reports.
.
@@ -96,5 +96,5 @@ of the collector did not support the specified test.
.SH AUTHOR
The Tor Project
.SH COPYRIGHT
-2014, The Tor Project
+2016, The Tor Project
.
diff --git a/data/ooniresources.1 b/data/ooniresources.1
index 5cd66cf..1e16822 100644
--- a/data/ooniresources.1
+++ b/data/ooniresources.1
@@ -1,8 +1,8 @@
.\" Man page generated from reStructuredText.
.
-.TH "ooniresources" "1" "October 1, 2014" "1.1.4" "ooniresources"
+.TH "ooniresources" "1" "April 26, 2016" "0.2.0" "ooniresources"
.SH NAME
-ooniresources - tool for generating ooniprobe test decks
+ooniresources - tool for updating resources for OONI tests
.
.nr rst2man-indent-level 0
.
@@ -35,14 +35,15 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.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.
+By invoking this command with no arguments the inputs and GeoIP data files
+shall be updated.
+
.SH OPTIONS
.TP
@@ -50,11 +51,11 @@ ooniprobe and related tools.
Display this help and exit.
.TP
.BR \-\-update\-inputs
-This will update the inputs that are used for generating test decks with
+(DEPRECATED) 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
+(DEPRECATED) This will update the maxmind geoip databases that are used for detecting the
probes country and ASN.
.TP
@@ -63,16 +64,11 @@ probes country and ASN.
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.
+every month or so as the data usually does not update or change that often.
.sp
.SH AUTHOR
The Tor Project
.SH COPYRIGHT
-2014, The Tor Project
+2016, The Tor Project
.
diff --git a/ooni/deckgen/__init__.py b/ooni/deckgen/__init__.py
index 3dc1f76..d3ec452 100644
--- a/ooni/deckgen/__init__.py
+++ b/ooni/deckgen/__init__.py
@@ -1 +1 @@
-__version__ = "0.1.0"
+__version__ = "0.2.0"
diff --git a/ooni/oonicli.py b/ooni/oonicli.py
index 4da81bc..09936b6 100644
--- a/ooni/oonicli.py
+++ b/ooni/oonicli.py
@@ -25,31 +25,41 @@ class Options(usage.Options):
" files listed on the command line.")
optFlags = [["help", "h"],
- ["no-collector", "n", "disable writing to collector"],
- ["no-yamloo", "N", "disable writing to YAML file"],
- ["no-geoip", "g"],
- ["list", "s"],
- ["printdeck", "p"],
- ["verbose", "v"]
+ ["no-collector", "n", "Disable writing to collector"],
+ ["no-yamloo", "N", "Disable writing to YAML file"],
+ ["no-geoip", "g", "Disable geoip lookup on start"],
+ ["list", "s", "List the currently installed ooniprobe "
+ "nettests"],
+ ["printdeck", "p", "Print the equivalent deck for the "
+ "provided command"],
+ ["verbose", "v", "Show more verbose information"]
]
optParameters = [
- ["reportfile", "o", None, "report file name"],
- ["testdeck", "i", None,
- "Specify as input a test deck: a yaml file containing the tests to run and their arguments"],
- ["collector", "c", None,
- "Address of the collector of test results. This option should not be used, but you should always use a bouncer."],
- ["bouncer", "b", 'httpo://nkvphnp3p6agi5qq.onion',
- "Address of the bouncer for test helpers."],
- ["logfile", "l", None, "log file name"],
- ["pcapfile", "O", None, "pcap file name"],
- ["configfile", "f", None,
- "Specify a path to the ooniprobe configuration file"],
- ["datadir", "d", None,
- "Specify a path to the ooniprobe data directory"],
- ["annotations", "a", None,
- "Annotate the report with a key:value[, key:value] format."],
- ["queue", "Q", None, "AMQP Queue URL amqp://user:pass@host:port/vhost/queue"]]
+ ["reportfile", "o", None, "Specify the report file name to write to."],
+ ["testdeck", "i", None, "Specify as input a test deck: a yaml file "
+ "containing the tests to run and their "
+ "arguments."],
+ ["collector", "c", None, "Specify the address of the collector for "
+ "test results. In most cases a user will "
+ "prefer to specify a bouncer over this."],
+ ["bouncer", "b", 'httpo://nkvphnp3p6agi5qq.onion', "Specify the "
+ "bouncer used to "
+ "obtain the "
+ "address of the "
+ "collector and "
+ "test helpers."],
+ ["logfile", "l", None, "Write to this logs to this filename."],
+ ["pcapfile", "O", None, "Write a PCAP of the ooniprobe session to "
+ "this filename."],
+ ["configfile", "f", None, "Specify a path to the ooniprobe "
+ "configuration file."],
+ ["datadir", "d", None, "Specify a path to the ooniprobe data "
+ "directory."],
+ ["annotations", "a", None, "Annotate the report with a key:value[, "
+ "key:value] format."],
+ ["queue", "Q", None, "AMQP Queue URL amqp://user:pass@host:port/vhost/queue"]
+ ]
compData = usage.Completions(
extraActions=[usage.CompleteFiles(
diff --git a/ooni/resources/__init__.py b/ooni/resources/__init__.py
index 8b7e63b..4b163bb 100644
--- a/ooni/resources/__init__.py
+++ b/ooni/resources/__init__.py
@@ -1,6 +1,6 @@
from ooni import __version__ as ooniprobe_version
-__version__ = "0.1.0"
+__version__ = "0.2.0"
ooni_resources_url = ("https://github.com/TheTorProject/ooni-probe/releases"
"/download/v{}/ooni-resources.tar.gz").format(ooniprobe_version)
More information about the tor-commits
mailing list