walkero
/
speedtest-cli
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

update usage information

This commit is contained in:
Matt Martz 2016-09-13 09:02:29 -05:00
parent 53b760dfba
commit 9e3a5b3a59
2 changed files with 39 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.rst
View File

@ -75,8 +75,8 @@ Usage
$ speedtest-cli -h $ speedtest-cli -h
usage: speedtest-cli [-h] [--bytes] [--share] [--simple] [--csv] usage: speedtest-cli [-h] [--bytes] [--share] [--simple] [--csv]
[--csv-delimiter CSV_DELIMITER] [--json] [--list] [--csv-delimiter CSV_DELIMITER] [--csv-header] [--json]
[--server SERVER] [--mini MINI] [--source SOURCE] [--list] [--server SERVER] [--mini MINI] [--source SOURCE]
[--timeout TIMEOUT] [--secure] [--version] [--timeout TIMEOUT] [--secure] [--version]
Command line interface for testing internet bandwidth using speedtest.net. Command line interface for testing internet bandwidth using speedtest.net.
@ -91,12 +91,15 @@ Usage
results image results image
--simple Suppress verbose output, only show basic information --simple Suppress verbose output, only show basic information
--csv Suppress verbose output, only show basic information --csv Suppress verbose output, only show basic information
in CSV format in CSV format. Speeds listed in bit/s and not affected
by --bytes
--csv-delimiter CSV_DELIMITER --csv-delimiter CSV_DELIMITER
Single character delimiter to use in CSV output. Single character delimiter to use in CSV output.
Default "," Default ","
--csv-header Print CSV headers
--json Suppress verbose output, only show basic information --json Suppress verbose output, only show basic information
in JSON format in JSON format. Speeds listed in bit/s and not
affected by --bytes
--list Display a list of speedtest.net servers sorted by --list Display a list of speedtest.net servers sorted by
distance distance
--server SERVER Specify a server ID to test against --server SERVER Specify a server ID to test against

34
speedtest-cli.1
View File

@ -1,9 +1,9 @@
.TH "speedtest-cli" 1 "2014-04-23" "speedtest-cli" .TH "speedtest-cli" 1 "2014-04-23" "speedtest-cli"
.SH NAME .SH NAME
speedtest\-cli \- Test your bandwidth througput using speedtest.net speedtest\-cli \- Command line interface for testing internet bandwidth using speedtest.net
.SH SYNOPSIS .SH SYNOPSIS
.B speedtest\-cli .B speedtest\-cli
[OPTION]... [OPTION...]
.SH DESCRIPTION .SH DESCRIPTION
Speedtest.net is a web service for testing your broadband connection by downloading a file 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 a nearby speedtest.net server on the web. This tool allows you to access the service
@ -38,6 +38,26 @@ Generate and provide a URL to the speedtest.net share results image
Suppress verbose output, only show basic information Suppress verbose output, only show basic information
.RE .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 \fB\-\-list\fR
.RS .RS
Display a list of speedtest.net servers sorted by distance Display a list of speedtest.net servers sorted by distance
@ -58,6 +78,16 @@ URL of the Speedtest Mini server
Source IP address to bind to Source IP address to bind to
.RE .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\-\-version\fR \fB\-\-version\fR
.RS .RS
Show the version number and exit Show the version number and exit