.TH "pathspider" "1" "October 2016" "MAMI Project" "User Commands"
.SH NAME
pathspider - Internet Path Transparency Measurement Tool
.SH SYNOPSIS
usage: pathspider [\-h] [\-s] [\-i INTERFACE] [\-w WORKERS] [\-\-input INPUTFILE] [\-\-output OUTPUTFILE] [\-v] PLUGIN ...
.SH DESCRIPTION
For each target PATHspider enqueues a job, to be distributed amongst the worker threads when
available. Each worker performs one connection with the “A” configuration and
one connection with the “B” configuration. The “A” configuration will always be
connected first and serves as the base line measurement, followed by the “B”
configuration.
.SH OPTIONS
.SS "Optional Arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-s\fR, \fB\-\-standalone\fR
run in standalone mode. this is the default mode (and
currently the only supported mode). in the future,
mplane will be supported as a mode of operation.
.TP
\fB\-i\fR INTERFACE, \fB\-\-interface\fR INTERFACE
the interface to use for the observer
.TP
\fB\-w\fR WORKERS, \fB\-\-workers\fR WORKERS
number of workers to use
.TP
\fB\-\-input\fR INPUTFILE
a file containing a list of remote hosts to test, with
any accompanying metadata expected by the pathspider
test. this file should be formatted as a commaseperated values file. Defaults to standard input.
.TP
\fB\-\-output\fR OUTPUTFILE
the file to output results data to. Defaults to
standard output.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
log debug\-level output.
.SS "Plugins:"
.TP
tfo
TCP Fast Open
.TP
ecn
Explicit Congestion Notification
.TP
tls
Transport Layer Security
.TP
dscp
DiffServ Codepoints
.TP
dnsresolv
DNS resolution for hostnames to IPv4 and v6 addresses
.SH EXAMPLES
You can run a small study using ECNSpider and the included webinput.csv file to
measure path transparency to ECN for a small selection of web servers:

  # pathspider -i eth0 ecn \\
      </usr/share/doc/pathspider/examples/webinput.csv \\
      >/tmp/results.txt
.SH REPORTING BUGS
Bugs relating to the operation of PATHspider should be filed against the
pathspider package using reportbug(1).
.SH COPYRIGHT
PATHspider is copyrighted by the authors of PATHspider. It is made available
under the terms of the GNU General Public License version 2, or at your option
any later version, which can be found at:

  /usr/share/common-licenses/GPL-2.

This manual page was written for Debian by Iain R. Learmonth <irl@debian.org>
but may be used by others under the same terms.
.SH SEE ALSO
PATHspider provides HTML documentation that explains the development of
PATHspider plugins. This is installed with the pathspider package and can be
found at:

  /usr/share/doc/pathspider/html/index.html

The PATHspider website can be found at https://pathspider.net/.