speedtest-cli/speedtest-cli.1

.TH "speedtest-cli" 1 "2018-01-05" "speedtest-cli"
.SH NAME
speedtest\-cli \- Command line interface for testing internet bandwidth using speedtest.net
.SH SYNOPSIS
.B speedtest\-cli
[OPTION...]
.SH DESCRIPTION
Speedtest.net is a web service for testing your broadband connection by downloading a file
from a nearby speedtest.net server on the web. This tool allows you to access the service
from the command line.

Speedtest mini is a version of the Speedtest.net server that you can host locally.

.SH OPTIONS
Usage: speedtest\-cli [OPTION...]

.B Help Options

\fB\-h, \-\-help\fR
.RS
Displays usage for the tool.
.RE

.B Options

\fB\-\-no\-download\fR
.RS
Do not perform download test
.RE

\fB\-\-no\-upload\fR
.RS
Do not perform upload test
.RE

\fB\-\-single\fR
.RS
Only use a single connection instead of multiple. This simulates a typical file transfer.
.RE

\fB\-\-bytes\fR
.RS
Display values in bytes instead of bits. Does not affect the image generated by \-\-share, nor output from \-\-json or \-\-csv
.RE

\fB\-\-share\fR
.RS
Generate and provide a URL to the speedtest.net share results image, not displayed with \-\-csv
.RE

\fB\-\-simple\fR
.RS
Suppress verbose output, only show basic information
.RE

\fB\-\-csv\fR
.RS
Suppress verbose output, only show basic information in CSV format. Speeds listed in bit/s and not affected by \-\-bytes
.RE

\fB\-\-csv\-delimiter CSV_DELIMITER\fR
.RS
Single character delimiter to use in CSV output. Default ","
.RE

\fB\-\-csv\-header\fR
.RS
Print CSV headers
.RE

\fB\-\-json\fR
.RS
Suppress verbose output, only show basic information in JSON format. Speeds listed in bit/s and not affected by \-\-bytes
.RE

\fB\-\-list\fR
.RS
Display a list of speedtest.net servers sorted by distance
.RE

\fB\-\-server SERVER\fR
.RS
Specify a server ID to test against. Can be supplied multiple times
.RE

\fB\-\-exclude EXCLUDE\fR
.RS
Exclude a server from selection. Can be supplied multiple times
.RE

\fB\-\-mini MINI\fR
.RS
URL of the Speedtest Mini server
.RE

\fB\-\-source SOURCE\fR
.RS
Source IP address to bind to
.RE

\fB\-\-timeout TIMEOUT\fR
.RS
HTTP timeout in seconds. Default 10
.RE

\fB\-\-secure\fR
.RS
Use HTTPS instead of HTTP when communicating with speedtest.net operated servers
.RE

\fB\-\-no\-pre\-allocate\fR
.RS
Do not pre allocate upload data. Pre allocation is enabled by default to improve upload performance. To support systems with insufficient memory, use this option to avoid a MemoryError
.RE

\fB\-\-version\fR
.RS
Show the version number and exit
.RE

.SH EXAMPLES

\fBAutomatically find closest server and start testing\fR
.RS
speedtest\-cli
.RE

\fBSpecify testing against server 1491\fR
.RS
speedtest-cli \-\-server 1491
.RE

\fBTesting against Speedtest Mini\fR
.RS
speedtest-cli \-\-mini 172.18.66.1
.RE

.SH REPORTING BUGS
Please file issues on the Github bug tracker: https://github.com/sivel/speedtest\-cli

.SH AUTHORS
This manual page was written by Jonathan Carter <jonathan@ubuntu.com>
Speedtest\-cli was written by Matt Martz <matt@sivel.net>
Update man page 2018-02-05 23:16:51 +01:00			`.TH "speedtest-cli" 1 "2018-01-05" "speedtest-cli"`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.SH NAME`
update usage information 2016-09-13 16:02:29 +02:00			`speedtest\-cli \- Command line interface for testing internet bandwidth using speedtest.net`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.SH SYNOPSIS`
Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`.B speedtest\-cli`
update usage information 2016-09-13 16:02:29 +02:00			`[OPTION...]`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.SH DESCRIPTION`
			`Speedtest.net is a web service for testing your broadband connection by downloading a file`
			`from a nearby speedtest.net server on the web. This tool allows you to access the service`
			`from the command line.`

			`Speedtest mini is a version of the Speedtest.net server that you can host locally.`

			`.SH OPTIONS`
Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`Usage: speedtest\-cli [OPTION...]`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00
			`.B Help Options`

Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`\fB\-h, \-\-help\fR`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.RS`
			`Displays usage for the tool.`
			`.RE`

			`.B Options`

Update man page 2018-02-05 23:16:51 +01:00			`\fB\-\-no\-download\fR`
			`.RS`
			`Do not perform download test`
			`.RE`

			`\fB\-\-no\-upload\fR`
			`.RS`
			`Do not perform upload test`
			`.RE`

Update usage 2019-03-11 15:57:19 +01:00			`\fB\-\-single\fR`
			`.RS`
			`Only use a single connection instead of multiple. This simulates a typical file transfer.`
			`.RE`

Update man page with --bytes argument 2014-04-23 18:52:26 +02:00			`\fB\-\-bytes\fR`
			`.RS`
Update man page 2018-02-05 23:16:51 +01:00			`Display values in bytes instead of bits. Does not affect the image generated by \-\-share, nor output from \-\-json or \-\-csv`
Update man page with --bytes argument 2014-04-23 18:52:26 +02:00			`.RE`

Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`\fB\-\-share\fR`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.RS`
Update man page 2018-02-05 23:16:51 +01:00			`Generate and provide a URL to the speedtest.net share results image, not displayed with \-\-csv`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.RE`

Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`\fB\-\-simple\fR`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.RS`
			`Suppress verbose output, only show basic information`
			`.RE`

update usage information 2016-09-13 16:02:29 +02:00			`\fB\-\-csv\fR`
			`.RS`
			`Suppress verbose output, only show basic information in CSV format. Speeds listed in bit/s and not affected by \-\-bytes`
			`.RE`

Update man page 2018-02-05 23:16:51 +01:00			`\fB\-\-csv\-delimiter CSV_DELIMITER\fR`
update usage information 2016-09-13 16:02:29 +02:00			`.RS`
			`Single character delimiter to use in CSV output. Default ","`
			`.RE`

Update man page 2018-02-05 23:16:51 +01:00			`\fB\-\-csv\-header\fR`
update usage information 2016-09-13 16:02:29 +02:00			`.RS`
			`Print CSV headers`
			`.RE`

			`\fB\-\-json\fR`
			`.RS`
			`Suppress verbose output, only show basic information in JSON format. Speeds listed in bit/s and not affected by \-\-bytes`
			`.RE`

Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`\fB\-\-list\fR`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.RS`
			`Display a list of speedtest.net servers sorted by distance`
			`.RE`

Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`\fB\-\-server SERVER\fR`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.RS`
Update man page 2018-02-05 23:16:51 +01:00			`Specify a server ID to test against. Can be supplied multiple times`
			`.RE`

			`\fB\-\-exclude EXCLUDE\fR`
			`.RS`
			`Exclude a server from selection. Can be supplied multiple times`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.RE`

Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`\fB\-\-mini MINI\fR`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.RS`
			`URL of the Speedtest Mini server`
			`.RE`

Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`\fB\-\-source SOURCE\fR`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.RS`
			`Source IP address to bind to`
			`.RE`

update usage information 2016-09-13 16:02:29 +02:00			`\fB\-\-timeout TIMEOUT\fR`
			`.RS`
			`HTTP timeout in seconds. Default 10`
			`.RE`

			`\fB\-\-secure\fR`
			`.RS`
			`Use HTTPS instead of HTTP when communicating with speedtest.net operated servers`
			`.RE`

Update man page 2018-02-05 23:16:51 +01:00			`\fB\-\-no\-pre\-allocate\fR`
			`.RS`
			`Do not pre allocate upload data. Pre allocation is enabled by default to improve upload performance. To support systems with insufficient memory, use this option to avoid a MemoryError`
			`.RE`

Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`\fB\-\-version\fR`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.RS`
			`Show the version number and exit`
			`.RE`

			`.SH EXAMPLES`

			`\fBAutomatically find closest server and start testing\fR`
			`.RS`
Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`speedtest\-cli`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.RE`

			`\fBSpecify testing against server 1491\fR`
			`.RS`
Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`speedtest-cli \-\-server 1491`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.RE`

			`\fBTesting against Speedtest Mini\fR`
			`.RS`
Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`speedtest-cli \-\-mini 172.18.66.1`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00			`.RE`

			`.SH REPORTING BUGS`
Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`Please file issues on the Github bug tracker: https://github.com/sivel/speedtest\-cli`
Add speedtest-cli man page 2014-01-26 14:48:48 +01:00
			`.SH AUTHORS`
			`This manual page was written by Jonathan Carter <jonathan@ubuntu.com>`
Properly escape minus signs so that they don't become hyphens 2014-02-10 21:24:43 +01:00			`Speedtest\-cli was written by Matt Martz <matt@sivel.net>`